EntangleCameraList

EntangleCameraList

Synopsis

struct              EntangleCameraList;
struct              EntangleCameraListClass;
EntangleCameraList * entangle_camera_list_new_active    (void);
EntangleCameraList * entangle_camera_list_new_supported (void);
gboolean            entangle_camera_list_refresh        (EntangleCameraList *list,
                                                         GError **error);
int                 entangle_camera_list_count          (EntangleCameraList *list);
void                entangle_camera_list_add            (EntangleCameraList *list,
                                                         EntangleCamera *cam);
void                entangle_camera_list_remove         (EntangleCameraList *list,
                                                         EntangleCamera *cam);
EntangleCamera *    entangle_camera_list_get            (EntangleCameraList *list,
                                                         int entry);
GList *             entangle_camera_list_get_cameras    (EntangleCameraList *list);
EntangleCamera *    entangle_camera_list_find           (EntangleCameraList *list,
                                                         const char *port);

Object Hierarchy

  GObject
   +----EntangleCameraList

Properties

  "active"                   gboolean              : Read / Write / Construct Only
  "device-manager"           EntangleDeviceManager*  : Read

Signals

  "camera-added"                                   : Run First
  "camera-removed"                                 : Run First

Description

Details

struct EntangleCameraList

struct EntangleCameraList;

struct EntangleCameraListClass

struct EntangleCameraListClass {
    GObjectClass parent_class;

    void (*camera_added)(EntangleCameraList *list, EntangleCamera *cam);
    void (*camera_removed)(EntangleCameraList *list, EntangleCamera *cam);
};

entangle_camera_list_new_active ()

EntangleCameraList * entangle_camera_list_new_active    (void);

Create a new camera list for enumerating camera cameras that are connected to the host computer

Returns :

the new camera list. [transfer full]

entangle_camera_list_new_supported ()

EntangleCameraList * entangle_camera_list_new_supported (void);

Create a new camera list for enumerating camera models that are supported by the library.

Returns :

the new camera list. [transfer full]

entangle_camera_list_refresh ()

gboolean            entangle_camera_list_refresh        (EntangleCameraList *list,
                                                         GError **error);

De-intialization the list of cameras

list :

the camera list. [transfer none]

Returns :

TRUE if the refresh was successful, FALSE on error

entangle_camera_list_count ()

int                 entangle_camera_list_count          (EntangleCameraList *list);

Get the total number of cameras currently detected

list :

the camera list. [transfer none]

Returns :

the number of cameras

entangle_camera_list_add ()

void                entangle_camera_list_add            (EntangleCameraList *list,
                                                         EntangleCamera *cam);

Adds the camera cam to the list list

list :

the camera list. [transfer none]

cam :

the camera to add. [transfer none]

entangle_camera_list_remove ()

void                entangle_camera_list_remove         (EntangleCameraList *list,
                                                         EntangleCamera *cam);

Removes the camera cam from the list list

list :

the camera list. [transfer none]

cam :

the camera to remove. [transfer none]

entangle_camera_list_get ()

EntangleCamera *    entangle_camera_list_get            (EntangleCameraList *list,
                                                         int entry);

Get the camera at position entry in the list

list :

the camera list. [transfer none]

entry :

the index of the camera to get. [transfer none]

Returns :

the camera at position entry. [transfer none]

entangle_camera_list_get_cameras ()

GList *             entangle_camera_list_get_cameras    (EntangleCameraList *list);

Get the full list of cameras

list :

the camera list. [transfer none]

Returns :

a list of EntangleCamera objects. [transfer container][element-type EntangleCamera]

entangle_camera_list_find ()

EntangleCamera *    entangle_camera_list_find           (EntangleCameraList *list,
                                                         const char *port);

Get the camera connected to hardware address port

list :

the camera list. [transfer none]

port :

the hardware port address. [transfer none]

Returns :

the camera connected to port, or NULL. [transfer none]

Property Details

The "active" property

  "active"                   gboolean              : Read / Write / Construct Only

Track kactive cameras.

Default value: FALSE


The "device-manager" property

  "device-manager"           EntangleDeviceManager*  : Read

Device manager for detecting cameras.

Signal Details

The "camera-added" signal

void                user_function                      (EntangleCameraList *entanglecameralist,
                                                        EntangleCamera     *arg1,
                                                        gpointer            user_data)               : Run First

The "camera-removed" signal

void                user_function                      (EntangleCameraList *entanglecameralist,
                                                        EntangleCamera     *arg1,
                                                        gpointer            user_data)               : Run First