Camera

Name

Camera -- 

Synopsis



int         (*CameraExitFunc)               (Camera *camera,
                                             GPContext *context);
int         (*CameraGetConfigFunc)          (Camera *camera,
                                             CameraWidget **widget,
                                             GPContext *context);
int         (*CameraSetConfigFunc)          (Camera *camera,
                                             CameraWidget *widget,
                                             GPContext *context);
int         (*CameraCaptureFunc)            (Camera *camera,
                                             CameraCaptureType type,
                                             CameraFilePath *path,
                                             GPContext *context);
int         (*CameraCapturePreviewFunc)     (Camera *camera,
                                             CameraFile *file,
                                             GPContext *context);
int         (*CameraSummaryFunc)            (Camera *camera,
                                             CameraText *text,
                                             GPContext *context);
int         (*CameraManualFunc)             (Camera *camera,
                                             CameraText *text,
                                             GPContext *context);
int         (*CameraAboutFunc)              (Camera *camera,
                                             CameraText *text,
                                             GPContext *context);
int         (*CameraPrePostFunc)            (Camera *camera,
                                             GPContext *context);
            CameraPrivateLibrary;
            CameraPrivateCore;
            CameraText;
            CameraFunctions;
            Camera;
int         gp_camera_new                   (Camera **camera);
int         gp_camera_ref                   (Camera *camera);
int         gp_camera_unref                 (Camera *camera);
int         gp_camera_free                  (Camera *camera);
int         gp_camera_set_abilities         (Camera *camera,
                                             CameraAbilities abilities);
int         gp_camera_get_abilities         (Camera *camera,
                                             CameraAbilities *abilities);
int         gp_camera_set_port_info         (Camera *camera,
                                             GPPortInfo info);
int         gp_camera_get_port_info         (Camera *camera,
                                             GPPortInfo *info);
int         gp_camera_get_port_speed        (Camera *camera);
int         gp_camera_set_port_speed        (Camera *camera,
                                             int speed);
int         gp_camera_init                  (Camera *camera,
                                             GPContext *context);
int         gp_camera_exit                  (Camera *camera,
                                             GPContext *context);
            CameraFilePath;
enum        CameraCaptureType;
int         gp_camera_capture               (Camera *camera,
                                             CameraCaptureType type,
                                             CameraFilePath *path,
                                             GPContext *context);
int         gp_camera_capture_preview       (Camera *camera,
                                             CameraFile *file,
                                             GPContext *context);
int         gp_camera_get_config            (Camera *camera,
                                             CameraWidget **window,
                                             GPContext *context);
int         gp_camera_set_config            (Camera *camera,
                                             CameraWidget *window,
                                             GPContext *context);
int         gp_camera_folder_list_files     (Camera *camera,
                                             const char *folder,
                                             CameraList *list,
                                             GPContext *context);
int         gp_camera_folder_list_folders   (Camera *camera,
                                             const char *folder,
                                             CameraList *list,
                                             GPContext *context);
int         gp_camera_folder_put_file       (Camera *camera,
                                             const char *folder,
                                             CameraFile *file,
                                             GPContext *context);
int         gp_camera_folder_delete_all     (Camera *camera,
                                             const char *folder,
                                             GPContext *context);
int         gp_camera_folder_make_dir       (Camera *camera,
                                             const char *folder,
                                             const char *name,
                                             GPContext *context);
int         gp_camera_folder_remove_dir     (Camera *camera,
                                             const char *folder,
                                             const char *name,
                                             GPContext *context);
int         gp_camera_file_get              (Camera *camera,
                                             const char *folder,
                                             const char *file,
                                             CameraFileType type,
                                             CameraFile *camera_file,
                                             GPContext *context);
int         gp_camera_file_delete           (Camera *camera,
                                             const char *folder,
                                             const char *file,
                                             GPContext *context);
int         gp_camera_file_get_info         (Camera *camera,
                                             const char *folder,
                                             const char *file,
                                             CameraFileInfo *info,
                                             GPContext *context);
int         gp_camera_file_set_info         (Camera *camera,
                                             const char *folder,
                                             const char *file,
                                             CameraFileInfo info,
                                             GPContext *context);
int         gp_camera_get_manual            (Camera *camera,
                                             CameraText *manual,
                                             GPContext *context);
int         gp_camera_get_summary           (Camera *camera,
                                             CameraText *summary,
                                             GPContext *context);
int         gp_camera_get_about             (Camera *camera,
                                             CameraText *about,
                                             GPContext *context);

Description

Details

CameraExitFunc ()

int         (*CameraExitFunc)               (Camera *camera,
                                             GPContext *context);

camera :

context :

Returns :


CameraGetConfigFunc ()

int         (*CameraGetConfigFunc)          (Camera *camera,
                                             CameraWidget **widget,
                                             GPContext *context);

camera :

widget :

context :

Returns :


CameraSetConfigFunc ()

int         (*CameraSetConfigFunc)          (Camera *camera,
                                             CameraWidget *widget,
                                             GPContext *context);

