2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef __TIZEN_MULTIMEDIA_CAMERA_H__
18 #define __TIZEN_MULTIMEDIA_CAMERA_H__
21 #include <media_packet.h>
29 * @brief This file contains the Camera API, related structures and enumerations.
34 * @addtogroup CAPI_MEDIA_CAMERA_MODULE
39 * @brief Tizen error class for camera.
42 #define CAMERA_ERROR_CLASS TIZEN_ERROR_CAMERA | 0x00
45 * @brief Enumeration for the error codes of Camera.
49 CAMERA_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
50 CAMERA_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
51 CAMERA_ERROR_INVALID_STATE = CAMERA_ERROR_CLASS | 0x02, /**< Invalid state */
52 CAMERA_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
53 CAMERA_ERROR_DEVICE = CAMERA_ERROR_CLASS | 0x04, /**< Device error */
54 CAMERA_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Internal error */
55 CAMERA_ERROR_SECURITY_RESTRICTED = CAMERA_ERROR_CLASS | 0x07, /**< Restricted by security system policy */
56 CAMERA_ERROR_DEVICE_BUSY = CAMERA_ERROR_CLASS | 0x08, /**< The device is using another application or working on some operation */
57 CAMERA_ERROR_DEVICE_NOT_FOUND = CAMERA_ERROR_CLASS | 0x09, /**< No camera device */
58 CAMERA_ERROR_ESD = CAMERA_ERROR_CLASS | 0x0c, /**< ESD situation */
59 CAMERA_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< The access to the resources can not be granted*/
60 CAMERA_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< The feature is not supported */
61 CAMERA_ERROR_RESOURCE_CONFLICT = CAMERA_ERROR_CLASS | 0x0d, /**< Blocked by resource conflict (Since 3.0) */
62 CAMERA_ERROR_SERVICE_DISCONNECTED = CAMERA_ERROR_CLASS | 0x0e, /**< Socket connection lost (Since 3.0) */
66 * @brief Enumeration for the camera state.
70 CAMERA_STATE_NONE, /**< Before creating */
71 CAMERA_STATE_CREATED, /**< Created, but not initialized yet */
72 CAMERA_STATE_PREVIEW, /**< Preview */
73 CAMERA_STATE_CAPTURING, /**< While capturing */
74 CAMERA_STATE_CAPTURED /**< After capturing */
78 * @brief Enumeration for the camera device state.
82 CAMERA_DEVICE_STATE_NULL, /**< Not opened */
83 CAMERA_DEVICE_STATE_OPENED, /**< Opened */
84 CAMERA_DEVICE_STATE_WORKING /**< Now previewing or capturing or is being used for video recording */
85 } camera_device_state_e;
88 * @brief Enumeration for the camera device.
92 CAMERA_DEVICE_CAMERA0 = 0, /**< Primary camera */
93 CAMERA_DEVICE_CAMERA1, /**< Secondary camera */
94 CAMERA_DEVICE_CAMERA2, /**< Third camera (Since 5.0) */
95 CAMERA_DEVICE_CAMERA3, /**< 4th camera (Since 5.0) */
96 CAMERA_DEVICE_CAMERA4, /**< 5th camera (Since 5.0) */
97 CAMERA_DEVICE_CAMERA5, /**< 6th camera (Since 5.0) */
98 CAMERA_DEVICE_CAMERA6, /**< 7th camera (Since 5.0) */
99 CAMERA_DEVICE_CAMERA7, /**< 8th camera (Since 5.0) */
100 CAMERA_DEVICE_CAMERA8, /**< 9th camera (Since 5.0) */
101 CAMERA_DEVICE_CAMERA9 /**< 10th camera (Since 5.0) */
105 * @brief Enumeration for the camera pixel format.
107 * @remarks If #CAMERA_PIXEL_FORMAT_INVZ is set, the type of display should be #CAMERA_DISPLAY_TYPE_NONE. \n
108 * Otherwise, camera_start_preview() will return #CAMERA_ERROR_INVALID_OPERATION. (Since 5.0)
111 CAMERA_PIXEL_FORMAT_INVALID = -1, /**< Invalid pixel format */
112 CAMERA_PIXEL_FORMAT_NV12, /**< NV12 pixel format */
113 CAMERA_PIXEL_FORMAT_NV12T, /**< NV12 Tiled pixel format */
114 CAMERA_PIXEL_FORMAT_NV16, /**< NV16 pixel format */
115 CAMERA_PIXEL_FORMAT_NV21, /**< NV21 pixel format */
116 CAMERA_PIXEL_FORMAT_YUYV, /**< YUYV(YUY2) pixel format */
117 CAMERA_PIXEL_FORMAT_UYVY, /**< UYVY pixel format */
118 CAMERA_PIXEL_FORMAT_422P, /**< YUV422(Y:U:V) planar pixel format */
119 CAMERA_PIXEL_FORMAT_I420, /**< I420 pixel format */
120 CAMERA_PIXEL_FORMAT_YV12, /**< YV12 pixel format */
121 CAMERA_PIXEL_FORMAT_RGB565, /**< RGB565 pixel format */
122 CAMERA_PIXEL_FORMAT_RGB888, /**< RGB888 pixel format */
123 CAMERA_PIXEL_FORMAT_RGBA, /**< RGBA pixel format */
124 CAMERA_PIXEL_FORMAT_ARGB, /**< ARGB pixel format */
125 CAMERA_PIXEL_FORMAT_JPEG, /**< Encoded pixel format */
126 CAMERA_PIXEL_FORMAT_H264 = 15, /**< Encoded pixel format : H264 (Since 3.0) */
127 CAMERA_PIXEL_FORMAT_INVZ, /**< Depth pixel format : INVZ (Since 5.0) */
128 CAMERA_PIXEL_FORMAT_MJPEG, /**< Encoded pixel format : Motion JPEG for preview (Since 6.0) */
129 CAMERA_PIXEL_FORMAT_VP8, /**< Encoded pixel format : VP8 (Since 6.5) */
130 CAMERA_PIXEL_FORMAT_VP9 /**< Encoded pixel format : VP9 (Since 6.5) */
131 } camera_pixel_format_e;
134 * @brief Enumeration for the camera display type.
138 CAMERA_DISPLAY_TYPE_OVERLAY = 0, /**< Overlay surface display */
139 CAMERA_DISPLAY_TYPE_EVAS, /**< Evas object surface display */
140 CAMERA_DISPLAY_TYPE_NONE /**< This disposes off buffers */
141 } camera_display_type_e;
144 * @brief Enumeration for the camera policy.
148 CAMERA_POLICY_NONE = 0, /**< None */
149 CAMERA_POLICY_SECURITY = 4, /**< Security policy */
150 CAMERA_POLICY_RESOURCE_CONFLICT /**< Resource conflict (Since 3.0) */
154 * @brief Enumeration for the camera rotation type.
158 CAMERA_ROTATION_NONE, /**< No rotation */
159 CAMERA_ROTATION_90, /**< 90 degree rotation */
160 CAMERA_ROTATION_180, /**< 180 degree rotation */
161 CAMERA_ROTATION_270, /**< 270 degree rotation */
166 * @brief Enumeration for the camera flip type.
170 CAMERA_FLIP_NONE, /**< No Flip */
171 CAMERA_FLIP_HORIZONTAL, /**< Horizontal flip */
172 CAMERA_FLIP_VERTICAL, /**< Vertical flip */
173 CAMERA_FLIP_BOTH /**< Horizontal and vertical flip */
177 * @brief Enumeration for the camera focus state.
181 CAMERA_FOCUS_STATE_RELEASED = 0, /**< Focus released */
182 CAMERA_FOCUS_STATE_ONGOING, /**< Focus in progress */
183 CAMERA_FOCUS_STATE_FOCUSED, /**< Focus succeeded */
184 CAMERA_FOCUS_STATE_FAILED, /**< Focus failed */
185 } camera_focus_state_e;
188 * @brief Enumeration for the facing direction of camera module.
192 CAMERA_FACING_DIRECTION_REAR = 0, /**< Rear */
193 CAMERA_FACING_DIRECTION_FRONT, /**< Front */
194 } camera_facing_direction_e;
197 * @brief Enumeration for the current flash state.
201 CAMERA_FLASH_STATE_NOT_USED = 0, /**< Flash is not used now through camera API */
202 CAMERA_FLASH_STATE_USED, /**< Flash is used now through camera API */
203 } camera_flash_state_e;
206 * @brief Enumeration for the device type.
210 CAMERA_DEVICE_TYPE_BUILTIN = 0, /**< Built-in camera */
211 CAMERA_DEVICE_TYPE_USB, /**< USB camera */
212 CAMERA_DEVICE_TYPE_NETWORK /**< Network camera */
213 } camera_device_type_e;
216 * @brief The structure type of the image data.
220 unsigned char *data; /**< The image buffer */
221 unsigned int size; /**< The size of the buffer */
222 int width; /**< The width of the image */
223 int height; /**< The height of the image */
224 camera_pixel_format_e format; /**< The format of the image pixel */
225 unsigned char *exif; /**< The exif raw data */
226 unsigned int exif_size; /**< The size of the exif data */
227 } camera_image_data_s;
230 * @brief The structure type for face detection.
234 int id; /**< The ID of each face */
235 int score; /**< The confidence level for the detection of the face */
236 int x; /**< The x coordinates of the face */
237 int y; /**< The y coordinates of the face */
238 int width; /**< The width of the face */
239 int height; /**< The height of the face */
240 } camera_detected_face_s;
243 * @brief The structure type to preview stream data.
247 camera_pixel_format_e format; /**< The format of the frame pixel */
248 int width; /**< The width of the frame */
249 int height; /**< The height of the frame */
250 int num_of_planes; /**< The number of planes */
251 unsigned int timestamp; /**< The timestamp of the frame */
254 unsigned char *yuv; /**< The yuv data pointer */
255 unsigned int size; /**< The size of data */
256 } single_plane; /**< Single plane frame data */
259 unsigned char *y; /**< The y data pointer */
260 unsigned char *uv; /**< The uv data pointer */
261 unsigned int y_size; /**< The size of y data */
262 unsigned int uv_size; /**< The size of uv data */
263 } double_plane; /**< Double plane frame data */
266 unsigned char *y; /**< The y data pointer */
267 unsigned char *u; /**< The u data pointer */
268 unsigned char *v; /**< The v data pointer */
269 unsigned int y_size; /**< The size of y data */
270 unsigned int u_size; /**< The size of u data */
271 unsigned int v_size; /**< The size of v data */
272 } triple_plane; /**< Triple plane frame data */
275 unsigned char *data; /**< The encoded data pointer */
276 unsigned int size; /**< The size of encoded data */
277 bool is_delta_frame; /**< The flag indicating whether it's delta frame or not (Since 6.0) */
278 } encoded_plane; /**< Encoded plane frame data */
281 unsigned char *data; /**< The depth data pointer */
282 unsigned int size; /**< The size of depth data */
283 } depth_plane; /**< Depth plane frame data (Since 5.0) */
286 unsigned char *data; /**< The RGB data pointer */
287 unsigned int size; /**< The size of RGB data */
288 } rgb_plane; /**< RGB plane frame data (Since 5.0) */
289 } data; /**< The frame data */
290 } camera_preview_data_s;
294 * @brief Maximum length of the camera device name.
297 #define CAMERA_DEVICE_NAME_MAX_LENGTH 64
300 * @brief Maximum length of the camera device ID.
303 #define CAMERA_DEVICE_ID_MAX_LENGTH 64
306 * @brief The structure type for the camera device.
309 typedef struct _camera_device_s {
310 camera_device_type_e type; /**< The type of camera device */
311 camera_device_e index; /**< The index of camera device */
312 char name[CAMERA_DEVICE_NAME_MAX_LENGTH]; /**< The name of camera device */
313 char id[CAMERA_DEVICE_ID_MAX_LENGTH]; /**< The ID of camera device */
314 int extra_stream_num; /**< The extra preview stream number of camera device */
318 * @brief The Camera handle.
320 * @see recorder_create_videorecorder()
322 typedef struct camera_cli_s *camera_h;
325 * @brief The Camera display handle.
328 typedef void *camera_display_h;
333 * @brief Gets a display handle.
336 #define GET_DISPLAY(x) (void*)(x)
341 * @brief The Camera device manager handle.
344 typedef void *camera_device_manager_h;
351 * @addtogroup CAPI_MEDIA_CAMERA_DISPLAY_MODULE
356 * @brief Enumeration for the camera display mode.
360 CAMERA_DISPLAY_MODE_LETTER_BOX = 0, /**< Letter box */
361 CAMERA_DISPLAY_MODE_ORIGIN_SIZE, /**< Origin size */
362 CAMERA_DISPLAY_MODE_FULL, /**< Full screen */
363 CAMERA_DISPLAY_MODE_CROPPED_FULL, /**< Cropped full screen */
364 CAMERA_DISPLAY_MODE_ORIGIN_OR_LETTER_BOX, /**< Original size or letter box (Since 3.0) */
365 CAMERA_DISPLAY_MODE_CUSTOM_ROI, /**< Custom ROI (Since 3.0) */
366 } camera_display_mode_e;
373 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
378 * @brief Enumeration for the color tone, which provides the impression of looking through a tinted glass.
382 CAMERA_ATTR_EFFECT_NONE = 0, /**< None */
383 CAMERA_ATTR_EFFECT_MONO, /**< Mono */
384 CAMERA_ATTR_EFFECT_SEPIA, /**< Sepia */
385 CAMERA_ATTR_EFFECT_NEGATIVE, /**< Negative */
386 CAMERA_ATTR_EFFECT_BLUE, /**< Blue */
387 CAMERA_ATTR_EFFECT_GREEN, /**< Green */
388 CAMERA_ATTR_EFFECT_AQUA, /**< Aqua */
389 CAMERA_ATTR_EFFECT_VIOLET, /**< Violet */
390 CAMERA_ATTR_EFFECT_ORANGE, /**< Orange */
391 CAMERA_ATTR_EFFECT_GRAY, /**< Gray */
392 CAMERA_ATTR_EFFECT_RED, /**< Red */
393 CAMERA_ATTR_EFFECT_ANTIQUE, /**< Antique */
394 CAMERA_ATTR_EFFECT_WARM, /**< Warm */
395 CAMERA_ATTR_EFFECT_PINK, /**< Pink */
396 CAMERA_ATTR_EFFECT_YELLOW, /**< Yellow */
397 CAMERA_ATTR_EFFECT_PURPLE, /**< Purple */
398 CAMERA_ATTR_EFFECT_EMBOSS, /**< Emboss */
399 CAMERA_ATTR_EFFECT_OUTLINE, /**< Outline */
400 CAMERA_ATTR_EFFECT_SOLARIZATION, /**< Solarization */
401 CAMERA_ATTR_EFFECT_SKETCH, /**< Sketch */
402 CAMERA_ATTR_EFFECT_WASHED, /**< Washed */
403 CAMERA_ATTR_EFFECT_VINTAGE_WARM, /**< Vintage warm */
404 CAMERA_ATTR_EFFECT_VINTAGE_COLD, /**< Vintage cold */
405 CAMERA_ATTR_EFFECT_POSTERIZATION, /**< Posterization */
406 CAMERA_ATTR_EFFECT_CARTOON, /**< Cartoon */
407 CAMERA_ATTR_EFFECT_SELECTIVE_RED, /**< Selective color - Red */
408 CAMERA_ATTR_EFFECT_SELECTIVE_GREEN, /**< Selective color - Green */
409 CAMERA_ATTR_EFFECT_SELECTIVE_BLUE, /**< Selective color - Blue */
410 CAMERA_ATTR_EFFECT_SELECTIVE_YELLOW, /**< Selective color - Yellow */
411 CAMERA_ATTR_EFFECT_SELECTIVE_RED_YELLOW, /**< Selective color - Red and Yellow */
412 CAMERA_ATTR_EFFECT_OTHER_GRAPHICS, /**< Other Graphic effects */
413 } camera_attr_effect_mode_e;
416 * @brief Enumeration for the white balance levels of the camera.
420 CAMERA_ATTR_WHITE_BALANCE_NONE = 0, /**< None */
421 CAMERA_ATTR_WHITE_BALANCE_AUTOMATIC, /**< Automatic */
422 CAMERA_ATTR_WHITE_BALANCE_DAYLIGHT, /**< Daylight */
423 CAMERA_ATTR_WHITE_BALANCE_CLOUDY, /**< Cloudy */
424 CAMERA_ATTR_WHITE_BALANCE_FLUORESCENT, /**< Fluorescent */
425 CAMERA_ATTR_WHITE_BALANCE_INCANDESCENT, /**< Incandescent */
426 CAMERA_ATTR_WHITE_BALANCE_SHADE, /**< Shade */
427 CAMERA_ATTR_WHITE_BALANCE_HORIZON, /**< Horizon */
428 CAMERA_ATTR_WHITE_BALANCE_FLASH, /**< Flash */
429 CAMERA_ATTR_WHITE_BALANCE_CUSTOM, /**< Custom */
430 } camera_attr_whitebalance_e;
433 * @brief Enumeration for the scene mode.
434 * @details The mode of operation can be in daylight, night, or back-light.
438 CAMERA_ATTR_SCENE_MODE_NORMAL = 0, /**< Normal */
439 CAMERA_ATTR_SCENE_MODE_PORTRAIT, /**< Portrait */
440 CAMERA_ATTR_SCENE_MODE_LANDSCAPE, /**< Landscape */
441 CAMERA_ATTR_SCENE_MODE_SPORTS, /**< Sports */
442 CAMERA_ATTR_SCENE_MODE_PARTY_N_INDOOR, /**< Party & indoor */
443 CAMERA_ATTR_SCENE_MODE_BEACH_N_INDOOR, /**< Beach & indoor */
444 CAMERA_ATTR_SCENE_MODE_SUNSET, /**< Sunset */
445 CAMERA_ATTR_SCENE_MODE_DUSK_N_DAWN, /**< Dusk & dawn */
446 CAMERA_ATTR_SCENE_MODE_FALL_COLOR, /**< Fall */
447 CAMERA_ATTR_SCENE_MODE_NIGHT_SCENE, /**< Night scene */
448 CAMERA_ATTR_SCENE_MODE_FIREWORK, /**< Firework */
449 CAMERA_ATTR_SCENE_MODE_TEXT, /**< Text */
450 CAMERA_ATTR_SCENE_MODE_SHOW_WINDOW, /**< Show window */
451 CAMERA_ATTR_SCENE_MODE_CANDLE_LIGHT, /**< Candle light */
452 CAMERA_ATTR_SCENE_MODE_BACKLIGHT, /**< Backlight */
453 CAMERA_ATTR_SCENE_MODE_AQUA, /**< Aqua */
454 } camera_attr_scene_mode_e;
457 * @brief Enumeration for the auto focus mode.
461 CAMERA_ATTR_AF_NONE = 0, /**< auto-focus is not set */
462 CAMERA_ATTR_AF_NORMAL, /**< auto-focus in the normal mode */
463 CAMERA_ATTR_AF_MACRO, /**< auto-focus in the macro mode(close distance) */
464 CAMERA_ATTR_AF_FULL, /**< auto-focus in the full mode(all range scan, limited by device spec) */
465 } camera_attr_af_mode_e;
468 * @brief Enumeration for the ISO levels of the camera.
472 CAMERA_ATTR_ISO_AUTO = 0, /**< ISO auto mode */
473 CAMERA_ATTR_ISO_50, /**< ISO 50 */
474 CAMERA_ATTR_ISO_100, /**< ISO 100 */
475 CAMERA_ATTR_ISO_200, /**< ISO 200 */
476 CAMERA_ATTR_ISO_400, /**< ISO 400 */
477 CAMERA_ATTR_ISO_800, /**< ISO 800 */
478 CAMERA_ATTR_ISO_1600, /**< ISO 1600 */
479 CAMERA_ATTR_ISO_3200, /**< ISO 3200 */
483 * @brief Enumeration for the camera exposure modes.
487 CAMERA_ATTR_EXPOSURE_MODE_OFF = 0, /**< Off */
488 CAMERA_ATTR_EXPOSURE_MODE_ALL, /**< All mode */
489 CAMERA_ATTR_EXPOSURE_MODE_CENTER, /**< Center mode */
490 CAMERA_ATTR_EXPOSURE_MODE_SPOT, /**< Spot mode */
491 CAMERA_ATTR_EXPOSURE_MODE_CUSTOM, /**< Custom mode */
492 CAMERA_ATTR_EXPOSURE_MODE_SHUTTER_PRIORITY, /**< Shutter priority mode (Since 8.0) */
493 CAMERA_ATTR_EXPOSURE_MODE_APERTURE_PRIORITY /**< Aperture priority mode (Since 8.0) */
494 } camera_attr_exposure_mode_e;
497 * @brief Enumeration for the orientation values of tag.
501 CAMERA_ATTR_TAG_ORIENTATION_TOP_LEFT = 1, /**< Row #0 is at the top, Column #0 is to the left */
502 CAMERA_ATTR_TAG_ORIENTATION_TOP_RIGHT = 2, /**< Row #0 is at the top, Column #0 is to the right (flipped) */
503 CAMERA_ATTR_TAG_ORIENTATION_BOTTOM_RIGHT = 3, /**< Row #0 is at the bottom, Column #0 is to the right */
504 CAMERA_ATTR_TAG_ORIENTATION_BOTTOM_LEFT = 4, /**< Row #0 is at the bottom, Column #0 is to the left (flipped) */
505 CAMERA_ATTR_TAG_ORIENTATION_LEFT_TOP = 5, /**< Row #0 is to the left, Column #0 is at the top (flipped) */
506 CAMERA_ATTR_TAG_ORIENTATION_RIGHT_TOP = 6, /**< Row #0 is to the right, Column #0 is at the top */
507 CAMERA_ATTR_TAG_ORIENTATION_RIGHT_BOTTOM = 7, /**< Row #0 is to the right, Column #0 is at the bottom (flipped) */
508 CAMERA_ATTR_TAG_ORIENTATION_LEFT_BOTTOM = 8, /**< Row #0 is to the left, Column #0 is at the bottom */
509 } camera_attr_tag_orientation_e;
512 * @brief Enumeration for the flash mode.
516 CAMERA_ATTR_FLASH_MODE_OFF = 0, /**< Always off */
517 CAMERA_ATTR_FLASH_MODE_ON, /**< Always splashes */
518 CAMERA_ATTR_FLASH_MODE_AUTO, /**< Depending on intensity of light, strobe starts to flash */
519 CAMERA_ATTR_FLASH_MODE_REDEYE_REDUCTION, /**< Red eye reduction. Multiple flash before capturing */
520 CAMERA_ATTR_FLASH_MODE_SLOW_SYNC, /**< Slow sync curtain synchronization */
521 CAMERA_ATTR_FLASH_MODE_FRONT_CURTAIN, /**< Front curtain synchronization */
522 CAMERA_ATTR_FLASH_MODE_REAR_CURTAIN, /**< Rear curtain synchronization */
523 CAMERA_ATTR_FLASH_MODE_PERMANENT, /**< Keep turned on until turning off */
524 } camera_attr_flash_mode_e;
527 * @brief Enumeration to preview FPS.
531 CAMERA_ATTR_FPS_AUTO = 0, /**< AUTO FPS */
532 CAMERA_ATTR_FPS_7 = 7, /**< 7 FPS */
533 CAMERA_ATTR_FPS_8 = 8, /**< 8 FPS */
534 CAMERA_ATTR_FPS_15 = 15, /**< 15 FPS */
535 CAMERA_ATTR_FPS_20 = 20, /**< 20 FPS */
536 CAMERA_ATTR_FPS_24 = 24, /**< 24 FPS */
537 CAMERA_ATTR_FPS_25 = 25, /**< 25 FPS */
538 CAMERA_ATTR_FPS_30 = 30, /**< 30 FPS */
539 CAMERA_ATTR_FPS_60 = 60, /**< 60 FPS */
540 CAMERA_ATTR_FPS_90 = 90, /**< 90 FPS */
541 CAMERA_ATTR_FPS_120 = 120 /**< 120 FPS */
545 * @brief Enumeration for the theater mode.
549 CAMERA_ATTR_THEATER_MODE_DISABLE = 0, /**< Disable theater mode - External display shows same image as device display */
550 CAMERA_ATTR_THEATER_MODE_ENABLE = 2, /**< Enable theater mode - Preview image is displayed on external display with full screen mode, but preview image is not shown on device display */
551 CAMERA_ATTR_THEATER_MODE_CLONE = 1 /**< Clone mode - Preview image is displayed on external display with full screen mode. Also preview image is shown by the UI on device display */
552 } camera_attr_theater_mode_e;
555 * @brief Enumeration for HDR capture mode.
559 CAMERA_ATTR_HDR_MODE_DISABLE = 0, /**< Disable HDR capture */
560 CAMERA_ATTR_HDR_MODE_ENABLE, /**< Enable HDR capture */
561 CAMERA_ATTR_HDR_MODE_KEEP_ORIGINAL /**< Enable HDR capture and keep original image data */
562 } camera_attr_hdr_mode_e;
565 * @brief Enumeration for PTZ (Pan Tilt Zoom) type.
569 CAMERA_ATTR_PTZ_TYPE_MECHANICAL = 0, /**< Move the camera device physically */
570 CAMERA_ATTR_PTZ_TYPE_ELECTRONIC /**< Zoom digitally and move into portion of the image */
571 } camera_attr_ptz_type_e;
574 * @brief Enumeration for PTZ (Pan Tilt Zoom) movement type.
578 CAMERA_ATTR_PTZ_MOVE_ABSOLUTE = 0, /**< Move to a specific coordinate position */
579 CAMERA_ATTR_PTZ_MOVE_RELATIVE /**< Move a specific distance from the current position */
580 } camera_attr_ptz_move_type_e;
588 * @addtogroup CAPI_MEDIA_CAMERA_MODULE
593 * @brief Invoked when the camera state is changed.
595 * @param[in] previous The previous state of the camera
596 * @param[in] current The current state of the camera
597 * @param[in] by_policy If @c true the state is changed by policy, otherwise @c false
598 * @param[in] user_data The user data passed from the callback registration function
599 * @pre camera_start_preview(), camera_start_capture() or camera_stop_preview()
600 * will invoke this callback if you set this callback using camera_set_state_changed_cb().
601 * @see camera_set_state_changed_cb()
603 typedef void (*camera_state_changed_cb)(camera_state_e previous, camera_state_e current, bool by_policy, void *user_data);
606 * @brief Invoked when the camera device state is changed.
608 * @param[in] device The hardware camera type
609 * @param[in] state The state of the camera device
610 * @param[in] user_data The user data passed from the callback registration function
611 * @see camera_add_device_state_changed_cb()
613 typedef void (*camera_device_state_changed_cb)(camera_device_e device, camera_device_state_e state, void *user_data);
616 * @brief Invoked when the camera is interrupted by policy.
618 * @remarks This callback is invoked after interrupt handling is completed.
619 * @param[in] policy The policy that interrupted the camera
620 * @param[in] previous The previous state of the camera
621 * @param[in] current The current state of the camera
622 * @param[in] user_data The user data passed from the callback registration function
623 * @see camera_set_interrupted_cb()
625 typedef void (*camera_interrupted_cb)(camera_policy_e policy, camera_state_e previous, camera_state_e current, void *user_data);
628 * @brief Invoked when the camera interrupt is started by policy.
630 * @remarks This callback is invoked before interrupt handling is started.
631 * @param[in] policy The policy that is interrupting the camera
632 * @param[in] state The current state of the camera
633 * @param[in] user_data The user data passed from the callback registration function
634 * @see camera_set_interrupt_started_cb()
636 typedef void (*camera_interrupt_started_cb)(camera_policy_e policy, camera_state_e state, void *user_data);
639 * @brief Invoked when the camera focus state is changed.
640 * @details When the camera auto focus completes or a change to the focus state occurs,
641 * this callback is invoked. \n \n
642 * Changes of focus state are as follows: \n
643 * #CAMERA_FOCUS_STATE_RELEASED -> start focusing -> #CAMERA_FOCUS_STATE_ONGOING -> working ->
644 * #CAMERA_FOCUS_STATE_FOCUSED or #CAMERA_FOCUS_STATE_FAILED.
647 * @param[in] state The current state of the auto-focus
648 * @param[in] user_data The user data passed from the callback registration function
649 * @pre camera_start_focusing() will invoke this callback if you set it using camera_set_focus_changed_cb().
650 * @see camera_set_focus_changed_cb()
651 * @see camera_unset_focus_changed_cb()
652 * @see camera_start_focusing()
653 * @see camera_cancel_focusing()
655 typedef void (*camera_focus_changed_cb)(camera_focus_state_e state, void *user_data);
658 * @brief Invoked for notifications about delivering a copy of the new preview frame when every preview frame is displayed.
661 * @remarks This function is invoked in the context of internal framework so the UI update code should not be directly called.\n
662 * If the camera is used as a recorder then this callback function won't be invoked.
663 * @remarks The @a frame should not be released and it's available until the callback returns.
665 * @param[in] frame The reference pointer to preview stream data
666 * @param[in] user_data The user data passed from the callback registration function
667 * @pre camera_start_preview() will invoke this callback function if you set this callback using camera_set_preview_cb().
668 * @see camera_start_preview()
669 * @see camera_set_preview_cb()
670 * @see camera_unset_preview_cb()
672 typedef void (*camera_preview_cb)(camera_preview_data_s *frame, void *user_data);
675 * @brief Invoked for notifications about delivering media packet when every preview frame is displayed.
678 * @remarks This function is invoked in the context of internal framework so the UI update code should not be directly called.\n
679 * If the camera is used as a recorder then this callback function won't be invoked.\n
680 * and the packet should be released by media_packet_destroy() after use.
682 * @param[in] pkt Reference pointer to media packet
683 * @param[in] user_data The user data passed from the callback registration function
684 * @pre camera_start_preview() will invoke this callback function if you set this callback using camera_set_media_packet_preview_cb().
685 * @see camera_start_preview()
686 * @see camera_set_media_packet_preview_cb()
687 * @see camera_unset_media_packet_preview_cb()
689 typedef void (*camera_media_packet_preview_cb)(media_packet_h pkt, void *user_data);
692 * @brief Invoked to get information about image data taken by the camera once per frame while capturing.
695 * @remarks This function is invoked in the context of internal framework so the UI update code should not be directly called.
696 * You must not call camera_start_preview() within this callback. \n
697 * The @a image, @a postview and @a thumbnail should not be released and it can be used only in the callback. To use outside, make a copy.
698 * @param[in] image The image data of the captured picture
699 * @param[in] postview The image data of the postview
700 * @param[in] thumbnail The image data of the thumbnail (it should be @c NULL if the available thumbnail data does not exist)
701 * @param[in] user_data The user data passed from the callback registration function
702 * @pre camera_start_capture() or camera_start_continuous_capture() will invoke this callback function if it is set using camera_start_capture() or camera_start_continuous_capture().
703 * @see camera_start_capture()
704 * @see camera_start_continuous_capture()
705 * @see camera_capture_completed_cb()
707 typedef void (*camera_capturing_cb)(camera_image_data_s *image, camera_image_data_s *postview, camera_image_data_s *thumbnail, void *user_data);
710 * @brief Invoked when the camera capturing completes.
713 * @remarks The callback is invoked after camera_capturing_cb() is completed.\n
714 * If you want to show the user a preview after capturing is finished, \n
715 * an application can use camera_start_preview() after calling this callback.
716 * @param[in] user_data The user data passed from the callback registration function
717 * @pre This callback function is invoked if it is set using camera_start_capture() or camera_start_continuous_capture().
718 * @see camera_start_capture()
719 * @see camera_start_continuous_capture()
720 * @see camera_capturing_cb()
722 typedef void (*camera_capture_completed_cb)(void *user_data);
725 * @brief Invoked when an error occurs.
728 * @remarks This callback informs about a critical error situation.\n
729 * When this callback is invoked, the user should release the resource and terminate the application.\n
730 * In case of errors, one of these codes occur:\n
731 * #CAMERA_ERROR_DEVICE,\n
732 * #CAMERA_ERROR_INVALID_OPERATION,\n
733 * #CAMERA_ERROR_OUT_OF_MEMORY.
734 * @param[in] error The error code
735 * @param[in] current_state The current state of the camera
736 * @param[in] user_data The user data passed from the callback registration function
737 * @pre This callback function is invoked if it is set using camera_set_error_cb().
738 * @see camera_set_error_cb()
739 * @see camera_unset_error_cb()
741 typedef void (*camera_error_cb)(camera_error_e error, camera_state_e current_state, void *user_data);
744 * @brief Invoked when a face is detected in the preview frame.
746 * @remarks The @a faces should not be released and it can be used only in the callback. To use outside, make a copy.
747 * @param[in] faces The detected face array
748 * @param[in] count The length of the array
749 * @param[in] user_data The user data passed from the callback registration function
750 * @see camera_start_face_detection()
752 typedef void (*camera_face_detected_cb)(camera_detected_face_s *faces, int count, void *user_data);
755 * @brief Invoked when the connection state of a camera device was changed.
757 * @remarks The @a device should not be released and it can be used only in the callback. To use outside, make a copy.
758 * @param[in] device The camera device
759 * @param[in] is_connected The state of device connection: (@c true = connected, @c false = disconnected)
760 * @param[in] user_data The user data passed from the callback registration function
761 * @see camera_device_manager_add_device_connection_changed_cb()
762 * @see camera_device_manager_remove_device_connection_changed_cb()
764 typedef void (*camera_device_connection_changed_cb)(camera_device_s *device, bool is_connected, void *user_data);
767 * @brief Invoked when the extra preview frame is delivered from the camera device.
769 * @remarks The @a frame should not be released and it can be used only in the callback. To use outside, make a copy.
770 * @param[in] frame The reference pointer to extra preview stream data
771 * @param[in] stream_id The ID of the preview stream
772 * @param[in] user_data The user data passed from the callback registration function
773 * @pre camera_start_preview() will invoke this callback function if you set this callback using camera_set_extra_preview_cb().
774 * @see camera_start_preview()
775 * @see camera_set_extra_preview_cb()
776 * @see camera_unset_extra_preview_cb()
778 typedef void (*camera_extra_preview_cb)(camera_preview_data_s *frame, int stream_id, void *user_data);
785 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
790 * @brief Invoked once for each supported preview resolution.
792 * @param[in] width The preview image width
793 * @param[in] height The preview image height
794 * @param[in] user_data The user data passed from the foreach function
795 * @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
796 * @pre camera_foreach_supported_preview_resolution() will invoke this callback.
797 * @see camera_foreach_supported_preview_resolution()
799 typedef bool (*camera_supported_preview_resolution_cb)(int width, int height, void *user_data);
802 * @brief Invoked once for each supported capture resolution.
804 * @param[in] width The capture resolution width
805 * @param[in] height The capture resolution height
806 * @param[in] user_data The user data passed from the foreach function
807 * @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
808 * @pre camera_foreach_supported_capture_resolution() will invoke this callback.
809 * @see camera_foreach_supported_capture_resolution()
811 typedef bool (*camera_supported_capture_resolution_cb)(int width, int height, void *user_data);
814 * @brief Invoked once for the pixel format of each supported capture format.
816 * @param[in] format The supported pixel format
817 * @param[in] user_data The user data passed from the foreach function
818 * @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
819 * @pre camera_foreach_supported_capture_format() will invoke this callback.
820 * @see camera_foreach_supported_capture_format()
822 typedef bool (*camera_supported_capture_format_cb)(camera_pixel_format_e format, void *user_data);
825 * @brief Invoked once for the pixel format of each supported preview format.
827 * @param[in] format The supported preview data format
828 * @param[in] user_data The user data passed from the foreach function
829 * @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
830 * @pre camera_foreach_supported_preview_format() will invoke this callback.
831 * @see camera_foreach_supported_preview_format()
833 typedef bool (*camera_supported_preview_format_cb)(camera_pixel_format_e format, void *user_data);
836 * @brief Invoked once for the each supported device.
838 * @remarks The @a device should not be released and it can be used only in the callback. To use outside, make a copy.
839 * @param[in] device The camera device
840 * @param[in] user_data The user data passed from the foreach function
841 * @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
842 * @pre camera_device_manager_foreach_supported_device() will invoke this callback.
843 * @see camera_device_manager_foreach_supported_device()
845 typedef bool (*camera_supported_device_cb)(camera_device_s *device, void *user_data);
852 * @addtogroup CAPI_MEDIA_CAMERA_MODULE
857 * @brief Creates a new camera handle for controlling a camera.
860 * @remarks Multiple handles on a context at the same time are allowed to be created. However,
861 * camera cannot guarantee proper operation because of limited resources, such as
862 * camera device, audio device, and display device.\n.
863 * A @a camera must be released using camera_destroy().
864 * @remarks The privilege %http://tizen.org/privilege/camera is not required since 4.0,\n
865 * but it is required in all earlier versions.
866 * @param[in] device The hardware camera to access
867 * @param[out] camera A newly returned handle to the camera
868 * @return @c 0 on success, otherwise a negative error value
869 * @retval #CAMERA_ERROR_NONE Successful
870 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
871 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
872 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
873 * @retval #CAMERA_ERROR_OUT_OF_MEMORY Out of memory
874 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
875 * @post If it succeeds, the camera state will be #CAMERA_STATE_CREATED.
877 * @see camera_destroy()
879 int camera_create(camera_device_e device, camera_h *camera);
882 * @brief Changes the camera device.
885 * @remarks This function can be used to change camera device simply without camera_destroy() and camera_create().\n
886 * If display reuse hint is set by camera_set_display_reuse_hint() before stopping the preview,\n
887 * display handle will be reused and last frame on display can be kept even though camera device is changed.
888 * @param[in] camera The handle to the camera
889 * @param[in] device The hardware camera to access
890 * @return @c 0 on success, otherwise a negative error value
891 * @retval #CAMERA_ERROR_NONE Successful
892 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
893 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
894 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
895 * @retval #CAMERA_ERROR_OUT_OF_MEMORY Out of memory
896 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
897 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
898 * @pre The camera state must be set to #CAMERA_STATE_CREATED.
899 * @post If it succeeds, the camera attributes and settings will be reset.
901 * @see camera_set_display_reuse_hint()
902 * @see camera_get_display_reuse_hint()
904 int camera_change_device(camera_h camera, camera_device_e device);
907 * @brief Destroys the camera handle and releases all its resources.
910 * @param[in] camera The handle to the camera
911 * @return @c 0 on success, otherwise a negative error value
912 * @retval #CAMERA_ERROR_NONE Successful
913 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
914 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
915 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
916 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
917 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
918 * @see camera_create()
919 * @see camera_create_network()
921 int camera_destroy(camera_h camera);
924 * @brief Creates a new camera handle for controlling a network camera.
926 * @remarks A @a camera must be released using camera_destroy().
927 * @param[in] device The network camera to access
928 * @param[out] camera A newly returned handle to the camera
929 * @return @c 0 on success, otherwise a negative error value
930 * @retval #CAMERA_ERROR_NONE Successful
931 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
932 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
933 * @retval #CAMERA_ERROR_OUT_OF_MEMORY Out of memory
934 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
935 * @post If it succeeds, the camera state will be #CAMERA_STATE_CREATED.
936 * @see camera_destroy()
938 int camera_create_network(camera_device_e device, camera_h *camera);
941 * @brief Initializes a camera device manager.
943 * @remarks A @a manager must be released with camera_device_manager_deinitialize().
944 * @param[out] manager A newly returned handle to the camera device manager
945 * @return @c 0 on success, otherwise a negative error value
946 * @retval #CAMERA_ERROR_NONE Successful
947 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
948 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
949 * @retval #CAMERA_ERROR_OUT_OF_MEMORY Out of memory
950 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
951 * @see camera_device_manager_deinitialize()
953 int camera_device_manager_initialize(camera_device_manager_h *manager);
956 * @brief Deinitializes the camera device manager handle.
958 * @param[in] manager The handle to the camera device manager
959 * @return @c 0 on success, otherwise a negative error value
960 * @retval #CAMERA_ERROR_NONE Successful
961 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
962 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
963 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
964 * @see camera_device_manager_initialize()
966 int camera_device_manager_deinitialize(camera_device_manager_h manager);
973 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
978 * @brief Retrieves all supported devices by invoking the callback function once for each supported device.
980 * @param[in] manager The handle to the camera device manager
981 * @param[in] callback The callback function to be invoked
982 * @param[in] user_data The user data to be passed to the callback function
983 * @return @c 0 on success, otherwise a negative error value
984 * @retval #CAMERA_ERROR_NONE Successful
985 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
986 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
987 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
988 * @post This function invokes camera_supported_device_cb() repeatedly to retrieve each supported device.
989 * @see camera_supported_device_cb()
990 * @see camera_device_manager_initialize()
991 * @see camera_device_manager_deinitialize()
993 int camera_device_manager_foreach_supported_device(camera_device_manager_h manager, camera_supported_device_cb callback, void *user_data);
1000 * @addtogroup CAPI_MEDIA_CAMERA_MODULE
1005 * @brief Adds a callback function to be invoked when the connection state of camera device is changed.
1007 * @param[in] manager The handle to the camera device manager
1008 * @param[in] callback The callback function to be invoked
1009 * @param[in] user_data The user data to be passed to the callback function
1010 * @param[out] cb_id The id of added callback
1011 * @return @c 0 on success, otherwise a negative error value
1012 * @retval #CAMERA_ERROR_NONE Successful
1013 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1014 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1015 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1016 * @post camera_device_connection_changed_cb() will be invoked when the connection state of camera device is changed.
1017 * @see camera_device_manager_remove_device_connection_changed_cb()
1018 * @see camera_device_connection_changed_cb()
1020 int camera_device_manager_add_device_connection_changed_cb(camera_device_manager_h manager, camera_device_connection_changed_cb callback, void *user_data, int *cb_id);
1023 * @brief Removes the device connection changed callback function.
1025 * @param[in] manager The handle to the camera device manager
1026 * @param[in] cb_id The id of added callback
1027 * @return @c 0 on success, otherwise a negative error value
1028 * @retval #CAMERA_ERROR_NONE Successful
1029 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1030 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1031 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1032 * @see camera_device_manager_add_device_changed_cb()
1034 int camera_device_manager_remove_device_connection_changed_cb(camera_device_manager_h manager, int cb_id);
1037 * @brief Gets the product id of the camera device.
1039 * @param[in] manager The handle to the camera device manager
1040 * @param[in] device The index of camera device
1041 * @param[out] product_id The product id of camera device
1042 * @return @c 0 on success, otherwise a negative error value
1043 * @retval #CAMERA_ERROR_NONE Successful
1044 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1045 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1046 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1047 * @see camera_device_manager_initialize()
1048 * @see camera_device_manager_deinitialize()
1049 * @see camera_supported_device_cb()
1051 int camera_device_manager_get_product_id(camera_device_manager_h manager, camera_device_e device, unsigned short *product_id);
1054 * @brief Gets the vendor id of the camera device.
1056 * @param[in] manager The handle to the camera device manager
1057 * @param[in] device The index of camera device
1058 * @param[out] vendor_id The vendor id of camera device
1059 * @return @c 0 on success, otherwise a negative error value
1060 * @retval #CAMERA_ERROR_NONE Successful
1061 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1062 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1063 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1064 * @see camera_device_manager_initialize()
1065 * @see camera_device_manager_deinitialize()
1066 * @see camera_supported_device_cb()
1068 int camera_device_manager_get_vendor_id(camera_device_manager_h manager, camera_device_e device, unsigned short *vendor_id);
1071 * @brief Starts capturing and drawing preview frames on the screen.
1075 * @privilege %http://tizen.org/privilege/camera
1076 * @param[in] camera The handle to the camera
1077 * @return @c 0 on success, otherwise a negative error value
1078 * @retval #CAMERA_ERROR_NONE Successful
1079 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1080 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1081 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1082 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1083 * @retval #CAMERA_ERROR_RESOURCE_CONFLICT Resource conflict error
1084 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1085 * @retval #CAMERA_ERROR_DEVICE_BUSY The device is being used in another application or is performing other operations
1086 * @retval #CAMERA_ERROR_DEVICE_NOT_FOUND No camera device
1087 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1088 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_CAPTURED.\n
1089 * You must set the display handle. \n
1090 * If needed, modify preview FPS(camera_attr_set_preview_fps()),
1091 * preview resolution(camera_set_preview_resolution()), or preview format(camera_set_preview_format()).
1092 * @post If it succeeds, the camera state will be #CAMERA_STATE_PREVIEW.\n
1093 * camera_preview_cb() will be invoked when preview image data becomes available.
1095 * @see camera_stop_preview()
1096 * @see camera_set_display()
1097 * @see camera_set_preview_cb()
1098 * @see camera_set_media_packet_preview_cb()
1099 * @see camera_foreach_supported_preview_resolution()
1100 * @see camera_set_preview_resolution()
1101 * @see camera_get_preview_resolution()
1102 * @see camera_foreach_supported_preview_format()
1103 * @see camera_set_preview_format()
1104 * @see camera_get_preview_format()
1105 * @see camera_attr_foreach_supported_fps()
1106 * @see camera_attr_set_preview_fps()
1107 * @see camera_attr_get_preview_fps()
1109 int camera_start_preview(camera_h camera);
1112 * @brief Stops capturing and drawing preview frames.
1115 * @privilege %http://tizen.org/privilege/camera
1116 * @param[in] camera The handle to the camera
1117 * @return @c 0 on success, otherwise a negative error value
1118 * @retval #CAMERA_ERROR_NONE Successful
1119 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1120 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1121 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1122 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1123 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1124 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1125 * @pre The camera state must be set to #CAMERA_STATE_PREVIEW.
1126 * @post The camera state will be #CAMERA_STATE_CREATED.
1127 * @see camera_start_preview()
1128 * @see camera_unset_preview_cb()
1129 * @see camera_unset_media_packet_preview_cb()
1131 int camera_stop_preview(camera_h camera);
1134 * @brief Starts capturing of still images.
1138 * @privilege %http://tizen.org/privilege/camera
1139 * @remarks This function causes the transition of the camera state from #CAMERA_STATE_CAPTURING to #CAMERA_STATE_CAPTURED automatically\n
1140 * and the corresponding callback function camera_capturing_cb() and camera_capture_completed_cb() will be invoked\n
1141 * The captured image will be delivered through camera_capturing_cb().\n
1142 * camera_capture_completed_cb() callback notifies about completion of camera_capturing_cb(). \n
1143 * The camera's preview should be restarted by calling camera_start_preview().
1144 * @param[in] camera The handle to the camera
1145 * @param[in] capturing_cb The callback for capturing data
1146 * @param[in] completed_cb The callback for notification of completion
1147 * @param[in] user_data The user data
1148 * @return @c 0 on success, otherwise a negative error value
1149 * @retval #CAMERA_ERROR_NONE Successful
1150 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1151 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1152 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1153 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1154 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1155 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1156 * @pre The camera state must be set to #CAMERA_STATE_PREVIEW. \n
1157 * If needed, modify capture resolution(camera_set_capture_resolution()),
1158 * capture format(camera_set_capture_format()), or image quality(camera_attr_set_image_quality()).
1159 * @post If it succeeds the camera state will be #CAMERA_STATE_CAPTURED.
1161 * @see camera_start_preview()
1162 * @see camera_start_continuous_capture()
1163 * @see camera_foreach_supported_capture_resolution()
1164 * @see camera_set_capture_resolution()
1165 * @see camera_get_capture_resolution()
1166 * @see camera_foreach_supported_capture_format()
1167 * @see camera_set_capture_format()
1168 * @see camera_get_capture_format()
1169 * @see camera_attr_set_image_quality()
1170 * @see camera_attr_get_image_quality()
1172 int camera_start_capture(camera_h camera, camera_capturing_cb capturing_cb, camera_capture_completed_cb completed_cb, void *user_data);
1175 * @brief Starts continuously capturing still images.
1179 * @privilege %http://tizen.org/privilege/camera
1180 * @remarks If this is not supported zero shutter lag occurs. The capture resolution could be changed to the preview resolution.\n
1181 * This function causes the transition of the camera state from #CAMERA_STATE_CAPTURING to #CAMERA_STATE_CAPTURED automatically\n
1182 * and the corresponding callback function camera_capturing_cb() and camera_capture_completed_cb() will be invoked\n
1183 * Each Captured image will be delivered through camera_capturing_cb().\n
1184 * The camera_capture_completed_cb() callback notifies about the completion of an entire capture.\n
1185 * The camera's preview should be restarted by calling camera_start_preview().\n.
1186 * @param[in] camera The handle to the camera
1187 * @param[in] count The number of still images
1188 * @param[in] interval The interval of the capture (millisecond)
1189 * @param[in] capturing_cb The callback for capturing data
1190 * @param[in] completed_cb The callback for notification of completion
1191 * @param[in] user_data The user data
1192 * @return @c 0 on success, otherwise a negative error value
1193 * @retval #CAMERA_ERROR_NONE Successful
1194 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1195 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1196 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1197 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1198 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1199 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1200 * @post If it succeeds the camera state will be #CAMERA_STATE_CAPTURED.
1202 * @see camera_start_preview()
1203 * @see camera_start_capture()
1204 * @see camera_stop_continuous_capture()
1205 * @see camera_is_supported_zero_shutter_lag()
1207 int camera_start_continuous_capture(camera_h camera, int count, int interval, camera_capturing_cb capturing_cb, camera_capture_completed_cb completed_cb, void *user_data);
1210 * @brief Aborts continuous capturing.
1214 * @privilege %http://tizen.org/privilege/camera
1215 * @remarks The camera state will be changed to #CAMERA_STATE_CAPTURED.
1216 * @param[in] camera The handle to the camera
1217 * @return @c 0 on success, otherwise a negative error value
1218 * @retval #CAMERA_ERROR_NONE Successful
1219 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1220 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1221 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1222 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1223 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1224 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1225 * @pre The camera state must be set to #CAMERA_STATE_PREVIEW.
1227 * @see camera_start_continuous_capture()
1229 int camera_stop_continuous_capture(camera_h camera);
1232 * @brief Gets the state of the camera.
1235 * @param[in] camera The handle to the camera
1236 * @param[out] state The current state of the camera
1237 * @return @c 0 on success, otherwise a negative error value
1238 * @retval #CAMERA_ERROR_NONE Successful
1239 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1240 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1241 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1242 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1243 * @see camera_create()
1244 * @see camera_start_preview()
1245 * @see camera_stop_preview()
1246 * @see camera_start_capture()
1248 int camera_get_state(camera_h camera, camera_state_e *state);
1251 * @brief Starts camera auto-focusing, asynchronously.
1255 * @privilege %http://tizen.org/privilege/camera
1256 * @remarks If continuous status is @c true, the camera continuously tries to focus.
1257 * @param[in] camera The handle to the camera
1258 * @param[in] continuous The status of continuous focusing
1259 * @return @c 0 on success, otherwise a negative error value
1260 * @retval #CAMERA_ERROR_NONE Successful
1261 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1262 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1263 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1264 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1265 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1266 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1267 * @pre The camera state must be set to #CAMERA_STATE_PREVIEW.
1268 * @post The camera focus state will be #CAMERA_FOCUS_STATE_ONGOING.
1270 * @see camera_cancel_focusing()
1271 * @see camera_set_focus_changed_cb()
1272 * @see camera_focus_changed_cb()
1273 * @see camera_attr_set_af_mode()
1275 int camera_start_focusing(camera_h camera, bool continuous);
1278 * @brief Stops camera auto focusing.
1281 * @privilege %http://tizen.org/privilege/camera
1282 * @param[in] camera The handle to the camera
1283 * @return @c 0 on success, otherwise a negative error value
1284 * @retval #CAMERA_ERROR_NONE Successful
1285 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1286 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1287 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1288 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1289 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1290 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1291 * @pre The camera state must be set to #CAMERA_STATE_PREVIEW.
1293 * @see camera_start_focusing()
1294 * @see camera_focus_changed_cb()
1296 int camera_cancel_focusing(camera_h camera);
1299 * @brief Sets the display handle to show preview images.
1302 * @remarks This function must be called before previewing (see camera_start_preview()).
1303 * In Custom ROI display mode, camera_attr_set_display_roi_area() function must be called before calling this function.
1304 * @remarks This function must be called in main thread of the application.
1305 * Otherwise, it will return #CAMERA_ERROR_INVALID_OPERATION by internal restriction.
1306 * To avoid #CAMERA_ERROR_INVALID_OPERATION in sub thread, ecore_thread_main_loop_begin() and
1307 * ecore_thread_main_loop_end() can be used, but deadlock can occur if the main thread is busy.
1308 * So, it's not recommended to use them. (Since 5.0)
1309 * @param[in] camera The handle to the camera
1310 * @param[in] type The display type
1311 * @param[in] display The display handle from #GET_DISPLAY
1312 * @return @c 0 on success, otherwise a negative error value
1313 * @retval #CAMERA_ERROR_NONE Successful
1314 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1315 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1316 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1317 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1318 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1319 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1320 * @pre The camera state must be set to #CAMERA_STATE_CREATED.
1322 * @see camera_start_preview()
1324 * @see ecore_thread_main_loop_begin()
1325 * @see ecore_thread_main_loop_end()
1327 int camera_set_display(camera_h camera, camera_display_type_e type, camera_display_h display);
1330 * @brief Sets the resolution of the preview.
1333 * @remarks This function should be called before previewing (camera_start_preview()).
1334 * @param[in] camera The handle to the camera
1335 * @param[in] width The preview width
1336 * @param[in] height The preview height
1337 * @return @c 0 on success, otherwise a negative error value
1338 * @retval #CAMERA_ERROR_NONE Successful
1339 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1340 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1341 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1342 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1343 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1344 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
1346 * @see camera_start_preview()
1347 * @see camera_get_preview_resolution()
1348 * @see camera_foreach_supported_preview_resolution()
1350 int camera_set_preview_resolution(camera_h camera, int width, int height);
1353 * @brief Gets the resolution of the preview.
1356 * @param[in] camera The handle to the camera
1357 * @param[out] width The preview width
1358 * @param[out] height The preview height
1359 * @return @c 0 on success, otherwise a negative error value
1360 * @retval #CAMERA_ERROR_NONE Successful
1361 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1362 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1363 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1364 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1365 * @see camera_set_preview_resolution()
1366 * @see camera_foreach_supported_preview_resolution()
1368 int camera_get_preview_resolution(camera_h camera, int *width, int *height);
1371 * @brief Gets the recommended preview resolution.
1374 * @remarks Depending on the capture resolution aspect ratio and display resolution, the recommended preview resolution is determined.
1375 * @param[in] camera The handle to the camera
1376 * @param[out] width The preview width
1377 * @param[out] height The preview height
1378 * @return @c 0 on success, otherwise a negative error value
1379 * @retval #CAMERA_ERROR_NONE Successful
1380 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1381 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1382 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1383 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1384 * @see camera_set_preview_resolution()
1385 * @see camera_foreach_supported_preview_resolution()
1387 int camera_get_recommended_preview_resolution(camera_h camera, int *width, int *height);
1390 * @brief Starts face detection.
1393 * @privilege %http://tizen.org/privilege/camera
1394 * @remarks This should be called after the preview is started.\n
1395 * This callback will be invoked when the face is detected in the preview frame.\n
1396 * Internally it starts continuous focus and focusing on the detected face.\n
1397 * When face detection is running, the camera_start_focusing(), camera_cancel_focusing(), camera_attr_set_af_mode(), camera_attr_set_af_area(), camera_attr_set_exposure_mode(), and camera_attr_set_whitebalance() settings are ignored.\n
1398 * If camera_stop_preview() is called, face detection is stopped and then preview is resumed using camera_start_preview(), this should be called again to resume face detection.
1399 * @param[in] camera The handle to the camera
1400 * @param[in] callback The callback to notify face detection
1401 * @param[in] user_data The user data to be passed to the callback function
1403 * @return @c 0 on success, otherwise a negative error value
1404 * @retval #CAMERA_ERROR_NONE Successful
1405 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1406 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1407 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1408 * @retval #CAMERA_ERROR_INVALID_STATE Not preview state
1409 * @retval #CAMERA_ERROR_INVALID_OPERATION Not supported this feature
1410 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1411 * @pre The camera state must be #CAMERA_STATE_PREVIEW.
1413 * @see camera_stop_face_detection()
1414 * @see camera_face_detected_cb()
1415 * @see camera_is_supported_face_detection()
1417 int camera_start_face_detection(camera_h camera, camera_face_detected_cb callback, void *user_data);
1420 * @brief Stops face detection.
1424 * @privilege %http://tizen.org/privilege/camera
1425 * @param[in] camera The handle to the camera
1426 * @return @c 0 on success, otherwise a negative error value
1427 * @retval #CAMERA_ERROR_NONE Successful
1428 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1429 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1430 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1431 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1432 * @pre This should be called after face detection is started.
1434 * @see camera_start_face_detection()
1435 * @see camera_is_supported_face_detection()
1437 int camera_stop_face_detection(camera_h camera);
1444 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
1449 * @brief Gets continuous capture feature's supported state.
1450 * @ingroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
1452 * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
1453 * @param[in] camera The handle to the camera
1454 * @return @c true on supported, otherwise false
1455 * @exception #CAMERA_ERROR_NONE Successful
1456 * @exception #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1457 * @exception #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1458 * @exception #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1461 bool camera_is_supported_continuous_capture(camera_h camera);
1464 * @brief Retrieves all supported camera preview resolutions by invoking the callback function once for each supported camera preview resolution.
1467 * @param[in] camera The handle to the camera
1468 * @param[in] callback The callback function to be invoked
1469 * @param[in] user_data The user data to be passed to the callback function
1470 * @return @c 0 on success, otherwise a negative error value
1471 * @retval #CAMERA_ERROR_NONE Successful
1472 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1473 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1474 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1475 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1476 * @post This function invokes camera_supported_preview_resolution_cb() repeatedly to retrieve each supported preview resolution.
1478 * @see camera_set_preview_resolution()
1479 * @see camera_get_preview_resolution()
1480 * @see camera_supported_preview_resolution_cb()
1482 int camera_foreach_supported_preview_resolution(camera_h camera, camera_supported_preview_resolution_cb callback, void *user_data);
1489 * @addtogroup CAPI_MEDIA_CAMERA_MODULE
1494 * @ingroup CAPI_MEDIA_CAMERA_DISPLAY_MODULE
1495 * @brief Sets the display rotation.
1498 * @remarks This function should be called before previewing (see camera_start_preview())
1499 * @param[in] camera The handle to the camera
1500 * @param[in] rotation The display rotation
1501 * @return @c 0 on success, otherwise a negative error value
1502 * @retval #CAMERA_ERROR_NONE Successful
1503 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1504 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1505 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1506 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1507 * @retval #CAMERA_ERROR_INVALID_OPERATION Display type is incorrect
1508 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1509 * @see camera_start_preview()
1510 * @see camera_get_display_rotation()
1512 int camera_set_display_rotation(camera_h camera, camera_rotation_e rotation);
1515 * @ingroup CAPI_MEDIA_CAMERA_DISPLAY_MODULE
1516 * @brief Gets the display rotation.
1519 * @param[in] camera The handle to the camera
1520 * @param[out] rotation The display rotation
1521 * @return @c 0 on success, otherwise a negative error value
1522 * @retval #CAMERA_ERROR_NONE Successful
1523 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1524 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1525 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1526 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1527 * @see camera_set_display_rotation()
1529 int camera_get_display_rotation(camera_h camera, camera_rotation_e *rotation);
1532 * @ingroup CAPI_MEDIA_CAMERA_DISPLAY_MODULE
1533 * @brief Sets the display flip.
1536 * @param[in] camera The handle to the camera
1537 * @param[in] flip The display flip
1538 * @return @c 0 on success, otherwise a negative error value
1539 * @retval #CAMERA_ERROR_NONE Successful
1540 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1541 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1542 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1543 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1544 * @retval #CAMERA_ERROR_INVALID_OPERATION Display type is incorrect
1545 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1546 * @see camera_get_display_flip()
1548 int camera_set_display_flip(camera_h camera, camera_flip_e flip);
1551 * @ingroup CAPI_MEDIA_CAMERA_DISPLAY_MODULE
1552 * @brief Gets the display flip.
1555 * @param[in] camera The handle to the camera
1556 * @param[out] flip The display flip
1557 * @return @c 0 on success, otherwise a negative error value
1558 * @retval #CAMERA_ERROR_NONE Successful
1559 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1560 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1561 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1562 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1563 * @see camera_set_display_flip()
1565 int camera_get_display_flip(camera_h camera, camera_flip_e *flip);
1568 * @ingroup CAPI_MEDIA_CAMERA_DISPLAY_MODULE
1569 * @brief Sets the visible property for display.
1572 * @param[in] camera The handle to the camera
1573 * @param[in] visible The display visibility property
1575 * @return @c 0 on success, otherwise a negative error value
1576 * @retval #CAMERA_ERROR_NONE Successful
1577 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1578 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1579 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1580 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1581 * @see camera_is_display_visible()
1583 int camera_set_display_visible(camera_h camera, bool visible);
1586 * @ingroup CAPI_MEDIA_CAMERA_DISPLAY_MODULE
1587 * @brief Gets the visible property of display.
1590 * @param[in] camera The handle to the camera
1591 * @param[out] visible @c true if camera display is visible, otherwise @c false
1593 * @return @c 0 on success, otherwise a negative error value
1594 * @retval #CAMERA_ERROR_NONE Successful
1595 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1596 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1597 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1598 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1599 * @see camera_set_display_visible()
1601 int camera_is_display_visible(camera_h camera, bool *visible);
1604 * @ingroup CAPI_MEDIA_CAMERA_DISPLAY_MODULE
1605 * @brief Sets the display mode.
1608 * @param[in] camera The handle to the camera
1609 * @param[in] mode The display mode
1611 * @return @c 0 on success, otherwise a negative error value
1612 * @retval #CAMERA_ERROR_NONE Successful
1613 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1614 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1615 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1616 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1617 * @see camera_get_display_mode()
1619 int camera_set_display_mode(camera_h camera, camera_display_mode_e mode);
1622 * @ingroup CAPI_MEDIA_CAMERA_DISPLAY_MODULE
1623 * @brief Gets the display mode.
1626 * @param[in] camera The handle to the camera
1627 * @param[out] mode The display mode
1629 * @return @c 0 on success, otherwise a negative error value
1630 * @retval #CAMERA_ERROR_NONE Successful
1631 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1632 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1633 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1634 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1635 * @see camera_set_display_mode()
1637 int camera_get_display_mode(camera_h camera, camera_display_mode_e *mode);
1640 * @brief Sets the hint for display reuse.
1641 * @details If the hint is set to true, the display will be reused when the camera device is changed with camera_change_device().
1643 * @remarks If the current display type is #CAMERA_DISPLAY_TYPE_NONE, this function will return #CAMERA_ERROR_INVALID_OPERATION.
1644 * @param[in] camera The handle to the camera
1645 * @param[in] hint The hint for display reuse; true - reuse the display, false - do not reuse
1646 * @return @c 0 on success, otherwise a negative error value
1647 * @retval #CAMERA_ERROR_NONE Successful
1648 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1649 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1650 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
1651 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1652 * @pre The camera state must be set to #CAMERA_STATE_PREVIEW.
1653 * @see camera_get_display_reuse_hint()
1654 * @see camera_change_device()
1656 int camera_set_display_reuse_hint(camera_h camera, bool hint);
1659 * @brief Gets the hint for display reuse.
1661 * @remarks If the current display type is #CAMERA_DISPLAY_TYPE_NONE, this function will return #CAMERA_ERROR_INVALID_OPERATION.
1662 * @param[in] camera The handle to the camera
1663 * @param[out] hint The hint for display reuse; true - reuse the display, false - do not reuse
1664 * @return @c 0 on success, otherwise a negative error value
1665 * @retval #CAMERA_ERROR_NONE Successful
1666 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1667 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
1668 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1669 * @see camera_set_display_reuse_hint()
1670 * @see camera_change_device()
1672 int camera_get_display_reuse_hint(camera_h camera, bool *hint);
1675 * @brief Sets the resolution of the captured image.
1677 * @param[in] camera The handle to the camera
1678 * @param[in] width The capture width
1679 * @param[in] height The capture height
1680 * @return @c 0 on success, otherwise a negative error value
1681 * @retval #CAMERA_ERROR_NONE Successful
1682 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1683 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1684 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1685 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1686 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1687 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
1688 * @see camera_start_capture()
1689 * @see camera_get_capture_resolution()
1690 * @see camera_foreach_supported_capture_resolution()
1692 int camera_set_capture_resolution(camera_h camera, int width, int height);
1695 * @brief Gets the resolution of the captured image.
1697 * @param[in] camera The handle to the camera
1698 * @param[out] width The capture width
1699 * @param[out] height The capture height
1700 * @return @c 0 on success, otherwise a negative error value
1701 * @retval #CAMERA_ERROR_NONE Successful
1702 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1703 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1704 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1705 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1706 * @see camera_set_capture_resolution()
1707 * @see camera_foreach_supported_capture_resolution()
1709 int camera_get_capture_resolution(camera_h camera, int *width, int *height);
1716 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
1721 * @brief Retrieves all supported camera captured resolutions by invoking the callback function once for each supported camera capture resolution.
1724 * @param[in] camera The handle to the camera
1725 * @param[in] callback The callback function to be invoked
1726 * @param[in] user_data The user data to be passed to the callback function
1727 * @return @c 0 on success, otherwise a negative error value
1728 * @retval #CAMERA_ERROR_NONE Successful
1729 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1730 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1731 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1732 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1733 * @post This function invokes camera_supported_capture_resolution_cb() repeatedly to retrieve each supported capture resolution.
1734 * @see camera_set_capture_resolution()
1735 * @see camera_get_capture_resolution()
1736 * @see camera_supported_capture_resolution_cb()
1738 int camera_foreach_supported_capture_resolution(camera_h camera, camera_supported_capture_resolution_cb callback, void *user_data);
1745 * @addtogroup CAPI_MEDIA_CAMERA_MODULE
1750 * @brief Sets the format of an image to be captured.
1753 * @remarks This function should be called before capturing (see camera_start_capture()).
1754 * @param[in] camera The handle to the camera
1755 * @param[in] format The format of the image to be captured
1756 * @return @c 0 on success, otherwise a negative error value
1757 * @retval #CAMERA_ERROR_NONE Successful
1758 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1759 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1760 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1761 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1762 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1763 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
1764 * @see camera_start_capture()
1765 * @see camera_get_capture_format()
1766 * @see camera_foreach_supported_capture_format()
1768 int camera_set_capture_format(camera_h camera, camera_pixel_format_e format);
1771 * @brief Gets the format of the image to be captured.
1774 * @param[in] camera The handle to the camera
1775 * @param[out] format The format of the image to be captured
1776 * @return @c 0 on success, otherwise a negative error value
1777 * @retval #CAMERA_ERROR_NONE Successful
1778 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1779 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1780 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1781 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1782 * @see camera_set_capture_format()
1783 * @see camera_foreach_supported_capture_format()
1785 int camera_get_capture_format(camera_h camera, camera_pixel_format_e *format);
1792 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
1797 * @brief Retrieves all supported camera capture formats by invoking the callback function once for each supported camera capture format.
1800 * @param[in] camera The handle to the camera
1801 * @param[in] callback The callback function to be invoked
1802 * @param[in] user_data The user data to be passed to the callback function
1803 * @return @c 0 on success, otherwise a negative error value
1804 * @retval #CAMERA_ERROR_NONE Successful
1805 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1806 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1807 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1808 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1809 * @post This function invokes camera_supported_capture_format_cb() repeatedly to retrieve each supported capture format.
1810 * @see camera_set_capture_format()
1811 * @see camera_get_capture_format()
1812 * @see camera_supported_capture_format_cb()
1814 int camera_foreach_supported_capture_format(camera_h camera, camera_supported_capture_format_cb callback, void *user_data);
1821 * @addtogroup CAPI_MEDIA_CAMERA_MODULE
1826 * @brief Sets the preview data format.
1828 * @remarks This function should be called before previewing (see camera_start_preview()).
1829 * @param[in] camera The handle to the camera
1830 * @param[in] format The preview data format
1831 * @return @c 0 on success, otherwise a negative error value
1832 * @retval #CAMERA_ERROR_NONE Successful
1833 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1834 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1835 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1836 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1837 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1838 * @pre The camera state must be set to #CAMERA_STATE_CREATED.
1839 * @see camera_start_preview()
1840 * @see camera_get_preview_format()
1841 * @see camera_foreach_supported_preview_format()
1843 int camera_set_preview_format(camera_h camera, camera_pixel_format_e format);
1846 * @brief Gets the format of the preview stream.
1848 * @param[in] camera The handle to the camera
1849 * @param[out] format The preview data format
1850 * @return @c 0 on success, otherwise a negative error value
1851 * @retval #CAMERA_ERROR_NONE Successful
1852 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1853 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1854 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1855 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1856 * @see camera_set_preview_format()
1857 * @see camera_foreach_supported_preview_format()
1859 int camera_get_preview_format(camera_h camera, camera_pixel_format_e *format);
1862 * @brief Gets the facing direction of camera module.
1864 * @param[in] camera The handle to the camera
1865 * @param[out] facing_direction The facing direction of camera module
1866 * @return @c 0 on success, otherwise a negative error value
1867 * @retval #CAMERA_ERROR_NONE Successful
1868 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1869 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1870 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
1871 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1873 int camera_get_facing_direction(camera_h camera, camera_facing_direction_e *facing_direction);
1876 * @brief Gets the camera's flash state.
1878 * @param[in] device The hardware camera to access
1879 * @param[out] state The current flash state
1880 * @return @c 0 on success, otherwise a negative error value
1881 * @retval #CAMERA_ERROR_NONE Successful
1882 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1883 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1884 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
1885 * @see camera_attr_set_flash_mode()
1886 * @see camera_attr_get_flash_mode()
1888 int camera_get_flash_state(camera_device_e device, camera_flash_state_e *state);
1891 * @brief Sets a callback function to be invoked for extra preview frames.
1893 * @remarks This function should not be called within a invoked @a callback,\n
1894 * otherwise #CAMERA_ERROR_INVALID_OPERATION is returned. (Since 9.0)
1895 * @param[in] camera The handle to the camera
1896 * @param[in] callback The callback function to be invoked
1897 * @param[in] user_data The user data to be passed to the callback function
1898 * @return @c 0 on success, otherwise a negative error value
1899 * @retval #CAMERA_ERROR_NONE Successful
1900 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1901 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1902 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1903 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1904 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
1905 * @see camera_start_preview()
1906 * @see camera_unset_extra_preview_cb()
1907 * @see camera_extra_preview_cb()
1909 int camera_set_extra_preview_cb(camera_h camera, camera_extra_preview_cb callback, void *user_data);
1912 * @brief Unsets the extra preview callback function.
1914 * @remarks This function should not be called within a invoked @a callback,\n
1915 * otherwise #CAMERA_ERROR_INVALID_OPERATION is returned. (Since 9.0)
1916 * @param[in] camera The handle to the camera
1917 * @return @c 0 on success, otherwise a negative error value
1918 * @retval #CAMERA_ERROR_NONE Successful
1919 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1920 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1921 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
1922 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1923 * @see camera_set_extra_preview_cb()
1925 int camera_unset_extra_preview_cb(camera_h camera);
1928 * @brief Sets the extra preview stream format.
1930 * @param[in] camera The handle to the camera
1931 * @param[in] stream_id The id of extra preview stream
1932 * @param[in] pixel_format The pixel format of extra preview stream
1933 * @param[in] width The width of extra preview stream
1934 * @param[in] height The height of extra preview stream
1935 * @param[in] fps The fps of extra preview stream
1936 * @return @c 0 on success, otherwise a negative error value
1937 * @retval #CAMERA_ERROR_NONE Successful
1938 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1939 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1940 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1941 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1942 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
1943 * @see camera_start_preview()
1944 * @see camera_set_extra_preview_cb()
1945 * @see camera_unset_extra_preview_cb()
1946 * @see camera_get_extra_preview_stream_format()
1948 int camera_set_extra_preview_stream_format(camera_h camera, int stream_id, camera_pixel_format_e pixel_format, int width, int height, int fps);
1951 * @brief Gets the extra preview stream format.
1953 * @param[in] camera The handle to the camera
1954 * @param[in] stream_id The id of extra preview stream
1955 * @param[out] pixel_format The pixel format of extra preview stream
1956 * @param[out] width The width of extra preview stream
1957 * @param[out] height The height of extra preview stream
1958 * @param[out] fps The fps of extra preview stream
1959 * @return @c 0 on success, otherwise a negative error value
1960 * @retval #CAMERA_ERROR_NONE Successful
1961 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1962 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1963 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
1964 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1965 * @pre The camera state must be set to #CAMERA_STATE_PREVIEW.
1966 * @see camera_start_preview()
1967 * @see camera_set_extra_preview_cb()
1968 * @see camera_unset_extra_preview_cb()
1969 * @see camera_set_extra_preview_stream_format()
1971 int camera_get_extra_preview_stream_format(camera_h camera, int stream_id, camera_pixel_format_e *pixel_format, int *width, int *height, int *fps);
1978 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
1983 * @brief Retrieves all supported camera preview formats by invoking the callback function once for each supported camera preview format.
1985 * @param[in] camera The handle to the camera
1986 * @param[in] callback The callback function to be invoked
1987 * @param[in] user_data The user data to be passed to the callback function
1988 * @return @c 0 on success, otherwise a negative error value
1989 * @retval #CAMERA_ERROR_NONE Successful
1990 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
1991 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
1992 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
1993 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
1994 * @post This function invokes camera_supported_preview_format_cb() repeatedly to retrieve each supported preview format.
1995 * @see camera_set_preview_format()
1996 * @see camera_get_preview_format()
1997 * @see camera_supported_preview_format_cb()
1999 int camera_foreach_supported_preview_format(camera_h camera, camera_supported_preview_format_cb callback, void *user_data);
2002 * @ingroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
2003 * @brief Gets the face detection feature's supported state.
2005 * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
2006 * @param[in] camera The handle to the camera
2007 * @return @c true if supported, otherwise @c false
2008 * @exception #CAMERA_ERROR_NONE Successful
2009 * @exception #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2010 * @exception #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2011 * @exception #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2012 * @see camera_start_face_detection()
2013 * @see camera_stop_face_detection()
2015 bool camera_is_supported_face_detection(camera_h camera);
2018 * @brief Gets the zero shutter lag feature's supported state.
2019 * @ingroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
2021 * @remarks If supporting zero shutter lag, continuous shot can be done with full capture size. \n
2022 * The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
2023 * @param[in] camera The handle to the camera
2024 * @return @c true if supported, otherwise @c false
2025 * @exception #CAMERA_ERROR_NONE Successful
2026 * @exception #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2027 * @exception #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2028 * @exception #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2030 bool camera_is_supported_zero_shutter_lag(camera_h camera);
2033 * @ingroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
2034 * @brief Gets the camera device count.
2036 * @remarks If the device supports primary and secondary camera, this returns @c 2. If @c 1 is returned, the device only supports primary camera.
2037 * @param[in] camera The handle to the camera
2038 * @param[out] device_count The device count
2039 * @return @c 0 on success, otherwise a negative error value
2040 * @retval #CAMERA_ERROR_NONE Successful
2041 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2042 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2043 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2044 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2046 int camera_get_device_count(camera_h camera, int *device_count);
2049 * @brief Gets the media packet preview callback feature's supported state.
2050 * @ingroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
2052 * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
2053 * @param[in] camera The handle to the camera
2054 * @return @c true if supported, otherwise @c false
2055 * @exception #CAMERA_ERROR_NONE Successful
2056 * @exception #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2057 * @exception #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2058 * @exception #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2061 bool camera_is_supported_media_packet_preview_cb(camera_h camera);
2064 * @brief Gets the extra preview feature's supported state.
2065 * @ingroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
2067 * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
2068 * @param[in] camera The handle to the camera
2069 * @return @c true if supported, otherwise @c false
2070 * @exception #CAMERA_ERROR_NONE Successful
2071 * @exception #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2073 bool camera_is_supported_extra_preview(camera_h camera);
2080 * @addtogroup CAPI_MEDIA_CAMERA_MODULE
2085 * @brief Sets a callback function to be invoked once per frame when previewing.
2087 * @remarks This callback does not work in the video recorder mode.\n
2088 * Before 4.0, the only allowed state for calling this function was #CAMERA_STATE_CREATED.\n
2089 * Since 4.0, #CAMERA_STATE_PREVIEW has been added as an allowed state,\n
2090 * so that this function could be invoked before previewing or even while previewing.\n
2091 * A @a callback is invoked on the internal thread of the camera.\n
2092 * A video frame can be retrieved using a @a callback,\n
2093 * and the buffer is only available in a @a callback.\n
2094 * Since tizen 3.0, if you change the buffer in a @a callback,\n
2095 * it could not be displayed on the device in case of copied buffer.\n
2096 * and if camera_is_supported_media_packet_preview_cb() returns false,\n
2097 * it's copied buffer case.
2098 * @remarks This function should not be called within a invoked @a callback,\n
2099 * otherwise #CAMERA_ERROR_INVALID_OPERATION is returned. (Since 9.0)
2100 * @param[in] camera The handle to the camera
2101 * @param[in] callback The callback function to be invoked
2102 * @param[in] user_data The user data to be passed to the callback function
2103 * @return @c 0 on success, otherwise a negative error value
2104 * @retval #CAMERA_ERROR_NONE Successful
2105 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2106 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2107 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2108 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
2109 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2110 * @pre Before 4.0 : The camera state must be set to #CAMERA_STATE_CREATED.\n
2111 * Since 4.0 : The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
2112 * @see camera_start_preview()
2113 * @see camera_unset_preview_cb()
2114 * @see camera_preview_cb()
2116 int camera_set_preview_cb(camera_h camera, camera_preview_cb callback, void *user_data);
2119 * @brief Unsets the preview callback function.
2121 * @remarks This function should not be called within a invoked @a callback,\n
2122 * otherwise #CAMERA_ERROR_INVALID_OPERATION is returned. (Since 9.0)
2123 * @param[in] camera The handle to the camera
2124 * @return @c 0 on success, otherwise a negative error value
2125 * @retval #CAMERA_ERROR_NONE Successful
2126 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2127 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2128 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2129 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
2130 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2131 * @see camera_set_preview_cb()
2133 int camera_unset_preview_cb(camera_h camera);
2136 * @brief Sets a media packet callback function to be invoked once per frame when previewing.
2138 * @remarks This callback does not work in video recorder mode.\n
2139 * This function should be called before previewing (see camera_start_preview())\n
2140 * A @a callback is invoked on the internal thread of the camera.\n
2141 * A video frame can be retrieved using a @a callback as a media packet.\n
2142 * The callback function holds the same buffer that will be drawn on the display device.\n
2143 * So if you change the media packet in a callback, it will be displayed on the device\n
2144 * and the media packet is available until it's destroyed by media_packet_destroy().
2145 * @remarks This function should not be called within a invoked @a callback,\n
2146 * otherwise #CAMERA_ERROR_INVALID_OPERATION is returned. (Since 9.0)
2147 * @param[in] camera The handle to the camera
2148 * @param[in] callback The callback function to be invoked
2149 * @param[in] user_data The user data to be passed to the callback function
2150 * @return 0 on success, otherwise a negative error value
2151 * @retval #CAMERA_ERROR_NONE Successful
2152 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2153 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2154 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2155 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
2156 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2157 * @pre The camera's state should be #CAMERA_STATE_CREATED.
2158 * @see camera_start_preview()
2159 * @see camera_unset_media_packet_preview_cb()
2160 * @see camera_media_packet_preview_cb()
2162 int camera_set_media_packet_preview_cb(camera_h camera, camera_media_packet_preview_cb callback, void *user_data);
2165 * @brief Unsets the media packet callback function.
2167 * @remarks This function should not be called within a invoked @a callback,\n
2168 * otherwise #CAMERA_ERROR_INVALID_OPERATION is returned. (Since 9.0)
2169 * @param[in] camera The handle to the camera
2170 * @return @c 0 on success, otherwise a negative error value
2171 * @retval #CAMERA_ERROR_NONE Successful
2172 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2173 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2174 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2175 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
2176 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2177 * @see camera_set_media_packet_preview_cb()
2179 int camera_unset_media_packet_preview_cb(camera_h camera);
2182 * @brief Sets a callback function to be invoked when the camera state changes.
2184 * @param[in] camera The handle to the camera
2185 * @param[in] callback The callback function to be invoked
2186 * @param[in] user_data The user data to be passed to the callback function
2187 * @return @c 0 on success, otherwise a negative error value
2188 * @retval #CAMERA_ERROR_NONE Successful
2189 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2190 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2191 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2192 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2193 * @post This function will invoke camera_state_changed_cb() when the camera state changes.
2194 * @see camera_unset_state_changed_cb()
2195 * @see camera_state_changed_cb()
2197 int camera_set_state_changed_cb(camera_h camera, camera_state_changed_cb callback, void *user_data);
2200 * @brief Unsets the state changed callback function.
2202 * @param[in] camera The handle to the camera
2203 * @return @c 0 on success, otherwise a negative error value
2204 * @retval #CAMERA_ERROR_NONE Successful
2205 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2206 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2207 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2208 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2209 * @see camera_set_state_changed_cb()
2211 int camera_unset_state_changed_cb(camera_h camera);
2214 * @brief Sets a callback function to be invoked when the camera is interrupted by policy.
2216 * @param[in] camera The handle to the camera
2217 * @param[in] callback The callback function to be invoked
2218 * @param[in] user_data The user data to be passed to the callback function
2219 * @return @c 0 on success, otherwise a negative error value
2220 * @retval #CAMERA_ERROR_NONE Successful
2221 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2222 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2223 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2224 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2225 * @see camera_unset_interrupted_cb()
2226 * @see camera_interrupted_cb()
2228 int camera_set_interrupted_cb(camera_h camera, camera_interrupted_cb callback, void *user_data);
2231 * @brief Unsets the interrupted callback function.
2233 * @param[in] camera The handle to the camera
2234 * @return @c 0 on success, otherwise a negative error value
2235 * @retval #CAMERA_ERROR_NONE Successful
2236 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2237 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2238 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2239 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2240 * @see camera_set_interrupted_cb()
2242 int camera_unset_interrupted_cb(camera_h camera);
2245 * @brief Sets a callback function to be invoked when the camera interrupt is started by policy.
2247 * @param[in] camera The handle to the camera
2248 * @param[in] callback The callback function to be invoked
2249 * @param[in] user_data The user data to be passed to the callback function
2250 * @return @c 0 on success, otherwise a negative error value
2251 * @retval #CAMERA_ERROR_NONE Successful
2252 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2253 * @see camera_unset_interrupt_started_cb()
2254 * @see camera_interrupt_started_cb()
2256 int camera_set_interrupt_started_cb(camera_h camera, camera_interrupt_started_cb callback, void *user_data);
2259 * @brief Unsets the interrupt started callback function.
2261 * @param[in] camera The handle to the camera
2262 * @return @c 0 on success, otherwise a negative error value
2263 * @retval #CAMERA_ERROR_NONE Successful
2264 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2265 * @see camera_set_interrupt_started_cb()
2267 int camera_unset_interrupt_started_cb(camera_h camera);
2270 * @brief Sets a callback function to be invoked when the auto-focus state changes.
2272 * @param[in] camera The handle to the camera
2273 * @param[in] callback The callback function to be invoked
2274 * @param[in] user_data The user data to be passed to the callback function
2275 * @return @c 0 on success, otherwise a negative error value
2276 * @retval #CAMERA_ERROR_NONE Successful
2277 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2278 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2279 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2280 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2281 * @post This function will invoke camera_focus_changed_cb() when the auto-focus state changes.
2282 * @see camera_start_focusing()
2283 * @see camera_cancel_focusing()
2284 * @see camera_unset_focus_changed_cb()
2285 * @see camera_focus_changed_cb()
2287 int camera_set_focus_changed_cb(camera_h camera, camera_focus_changed_cb callback, void *user_data);
2290 * @brief Unsets the focus changed callback function.
2292 * @param[in] camera The handle to the camera
2293 * @return @c 0 on success, otherwise a negative error value
2294 * @retval #CAMERA_ERROR_NONE Successful
2295 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2296 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2297 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2298 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2299 * @see camera_set_focus_changed_cb()
2301 int camera_unset_focus_changed_cb(camera_h camera);
2304 * @brief Sets a callback function to be invoked when an asynchronous operation error occurs.
2306 * @remarks This callback informs about a critical error situation.\n
2307 * When this callback is invoked, the user should release the resource and terminate the application.\n
2308 * In case of errors, one of the following codes will occur:\n
2309 * #CAMERA_ERROR_DEVICE,\n
2310 * #CAMERA_ERROR_INVALID_OPERATION,\n
2311 * #CAMERA_ERROR_OUT_OF_MEMORY.
2312 * @param[in] camera The handle to the camera
2313 * @param[in] callback The callback function to be invoked
2314 * @param[in] user_data The user data to be passed to the callback function
2315 * @return @c 0 on success, otherwise a negative error value
2316 * @retval #CAMERA_ERROR_NONE Successful
2317 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2318 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2319 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2320 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2321 * @post This function will invoke camera_error_cb() when an asynchronous operation error occurs.
2323 * @see camera_unset_error_cb()
2324 * @see camera_error_cb()
2326 int camera_set_error_cb(camera_h camera, camera_error_cb callback, void *user_data);
2329 * @brief Unsets the error callback function.
2331 * @param[in] camera The handle to the camera
2332 * @return @c 0 on success, otherwise a negative error value
2333 * @retval #CAMERA_ERROR_NONE Successful
2334 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2335 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2336 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2337 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2338 * @see camera_set_error_cb()
2340 int camera_unset_error_cb(camera_h camera);
2343 * @brief Gets the state of camera device.
2345 * @param[in] device The hardware camera type
2346 * @param[out] state The current state of the device
2347 * @return @c 0 on success, otherwise a negative error value
2348 * @retval #CAMERA_ERROR_NONE Successful
2349 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2350 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2351 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
2353 int camera_get_device_state(camera_device_e device, camera_device_state_e *state);
2356 * @brief Adds a callback function to be invoked when the camera device state changes.
2358 * @param[in] callback The callback function to be invoked
2359 * @param[in] user_data The user data to be passed to the callback function
2360 * @param[out] cb_id The id of added callback
2361 * @return @c 0 on success, otherwise a negative error value
2362 * @retval #CAMERA_ERROR_NONE Successful
2363 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2364 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2365 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
2366 * @retval #CAMERA_ERROR_OUT_OF_MEMORY Out of memory
2367 * @post This function will invoke camera_device_state_changed_cb() when the camera device's state changes.
2368 * @see camera_remove_device_state_changed_cb()
2369 * @see camera_device_state_changed_cb()
2371 int camera_add_device_state_changed_cb(camera_device_state_changed_cb callback, void *user_data, int *cb_id);
2374 * @brief Removes the device state changed callback function.
2376 * @param[in] cb_id The id of added callback
2377 * @return @c 0 on success, otherwise a negative error value
2378 * @retval #CAMERA_ERROR_NONE Successful
2379 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2380 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2381 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
2382 * @see camera_add_device_state_changed_cb()
2384 int camera_remove_device_state_changed_cb(int cb_id);
2391 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
2396 * @brief Invoked to get each supported auto-focus mode.
2398 * @param[in] mode The supported auto-focus mode
2399 * @param[in] user_data The user data passed from the foreach function
2400 * @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
2401 * @pre camera_attr_foreach_supported_af_mode() will invoke this callback.
2402 * @see camera_attr_foreach_supported_af_mode()
2404 typedef bool (*camera_attr_supported_af_mode_cb)(camera_attr_af_mode_e mode, void *user_data);
2407 * @brief Invoked to get each supported exposure mode.
2409 * @param[in] mode The supported exposure mode
2410 * @param[in] user_data The user data passed from the foreach function
2411 * @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
2412 * @pre camera_attr_foreach_supported_exposure_mode() will invoke this callback.
2413 * @see camera_attr_foreach_supported_exposure_mode()
2414 * @see #camera_attr_exposure_mode_e
2416 typedef bool (*camera_attr_supported_exposure_mode_cb)(camera_attr_exposure_mode_e mode, void *user_data);
2419 * @brief Invoked to get each supported ISO mode.
2421 * @param[in] iso The supported ISO mode
2422 * @param[in] user_data The user data passed from the foreach function
2423 * @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
2424 * @pre camera_attr_foreach_supported_iso() will invoke this callback.
2425 * @see camera_attr_foreach_supported_iso()
2427 typedef bool (*camera_attr_supported_iso_cb)(camera_attr_iso_e iso, void *user_data);
2430 * @brief Invoked to get each supported white balance.
2432 * @param[in] wb The supported white balance mode
2433 * @param[in] user_data The user data passed from the foreach function
2434 * @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
2435 * @pre camera_attr_foreach_supported_whitebalance() will invoke this callback.
2436 * @see camera_attr_foreach_supported_whitebalance()
2437 * @see #camera_attr_whitebalance_e
2439 typedef bool (*camera_attr_supported_whitebalance_cb)(camera_attr_whitebalance_e wb, void *user_data);
2442 * @brief Invoked to get each supported effect mode.
2444 * @param[in] effect The supported effect mode
2445 * @param[in] user_data The user data passed from the foreach function
2446 * @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
2447 * @pre camera_attr_foreach_supported_effect() will invoke this callback.
2448 * @see camera_attr_foreach_supported_effect()
2450 typedef bool (*camera_attr_supported_effect_cb)(camera_attr_effect_mode_e effect, void *user_data);
2453 * @brief Invoked to get each supported scene mode.
2455 * @param[in] mode The supported scene mode
2456 * @param[in] user_data The user data passed from the foreach function
2457 * @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
2458 * @pre camera_attr_foreach_supported_scene_mode() will invoke this callback.
2459 * @see camera_attr_foreach_supported_scene_mode()
2460 * @see #camera_attr_scene_mode_e
2462 typedef bool (*camera_attr_supported_scene_mode_cb)(camera_attr_scene_mode_e mode, void *user_data);
2465 * @brief Invoked to get each supported flash mode.
2467 * @param[in] mode The supported flash mode
2468 * @param[in] user_data The user data passed from the foreach function
2469 * @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
2470 * @pre camera_attr_foreach_supported_flash_mode() will invoke this callback.
2471 * @see camera_attr_foreach_supported_flash_mode()
2473 typedef bool (*camera_attr_supported_flash_mode_cb)(camera_attr_flash_mode_e mode, void *user_data);
2476 * @brief Invoked to get each supported FPS mode.
2478 * @param[in] fps The supported FPS mode
2479 * @param[in] user_data The user data passed from the foreach function
2480 * @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
2481 * @pre camera_attr_foreach_supported_fps() will invoke this callback.
2482 * @see camera_attr_foreach_supported_fps()
2484 typedef bool (*camera_attr_supported_fps_cb)(camera_attr_fps_e fps, void *user_data);
2487 * @brief Invoked to get each supported stream flip mode.
2489 * @param[in] flip The supported stream flip mode
2490 * @param[in] user_data The user data passed from the foreach function
2491 * @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
2492 * @pre camera_attr_foreach_supported_stream_flip() will invoke this callback.
2493 * @see camera_attr_foreach_supported_stream_flip()
2495 typedef bool (*camera_attr_supported_stream_flip_cb)(camera_flip_e flip, void *user_data);
2498 * @brief Invoked to get each supported stream rotation mode.
2500 * @param[in] rotation The supported stream rotation mode
2501 * @param[in] user_data The user data passed from the foreach function
2502 * @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
2503 * @pre camera_attr_foreach_supported_stream_rotation() will invoke this callback.
2504 * @see camera_attr_foreach_supported_stream_rotation()
2506 typedef bool (*camera_attr_supported_stream_rotation_cb)(camera_rotation_e rotation, void *user_data);
2509 * @brief Invoked to get each supported theater mode.
2511 * @param[in] mode The supported theater mode
2512 * @param[in] user_data The user data passed from the foreach function
2513 * @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
2514 * @pre camera_attr_foreach_supported_theater_mode() will invoke this callback.
2515 * @see camera_attr_foreach_supported_theater_mode()
2517 typedef bool (*camera_attr_supported_theater_mode_cb)(camera_attr_theater_mode_e mode, void *user_data);
2520 * @brief Invoked to get each supported PTZ (Pan Tilt Zoom) type.
2522 * @param[in] type The supported ptz type
2523 * @param[in] user_data The user data passed from the foreach function
2524 * @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
2525 * @pre camera_attr_foreach_supported_ptz_type() will invoke this callback.
2526 * @see camera_attr_foreach_supported_ptz_type()
2528 typedef bool (*camera_attr_supported_ptz_type_cb)(camera_attr_ptz_type_e type, void *user_data);
2536 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
2541 * @brief Sets the preview frame rate.
2543 * @remarks This function should be called before previewing (see camera_start_preview()).
2544 * @param[in] camera The handle to the camera
2545 * @param[in] fps The frame rate
2546 * @return @c 0 on success, otherwise a negative error value
2547 * @retval #CAMERA_ERROR_NONE Successful
2548 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2549 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2550 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2551 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
2552 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2553 * @pre The camera state must be set to #CAMERA_STATE_CREATED.
2554 * @see camera_start_preview()
2555 * @see camera_attr_get_preview_fps()
2556 * @see camera_attr_foreach_supported_fps()
2558 int camera_attr_set_preview_fps(camera_h camera, camera_attr_fps_e fps);
2561 * @brief Gets the frames per second of a preview video stream.
2563 * @param[in] camera The handle to the camera
2564 * @param[out] fps The frames per second of the preview video stream
2565 * @return @c 0 on success, otherwise a negative error value
2566 * @retval #CAMERA_ERROR_NONE Successful
2567 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2568 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2569 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2570 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2571 * @see camera_attr_set_preview_fps()
2572 * @see camera_attr_foreach_supported_fps()
2574 int camera_attr_get_preview_fps(camera_h camera, camera_attr_fps_e *fps);
2577 * @brief Sets the bitrate of extra preview.
2579 * @param[in] camera The handle to the camera
2580 * @param[in] stream_id The id of extra preview stream
2581 * @param[in] bitrate The bitrate(bps) of extra preview
2582 * @return @c 0 on success, otherwise a negative error value
2583 * @retval #CAMERA_ERROR_NONE Successful
2584 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2585 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2586 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
2587 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2588 * @see camera_attr_get_extra_preview_bitrate()
2590 int camera_attr_set_extra_preview_bitrate(camera_h camera, int stream_id, int bitrate);
2593 * @brief Gets the bitrate of extra preview.
2595 * @param[in] camera The handle to the camera
2596 * @param[in] stream_id The id of extra preview stream
2597 * @param[out] bitrate The bitrate(bps) of extra preview stream
2598 * @return @c 0 on success, otherwise a negative error value
2599 * @retval #CAMERA_ERROR_NONE Successful
2600 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2601 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2602 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
2603 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2604 * @see camera_attr_set_extra_preview_bitrate()
2606 int camera_attr_get_extra_preview_bitrate(camera_h camera, int stream_id, int *bitrate);
2609 * @brief Sets the GOP (Group Of Pictures) interval of extra preview.
2611 * @remarks The recommended range is from 1,000 (1 second) to 600,000 (10 minutes). \n
2612 * But, due to codec limitations, it may not apply.
2613 * @param[in] camera The handle to the camera
2614 * @param[in] stream_id The id of extra preview stream
2615 * @param[in] interval The GOP interval of extra preview (millisecond)
2616 * @return @c 0 on success, otherwise a negative error value
2617 * @retval #CAMERA_ERROR_NONE Successful
2618 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2619 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2620 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
2621 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2622 * @see camera_attr_get_extra_preview_gop_interval()
2624 int camera_attr_set_extra_preview_gop_interval(camera_h camera, int stream_id, int interval);
2627 * @brief Gets the GOP (Group Of Pictures) interval of extra preview.
2629 * @param[in] camera The handle to the camera
2630 * @param[in] stream_id The id of extra preview stream
2631 * @param[out] interval The GOP interval of extra preview (millisecond)
2632 * @return @c 0 on success, otherwise a negative error value
2633 * @retval #CAMERA_ERROR_NONE Successful
2634 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2635 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2636 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
2637 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2638 * @see camera_attr_set_extra_preview_gop_interval()
2640 int camera_attr_get_extra_preview_gop_interval(camera_h camera, int stream_id, int *interval);
2643 * @brief Gets the rotation of preview frame.
2645 * @remarks The function should be called in camera_preview_cb(),\n
2646 * otherwise, it will return #CAMERA_ERROR_INVALID_OPERATION.
2647 * @param[in] camera The handle to the camera
2648 * @param[out] rotation The rotation of preview frame
2649 * @return @c 0 on success, otherwise a negative error value
2650 * @retval #CAMERA_ERROR_NONE Successful
2651 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2652 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
2653 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2655 int camera_attr_get_preview_frame_rotation(camera_h camera, camera_rotation_e *rotation);
2662 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
2667 * @brief Retrieves all supported FPS modes by invoking the callback function once for each supported FPS mode.
2669 * @param[in] camera The handle to the camera
2670 * @param[in] callback The callback function to be invoked
2671 * @param[in] user_data The user data to be passed to the callback function
2672 * @return @c 0 on success, otherwise a negative error value
2673 * @retval #CAMERA_ERROR_NONE Successful
2674 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2675 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2676 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2677 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2678 * @post This function invokes camera_attr_supported_fps_cb() repeatedly to get each supported FPS mode.
2679 * @see camera_attr_set_preview_fps()
2680 * @see camera_attr_get_preview_fps()
2681 * @see camera_attr_supported_fps_cb()
2683 int camera_attr_foreach_supported_fps(camera_h camera, camera_attr_supported_fps_cb callback, void *user_data);
2686 * @brief Retrieves all supported FPS modes by invoking the callback function once for each supported FPS mode by resolution.
2688 * @param[in] camera The handle to the camera
2689 * @param[in] width Required preview resolution's width
2690 * @param[in] height Required preview resolution's height
2691 * @param[in] callback The callback function to be invoked
2692 * @param[in] user_data The user data to be passed to the callback function
2693 * @return @c 0 on success, otherwise a negative error value
2694 * @retval #CAMERA_ERROR_NONE Successful
2695 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2696 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2697 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2698 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2699 * @post This function invokes camera_attr_supported_fps_cb() repeatedly to get each supported FPS mode.
2700 * @see camera_attr_set_preview_fps()
2701 * @see camera_attr_get_preview_fps()
2702 * @see camera_attr_supported_fps_cb()
2704 int camera_attr_foreach_supported_fps_by_resolution(camera_h camera, int width, int height, camera_attr_supported_fps_cb callback, void *user_data);
2711 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
2716 * @brief Sets quality of the image.
2717 * @details The range for image quality is 1 to 100. If @a quality is out of range, #CAMERA_ERROR_INVALID_PARAMETER error occurred.
2719 * @param[in] camera The handle to the camera
2720 * @param[in] quality The quality of image (1 ~ 100)
2721 * @return @c 0 on success, otherwise a negative error value
2722 * @retval #CAMERA_ERROR_NONE Successful
2723 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2724 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2725 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2726 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
2727 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2728 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
2729 * @see camera_start_preview()
2730 * @see camera_attr_get_image_quality()
2732 int camera_attr_set_image_quality(camera_h camera, int quality);
2735 * @brief Gets the quality of a still image, which is captured.
2737 * @param[in] camera The handle to the camera
2738 * @param[out] quality The quality of the image(1 ~ 100)
2739 * @return @c 0 on success, otherwise a negative error value
2740 * @retval #CAMERA_ERROR_NONE Successful
2741 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2742 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2743 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2744 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2745 * @see camera_attr_set_image_quality()
2747 int camera_attr_get_image_quality(camera_h camera, int *quality);
2750 * @brief Gets the bit rate of encoded preview.
2752 * @param[in] camera The handle to the camera
2753 * @param[out] bitrate The bit rate of encoded preview
2754 * @return @c 0 on success, otherwise a negative error value
2755 * @retval #CAMERA_ERROR_NONE Successful
2756 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2757 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2758 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
2759 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2760 * @see camera_attr_set_encoded_preview_bitrate()
2762 int camera_attr_get_encoded_preview_bitrate(camera_h camera, int *bitrate);
2765 * @brief Sets the bit rate of encoded preview.
2767 * @remarks The recommended range is from 1,000 (1 kbps) to 100,000,000 (100 Mbps). \n
2768 * But, due to codec limitations, it may not apply.
2769 * @param[in] camera The handle to the camera
2770 * @param[in] bitrate The bit rate of encoded preview
2771 * @return @c 0 on success, otherwise a negative error value
2772 * @retval #CAMERA_ERROR_NONE Successful
2773 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2774 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2775 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
2776 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2777 * @see camera_attr_get_encoded_preview_bitrate()
2779 int camera_attr_set_encoded_preview_bitrate(camera_h camera, int bitrate);
2782 * @brief Gets the GOP (Group Of Pictures) interval of encoded preview.
2784 * @param[in] camera The handle to the camera
2785 * @param[out] interval The GOP interval of encoded preview (millisecond)
2786 * @return @c 0 on success, otherwise a negative error value
2787 * @retval #CAMERA_ERROR_NONE Successful
2788 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2789 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2790 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
2791 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2792 * @see camera_attr_set_encoded_preview_gop_interval()
2794 int camera_attr_get_encoded_preview_gop_interval(camera_h camera, int *interval);
2797 * @brief Sets the GOP (Group Of Pictures) interval of encoded preview.
2799 * @remarks The recommended range is from 1,000 (1 second) to 600,000 (10 minutes). \n
2800 * But, due to codec limitations, it may not apply.
2801 * @param[in] camera The handle to the camera
2802 * @param[in] interval The GOP interval of encoded preview (millisecond)
2803 * @return @c 0 on success, otherwise a negative error value
2804 * @retval #CAMERA_ERROR_NONE Successful
2805 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2806 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2807 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
2808 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2809 * @see camera_attr_get_encoded_preview_gop_interval()
2811 int camera_attr_set_encoded_preview_gop_interval(camera_h camera, int interval);
2814 * @brief Sets the zoom level.
2815 * @details The range for the zoom level is received from camera_attr_get_zoom_range(). If @a zoom is out of range, the #CAMERA_ERROR_INVALID_PARAMETER error occurs.
2817 * @param[in] camera The handle to the camera
2818 * @param[in] zoom The zoom level
2819 * @return @c 0 on success, otherwise a negative error value
2820 * @retval #CAMERA_ERROR_NONE Successful
2821 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2822 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2823 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2824 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
2825 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2826 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
2827 * @see camera_attr_get_zoom()
2828 * @see camera_attr_get_zoom_range()
2830 int camera_attr_set_zoom(camera_h camera, int zoom);
2833 * @brief Gets the zoom level.
2835 * @param[in] camera The handle to the camera
2836 * @param[out] zoom The zoom level
2837 * @return @c 0 on success, otherwise a negative error value
2838 * @retval #CAMERA_ERROR_NONE Successful
2839 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2840 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2841 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2842 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2843 * @see camera_attr_set_zoom()
2844 * @see camera_attr_get_zoom_range()
2846 int camera_attr_get_zoom(camera_h camera, int *zoom);
2849 * @brief Gets the available zoom level.
2851 * @remarks If the min value is greater than the max value, it means that this feature is not supported.
2852 * @param[in] camera The handle to the camera
2853 * @param[out] min The minimum zoom level
2854 * @param[out] max The maximum zoom level
2855 * @return @c 0 on success, otherwise a negative error value
2856 * @retval #CAMERA_ERROR_NONE Successful
2857 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2858 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2859 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2860 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2861 * @see camera_attr_set_zoom()
2862 * @see camera_attr_get_zoom()
2864 int camera_attr_get_zoom_range(camera_h camera, int *min, int *max);
2868 * @brief Sets the auto focus mode.
2870 * @param[in] camera The handle to the camera
2871 * @param[in] mode The auto focus mode
2872 * @return @c 0 on success, otherwise a negative error value
2873 * @retval #CAMERA_ERROR_NONE Successful
2874 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2875 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2876 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2877 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
2878 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2879 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
2880 * @see camera_attr_get_af_mode()
2881 * @see camera_attr_foreach_supported_af_mode()
2882 * @see #camera_attr_af_mode_e
2884 int camera_attr_set_af_mode(camera_h camera, camera_attr_af_mode_e mode);
2887 * @brief Gets the auto focus mode.
2889 * @param[in] camera The handle to the camera
2890 * @param[out] mode The auto focus mode
2891 * @return @c 0 on success, otherwise a negative error value
2892 * @retval #CAMERA_ERROR_NONE Successful
2893 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2894 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2895 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2896 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2897 * @see camera_attr_foreach_supported_af_mode()
2898 * @see camera_attr_set_af_mode()
2899 * @see #camera_attr_af_mode_e
2901 int camera_attr_get_af_mode(camera_h camera, camera_attr_af_mode_e *mode);
2904 * @brief Sets auto focus area.
2906 * @remarks It will return #CAMERA_ERROR_INVALID_OPERATION in the #CAMERA_ATTR_AF_NONE mode.\n
2907 * The coordinates are mapped to preview area.
2908 * @param[in] camera The handle to the camera
2909 * @param[in] x The x coordinates of the focus area
2910 * @param[in] y The y coordinates of the focus area
2911 * @return @c 0 on success, otherwise a negative error value
2912 * @retval #CAMERA_ERROR_NONE Successful
2913 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2914 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2915 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2916 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
2917 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
2918 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2919 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
2920 * @see camera_attr_set_af_mode()
2921 * @see camera_attr_clear_af_area()
2923 int camera_attr_set_af_area(camera_h camera, int x, int y);
2926 * @brief Clears the auto focus area.
2928 * @remarks The focusing area is set to the center.
2929 * @param[in] camera The handle to the camera
2930 * @return @c 0 on success, otherwise a negative error value
2931 * @retval #CAMERA_ERROR_NONE Successful
2932 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2933 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2934 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2935 * @retval #CAMERA_ERROR_INVALID_OPERATION Invalid operation
2936 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2937 * @see camera_attr_set_af_mode()
2938 * @see camera_attr_set_af_area()
2940 int camera_attr_clear_af_area(camera_h camera);
2947 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
2952 * @brief Retrieves all supported auto focus modes by invoking the callback function once for each supported auto focus mode.
2954 * @param[in] camera The handle to the camera
2955 * @param[in] callback The callback function to be invoked
2956 * @param[in] user_data The user data to be passed to the callback function
2957 * @return @c 0 on success, otherwise a negative error value
2958 * @retval #CAMERA_ERROR_NONE Successful
2959 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2960 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2961 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2962 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2963 * @post This function invokes camera_attr_supported_af_mode_cb() to get all the supported auto focus modes.
2964 * @see camera_attr_set_af_mode()
2965 * @see camera_attr_get_af_mode()
2966 * @see camera_attr_supported_af_mode_cb()
2968 int camera_attr_foreach_supported_af_mode(camera_h camera, camera_attr_supported_af_mode_cb callback, void *user_data);
2975 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
2980 * @brief Sets the exposure mode.
2982 * @param[in] camera The handle to the camera
2983 * @param[in] mode The exposure mode
2984 * @return @c 0 on success, otherwise a negative error value
2985 * @retval #CAMERA_ERROR_NONE Successful
2986 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
2987 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
2988 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
2989 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
2990 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
2991 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
2992 * @see camera_attr_get_exposure_mode()
2993 * @see camera_attr_foreach_supported_exposure_mode()
2995 int camera_attr_set_exposure_mode(camera_h camera, camera_attr_exposure_mode_e mode);
2998 * @brief Gets the exposure mode.
3000 * @param[in] camera The handle to the camera
3001 * @param[out] mode The exposure mode
3002 * @return @c 0 on success, otherwise a negative error value
3003 * @retval #CAMERA_ERROR_NONE Successful
3004 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3005 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3006 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3007 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3008 * @see camera_attr_set_exposure_mode()
3009 * @see camera_attr_foreach_supported_exposure_mode()
3011 int camera_attr_get_exposure_mode(camera_h camera, camera_attr_exposure_mode_e *mode);
3018 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
3023 * @brief Retrieves all supported exposure modes by invoking the callback function once for each supported exposure mode.
3025 * @param[in] camera The handle to the camera
3026 * @param[in] callback The callback function to be invoked
3027 * @param[in] user_data The user data to be passed to the callback function
3028 * @return @c 0 on success, otherwise a negative error value
3029 * @retval #CAMERA_ERROR_NONE Successful
3030 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3031 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3032 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3033 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3034 * @post This function invokes camera_attr_supported_exposure_mode_cb() to get all the supported exposure modes.
3035 * @see camera_attr_set_exposure_mode()
3036 * @see camera_attr_get_exposure_mode()
3037 * @see camera_attr_supported_exposure_mode_cb()
3039 int camera_attr_foreach_supported_exposure_mode(camera_h camera, camera_attr_supported_exposure_mode_cb callback, void *user_data);
3046 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
3051 * @brief Sets the exposure value.
3053 * @param[in] camera The handle to the camera
3054 * @param[in] value The exposure value
3055 * @return @c 0 on success, otherwise a negative error value
3056 * @retval #CAMERA_ERROR_NONE Successful
3057 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3058 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3059 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3060 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3061 * @see camera_attr_get_exposure()
3063 int camera_attr_set_exposure(camera_h camera, int value);
3066 * @brief Gets the exposure value.
3068 * @param[in] camera The handle to the camera
3069 * @param[out] value The exposure value
3070 * @return @c 0 on success, otherwise a negative error value
3071 * @retval #CAMERA_ERROR_NONE Successful
3072 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3073 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3074 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3075 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3076 * @see camera_attr_set_exposure()
3078 int camera_attr_get_exposure(camera_h camera, int *value);
3081 * @brief Gets the available exposure value.
3083 * @remarks If the min value is greater than the max value, it means that this feature is not supported.
3084 * @param[in] camera The handle to the camera
3085 * @param[out] min The minimum exposure value
3086 * @param[out] max The maximum exposure value
3087 * @return @c 0 on success, otherwise a negative error value
3088 * @retval #CAMERA_ERROR_NONE Successful
3089 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3090 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3091 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3092 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3093 * @see camera_attr_set_exposure()
3095 int camera_attr_get_exposure_range(camera_h camera, int *min, int *max);
3098 * @brief Sets the ISO level.
3100 * @param[in] camera The handle to the camera
3101 * @param[in] iso The ISO level
3102 * @return @c 0 on success, otherwise a negative error value
3103 * @retval #CAMERA_ERROR_NONE Successful
3104 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3105 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3106 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3107 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
3108 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3109 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
3110 * @see camera_attr_get_iso()
3111 * @see camera_attr_foreach_supported_iso()
3113 int camera_attr_set_iso(camera_h camera, camera_attr_iso_e iso);
3116 * @brief Gets the ISO level.
3118 * @param[in] camera The handle to the camera
3119 * @param[out] iso The ISO level
3120 * @return @c 0 on success, otherwise a negative error value
3121 * @retval #CAMERA_ERROR_NONE Successful
3122 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3123 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3124 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3125 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3126 * @see camera_attr_set_iso()
3127 * @see camera_attr_foreach_supported_iso()
3129 int camera_attr_get_iso(camera_h camera, camera_attr_iso_e *iso);
3132 * @brief Sets the gain level.
3134 * @param[in] camera The handle to the camera
3135 * @param[in] level The gain level
3136 * @return @c 0 on success, otherwise a negative error value
3137 * @retval #CAMERA_ERROR_NONE Successful
3138 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3139 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3140 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
3141 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3142 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
3143 * @see camera_attr_get_gain()
3144 * @see camera_attr_get_gain_range()
3145 * @see camera_attr_get_gain_step()
3147 int camera_attr_set_gain(camera_h camera, int level);
3150 * @brief Gets the gain level.
3152 * @param[in] camera The handle to the camera
3153 * @param[out] level The gain level
3154 * @return @c 0 on success, otherwise a negative error value
3155 * @retval #CAMERA_ERROR_NONE Successful
3156 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3157 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3158 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3159 * @see camera_attr_set_gain()
3160 * @see camera_attr_get_gain_range()
3161 * @see camera_attr_get_gain_step()
3163 int camera_attr_get_gain(camera_h camera, int *level);
3166 * @brief Gets the available gain level.
3168 * @remarks If the min value is greater than the max value, it means that this feature is not supported.
3169 * @param[in] camera The handle to the camera
3170 * @param[out] min The minimum gain level
3171 * @param[out] max The maximum gain level
3172 * @return @c 0 on success, otherwise a negative error value
3173 * @retval #CAMERA_ERROR_NONE Successful
3174 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3175 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3176 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3177 * @see camera_attr_set_gain()
3178 * @see camera_attr_get_gain()
3179 * @see camera_attr_get_gain_step()
3181 int camera_attr_get_gain_range(camera_h camera, int *min, int *max);
3184 * @brief Gets the gain level step.
3186 * @param[in] camera The handle to the camera
3187 * @param[out] step The gain level step
3188 * @return @c 0 on success, otherwise a negative error value
3189 * @retval #CAMERA_ERROR_NONE Successful
3190 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3191 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3192 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3193 * @see camera_attr_set_gain()
3194 * @see camera_attr_get_gain()
3195 * @see camera_attr_get_gain_range()
3197 int camera_attr_get_gain_step(camera_h camera, int *step);
3204 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
3209 * @brief Retrieves all supported ISO levels by invoking the callback function once for each supported ISO level.
3211 * @param[in] camera The handle to the camera
3212 * @param[in] callback The callback function to be invoked
3213 * @param[in] user_data The user data to be passed to the callback function
3214 * @return @c 0 on success, otherwise a negative error value
3215 * @retval #CAMERA_ERROR_NONE Successful
3216 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3217 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3218 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3219 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3220 * @post This function invokes camera_attr_supported_iso_cb() to get all the supported ISO levels.
3221 * @see camera_attr_set_iso()
3222 * @see camera_attr_get_iso()
3223 * @see camera_attr_supported_iso_cb()
3225 int camera_attr_foreach_supported_iso(camera_h camera, camera_attr_supported_iso_cb callback, void *user_data);
3232 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
3237 * @brief Sets the theater mode.
3239 * @remarks If you want to display the preview image on the external display with the full screen mode, use this function.
3240 * @param[in] camera The handle to the camera
3241 * @param[in] mode The theater mode
3242 * @return @c 0 on success, otherwise a negative error value
3243 * @retval #CAMERA_ERROR_NONE Successful
3244 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3245 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3246 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3247 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3248 * @pre This function is valid only when the external display is connected.
3249 * @see camera_attr_get_theater_mode()
3251 int camera_attr_set_theater_mode(camera_h camera, camera_attr_theater_mode_e mode);
3254 * @brief Gets the theater mode.
3256 * @param[in] camera The handle to the camera
3257 * @param[out] mode The theater mode
3258 * @return @c 0 on success, otherwise a negative error value
3259 * @retval #CAMERA_ERROR_NONE Successful
3260 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3261 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3262 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3263 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3264 * @see camera_attr_set_theater_mode()
3266 int camera_attr_get_theater_mode(camera_h camera, camera_attr_theater_mode_e *mode);
3273 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
3278 * @brief Retrieves all supported theater modes by invoking callback function once for each supported theater modes.
3280 * @param[in] camera The handle to the camera
3281 * @param[in] callback The callback function to be invoked
3282 * @param[in] user_data The user data to be passed to the callback function
3283 * @return @c 0 on success, otherwise a negative error value
3284 * @retval #CAMERA_ERROR_NONE Successful
3285 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3286 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3287 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3288 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3289 * @post This function invokes camera_attr_supported_theater_mode_cb() to get all supported theater modes.
3290 * @see camera_attr_set_theater_mode()
3291 * @see camera_attr_get_theater_mode()
3292 * @see camera_attr_supported_theater_mode_cb()
3294 int camera_attr_foreach_supported_theater_mode(camera_h camera, camera_attr_supported_theater_mode_cb callback, void *user_data);
3302 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
3307 * @brief Sets the brightness level.
3309 * @remarks If the min value is greater than the max value from camera_attr_get_brightness_range(), \n
3310 * it means that this feature is not supported.
3311 * @param[in] camera The handle to the camera
3312 * @param[in] level The brightness level
3313 * @return @c 0 on success, otherwise a negative error value
3314 * @retval #CAMERA_ERROR_NONE Successful
3315 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3316 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3317 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3318 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
3319 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3320 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
3321 * @see camera_attr_get_brightness()
3322 * @see camera_attr_get_brightness_range()
3324 int camera_attr_set_brightness(camera_h camera, int level);
3327 * @brief Gets the brightness level.
3329 * @param[in] camera The handle to the camera
3330 * @param[out] level The brightness level
3331 * @return @c 0 on success, otherwise a negative error value
3332 * @retval #CAMERA_ERROR_NONE Successful
3333 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3334 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3335 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3336 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3337 * @see camera_attr_set_brightness()
3338 * @see camera_attr_get_brightness_range()
3340 int camera_attr_get_brightness(camera_h camera, int *level);
3343 * @brief Gets the available brightness level.
3345 * @remarks If the min value is greater than the max value, it means that this feature is not supported.
3346 * @param[in] camera The handle to the camera
3347 * @param[out] min The minimum brightness level
3348 * @param[out] max The maximum brightness level
3349 * @return @c 0 on success, otherwise a negative error value
3350 * @retval #CAMERA_ERROR_NONE Successful
3351 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3352 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3353 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3354 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3355 * @see camera_attr_set_brightness()
3356 * @see camera_attr_get_brightness()
3358 int camera_attr_get_brightness_range(camera_h camera, int *min, int *max);
3361 * @brief Sets the contrast level.
3363 * @param[in] camera The handle to the camera
3364 * @param[in] level The contrast level
3365 * @return @c 0 on success, otherwise a negative error value
3366 * @retval #CAMERA_ERROR_NONE Successful
3367 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3368 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3369 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3370 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
3371 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3372 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
3373 * @see camera_attr_get_contrast()
3374 * @see camera_attr_get_contrast_range()
3376 int camera_attr_set_contrast(camera_h camera, int level);
3379 * @brief Gets the contrast level.
3381 * @param[in] camera The handle to the camera
3382 * @param[out] level The contrast level
3383 * @return @c 0 on success, otherwise a negative error value
3384 * @retval #CAMERA_ERROR_NONE Successful
3385 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3386 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3387 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3388 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3389 * @see camera_attr_set_contrast()
3390 * @see camera_attr_get_contrast_range()
3392 int camera_attr_get_contrast(camera_h camera, int *level);
3395 * @brief Gets the available contrast level.
3397 * @remarks If the min value is greater than the max value, it means that this feature is not supported.
3398 * @param[in] camera The handle to the camera
3399 * @param[out] min The minimum contrast level
3400 * @param[out] max The maximum contrast level
3401 * @return @c 0 on success, otherwise a negative error value
3402 * @retval #CAMERA_ERROR_NONE Successful
3403 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3404 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3405 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3406 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3407 * @see camera_attr_set_contrast()
3408 * @see camera_attr_get_contrast()
3410 int camera_attr_get_contrast_range(camera_h camera, int *min, int *max);
3413 * @brief Sets the hue level.
3415 * @param[in] camera The handle to the camera
3416 * @param[in] level The hue level
3417 * @return @c 0 on success, otherwise a negative error value
3418 * @retval #CAMERA_ERROR_NONE Successful
3419 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3420 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3421 * @see camera_attr_get_hue()
3422 * @see camera_attr_get_hue_range()
3424 int camera_attr_set_hue(camera_h camera, int level);
3427 * @brief Gets the hue level.
3429 * @param[in] camera The handle to the camera
3430 * @param[out] level The hue level
3431 * @return @c 0 on success, otherwise a negative error value
3432 * @retval #CAMERA_ERROR_NONE Successful
3433 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3434 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3435 * @see camera_attr_set_hue()
3436 * @see camera_attr_get_hue_range()
3438 int camera_attr_get_hue(camera_h camera, int *level);
3441 * @brief Gets the available hue level.
3443 * @remarks If the min value is greater than the max value, it means that this feature is not supported.
3444 * @param[in] camera The handle to the camera
3445 * @param[out] min The minimum hue level
3446 * @param[out] max The maximum hue level
3447 * @return @c 0 on success, otherwise a negative error value
3448 * @retval #CAMERA_ERROR_NONE Successful
3449 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3450 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3451 * @see camera_attr_set_hue()
3452 * @see camera_attr_get_hue()
3454 int camera_attr_get_hue_range(camera_h camera, int *min, int *max);
3457 * @brief Sets the white balance mode.
3459 * @param[in] camera The handle to the camera
3460 * @param[in] whitebalance The white balance mode
3461 * @return @c 0 on success, otherwise a negative error value
3462 * @retval #CAMERA_ERROR_NONE Successful
3463 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3464 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3465 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3466 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
3467 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3468 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
3469 * @see camera_attr_foreach_supported_whitebalance()
3470 * @see camera_attr_get_whitebalance()
3472 int camera_attr_set_whitebalance(camera_h camera, camera_attr_whitebalance_e whitebalance);
3475 * @brief Gets the white balance mode.
3477 * @param[in] camera The handle to the camera
3478 * @param[out] whitebalance The white balance mode
3479 * @return @c 0 on success, otherwise a negative error value
3480 * @retval #CAMERA_ERROR_NONE Successful
3481 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3482 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3483 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3484 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3485 * @see camera_attr_foreach_supported_whitebalance()
3486 * @see camera_attr_set_whitebalance()
3488 int camera_attr_get_whitebalance(camera_h camera, camera_attr_whitebalance_e *whitebalance);
3491 * @brief Sets the white balance temperature.
3493 * @param[in] camera The handle to the camera
3494 * @param[in] temperature The white balance temperature
3495 * @return @c 0 on success, otherwise a negative error value
3496 * @retval #CAMERA_ERROR_NONE Successful
3497 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3498 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3499 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3500 * @see camera_attr_get_whitebalance_temperature()
3501 * @see camera_attr_get_whitebalance_temperature_range()
3502 * @see camera_attr_get_whitebalance_temperature_step()
3504 int camera_attr_set_whitebalance_temperature(camera_h camera, int temperature);
3507 * @brief Gets the white balance temperature.
3509 * @param[in] camera The handle to the camera
3510 * @param[out] temperature The white balance temperature
3511 * @return @c 0 on success, otherwise a negative error value
3512 * @retval #CAMERA_ERROR_NONE Successful
3513 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3514 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3515 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3516 * @see camera_attr_set_whitebalance_temperature()
3517 * @see camera_attr_get_whitebalance_temperature_range()
3518 * @see camera_attr_get_whitebalance_temperature_step()
3520 int camera_attr_get_whitebalance_temperature(camera_h camera, int *temperature);
3523 * @brief Gets the available white balance temperature.
3525 * @remarks If the min value is greater than the max value, it means that this feature is not supported.
3526 * @param[in] camera The handle to the camera
3527 * @param[out] min The minimum white balance temperature
3528 * @param[out] max The maximum white balance temperature
3529 * @return @c 0 on success, otherwise a negative error value
3530 * @retval #CAMERA_ERROR_NONE Successful
3531 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3532 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3533 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3534 * @see camera_attr_set_whitebalance_temperature()
3535 * @see camera_attr_get_whitebalance_temperature()
3536 * @see camera_attr_get_whitebalance_temperature_step()
3538 int camera_attr_get_whitebalance_temperature_range(camera_h camera, int *min, int *max);
3541 * @brief Gets the step of white balance temperature.
3543 * @param[in] camera The handle to the camera
3544 * @param[out] step The step of white balance temperature
3545 * @return @c 0 on success, otherwise a negative error value
3546 * @retval #CAMERA_ERROR_NONE Successful
3547 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3548 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3549 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3550 * @see camera_attr_set_whitebalance_temperature()
3551 * @see camera_attr_get_whitebalance_temperature()
3552 * @see camera_attr_get_whitebalance_temperature_range()
3554 int camera_attr_get_whitebalance_temperature_step(camera_h camera, int *step);
3557 * @brief Sets the saturation level.
3559 * @param[in] camera The handle to the camera
3560 * @param[in] level The saturation level
3561 * @return @c 0 on success, otherwise a negative error value
3562 * @retval #CAMERA_ERROR_NONE Successful
3563 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3564 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3565 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3566 * @see camera_attr_get_saturation()
3567 * @see camera_attr_get_saturation_range()
3569 int camera_attr_set_saturation(camera_h camera, int level);
3572 * @brief Gets the saturation level.
3574 * @param[in] camera The handle to the camera
3575 * @param[out] level The saturation level
3576 * @return @c 0 on success, otherwise a negative error value
3577 * @retval #CAMERA_ERROR_NONE Successful
3578 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3579 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3580 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3581 * @see camera_attr_set_saturation()
3582 * @see camera_attr_get_saturation_range()
3584 int camera_attr_get_saturation(camera_h camera, int *level);
3587 * @brief Gets the available saturation level.
3589 * @remarks If the min value is greater than the max value, it means that this feature is not supported.
3590 * @param[in] camera The handle to the camera
3591 * @param[out] min The minimum saturation level
3592 * @param[out] max The maximum saturation level
3593 * @return @c 0 on success, otherwise a negative error value
3594 * @retval #CAMERA_ERROR_NONE Successful
3595 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3596 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3597 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3598 * @see camera_attr_set_saturation()
3599 * @see camera_attr_get_saturation()
3601 int camera_attr_get_saturation_range(camera_h camera, int *min, int *max);
3604 * @brief Sets the sharpness level.
3606 * @param[in] camera The handle to the camera
3607 * @param[in] level The sharpness level
3608 * @return @c 0 on success, otherwise a negative error value
3609 * @retval #CAMERA_ERROR_NONE Successful
3610 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3611 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3612 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3613 * @see camera_attr_get_sharpness()
3614 * @see camera_attr_get_sharpness_range()
3616 int camera_attr_set_sharpness(camera_h camera, int level);
3619 * @brief Gets the sharpness level.
3621 * @param[in] camera The handle to the camera
3622 * @param[out] level The sharpness level
3623 * @return @c 0 on success, otherwise a negative error value
3624 * @retval #CAMERA_ERROR_NONE Successful
3625 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3626 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3627 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3628 * @see camera_attr_set_sharpness()
3629 * @see camera_attr_get_sharpness_range()
3631 int camera_attr_get_sharpness(camera_h camera, int *level);
3634 * @brief Gets the available sharpness level.
3636 * @remarks If the min value is greater than the max value, it means that this feature is not supported.
3637 * @param[in] camera The handle to the camera
3638 * @param[out] min The minimum sharpness level
3639 * @param[out] max The maximum sharpness level
3640 * @return @c 0 on success, otherwise a negative error value
3641 * @retval #CAMERA_ERROR_NONE Successful
3642 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3643 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3644 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3645 * @see camera_attr_set_sharpness()
3646 * @see camera_attr_get_sharpness()
3648 int camera_attr_get_sharpness_range(camera_h camera, int *min, int *max);
3651 * @brief Sets the manual focus level.
3653 * @remarks The auto focusing will be stopped when camera_attr_set_focus_level() is called.
3654 * @param[in] camera The handle to the camera
3655 * @param[in] level The manual focus level
3656 * @return @c 0 on success, otherwise a negative error value
3657 * @retval #CAMERA_ERROR_NONE Successful
3658 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3659 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3660 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
3661 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3662 * @see camera_attr_get_focus_level()
3663 * @see camera_attr_get_focus_level_range()
3665 int camera_attr_set_focus_level(camera_h camera, int level);
3668 * @brief Gets the manual focus level.
3670 * @param[in] camera The handle to the camera
3671 * @param[out] level The manual focus level
3672 * @return @c 0 on success, otherwise a negative error value
3673 * @retval #CAMERA_ERROR_NONE Successful
3674 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3675 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3676 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
3677 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3678 * @see camera_attr_set_focus_level()
3679 * @see camera_attr_get_focus_level_range()
3681 int camera_attr_get_focus_level(camera_h camera, int *level);
3684 * @brief Gets lower limit and upper limit for manual focus level.
3686 * @remarks If the min value is greater than the max value, it means that this feature is not supported.
3687 * @param[in] camera The handle to the camera
3688 * @param[out] min The lower limit for manual focus level
3689 * @param[out] max The upper limit for manual focus level
3690 * @return @c 0 on success, otherwise a negative error value
3691 * @retval #CAMERA_ERROR_NONE Successful
3692 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3693 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3694 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
3695 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3696 * @see camera_attr_set_focus_level()
3697 * @see camera_attr_get_focus_level()
3699 int camera_attr_get_focus_level_range(camera_h camera, int *min, int *max);
3706 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
3711 * @brief Retrieves all supported white balances by invoking the callback function once for each supported white balance.
3713 * @param[in] camera The handle to the camera
3714 * @param[in] callback The callback function to be invoked
3715 * @param[in] user_data The user data to be passed to the callback function
3716 * @return @c 0 on success, otherwise a negative error value
3717 * @retval #CAMERA_ERROR_NONE Successful
3718 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3719 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3720 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3721 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3722 * @post This function invokes camera_attr_supported_whitebalance_cb() to get all the supported white balances.
3723 * @see camera_attr_set_whitebalance()
3724 * @see camera_attr_get_whitebalance()
3725 * @see camera_attr_supported_whitebalance_cb()
3727 int camera_attr_foreach_supported_whitebalance(camera_h camera, camera_attr_supported_whitebalance_cb callback, void *user_data);
3734 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
3739 * @brief Sets the camera effect mode.
3741 * @param[in] camera The handle to the camera
3742 * @param[in] effect The camera effect mode
3743 * @return @c 0 on success, otherwise a negative error value
3744 * @retval #CAMERA_ERROR_NONE Successful
3745 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3746 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3747 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3748 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
3749 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3750 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
3751 * @see camera_attr_foreach_supported_effect()
3752 * @see camera_attr_get_effect()
3754 int camera_attr_set_effect(camera_h camera, camera_attr_effect_mode_e effect);
3758 * @brief Gets the camera effect mode.
3760 * @param[in] camera The handle to the camera
3761 * @param[out] effect The camera effect mode
3762 * @return @c 0 on success, otherwise a negative error value
3763 * @retval #CAMERA_ERROR_NONE Successful
3764 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3765 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3766 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3767 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3768 * @see camera_attr_foreach_supported_effect()
3769 * @see camera_attr_set_effect()
3771 int camera_attr_get_effect(camera_h camera, camera_attr_effect_mode_e *effect);
3778 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
3783 * @brief Retrieves all supported effect modes by invoking the callback function once for each supported effect mode.
3785 * @param[in] camera The handle to the camera
3786 * @param[in] callback The callback function to be invoked
3787 * @param[in] user_data The user data to be passed to the callback function
3788 * @return @c 0 on success, otherwise a negative error value
3789 * @retval #CAMERA_ERROR_NONE Successful
3790 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3791 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3792 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3793 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3794 * @post This function invokes camera_attr_supported_effect_cb() to get all the supported effect modes.
3795 * @see camera_attr_set_effect()
3796 * @see camera_attr_get_effect()
3797 * @see camera_attr_supported_effect_cb()
3799 int camera_attr_foreach_supported_effect(camera_h camera, camera_attr_supported_effect_cb callback, void *user_data);
3806 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
3811 * @brief Sets the scene mode.
3813 * @param[in] camera The handle to the camera
3814 * @param[in] mode The scene mode
3815 * @return @c 0 on success, otherwise a negative error value
3816 * @retval #CAMERA_ERROR_NONE Successful
3817 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3818 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3819 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3820 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
3821 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3822 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
3823 * @see camera_attr_foreach_supported_scene_mode()
3824 * @see camera_attr_get_scene_mode()
3826 int camera_attr_set_scene_mode(camera_h camera, camera_attr_scene_mode_e mode);
3829 * @brief Gets the scene mode.
3831 * @param[in] camera The handle to the camera
3832 * @param[out] mode The scene mode
3833 * @return @c 0 on success, otherwise a negative error value
3834 * @retval #CAMERA_ERROR_NONE Successful
3835 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3836 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3837 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3838 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3839 * @see camera_attr_foreach_supported_scene_mode()
3840 * @see camera_attr_set_scene_mode()
3842 int camera_attr_get_scene_mode(camera_h camera, camera_attr_scene_mode_e *mode);
3849 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
3854 * @brief Retrieves all supported scene modes by invoking the callback function once for each supported scene mode.
3856 * @param[in] camera The handle to the camera
3857 * @param[in] callback The callback function to be invoked
3858 * @param[in] user_data The user data to be passed to the callback function
3859 * @return @c 0 on success, otherwise a negative error value
3860 * @retval #CAMERA_ERROR_NONE Successful
3861 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3862 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3863 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3864 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3865 * @post This function invokes camera_attr_supported_scene_mode_cb() to get all the supported scene modes.
3866 * @see camera_attr_set_scene_mode()
3867 * @see camera_attr_get_scene_mode()
3868 * @see camera_attr_supported_scene_mode_cb()
3870 int camera_attr_foreach_supported_scene_mode(camera_h camera, camera_attr_supported_scene_mode_cb callback, void *user_data);
3877 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
3882 * @brief Enables to write EXIF (Exchangeable image file format) tags in a JPEG file.
3884 * @param[in] camera The handle to the camera
3885 * @param[in] enable If @c true writing EXIF tags in a JPEG file is enabled, otherwise @c false
3886 * @return @c 0 on success, otherwise a negative error value
3887 * @retval #CAMERA_ERROR_NONE Successful
3888 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3889 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3890 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3891 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3892 * @see camera_attr_is_enabled_tag()
3894 int camera_attr_enable_tag(camera_h camera, bool enable);
3897 * @brief Gets the value that indicates whether writing EXIF (Exchangeable image file format) tags in a JPEG file is enabled.
3899 * @param[in] camera The handle to the camera
3900 * @param[out] enabled If @c true camera information is enabled, otherwise @c false
3901 * @return @c 0 on success, otherwise a negative error value
3902 * @retval #CAMERA_ERROR_NONE Successful
3903 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3904 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3905 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3906 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3907 * @see camera_attr_enable_tag()
3909 int camera_attr_is_enabled_tag(camera_h camera, bool *enabled);
3912 * @brief Sets the camera image description in the EXIF (Exchangeable image file format) tag.
3914 * @param[in] camera The handle to the camera
3915 * @param[in] description The string with description
3916 * @return @c 0 on success, otherwise a negative error value
3917 * @retval #CAMERA_ERROR_NONE Successful
3918 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3919 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3920 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3921 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3922 * @see camera_attr_get_tag_image_description()
3924 int camera_attr_set_tag_image_description(camera_h camera, const char *description);
3927 * @brief Gets the camera image description in EXIF (Exchangeable image file format) tag.
3929 * @remarks You must release @a description using free().
3930 * @param[in] camera The handle to the camera
3931 * @param[out] description A pointer to a string
3932 * @return @c 0 on success, otherwise a negative error value
3933 * @retval #CAMERA_ERROR_NONE Successful
3934 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3935 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3936 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3937 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3938 * @see camera_attr_set_tag_image_description()
3940 int camera_attr_get_tag_image_description(camera_h camera, char **description);
3943 * @brief Sets the camera orientation in the EXIF (Exchangeable image file format) tag.
3945 * @param[in] camera The handle to the camera
3946 * @param[in] orientation The camera orientation
3947 * @return @c 0 on success, otherwise a negative error value
3948 * @retval #CAMERA_ERROR_NONE Successful
3949 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3950 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3951 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3952 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3953 * @see camera_attr_get_tag_orientation()
3955 int camera_attr_set_tag_orientation(camera_h camera, camera_attr_tag_orientation_e orientation);
3958 * @brief Gets the camera orientation in the EXIF (Exchangeable image file format) tag.
3960 * @param[in] camera The handle to the camera
3961 * @param[out] orientation The camera orientation
3962 * @return @c 0 on success, otherwise a negative error value
3963 * @retval #CAMERA_ERROR_NONE Successful
3964 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3965 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3966 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3967 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3968 * @see camera_attr_set_tag_orientation()
3970 int camera_attr_get_tag_orientation(camera_h camera, camera_attr_tag_orientation_e *orientation);
3973 * @brief Sets the software information in the EXIF (Exchangeable image file format) tag.
3975 * @param[in] camera The handle to the camera
3976 * @param[in] software The software information tag
3977 * @return @c 0 on success, otherwise a negative error value
3978 * @retval #CAMERA_ERROR_NONE Successful
3979 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3980 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3981 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3982 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3983 * @see camera_attr_get_tag_software()
3985 int camera_attr_set_tag_software(camera_h camera, const char *software);
3988 * @brief Gets the software information in the EXIF (Exchangeable image file format) tag.
3990 * @remarks You must release @a software using free().
3991 * @param[in] camera The handle to the camera
3992 * @param[out] software A pointer to a string
3993 * @return @c 0 on success, otherwise a negative error value
3994 * @retval #CAMERA_ERROR_NONE Successful
3995 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
3996 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
3997 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
3998 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
3999 * @see camera_attr_set_tag_software()
4001 int camera_attr_get_tag_software(camera_h camera, char **software);
4004 * @brief Sets the geotag (GPS data) in the EXIF (Exchangeable image file format) tag.
4006 * @param[in] camera The handle to the camera
4007 * @param[in] latitude The latitude data
4008 * @param[in] longitude The longitude data
4009 * @param[in] altitude The altitude data
4010 * @return @c 0 on success, otherwise a negative error value
4011 * @retval #CAMERA_ERROR_NONE Successful
4012 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4013 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4014 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4015 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
4016 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4017 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
4018 * @see camera_attr_get_geotag()
4019 * @see camera_attr_remove_geotag()
4021 int camera_attr_set_geotag(camera_h camera, double latitude, double longitude, double altitude);
4024 * @brief Gets the geotag (GPS data) in the EXIF (Exchangeable image file format) tag.
4026 * @param[in] camera The handle to the camera
4027 * @param[out] latitude The latitude data
4028 * @param[out] longitude The longitude data
4029 * @param[out] altitude The altitude data
4030 * @return @c 0 on success, otherwise a negative error value
4031 * @retval #CAMERA_ERROR_NONE Successful
4032 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4033 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4034 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4035 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4036 * @see camera_attr_set_geotag()
4037 * @see camera_attr_remove_geotag()
4039 int camera_attr_get_geotag(camera_h camera, double *latitude, double *longitude, double *altitude);
4042 * @brief Removes the geotag (GPS data) in the EXIF (Exchangeable image file format) tag.
4044 * @param[in] camera The handle to the camera
4045 * @return @c 0 on success, otherwise a negative error value
4046 * @retval #CAMERA_ERROR_NONE Successful
4047 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4048 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4049 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4050 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
4051 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4052 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
4053 * @see camera_attr_set_geotag()
4054 * @see camera_attr_get_geotag()
4056 int camera_attr_remove_geotag(camera_h camera);
4059 * @brief Sets the camera's flash mode.
4061 * @remarks Since 2.4, while setting the flash mode, if the flash was preempted by other APIs,\n
4062 * then this function returns #CAMERA_ERROR_DEVICE_BUSY error.
4063 * @param[in] camera The handle to the camera
4064 * @param[in] mode The flash mode
4065 * @return @c 0 on success, otherwise a negative error value
4066 * @retval #CAMERA_ERROR_NONE Successful
4067 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4068 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4069 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4070 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
4071 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4072 * @retval #CAMERA_ERROR_DEVICE_BUSY The flash was preempted by other API
4073 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
4074 * @see camera_attr_foreach_supported_flash_mode()
4075 * @see camera_attr_get_flash_mode()
4077 int camera_attr_set_flash_mode(camera_h camera, camera_attr_flash_mode_e mode);
4080 * @brief Gets the camera's flash mode.
4082 * @param[in] camera The handle to the camera
4083 * @param[out] mode The flash mode
4084 * @return @c 0 on success, otherwise a negative error value
4085 * @retval #CAMERA_ERROR_NONE Successful
4086 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4087 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4088 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4089 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4090 * @see camera_attr_foreach_supported_flash_mode()
4091 * @see camera_attr_set_flash_mode()
4093 int camera_attr_get_flash_mode(camera_h camera, camera_attr_flash_mode_e *mode);
4100 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
4105 * @brief Retrieves all supported flash modes by invoking the callback function once for each supported flash mode.
4107 * @param[in] camera The handle to the camera
4108 * @param[in] callback The callback function to be invoked
4109 * @param[in] user_data The user data passed to the callback registration function
4110 * @return @c 0 on success, otherwise a negative error value
4111 * @retval #CAMERA_ERROR_NONE Successful
4112 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4113 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4114 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4115 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4116 * @post This function invokes camera_attr_supported_flash_mode_cb() to get all supported flash modes.
4117 * @see camera_attr_set_flash_mode()
4118 * @see camera_attr_get_flash_mode()
4119 * @see camera_attr_supported_flash_mode_cb()
4121 int camera_attr_foreach_supported_flash_mode(camera_h camera, camera_attr_supported_flash_mode_cb callback, void *user_data);
4128 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
4133 * @brief Gets the camera len's orientation angle.
4135 * @param[in] camera The handle to the camera
4136 * @param[out] angle The orientation angle
4137 * @return @c 0 on success, otherwise a negative error value
4138 * @retval #CAMERA_ERROR_NONE Successful
4139 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4140 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4141 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4142 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4143 * @see camera_set_display_rotation()
4145 int camera_attr_get_lens_orientation(camera_h camera, int *angle);
4148 * @brief Sets the stream rotation.
4150 * @param[in] camera The handle to the camera
4151 * @param[in] rotation The stream rotation
4152 * @return @c 0 on success, otherwise a negative error value
4153 * @retval #CAMERA_ERROR_NONE Successful
4154 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4155 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4156 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4157 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4158 * @pre The camera state must be set to #CAMERA_STATE_CREATED.
4159 * @see camera_attr_get_stream_rotation()
4161 int camera_attr_set_stream_rotation(camera_h camera, camera_rotation_e rotation);
4164 * @brief Gets the stream rotation.
4166 * @param[in] camera The handle to the camera
4167 * @param[out] rotation The stream rotation
4168 * @return @c 0 on success, otherwise a negative error value
4169 * @retval #CAMERA_ERROR_NONE Successful
4170 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4171 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4172 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4173 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4174 * @pre The camera state must be set to #CAMERA_STATE_CREATED.
4175 * @see camera_attr_set_stream_rotation()
4177 int camera_attr_get_stream_rotation(camera_h camera, camera_rotation_e *rotation);
4184 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
4189 * @brief Retrieves all supported stream rotation modes by invoking callback function once for each supported stream rotation mode.
4191 * @param[in] camera The handle to the camera
4192 * @param[in] callback The callback function to be invoked
4193 * @param[in] user_data The user data to be passed to the callback function
4194 * @return @c 0 on success, otherwise a negative error value
4195 * @retval #CAMERA_ERROR_NONE Successful
4196 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4197 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4198 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4199 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4200 * @post This function invokes camera_attr_supported_stream_rotation_cb() to get all supported stream rotation mode.
4201 * @see camera_attr_set_stream_rotation()
4202 * @see camera_attr_get_stream_rotation()
4203 * @see camera_attr_supported_stream_rotation_cb()
4205 int camera_attr_foreach_supported_stream_rotation(camera_h camera, camera_attr_supported_stream_rotation_cb callback, void *user_data);
4212 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
4217 * @brief Sets the stream flip.
4219 * @param[in] camera The handle to the camera
4220 * @param[in] flip The stream flip
4221 * @return @c 0 on success, otherwise a negative error value
4222 * @retval #CAMERA_ERROR_NONE Successful
4223 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4224 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4225 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4226 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
4227 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4228 * @pre The camera state must be set to #CAMERA_STATE_CREATED.
4229 * @see camera_attr_set_stream_rotation()
4231 int camera_attr_set_stream_flip(camera_h camera, camera_flip_e flip);
4234 * @brief Gets the stream flip.
4236 * @param[in] camera The handle to the camera
4237 * @param[out] flip The stream flip
4238 * @return @c 0 on success, otherwise a negative error value
4239 * @retval #CAMERA_ERROR_NONE Successful
4240 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4241 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4242 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4243 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4244 * @pre The camera state must be set to #CAMERA_STATE_CREATED.
4245 * @see camera_attr_set_stream_rotation()
4247 int camera_attr_get_stream_flip(camera_h camera, camera_flip_e *flip);
4254 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
4259 * @brief Retrieves all supported stream flip modes by invoking callback function once for each supported stream flip mode.
4261 * @param[in] camera The handle to the camera
4262 * @param[in] callback The callback function to be invoked
4263 * @param[in] user_data The user data to be passed to the callback function
4264 * @return @c 0 on success, otherwise a negative error value
4265 * @retval #CAMERA_ERROR_NONE Successful
4266 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4267 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4268 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4269 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4270 * @post This function invokes camera_attr_supported_stream_flip_cb() to get all supported stream flip mode.
4271 * @see camera_attr_set_stream_flip()
4272 * @see camera_attr_get_stream_flip()
4273 * @see camera_attr_supported_stream_flip_cb()
4275 int camera_attr_foreach_supported_stream_flip(camera_h camera, camera_attr_supported_stream_flip_cb callback, void *user_data);
4282 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
4287 * @brief Invoked when the HDR capture process is updated.
4289 * @param[in] percent The progress percentage of HDR capture
4290 * @param[in] user_data The user data passed from the callback registration function
4291 * @pre camera_start_capture() will invoke this callback if you set it using camera_attr_set_hdr_capture_progress_cb().
4292 * @see camera_attr_get_hdr_mode()
4293 * @see camera_attr_set_hdr_capture_progress_cb()
4294 * @see camera_attr_unset_hdr_capture_progress_cb()
4295 * @see camera_attr_is_supported_hdr_capture()
4297 typedef void (*camera_attr_hdr_progress_cb)(int percent, void *user_data);
4300 * @brief Sets the mode of HDR (High Dynamic Range) capture.
4302 * @remarks Taking multiple pictures at different exposure levels and intelligently stitching them together so that we eventually arrive at a picture that is representative in both dark and bright areas.\n
4303 * If this attribute is set to @c true. camera_attr_hdr_progress_cb() is invoked during capture.\n
4304 * If you set #CAMERA_ATTR_HDR_MODE_KEEP_ORIGINAL, the capturing callback is invoked twice. The first callback is delivering origin image data. The second callback is delivering improved image data.
4305 * @param[in] camera The handle to the camera
4306 * @param[in] mode The mode of HDR capture
4307 * @return @c 0 on success, otherwise a negative error value
4308 * @retval #CAMERA_ERROR_NONE Successful
4309 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4310 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4311 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4312 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
4313 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4314 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
4315 * @see camera_attr_get_hdr_mode()
4316 * @see camera_attr_set_hdr_capture_progress_cb()
4317 * @see camera_attr_unset_hdr_capture_progress_cb()
4318 * @see camera_attr_is_supported_hdr_capture()
4321 int camera_attr_set_hdr_mode(camera_h camera, camera_attr_hdr_mode_e mode);
4324 * @brief Gets the mode of HDR (High Dynamic Range) capture.
4326 * @param[in] camera The handle to the camera
4327 * @param[out] mode The mode of HDR capture
4328 * @return @c 0 on success, otherwise a negative error value
4329 * @retval #CAMERA_ERROR_NONE Successful
4330 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4331 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4332 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4333 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4334 * @see camera_attr_set_hdr_mode()
4335 * @see camera_attr_set_hdr_capture_progress_cb()
4336 * @see camera_attr_unset_hdr_capture_progress_cb()
4337 * @see camera_attr_is_supported_hdr_capture()
4339 int camera_attr_get_hdr_mode(camera_h camera, camera_attr_hdr_mode_e *mode);
4342 * @brief Sets a callback function to be invoked when HDR capture is progressing.
4344 * @remarks This callback notifies progress of the HDR process.
4345 * @param[in] camera The handle to the camera
4346 * @param[in] callback The callback function to be invoked
4347 * @param[in] user_data The user data passed to the callback registration function
4348 * @return @c 0 on success, otherwise a negative error value
4349 * @retval #CAMERA_ERROR_NONE Successful
4350 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4351 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4352 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4353 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4354 * @see camera_attr_set_hdr_mode()
4355 * @see camera_attr_get_hdr_mode()
4356 * @see camera_attr_unset_hdr_capture_progress_cb()
4357 * @see camera_attr_is_supported_hdr_capture()
4359 int camera_attr_set_hdr_capture_progress_cb(camera_h camera, camera_attr_hdr_progress_cb callback, void* user_data);
4362 * @brief Unsets the HDR capture progress callback function.
4364 * @param[in] camera The handle to the camera
4365 * @return @c 0 on success, otherwise a negative error value
4366 * @retval #CAMERA_ERROR_NONE Successful
4367 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4368 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4369 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4370 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4371 * @see camera_attr_set_hdr_mode()
4372 * @see camera_attr_get_hdr_mode()
4373 * @see camera_attr_set_hdr_capture_progress_cb()
4374 * @see camera_attr_is_supported_hdr_capture()
4376 int camera_attr_unset_hdr_capture_progress_cb(camera_h camera);
4379 * @ingroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
4380 * @brief Gets the support state of HDR capture.
4382 * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
4383 * @param[in] camera The handle to the camera
4384 * @return @c true if supported, otherwise @c false
4385 * @exception #CAMERA_ERROR_NONE Successful
4386 * @exception #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4387 * @exception #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4388 * @exception #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4389 * @see camera_attr_set_hdr_mode()
4390 * @see camera_attr_get_hdr_mode()
4391 * @see camera_attr_set_hdr_capture_progress_cb()
4392 * @see camera_attr_unset_hdr_capture_progress_cb()
4394 bool camera_attr_is_supported_hdr_capture(camera_h camera);
4397 * @brief Enables/Disables the anti-shake feature.
4399 * @remarks This feature is used for image capture.
4400 * @param[in] camera The handle to the camera
4401 * @param[in] enable If @c true the anti-shake feature is enabled, otherwise @c false
4402 * @return @c 0 on success, otherwise a negative error value
4403 * @retval #CAMERA_ERROR_NONE Successful
4404 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4405 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4406 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4407 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4408 * @see camera_attr_is_enabled_anti_shake()
4409 * @see camera_attr_is_supported_anti_shake()
4412 int camera_attr_enable_anti_shake(camera_h camera, bool enable);
4415 * @brief Gets the state of the anti-shake feature.
4417 * @param[in] camera The handle to the camera
4418 * @param[out] enabled The state of anti-shake
4419 * @return @c 0 on success, otherwise a negative error value
4420 * @retval #CAMERA_ERROR_NONE Successful
4421 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4422 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4423 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4424 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4425 * @see camera_attr_enable_anti_shake()
4426 * @see camera_attr_is_supported_anti_shake()
4428 int camera_attr_is_enabled_anti_shake(camera_h camera, bool *enabled);
4431 * @ingroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
4432 * @brief Gets the support state of the anti-shake feature.
4434 * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
4435 * @param[in] camera The handle to the camera
4436 * @return @c true if supported, otherwise @c false
4437 * @exception #CAMERA_ERROR_NONE Successful
4438 * @exception #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4439 * @exception #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4440 * @exception #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4441 * @see camera_attr_enable_anti_shake()
4442 * @see camera_attr_is_enabled_anti_shake()
4444 bool camera_attr_is_supported_anti_shake(camera_h camera);
4447 * @brief Enables/Disables the video stabilization feature.
4449 * @remarks If video stabilization is enabled, zero shutter lag is disabled.\n
4450 * This feature is used to record a video.
4451 * @param[in] camera The handle to the camera
4452 * @param[in] enable If @c true video stabilization is enabled, otherwise @c false
4453 * @return @c 0 on success, otherwise a negative error value
4454 * @retval #CAMERA_ERROR_NONE Successful
4455 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4456 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4457 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4458 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4459 * @see camera_attr_is_enabled_video_stabilization()
4460 * @see camera_attr_is_supported_video_stabilization()
4463 int camera_attr_enable_video_stabilization(camera_h camera, bool enable);
4466 * @brief Gets the state of the video stabilization feature.
4468 * @param[in] camera The handle to the camera
4469 * @param[out] enabled The state of video stabilization
4470 * @return @c 0 on success, otherwise a negative error value
4471 * @retval #CAMERA_ERROR_NONE Successful
4472 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4473 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4474 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4475 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4476 * @see camera_attr_enable_video_stabilization()
4477 * @see camera_attr_is_supported_video_stabilization()
4479 int camera_attr_is_enabled_video_stabilization(camera_h camera, bool *enabled);
4482 * @ingroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
4483 * @brief Gets the support state of the video stabilization feature.
4485 * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
4486 * @param[in] camera The handle to the camera
4487 * @return @c true if supported, otherwise @c false
4488 * @exception #CAMERA_ERROR_NONE Successful
4489 * @exception #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4490 * @exception #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4491 * @exception #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4492 * @see camera_attr_enable_video_stabilization()
4493 * @see camera_attr_is_enabled_video_stabilization()
4495 bool camera_attr_is_supported_video_stabilization(camera_h camera);
4498 * @brief Enables/Disables auto contrast.
4500 * @param[in] camera The handle to the camera
4501 * @param[in] enable If @c true auto contrast is enabled, otherwise @c false
4502 * @return @c 0 on success, otherwise a negative error value
4503 * @retval #CAMERA_ERROR_NONE Successful
4504 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4505 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4506 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4507 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
4508 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4509 * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
4510 * @see camera_attr_is_enabled_auto_contrast()
4512 int camera_attr_enable_auto_contrast(camera_h camera, bool enable);
4515 * @brief Gets the state of auto contrast.
4517 * @param[in] camera The handle to the camera
4518 * @param[out] enabled The state of auto contrast
4519 * @return @c 0 on success, otherwise a negative error value
4520 * @retval #CAMERA_ERROR_NONE Successful
4521 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4522 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4523 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4524 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4525 * @see camera_attr_enable_auto_contrast()
4527 int camera_attr_is_enabled_auto_contrast(camera_h camera, bool *enabled);
4534 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
4539 * @brief Gets state of support of auto contrast feature.
4540 * @ingroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
4542 * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
4543 * @param[in] camera The handle to the camera
4544 * @return true on supported, otherwise false
4545 * @exception #CAMERA_ERROR_NONE Successful
4546 * @exception #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4547 * @exception #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4548 * @exception #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4549 * @see camera_attr_enable_auto_contrast()
4550 * @see camera_attr_is_enabled_auto_contrast()
4552 bool camera_attr_is_supported_auto_contrast(camera_h camera);
4559 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
4564 * @brief Disables shutter sound.
4566 * @remarks In some countries, this operation is not permitted.
4567 * @param[in] camera The handle to the camera
4568 * @param[in] disable If @c true shutter sound is disabled, otherwise @c false
4569 * @return @c 0 on success, otherwise a negative error value
4570 * @retval #CAMERA_ERROR_NONE Successful
4571 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4572 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4573 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4574 * @retval #CAMERA_ERROR_INVALID_OPERATION Disabling shutter sound is not permitted
4575 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4577 int camera_attr_disable_shutter_sound(camera_h camera, bool disable);
4580 * @brief Sets the position to move horizontally.
4582 * @param[in] camera The handle to the camera
4583 * @param[in] move_type The PTZ (Pan Tilt Zoom) move type
4584 * @param[in] pan_step The step to move the camera
4585 * @return @c 0 on success, otherwise a negative error value
4586 * @retval #CAMERA_ERROR_NONE Successful
4587 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4588 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4589 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
4590 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
4591 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4592 * @pre The camera state must be set to #CAMERA_STATE_PREVIEW.
4593 * @see camera_attr_get_pan()
4594 * @see camera_attr_get_pan_range()
4596 int camera_attr_set_pan(camera_h camera, camera_attr_ptz_move_type_e move_type, int pan_step);
4599 * @brief Gets the current horizontal position of the camera.
4601 * @param[in] camera The handle to the camera
4602 * @param[out] pan_step The current horizontal distance from the starting point.
4603 * @return @c 0 on success, otherwise a negative error value
4604 * @retval #CAMERA_ERROR_NONE Successful
4605 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4606 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4607 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
4608 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4609 * @see camera_attr_set_pan()
4610 * @see camera_attr_get_pan_range()
4612 int camera_attr_get_pan(camera_h camera, int *pan_step);
4615 * @brief Gets lower limit and upper limit for pan position.
4617 * @remarks If the min value is greater than the max value, it means that this feature is not supported.
4618 * @param[in] camera The handle to the camera
4619 * @param[out] min The lower limit for pan
4620 * @param[out] max The upper limit for pan
4621 * @return @c 0 on success, otherwise a negative error value
4622 * @retval #CAMERA_ERROR_NONE Successful
4623 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4624 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4625 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
4626 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4627 * @see camera_attr_set_pan()
4628 * @see camera_attr_get_pan()
4630 int camera_attr_get_pan_range(camera_h camera, int *min, int *max);
4633 * @brief Sets the position to move vertically.
4635 * @param[in] camera The handle to the camera
4636 * @param[in] move_type The PTZ (Pan Tilt Zoom) move type
4637 * @param[in] tilt_step The step to move the camera
4638 * @return @c 0 on success, otherwise a negative error value
4639 * @retval #CAMERA_ERROR_NONE Successful
4640 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4641 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4642 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
4643 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
4644 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4645 * @pre The camera state must be set to #CAMERA_STATE_PREVIEW.
4646 * @see camera_attr_get_tilt()
4647 * @see camera_attr_get_tilt_range()
4649 int camera_attr_set_tilt(camera_h camera, camera_attr_ptz_move_type_e move_type, int tilt_step);
4652 * @brief Gets the current vertical position of the camera.
4654 * @param[in] camera The handle to the camera
4655 * @param[out] tilt_step The current vertical distance from the starting point.
4656 * @return @c 0 on success, otherwise a negative error value
4657 * @retval #CAMERA_ERROR_NONE Successful
4658 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4659 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4660 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
4661 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4662 * @see camera_attr_set_tilt()
4663 * @see camera_attr_get_tilt_range()
4665 int camera_attr_get_tilt(camera_h camera, int *tilt_step);
4668 * @brief Gets lower limit and upper limit for tilt position.
4670 * @remarks If the min value is greater than the max value, it means that this feature is not supported.
4671 * @param[in] camera The handle to the camera
4672 * @param[out] min The lower limit for tilt
4673 * @param[out] max The upper limit for tilt
4674 * @return @c 0 on success, otherwise a negative error value
4675 * @retval #CAMERA_ERROR_NONE Successful
4676 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4677 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4678 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
4679 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4680 * @see camera_attr_set_tilt()
4681 * @see camera_attr_get_tilt()
4683 int camera_attr_get_tilt_range(camera_h camera, int *min, int *max);
4686 * @brief Sets the type of PTZ (Pan Tilt Zoom).
4688 * @param[in] camera The handle to the camera
4689 * @param[in] ptz_type PTZ type
4690 * @return @c 0 on success, otherwise a negative error value
4691 * @retval #CAMERA_ERROR_NONE Successful
4692 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4693 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4694 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
4695 * @retval #CAMERA_ERROR_INVALID_STATE Invalid state
4696 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4697 * @pre The camera state must be set to #CAMERA_STATE_PREVIEW.
4698 * @see camera_attr_get_pan()
4699 * @see camera_attr_set_pan()
4700 * @see camera_attr_get_pan_range()
4701 * @see camera_attr_get_tilt()
4702 * @see camera_attr_set_tilt()
4703 * @see camera_attr_get_tilt_range()
4704 * @see camera_attr_foreach_supported_ptz_type()
4706 int camera_attr_set_ptz_type(camera_h camera, camera_attr_ptz_type_e ptz_type);
4713 * @addtogroup CAPI_MEDIA_CAMERA_CAPABILITY_MODULE
4718 * @brief Retrieves all supported PTZ (Pan Tilt Zoom) types by invoking callback function once for each supported ptz type.
4720 * @param[in] camera The handle to the camera
4721 * @param[in] callback The callback function to be invoked
4722 * @param[in] user_data The user data to be passed to the callback function
4723 * @return @c 0 on success, otherwise a negative error value
4724 * @retval #CAMERA_ERROR_NONE Successful
4725 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4726 * @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
4727 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4728 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4729 * @post This function invokes camera_attr_supported_ptz_type_cb() to get all supported ptz type.
4730 * @see camera_attr_set_ptz_type()
4732 int camera_attr_foreach_supported_ptz_type(camera_h camera, camera_attr_supported_ptz_type_cb callback, void *user_data);
4739 * @addtogroup CAPI_MEDIA_CAMERA_ATTRIBUTES_MODULE
4744 * @brief Sets the ROI (Region Of Interest) area of display.
4746 * @remarks If no display is set, no operation is performed and
4747 * the ROI area is valid only in #CAMERA_DISPLAY_MODE_CUSTOM_ROI display mode.
4748 * @remarks The minimum value of width and height are 1.
4749 * @remarks ROI area can be set before setting ROI display mode. (since 4.0)
4750 * @param[in] camera The handle to the camera
4751 * @param[in] x X coordinate of area
4752 * @param[in] y Y coordinate of area
4753 * @param[in] width Width of area
4754 * @param[in] height Height of area
4755 * @return @c 0 on success, otherwise a negative error value
4756 * @retval #CAMERA_ERROR_NONE Successful
4757 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4758 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4759 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
4760 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4761 * @see camera_attr_get_display_roi_area()
4763 int camera_attr_set_display_roi_area(camera_h camera, int x, int y, int width, int height);
4766 * @brief Gets the ROI (Region Of Interest) area of display.
4768 * @param[in] camera The handle to the camera
4769 * @param[out] x X coordinate of area
4770 * @param[out] y Y coordinate of area
4771 * @param[out] width Width of area
4772 * @param[out] height Height of area
4773 * @return @c 0 on success, otherwise a negative error value
4774 * @retval #CAMERA_ERROR_NONE Successful
4775 * @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
4776 * @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
4777 * @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
4778 * @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
4779 * @see camera_attr_set_display_roi_area()
4781 int camera_attr_get_display_roi_area(camera_h camera, int *x, int *y, int *width, int *height);
4790 #endif /* __TIZEN_MULTIMEDIA_CAMERA_H__ */