libgphoto2 photo camera library (libgphoto2) API  2.4.14
gphoto2-camera.h
Go to the documentation of this file.
1 
26 #ifndef __GPHOTO2_CAMERA_H__
27 #define __GPHOTO2_CAMERA_H__
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif /* __cplusplus */
32 
44 typedef struct _Camera Camera;
45 #ifdef __cplusplus
46 }
47 #endif /* __cplusplus */
48 
49 
51 #include <gphoto2/gphoto2-port.h>
52 
53 #include <gphoto2/gphoto2-widget.h>
55 #include <gphoto2/gphoto2-result.h>
56 
57 #ifdef __cplusplus
58 extern "C" {
59 #endif /* __cplusplus */
60 
68 typedef struct {
69  char text [32 * 1024];
70 } CameraText;
71 
79 typedef struct {
80  char name [128];
81  char folder [1024];
83 
90 typedef enum {
95 
104 typedef enum {
111 
138 typedef int (*CameraExitFunc) (Camera *camera, GPContext *context);
158 typedef int (*CameraGetConfigFunc) (Camera *camera, CameraWidget **widget,
159  GPContext *context);
173 typedef int (*CameraSetConfigFunc) (Camera *camera, CameraWidget *widget,
174  GPContext *context);
175 typedef int (*CameraCaptureFunc) (Camera *camera, CameraCaptureType type,
176  CameraFilePath *path, GPContext *context);
177 typedef int (*CameraCapturePreviewFunc) (Camera *camera, CameraFile *file,
178  GPContext *context);
179 typedef int (*CameraSummaryFunc) (Camera *camera, CameraText *text,
180  GPContext *context);
181 typedef int (*CameraManualFunc) (Camera *camera, CameraText *text,
182  GPContext *context);
183 typedef int (*CameraAboutFunc) (Camera *camera, CameraText *text,
184  GPContext *context);
185 typedef int (*CameraWaitForEvent) (Camera *camera, int timeout,
186  CameraEventType *eventtype, void **eventdata,
187  GPContext *context);
205 typedef int (*CameraPrePostFunc) (Camera *camera, GPContext *context);
206 
219 typedef struct _CameraFunctions {
225  /* Configuration */
229  /* Capturing */
230  CameraCaptureFunc capture;
231  CameraCapturePreviewFunc capture_preview;
233  /* Textual information */
234  CameraSummaryFunc summary;
235  CameraManualFunc manual;
236  CameraAboutFunc about;
238  /* Event Interface */
239  CameraWaitForEvent wait_for_event;
241  /* Reserved space to use in the future without changing the struct size */
242  void *reserved1;
243  void *reserved2;
244  void *reserved3;
245  void *reserved4;
246  void *reserved5;
247  void *reserved6;
248  void *reserved7;
250 
251 /* Those are DEPRECATED */
252 typedef GPPort CameraPort;
253 typedef GPPortInfo CameraPortInfo;
254 
255 typedef struct _CameraPrivateLibrary CameraPrivateLibrary;
257 
258 struct _Camera {
259 
262  GPPort *port;
263  CameraFilesystem *fs;
264  CameraFunctions *functions;
267  CameraPrivateLibrary *pl;
269 };
270 
271 
273 int gp_camera_new (Camera **camera);
274 
275 
279 int gp_camera_set_abilities (Camera *camera, CameraAbilities abilities);
280 int gp_camera_get_abilities (Camera *camera, CameraAbilities *abilities);
281 int gp_camera_set_port_info (Camera *camera, GPPortInfo info);
282 int gp_camera_get_port_info (Camera *camera, GPPortInfo *info);
283 
295 int gp_camera_set_port_speed (Camera *camera, int speed);
296 int gp_camera_get_port_speed (Camera *camera);
297 
304 int gp_camera_init (Camera *camera, GPContext *context);
305 int gp_camera_exit (Camera *camera, GPContext *context);
306 
314 int gp_camera_ref (Camera *camera);
315 int gp_camera_unref (Camera *camera);
316 int gp_camera_free (Camera *camera);
317 
318 int gp_camera_get_config (Camera *camera, CameraWidget **window,
319  GPContext *context);
320 int gp_camera_set_config (Camera *camera, CameraWidget *window,
321  GPContext *context);
322 int gp_camera_get_summary (Camera *camera, CameraText *summary,
323  GPContext *context);
324 int gp_camera_get_manual (Camera *camera, CameraText *manual,
325  GPContext *context);
326 int gp_camera_get_about (Camera *camera, CameraText *about,
327  GPContext *context);
328 int gp_camera_capture (Camera *camera, CameraCaptureType type,
329  CameraFilePath *path, GPContext *context);
330 int gp_camera_capture_preview (Camera *camera, CameraFile *file,
331  GPContext *context);
332 int gp_camera_wait_for_event (Camera *camera, int timeout,
333  CameraEventType *eventtype, void **eventdata,
334  GPContext *context);
335 
337  int *, GPContext *context);
338 
345 int gp_camera_folder_list_files (Camera *camera, const char *folder,
346  CameraList *list, GPContext *context);
347 int gp_camera_folder_list_folders (Camera *camera, const char *folder,
348  CameraList *list, GPContext *context);
349 int gp_camera_folder_delete_all (Camera *camera, const char *folder,
350  GPContext *context);
351 int gp_camera_folder_put_file (Camera *camera, const char *folder,
352  CameraFile *file, GPContext *context);
353 int gp_camera_folder_make_dir (Camera *camera, const char *folder,
354  const char *name, GPContext *context);
355 int gp_camera_folder_remove_dir (Camera *camera, const char *folder,
356  const char *name, GPContext *context);
363 int gp_camera_file_get_info (Camera *camera, const char *folder,
364  const char *file, CameraFileInfo *info,
365  GPContext *context);
366 int gp_camera_file_set_info (Camera *camera, const char *folder,
367  const char *file, CameraFileInfo info,
368  GPContext *context);
369 int gp_camera_file_get (Camera *camera, const char *folder,
370  const char *file, CameraFileType type,
371  CameraFile *camera_file, GPContext *context);
372 int gp_camera_file_delete (Camera *camera, const char *folder,
373  const char *file, GPContext *context);
381 typedef int (* CameraTimeoutFunc) (Camera *camera,
382  GPContext *context);
383 typedef unsigned int (* CameraTimeoutStartFunc) (Camera *camera,
384  unsigned int timeout,
385  CameraTimeoutFunc func,
386  void *data);
387 typedef void (* CameraTimeoutStopFunc) (Camera *camera,
388  unsigned int id, void *data);
389 void gp_camera_set_timeout_funcs (Camera *camera,
390  CameraTimeoutStartFunc start_func,
391  CameraTimeoutStopFunc stop_func,
392  void *data);
393 int gp_camera_start_timeout (Camera *camera, unsigned int timeout,
394  CameraTimeoutFunc func);
395 void gp_camera_stop_timeout (Camera *camera, unsigned int id);
396 
398 #ifdef __cplusplus
399 }
400 #endif /* __cplusplus */
401 
402 #endif /* __GPHOTO2_CAMERA_H__ */