camera :

widget :

context :

Returns :


CameraCaptureFunc ()

int         (*CameraCaptureFunc)            (Camera *camera,
                                             CameraCaptureType type,
                                             CameraFilePath *path,
                                             GPContext *context);

camera :

type :

path :

context :

Returns :


CameraCapturePreviewFunc ()

int         (*CameraCapturePreviewFunc)     (Camera *camera,
                                             CameraFile *file,
                                             GPContext *context);

camera :

file :

context :

Returns :


CameraSummaryFunc ()

int         (*CameraSummaryFunc)            (Camera *camera,
                                             CameraText *text,
                                             GPContext *context);

camera :

text :

context :

Returns :


CameraManualFunc ()

int         (*CameraManualFunc)             (Camera *camera,
                                             CameraText *text,
                                             GPContext *context);

camera :

text :

context :

Returns :


CameraAboutFunc ()

int         (*CameraAboutFunc)              (Camera *camera,
                                             CameraText *text,
                                             GPContext *context);

camera :

text :

context :

Returns :


CameraPrePostFunc ()

int         (*CameraPrePostFunc)            (Camera *camera,
                                             GPContext *context);

camera :

context :

Returns :


CameraPrivateLibrary

typedef struct _CameraPrivateLibrary CameraPrivateLibrary;


CameraPrivateCore

typedef struct _CameraPrivateCore CameraPrivateCore;


CameraText

typedef struct {
	char text [32 * 1024];
} CameraText;


CameraFunctions

typedef struct {
	/* Those will be called before and after each operation */
	CameraPrePostFunc pre_func;
	CameraPrePostFunc post_func;

	CameraExitFunc exit;

	/* Configuration */
	CameraGetConfigFunc       get_config;
	CameraSetConfigFunc       set_config;

	/* Capturing */
	CameraCaptureFunc        capture;
	CameraCapturePreviewFunc capture_preview;

	/* Textual information */
	CameraSummaryFunc summary;
	CameraManualFunc  manual;
	CameraAboutFunc   about;

	/* Reserved space to use in the future without changing the struct size */
	void *reserved1;
	void *reserved2;
	void *reserved3;
	void *reserved4;
	void *reserved5;
	void *reserved6;
	void *reserved7;
	void *reserved8;
} CameraFunctions;


Camera

typedef struct {
	/** \name Those should be accessed only by the camera driver.
	 * @{ */
	GPPort           *port;
	CameraFilesystem *fs;
	CameraFunctions  *functions;
 	/**@}*/

	CameraPrivateLibrary  *pl; /**< Private data of camera libraries.    */
	CameraPrivateCore     *pc; /**< Private data of the core of gphoto2. */
} Camera;


gp_camera_new ()

int         gp_camera_new                   (Camera **camera);

camera :

Returns :


gp_camera_ref ()

int         gp_camera_ref                   (Camera *camera);

camera :

Returns :


gp_camera_unref ()

int         gp_camera_unref                 (Camera *camera);

camera :

Returns :


gp_camera_free ()

int         gp_camera_free                  (Camera *camera);

camera :

Returns :


gp_camera_set_abilities ()

int         gp_camera_set_abilities         (Camera *camera,
                                             CameraAbilities abilities);

camera :

abilities :

Returns :


gp_camera_get_abilities ()

int         gp_camera_get_abilities         (Camera *camera,
                                             CameraAbilities *abilities);

camera :

abilities :

Returns :


gp_camera_set_port_info ()

int         gp_camera_set_port_info         (Camera *camera,
                                             GPPortInfo info);

camera :

info :

Returns :


gp_camera_get_port_info ()

int         gp_camera_get_port_info         (Camera *camera,
                                             GPPortInfo *info);

camera :

info :

Returns :


gp_camera_get_port_speed ()

int         gp_camera_get_port_speed        (Camera *camera);

camera :

Returns :


gp_camera_set_port_speed ()

int         gp_camera_set_port_speed        (Camera *camera,
                                             int speed);

camera :

speed :

Returns :


gp_camera_init ()

int         gp_camera_init                  (Camera *camera,
                                             GPContext *context);

camera :

context :

Returns :


gp_camera_exit ()

int         gp_camera_exit                  (Camera *camera,
                                             GPContext *context);

camera :

context :

Returns :


CameraFilePath

typedef struct {
	char name [128];
	char folder [1024];
} CameraFilePath;


enum CameraCaptureType

typedef enum {
	GP_CAPTURE_IMAGE,
	GP_CAPTURE_MOVIE,
	GP_CAPTURE_SOUND
} CameraCaptureType;


gp_camera_capture ()

int         gp_camera_capture               (Camera *camera,
                                             CameraCaptureType type,
                                             CameraFilePath *path,
                                             GPContext *context);

Captures an image, movie, or sound clip depending on the given type. The resulting file will be stored on the camera. The location gets stored in path. The file can then be downloaded using gp_camera_file_get.

\return a gphoto2 error code

camera :

a Camera

type :

a CameraCaptureType

path :

a CameraFilePath

context :

a GPContext

Returns :


gp_camera_capture_preview ()

int         gp_camera_capture_preview       (Camera *camera,
                                             CameraFile *file,
                                             GPContext *context);

Captures a preview that won't be stored on the camera but returned in supplied file. For example, you could use gp_capture_preview for taking some sample pictures before calling gp_capture.

\return a gphoto2 error code

camera :

file :

context :

Returns :


gp_camera_get_config ()

int         gp_camera_get_config            (Camera *camera,
                                             CameraWidget **window,
                                             GPContext *context);

camera :

window :

context :

Returns :


gp_camera_set_config ()

int         gp_camera_set_config            (Camera *camera,
                                             CameraWidget *window,
                                             GPContext *context);

Sets the configuration. Typically, a window is retrieved using gp_camera_get_config and passed to this function in order to adjust the settings on the camera.

\return a gphoto2 error code

camera :

a Camera

window :

a CameraWidget

context :

a GPContext

Returns :


gp_camera_folder_list_files ()

int         gp_camera_folder_list_files     (Camera *camera,
                                             const char *folder,
                                             CameraList *list,
                                             GPContext *context);

Lists the files in supplied folder.

\return a gphoto2 error code

camera :

folder :

list :

context :

Returns :


gp_camera_folder_list_folders ()

int         gp_camera_folder_list_folders   (Camera *camera,
                                             const char *folder,
                                             CameraList *list,
                                             GPContext *context);

Lists the folders in supplied folder.

\return a gphoto2 error code

camera :

folder :

list :

context :

Returns :


gp_camera_folder_put_file ()

int         gp_camera_folder_put_file       (Camera *camera,
                                             const char *folder,
                                             CameraFile *file,
                                             GPContext *context);

Uploads a file into given folder.

\return a gphoto2 error code

camera :

folder :

file :

context :

Returns :


gp_camera_folder_delete_all ()

int         gp_camera_folder_delete_all     (Camera *camera,
                                             const char *folder,
                                             GPContext *context);

Deletes all files in a given folder.

\return a gphoto2 error code

camera :

folder :

context :

Returns :


gp_camera_folder_make_dir ()

int         gp_camera_folder_make_dir       (Camera *camera,
                                             const char *folder,
                                             const char *name,
                                             GPContext *context);

Creates a new directory called name in given folder.

\return a gphoto2 error code

camera :

folder :

name :

context :

Returns :


gp_camera_folder_remove_dir ()

int         gp_camera_folder_remove_dir     (Camera *camera,
                                             const char *folder,
                                             const char *name,
                                             GPContext *context);

Removes an (empty) directory called name from the given folder.

\return a gphoto2 error code

camera :

folder :

name :

context :

Returns :


gp_camera_file_get ()

int         gp_camera_file_get              (Camera *camera,
                                             const char *folder,
                                             const char *file,
                                             CameraFileType type,
                                             CameraFile *camera_file,
                                             GPContext *context);

Retrieves a file from the camera.

\return a gphoto2 error code

camera :

folder :

file :

type :

camera_file :

context :

Returns :


gp_camera_file_delete ()

int         gp_camera_file_delete           (Camera *camera,
                                             const char *folder,
                                             const char *file,
                                             GPContext *context);

Deletes the file from a folder.

\return a gphoto2 error code

camera :

folder :

file :

context :

Returns :


gp_camera_file_get_info ()

int         gp_camera_file_get_info         (Camera *camera,
                                             const char *folder,
                                             const char *file,
                                             CameraFileInfo *info,
                                             GPContext *context);

Retrieves information about a file.

\return a gphoto2 error code

camera :

folder :

file :

info :

context :

Returns :


gp_camera_file_set_info ()

int         gp_camera_file_set_info         (Camera *camera,
                                             const char *folder,
                                             const char *file,
                                             CameraFileInfo info,
                                             GPContext *context);

Sets some file properties like name or permissions.

\return a gphoto2 error code

camera :

folder :

file :

info :

context :

Returns :


gp_camera_get_manual ()

int         gp_camera_get_manual            (Camera *camera,
                                             CameraText *manual,
                                             GPContext *context);

Retrieves the manual for given camera. This manual typically contains information about using the camera.

\return a gphoto2 error code

camera :

a Camera

manual :

a CameraText

context :

a GPContext

Returns :


gp_camera_get_summary ()

int         gp_camera_get_summary           (Camera *camera,
                                             CameraText *summary,
                                             GPContext *context);

Retrieves a camera summary. This summary typically contains information like manufacturer, pictures taken, or generally information that is not configurable.

\return a gphoto2 error code

camera :

a Camera

summary :

a CameraText

context :

a GPContext

Returns :


gp_camera_get_about ()

int         gp_camera_get_about             (Camera *camera,
                                             CameraText *about,
                                             GPContext *context);

Retrieves information about the camera driver. Typically, this information contains name and address of the author, acknowledgements, etc.

\return a gphoto2 error code

camera :

a Camera

about :

a CameraText

context :

a GPContext

Returns :