* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef enum {
- CAMERA_DISPLAY_TYPE_OVERLAY = 0, /**< Overlay surface display */
- CAMERA_DISPLAY_TYPE_EVAS, /**< Evas object surface display */
- CAMERA_DISPLAY_TYPE_NONE /**< This disposes off buffers */
+ CAMERA_DISPLAY_TYPE_OVERLAY = 0, /**< Overlay surface display */
+ CAMERA_DISPLAY_TYPE_EVAS, /**< Evas object surface display */
+ CAMERA_DISPLAY_TYPE_NONE /**< This disposes off buffers */
} camera_display_type_e;
/**
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef enum {
- CAMERA_ROTATION_NONE, /**< No rotation */
- CAMERA_ROTATION_90, /**< 90 degree rotation */
- CAMERA_ROTATION_180, /**< 180 degree rotation */
- CAMERA_ROTATION_270, /**< 270 degree rotation */
+ CAMERA_ROTATION_NONE, /**< No rotation */
+ CAMERA_ROTATION_90, /**< 90 degree rotation */
+ CAMERA_ROTATION_180, /**< 180 degree rotation */
+ CAMERA_ROTATION_270, /**< 270 degree rotation */
} camera_rotation_e;
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef enum {
- CAMERA_FLIP_NONE, /**< No Flip */
- CAMERA_FLIP_HORIZONTAL, /**< Horizontal flip */
- CAMERA_FLIP_VERTICAL, /**< Vertical flip */
- CAMERA_FLIP_BOTH /**< Horizontal and vertical flip */
+ CAMERA_FLIP_NONE, /**< No Flip */
+ CAMERA_FLIP_HORIZONTAL, /**< Horizontal flip */
+ CAMERA_FLIP_VERTICAL, /**< Vertical flip */
+ CAMERA_FLIP_BOTH /**< Horizontal and vertical flip */
} camera_flip_e;
/**
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef struct {
- unsigned char *data; /**< The image buffer */
- unsigned int size; /**< The size of the buffer */
- int width; /**< The width of the image */
- int height; /**< The height of the image */
- camera_pixel_format_e format; /**< The format of the image pixel */
- unsigned char *exif; /**< The exif raw data */
- unsigned int exif_size; /**< The size of the exif data */
+ unsigned char *data; /**< The image buffer */
+ unsigned int size; /**< The size of the buffer */
+ int width; /**< The width of the image */
+ int height; /**< The height of the image */
+ camera_pixel_format_e format; /**< The format of the image pixel */
+ unsigned char *exif; /**< The exif raw data */
+ unsigned int exif_size; /**< The size of the exif data */
} camera_image_data_s;
/**
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef struct {
- int id; /**< The ID of each face */
- int score; /**< The confidence level for the detection of the face */
- int x; /**< The x coordinates of the face */
- int y; /**< The y coordinates of the face */
- int width; /**< The width of the face */
- int height; /**< The height of the face */
+ int id; /**< The ID of each face */
+ int score; /**< The confidence level for the detection of the face */
+ int x; /**< The x coordinates of the face */
+ int y; /**< The y coordinates of the face */
+ int width; /**< The width of the face */
+ int height; /**< The height of the face */
} camera_detected_face_s;
/**
/**
* @brief Called when the camera state is changed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] previous The previous state of the camera
- * @param[in] current The current state of the camera
+ * @param[in] previous The previous state of the camera
+ * @param[in] current The current state of the camera
* @param[in] by_policy If @c true the state is changed by policy, otherwise @c false
* @param[in] user_data The user data passed from the callback registration function
* @pre camera_start_preview(), camera_start_capture() or camera_stop_preview()
/**
* @brief Called when the camera device state is changed.
* @since_tizen 3.0
- * @param[in] device The hardware camera type
- * @param[in] state The state of the camera device
+ * @param[in] device The hardware camera type
+ * @param[in] state The state of the camera device
* @param[in] user_data The user data passed from the callback registration function
- * @see camera_add_device_state_changed_cb()
+ * @see camera_add_device_state_changed_cb()
*/
typedef void (*camera_device_state_changed_cb)(camera_device_e device, camera_device_state_e state, void *user_data);
* @brief Called when the camera is interrupted by policy.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks This callback is called after interrupt handling is completed.
- * @param[in] policy The policy that interrupted the camera
- * @param[in] previous The previous state of the camera
- * @param[in] current The current state of the camera
+ * @param[in] policy The policy that interrupted the camera
+ * @param[in] previous The previous state of the camera
+ * @param[in] current The current state of the camera
* @param[in] user_data The user data passed from the callback registration function
- * @see camera_set_interrupted_cb()
+ * @see camera_set_interrupted_cb()
*/
typedef void (*camera_interrupted_cb)(camera_policy_e policy, camera_state_e previous, camera_state_e current, void *user_data);
* @brief Called when the camera interrupt is started by policy.
* @since_tizen 4.0
* @remarks This callback is called before interrupt handling is started.
- * @param[in] policy The policy that is interrupting the camera
- * @param[in] state The current state of the camera
+ * @param[in] policy The policy that is interrupting the camera
+ * @param[in] state The current state of the camera
* @param[in] user_data The user data passed from the callback registration function
* @see camera_set_interrupt_started_cb()
*/
* #CAMERA_FOCUS_STATE_FOCUSED or #CAMERA_FOCUS_STATE_FAILED.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] state The current state of the auto-focus
+ * @param[in] state The current state of the auto-focus
* @param[in] user_data The user data passed from the callback registration function
* @pre camera_start_focusing() will invoke this callback if you register it using camera_set_focus_changed_cb().
- * @see camera_set_focus_changed_cb()
- * @see camera_unset_focus_changed_cb()
- * @see camera_start_focusing()
+ * @see camera_set_focus_changed_cb()
+ * @see camera_unset_focus_changed_cb()
+ * @see camera_start_focusing()
* @see camera_cancel_focusing()
*/
typedef void (*camera_focus_changed_cb)(camera_focus_state_e state, void *user_data);
* If the camera is used as a recorder then this callback function won't be called.
* @remarks The @a frame should not be released and it's available until the callback returns.
*
- * @param[in] frame The reference pointer to preview stream data
+ * @param[in] frame The reference pointer to preview stream data
* @param[in] user_data The user data passed from the callback registration function
- * @pre camera_start_preview() will invoke this callback function if you register this callback using camera_set_preview_cb().
- * @see camera_start_preview()
- * @see camera_set_preview_cb()
- * @see camera_unset_preview_cb()
+ * @pre camera_start_preview() will invoke this callback function if you register this callback using camera_set_preview_cb().
+ * @see camera_start_preview()
+ * @see camera_set_preview_cb()
+ * @see camera_unset_preview_cb()
*/
typedef void (*camera_preview_cb)(camera_preview_data_s *frame, void *user_data);
* If the camera is used as a recorder then this callback function won't be called.\n
* and the packet should be released by media_packet_destroy() after use.
*
- * @param[in] pkt Reference pointer to media packet
+ * @param[in] pkt Reference pointer to media packet
* @param[in] user_data The user data passed from the callback registration function
- * @pre camera_start_preview() will invoke this callback function if you register this callback using camera_set_media_packet_preview_cb().
- * @see camera_start_preview()
- * @see camera_set_media_packet_preview_cb()
- * @see camera_unset_media_packet_preview_cb()
+ * @pre camera_start_preview() will invoke this callback function if you register this callback using camera_set_media_packet_preview_cb().
+ * @see camera_start_preview()
+ * @see camera_set_media_packet_preview_cb()
+ * @see camera_unset_media_packet_preview_cb()
*/
typedef void (*camera_media_packet_preview_cb)(media_packet_h pkt, void *user_data);
* @remarks This function is issued in the context of internal framework so the UI update code should not be directly invoked.
* You must not call camera_start_preview() within this callback.
*
- * @param[in] image The image data of the captured picture
- * @param[in] postview The image data of the postview
+ * @param[in] image The image data of the captured picture
+ * @param[in] postview The image data of the postview
* @param[in] thumbnail The image data of the thumbnail (it should be @c NULL if the available thumbnail data does not exist)
* @param[in] user_data The user data passed from the callback registration function
- * @pre camera_start_capture() or camera_start_continuous_capture() will invoke this callback function if it is registered using camera_start_capture() or camera_start_continuous_capture().
- * @see camera_start_capture()
- * @see camera_start_continuous_capture()
- * @see camera_capture_completed_cb()
+ * @pre camera_start_capture() or camera_start_continuous_capture() will invoke this callback function if it is registered using camera_start_capture() or camera_start_continuous_capture().
+ * @see camera_start_capture()
+ * @see camera_start_continuous_capture()
+ * @see camera_capture_completed_cb()
*/
typedef void (*camera_capturing_cb)(camera_image_data_s *image, camera_image_data_s *postview, camera_image_data_s *thumbnail, void *user_data);
* If you want to show the user a preview after capturing is finished, \n
* an application can use camera_start_preview() after calling this callback.
* @param[in] user_data The user data passed from the callback registration function
- * @pre This callback function is invoked if it is registered using camera_start_capture() or camera_start_continuous_capture().
- * @see camera_start_capture()
- * @see camera_start_continuous_capture()
- * @see camera_capturing_cb()
+ * @pre This callback function is invoked if it is registered using camera_start_capture() or camera_start_continuous_capture().
+ * @see camera_start_capture()
+ * @see camera_start_continuous_capture()
+ * @see camera_capturing_cb()
*/
typedef void (*camera_capture_completed_cb)(void *user_data);
* #CAMERA_ERROR_DEVICE,\n
* #CAMERA_ERROR_INVALID_OPERATION,\n
* #CAMERA_ERROR_OUT_OF_MEMORY.
- * @param[in] error The error code
+ * @param[in] error The error code
* @param[in] current_state The current state of the camera
- * @param[in] user_data The user data passed from the callback registration function
- * @pre This callback function is invoked if it is registered using camera_set_error_cb().
- * @see camera_set_error_cb()
- * @see camera_unset_error_cb()
+ * @param[in] user_data The user data passed from the callback registration function
+ * @pre This callback function is invoked if it is registered using camera_set_error_cb().
+ * @see camera_set_error_cb()
+ * @see camera_unset_error_cb()
*/
typedef void (*camera_error_cb)(camera_error_e error, camera_state_e current_state, void *user_data);
/**
* @brief Called when a face is detected in the preview frame.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] faces The detected face array
- * @param[in] count The length of the array
+ * @param[in] faces The detected face array
+ * @param[in] count The length of the array
* @param[in] user_data The user data passed from the callback registration function
- * @see camera_start_face_detection()
+ * @see camera_start_face_detection()
*/
typedef void (*camera_face_detected_cb)(camera_detected_face_s *faces, int count, void *user_data);
/**
* @brief Called once for each supported preview resolution.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] width The preview image width
- * @param[in] height The preview image height
+ * @param[in] width The preview image width
+ * @param[in] height The preview image height
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
- * @pre camera_foreach_supported_preview_resolution() will invoke this callback.
- * @see camera_foreach_supported_preview_resolution()
+ * @pre camera_foreach_supported_preview_resolution() will invoke this callback.
+ * @see camera_foreach_supported_preview_resolution()
*/
typedef bool (*camera_supported_preview_resolution_cb)(int width, int height, void *user_data);
/**
* @brief Called once for each supported capture resolution.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] width The capture resolution width
- * @param[in] height The capture resolution height
+ * @param[in] width The capture resolution width
+ * @param[in] height The capture resolution height
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
- * @pre camera_foreach_supported_capture_resolution() will invoke this callback.
- * @see camera_foreach_supported_capture_resolution()
+ * @pre camera_foreach_supported_capture_resolution() will invoke this callback.
+ * @see camera_foreach_supported_capture_resolution()
*/
typedef bool (*camera_supported_capture_resolution_cb)(int width, int height, void *user_data);
/**
* @brief Called once for the pixel format of each supported capture format.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] format The supported pixel format
+ * @param[in] format The supported pixel format
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
- * @pre camera_foreach_supported_capture_format() will invoke this callback.
- * @see camera_foreach_supported_capture_format()
+ * @pre camera_foreach_supported_capture_format() will invoke this callback.
+ * @see camera_foreach_supported_capture_format()
*/
typedef bool (*camera_supported_capture_format_cb)(camera_pixel_format_e format, void *user_data);
/**
* @brief Called once for the pixel format of each supported preview format.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] format The supported preview data format
+ * @param[in] format The supported preview data format
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
- * @pre camera_foreach_supported_preview_format() will invoke this callback.
- * @see camera_foreach_supported_preview_format()
+ * @pre camera_foreach_supported_preview_format() will invoke this callback.
+ * @see camera_foreach_supported_preview_format()
*/
typedef bool (*camera_supported_preview_format_cb)(camera_pixel_format_e format, void *user_data);
* A @a camera must be released using camera_destroy().
* @remarks The privilege %http://tizen.org/privilege/camera is not required since 4.0,\n
* but it is required in all earlier versions.
- * @param[in] device The hardware camera to access
+ * @param[in] device The hardware camera to access
* @param[out] camera A newly returned handle to the camera
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @post If it succeeds, the camera state will be #CAMERA_STATE_PREVIEW.\n
* camera_preview_cb() will be called when preview image data becomes available.
*
- * @see camera_stop_preview()
+ * @see camera_stop_preview()
* @see camera_set_display()
* @see camera_set_preview_cb()
* @see camera_set_media_packet_preview_cb()
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @pre The camera state must be set to #CAMERA_STATE_PREVIEW.
* @post The camera state will be #CAMERA_STATE_CREATED.
- * @see camera_start_preview()
- * @see camera_unset_preview_cb()
- * @see camera_unset_media_packet_preview_cb()
+ * @see camera_start_preview()
+ * @see camera_unset_preview_cb()
+ * @see camera_unset_media_packet_preview_cb()
*/
int camera_stop_preview(camera_h camera);
* The captured image will be delivered through camera_capturing_cb().\n
* camera_capture_completed_cb() callback notifies about completion of camera_capturing_cb(). \n
* The camera's preview should be restarted by calling camera_start_preview().
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] capturing_cb The callback for capturing data
* @param[in] completed_cb The callback for notification of completion
- * @param[in] user_data The user data
+ * @param[in] user_data The user data
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* Each Captured image will be delivered through camera_capturing_cb().\n
* The camera_capture_completed_cb() callback notifies about the completion of an entire capture.\n
* The camera's preview should be restarted by calling camera_start_preview().\n.
- * @param[in] camera The handle to the camera
- * @param[in] count The number of still images
- * @param[in] interval The interval of the capture (millisecond)
+ * @param[in] camera The handle to the camera
+ * @param[in] count The number of still images
+ * @param[in] interval The interval of the capture (millisecond)
* @param[in] capturing_cb The callback for capturing data
* @param[in] completed_cb The callback for notification of completion
- * @param[in] user_data The user data
+ * @param[in] user_data The user data
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Gets the state of the camera.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] state The current state of the camera
+ * @param[in] camera The handle to the camera
+ * @param[out] state The current state of the camera
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @privlevel public
* @privilege %http://tizen.org/privilege/camera
* @remarks If continuous status is @c true, the camera continuously tries to focus.
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] continuous The status of continuous focusing
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @pre The camera state must be set to #CAMERA_STATE_PREVIEW.
*
* @see camera_start_focusing()
- * @see camera_focus_changed_cb()
+ * @see camera_focus_changed_cb()
*/
int camera_cancel_focusing(camera_h camera);
* To avoid #CAMERA_ERROR_INVALID_OPERATION in sub thread, ecore_thread_main_loop_begin() and
* ecore_thread_main_loop_end() can be used, but deadlock can occur if the main thread is busy.
* So, it's not recommended to use them. (Since 5.0)
- * @param[in] camera The handle to the camera
- * @param[in] type The display type
+ * @param[in] camera The handle to the camera
+ * @param[in] type The display type
* @param[in] display The display handle from #GET_DISPLAY
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks This function should be called before previewing (camera_start_preview()).
* @param[in] camera The handle to the camera
- * @param[in] width The preview width
+ * @param[in] width The preview width
* @param[in] height The preview height
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
*
* @see camera_start_preview()
- * @see camera_get_preview_resolution()
- * @see camera_foreach_supported_preview_resolution()
+ * @see camera_get_preview_resolution()
+ * @see camera_foreach_supported_preview_resolution()
*/
int camera_set_preview_resolution(camera_h camera, int width, int height);
* @brief Gets the resolution of the preview.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] width The preview width
+ * @param[in] camera The handle to the camera
+ * @param[out] width The preview width
* @param[out] height The preview height
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_set_preview_resolution()
- * @see camera_foreach_supported_preview_resolution()
+ * @see camera_set_preview_resolution()
+ * @see camera_foreach_supported_preview_resolution()
*/
int camera_get_preview_resolution(camera_h camera, int *width, int *height);
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks Depending on the capture resolution aspect ratio and display resolution, the recommended preview resolution is determined.
- * @param[in] camera The handle to the camera
- * @param[out] width The preview width
+ * @param[in] camera The handle to the camera
+ * @param[out] width The preview width
* @param[out] height The preview height
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_set_preview_resolution()
- * @see camera_foreach_supported_preview_resolution()
+ * @see camera_set_preview_resolution()
+ * @see camera_foreach_supported_preview_resolution()
*/
int camera_get_recommended_preview_resolution(camera_h camera, int *width, int *height);
* Internally it starts continuous focus and focusing on the detected face.\n
* 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
* If camera_stop_preview() is invoked, face detection is stopped and then preview is resumed using camera_start_preview(), this method should be called again to resume face detection.
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback to notify face detection
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback to notify face detection
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success, otherwise a negative error value
* @brief Retrieves all supported camera preview resolutions by invoking the callback function once for each supported camera preview resolution.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to be invoked
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to be invoked
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @post This function invokes camera_supported_preview_resolution_cb() repeatedly to retrieve each supported preview resolution.
*
- * @see camera_set_preview_resolution()
- * @see camera_get_preview_resolution()
- * @see camera_supported_preview_resolution_cb()
+ * @see camera_set_preview_resolution()
+ * @see camera_get_preview_resolution()
+ * @see camera_supported_preview_resolution_cb()
*/
int camera_foreach_supported_preview_resolution(camera_h camera, camera_supported_preview_resolution_cb callback, void *user_data);
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks This function should be called before previewing (see camera_start_preview())
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] rotation The display rotation
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @see camera_start_preview()
- * @see camera_get_display_rotation()
+ * @see camera_get_display_rotation()
*/
int camera_set_display_rotation(camera_h camera, camera_rotation_e rotation);
* @brief Gets the display rotation.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] rotation The display rotation
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] camera The handle to the camera
- * @param[in] flip The display flip
+ * @param[in] flip The display flip
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_get_display_flip()
+ * @see camera_get_display_flip()
*/
int camera_set_display_flip(camera_h camera, camera_flip_e flip);
* @brief Gets the display flip.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] flip The display flip
+ * @param[in] camera The handle to the camera
+ * @param[out] flip The display flip
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Sets the visible property for display.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] visible The display visibility property
*
* @return @c 0 on success, otherwise a negative error value
* @brief Gets the visible property of display.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] visible @c true if camera display is visible, otherwise @c false
*
* @return @c 0 on success, otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] camera The handle to the camera
- * @param[in] mode The display mode
+ * @param[in] mode The display mode
*
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @brief Gets the display mode.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] mode The display mode
+ * @param[in] camera The handle to the camera
+ * @param[out] mode The display mode
*
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @since_tizen 3.0
* @remarks If the current display type is #CAMERA_DISPLAY_TYPE_NONE, this function will return #CAMERA_ERROR_INVALID_OPERATION.
* @param[in] camera The handle to the camera
- * @param[in] hint The hint for display reuse; true - reuse the display, false - do not reuse
+ * @param[in] hint The hint for display reuse; true - reuse the display, false - do not reuse
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Gets the hint for display reuse.
* @since_tizen 3.0
* @remarks If the current display type is #CAMERA_DISPLAY_TYPE_NONE, this function will return #CAMERA_ERROR_INVALID_OPERATION.
- * @param[in] camera The handle to the camera
- * @param[out] hint The hint for display reuse; true - reuse the display, false - do not reuse
+ * @param[in] camera The handle to the camera
+ * @param[out] hint The hint for display reuse; true - reuse the display, false - do not reuse
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Sets the resolution of the captured image.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] camera The handle to the camera
- * @param[in] width The capture width
+ * @param[in] width The capture width
* @param[in] height The capture height
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
* @see camera_start_capture()
- * @see camera_get_capture_resolution()
- * @see camera_foreach_supported_capture_resolution()
+ * @see camera_get_capture_resolution()
+ * @see camera_foreach_supported_capture_resolution()
*/
int camera_set_capture_resolution(camera_h camera, int width, int height);
/**
* @brief Gets the resolution of the captured image.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] width The capture width
+ * @param[in] camera The handle to the camera
+ * @param[out] width The capture width
* @param[out] height The capture height
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @brief Retrieves all supported camera captured resolutions by invoking the callback function once for each supported camera capture resolution.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to register
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to register
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @post This function invokes camera_supported_capture_resolution_cb() repeatedly to retrieve each supported capture resolution.
* @see camera_set_capture_resolution()
* @see camera_get_capture_resolution()
- * @see camera_supported_capture_resolution_cb()
+ * @see camera_supported_capture_resolution_cb()
*/
int camera_foreach_supported_capture_resolution(camera_h camera, camera_supported_capture_resolution_cb callback, void *user_data);
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks This function should be called before capturing (see camera_start_capture()).
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] format The format of the image to be captured
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
+ * @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
* @see camera_start_capture()
- * @see camera_get_capture_format()
- * @see camera_foreach_supported_capture_format()
+ * @see camera_get_capture_format()
+ * @see camera_foreach_supported_capture_format()
*/
int camera_set_capture_format(camera_h camera, camera_pixel_format_e format);
* @brief Gets the format of the image to be captured.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] format The format of the image to be captured
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_set_capture_format()
- * @see camera_foreach_supported_capture_format()
+ * @see camera_set_capture_format()
+ * @see camera_foreach_supported_capture_format()
*/
int camera_get_capture_format(camera_h camera, camera_pixel_format_e *format);
* @brief Retrieves all supported camera capture formats by invoking the callback function once for each supported camera capture format.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to be invoked
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to be invoked
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @post This function invokes camera_supported_capture_format_cb() repeatedly to retrieve each supported capture format.
- * @see camera_set_capture_format()
- * @see camera_get_capture_format()
- * @see camera_supported_capture_format_cb()
+ * @see camera_set_capture_format()
+ * @see camera_get_capture_format()
+ * @see camera_supported_capture_format_cb()
*/
int camera_foreach_supported_capture_format(camera_h camera, camera_supported_capture_format_cb callback, void *user_data);
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @pre The camera state must be set to #CAMERA_STATE_CREATED.
* @see camera_start_preview()
- * @see camera_get_preview_format()
- * @see camera_foreach_supported_preview_format()
+ * @see camera_get_preview_format()
+ * @see camera_foreach_supported_preview_format()
*/
int camera_set_preview_format(camera_h camera, camera_pixel_format_e format);
/**
* @brief Gets the format of the preview stream.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] format The preview data format
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_set_preview_format()
- * @see camera_foreach_supported_preview_format()
+ * @see camera_set_preview_format()
+ * @see camera_foreach_supported_preview_format()
*/
int camera_get_preview_format(camera_h camera, camera_pixel_format_e *format);
/**
* @brief Gets the facing direction of camera module.
* @since_tizen 3.0
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] facing_direction The facing direction of camera module
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Gets the camera's flash state.
* @since_tizen 3.0
- * @param[in] device The hardware camera to access
- * @param[out] state The current flash state
+ * @param[in] device The hardware camera to access
+ * @param[out] state The current flash state
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
/**
* @brief Retrieves all supported camera preview formats by invoking the callback function once for each supported camera preview format.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to be invoked
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to be invoked
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @post This function invokes camera_supported_preview_format_cb() repeatedly to retrieve each supported preview format.
- * @see camera_set_preview_format()
- * @see camera_get_preview_format()
- * @see camera_supported_preview_format_cb()
+ * @see camera_set_preview_format()
+ * @see camera_get_preview_format()
+ * @see camera_supported_preview_format_cb()
*/
int camera_foreach_supported_preview_format(camera_h camera, camera_supported_preview_format_cb callback, void *user_data);
* @brief Gets the camera device count.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks If the device supports primary and secondary camera, this returns @c 2. If @c 1 is returned, the device only supports primary camera.
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] device_count The device count
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* it could not be displayed on the device in case of copied buffer.\n
* and if camera_is_supported_media_packet_preview_cb() returns false,\n
* it's copied buffer case.
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to be registered
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to be registered
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @pre Before 4.0 : The camera state must be set to #CAMERA_STATE_CREATED.\n
- * Since 4.0 : The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
- * @see camera_start_preview()
- * @see camera_unset_preview_cb()
- * @see camera_preview_cb()
+ * @pre Before 4.0 : The camera state must be set to #CAMERA_STATE_CREATED.\n
+ * Since 4.0 : The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
+ * @see camera_start_preview()
+ * @see camera_unset_preview_cb()
+ * @see camera_preview_cb()
*/
int camera_set_preview_cb(camera_h camera, camera_preview_cb callback, void *user_data);
* The callback function holds the same buffer that will be drawn on the display device.\n
* So if you change the media packet in a registered callback, it will be displayed on the device\n
* and the media packet is available until it's destroyed by media_packet_destroy().
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to be registered
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to be registered
* @param[in] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @pre The camera's state should be #CAMERA_STATE_CREATED.
- * @see camera_start_preview()
- * @see camera_unset_media_packet_preview_cb()
- * @see camera_media_packet_preview_cb()
+ * @pre The camera's state should be #CAMERA_STATE_CREATED.
+ * @see camera_start_preview()
+ * @see camera_unset_media_packet_preview_cb()
+ * @see camera_media_packet_preview_cb()
*/
int camera_set_media_packet_preview_cb(camera_h camera, camera_media_packet_preview_cb callback, void *user_data);
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_set_media_packet_preview_cb()
+ * @see camera_set_media_packet_preview_cb()
*/
int camera_unset_media_packet_preview_cb(camera_h camera);
/**
* @brief Registers a callback function to be called when the camera state changes.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to register
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @post This function will invoke camera_state_changed_cb() when the camera state changes.
* @see camera_unset_state_changed_cb()
- * @see camera_state_changed_cb()
+ * @see camera_state_changed_cb()
*/
int camera_set_state_changed_cb(camera_h camera, camera_state_changed_cb callback, void *user_data);
/**
* @brief Registers a callback function to be called when the camera is interrupted by policy.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to register
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @see camera_unset_interrupted_cb()
- * @see camera_interrupted_cb()
+ * @see camera_interrupted_cb()
*/
int camera_set_interrupted_cb(camera_h camera, camera_interrupted_cb callback, void *user_data);
/**
* @brief Registers a callback function to be called when the camera interrupt is started by policy.
* @since_tizen 4.0
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to register
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Registers a callback function to be called when the auto-focus state changes.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to register
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to register
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @post This function will invoke camera_focus_changed_cb() when the auto-focus state changes.
- * @see camera_start_focusing()
- * @see camera_cancel_focusing()
- * @see camera_unset_focus_changed_cb()
- * @see camera_focus_changed_cb()
+ * @see camera_start_focusing()
+ * @see camera_cancel_focusing()
+ * @see camera_unset_focus_changed_cb()
+ * @see camera_focus_changed_cb()
*/
int camera_set_focus_changed_cb(camera_h camera, camera_focus_changed_cb callback, void *user_data);
* #CAMERA_ERROR_DEVICE,\n
* #CAMERA_ERROR_INVALID_OPERATION,\n
* #CAMERA_ERROR_OUT_OF_MEMORY.
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to register
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to register
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @post This function will invoke camera_error_cb() when an asynchronous operation error occurs.
* @see camera_unset_error_cb()
- * @see camera_error_cb()
+ * @see camera_error_cb()
*/
int camera_set_error_cb(camera_h camera, camera_error_cb callback, void *user_data);
/**
* @brief Gets the state of camera device.
* @since_tizen 3.0
- * @param[in] device The hardware camera type
- * @param[out] state The current state of the device
+ * @param[in] device The hardware camera type
+ * @param[out] state The current state of the device
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Registers a callback function to be called when the camera device state changes.
* @since_tizen 3.0
- * @param[in] callback The callback function to register
- * @param[in] user_data The user data to be passed to the callback function
- * @param[out] cb_id The id of registered callback
+ * @param[in] callback The callback function to register
+ * @param[in] user_data The user data to be passed to the callback function
+ * @param[out] cb_id The id of registered callback
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Called to get each supported auto-focus mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] mode The supported auto-focus mode
+ * @param[in] mode The supported auto-focus mode
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
- * @pre camera_attr_foreach_supported_af_mode() will invoke this callback.
- * @see camera_attr_foreach_supported_af_mode()
+ * @pre camera_attr_foreach_supported_af_mode() will invoke this callback.
+ * @see camera_attr_foreach_supported_af_mode()
*/
typedef bool (*camera_attr_supported_af_mode_cb)(camera_attr_af_mode_e mode, void *user_data);
/**
* @brief Called to get each supported exposure mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] mode The supported exposure mode
+ * @param[in] mode The supported exposure mode
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
- * @pre camera_attr_foreach_supported_exposure_mode() will invoke this callback.
- * @see camera_attr_foreach_supported_exposure_mode()
- * @see #camera_attr_exposure_mode_e
+ * @pre camera_attr_foreach_supported_exposure_mode() will invoke this callback.
+ * @see camera_attr_foreach_supported_exposure_mode()
+ * @see #camera_attr_exposure_mode_e
*/
typedef bool (*camera_attr_supported_exposure_mode_cb)(camera_attr_exposure_mode_e mode, void *user_data);
/**
* @brief Called to get each supported ISO mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] iso The supported ISO mode
+ * @param[in] iso The supported ISO mode
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
- * @pre camera_attr_foreach_supported_iso() will invoke this callback.
- * @see camera_attr_foreach_supported_iso()
+ * @pre camera_attr_foreach_supported_iso() will invoke this callback.
+ * @see camera_attr_foreach_supported_iso()
*/
typedef bool (*camera_attr_supported_iso_cb)(camera_attr_iso_e iso, void *user_data);
/**
* @brief Called to get each supported white balance.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] wb The supported white balance mode
+ * @param[in] wb The supported white balance mode
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
- * @pre camera_attr_foreach_supported_whitebalance() will invoke this callback.
- * @see camera_attr_foreach_supported_whitebalance()
- * @see #camera_attr_whitebalance_e
+ * @pre camera_attr_foreach_supported_whitebalance() will invoke this callback.
+ * @see camera_attr_foreach_supported_whitebalance()
+ * @see #camera_attr_whitebalance_e
*/
typedef bool (*camera_attr_supported_whitebalance_cb)(camera_attr_whitebalance_e wb, void *user_data);
/**
* @brief Called to get each supported effect mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] effect The supported effect mode
+ * @param[in] effect The supported effect mode
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
- * @pre camera_attr_foreach_supported_effect() will invoke this callback.
- * @see camera_attr_foreach_supported_effect()
+ * @pre camera_attr_foreach_supported_effect() will invoke this callback.
+ * @see camera_attr_foreach_supported_effect()
*/
typedef bool (*camera_attr_supported_effect_cb)(camera_attr_effect_mode_e effect, void *user_data);
/**
* @brief Called to get each supported scene mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] mode The supported scene mode
+ * @param[in] mode The supported scene mode
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
- * @pre camera_attr_foreach_supported_scene_mode() will invoke this callback.
- * @see camera_attr_foreach_supported_scene_mode()
- * @see #camera_attr_scene_mode_e
+ * @pre camera_attr_foreach_supported_scene_mode() will invoke this callback.
+ * @see camera_attr_foreach_supported_scene_mode()
+ * @see #camera_attr_scene_mode_e
*/
typedef bool (*camera_attr_supported_scene_mode_cb)(camera_attr_scene_mode_e mode, void *user_data);
/**
* @brief Called to get each supported flash mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] mode The supported flash mode
+ * @param[in] mode The supported flash mode
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
- * @pre camera_attr_foreach_supported_flash_mode() will invoke this callback.
- * @see camera_attr_foreach_supported_flash_mode()
+ * @pre camera_attr_foreach_supported_flash_mode() will invoke this callback.
+ * @see camera_attr_foreach_supported_flash_mode()
*/
typedef bool (*camera_attr_supported_flash_mode_cb)(camera_attr_flash_mode_e mode, void *user_data);
/**
* @brief Called to get each supported FPS mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] fps The supported FPS mode
+ * @param[in] fps The supported FPS mode
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n otherwise @c false to break out of the loop
- * @pre camera_attr_foreach_supported_fps() will invoke this callback.
- * @see camera_attr_foreach_supported_fps()
+ * @pre camera_attr_foreach_supported_fps() will invoke this callback.
+ * @see camera_attr_foreach_supported_fps()
*/
typedef bool (*camera_attr_supported_fps_cb)(camera_attr_fps_e fps, void *user_data);
/**
* @brief Called to get each supported stream flip mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] flip The supported stream flip mode
+ * @param[in] flip The supported stream flip mode
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
- * @pre camera_attr_foreach_supported_stream_flip() will invoke this callback.
- * @see camera_attr_foreach_supported_stream_flip()
+ * @pre camera_attr_foreach_supported_stream_flip() will invoke this callback.
+ * @see camera_attr_foreach_supported_stream_flip()
*/
typedef bool (*camera_attr_supported_stream_flip_cb)(camera_flip_e flip, void *user_data);
/**
* @brief Called to get each supported stream rotation mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] rotation The supported stream rotation mode
+ * @param[in] rotation The supported stream rotation mode
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
- * @pre camera_attr_foreach_supported_stream_rotation() will invoke this callback.
- * @see camera_attr_foreach_supported_stream_rotation()
+ * @pre camera_attr_foreach_supported_stream_rotation() will invoke this callback.
+ * @see camera_attr_foreach_supported_stream_rotation()
*/
typedef bool (*camera_attr_supported_stream_rotation_cb)(camera_rotation_e rotation, void *user_data);
/**
* @brief Called to get each supported theater mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] mode The supported theater mode
+ * @param[in] mode The supported theater mode
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
- * @pre camera_attr_foreach_supported_theater_mode() will invoke this callback.
- * @see camera_attr_foreach_supported_theater_mode()
+ * @pre camera_attr_foreach_supported_theater_mode() will invoke this callback.
+ * @see camera_attr_foreach_supported_theater_mode()
*/
typedef bool (*camera_attr_supported_theater_mode_cb)(camera_attr_theater_mode_e mode, void *user_data);
/**
* @brief Called to get each supported PTZ (Pan Tilt Zoom) type.
* @since_tizen 3.0
- * @param[in] type The supported ptz type
+ * @param[in] type The supported ptz type
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
- * @pre camera_attr_foreach_supported_ptz_mode() will invoke this callback.
- * @see camera_attr_foreach_supported_ptz_mode()
+ * @pre camera_attr_foreach_supported_ptz_mode() will invoke this callback.
+ * @see camera_attr_foreach_supported_ptz_mode()
*/
typedef bool (*camera_attr_supported_ptz_type_cb)(camera_attr_ptz_type_e type, void *user_data);
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks This function should be called before previewing (see camera_start_preview()).
* @param[in] camera The handle to the camera
- * @param[in] fps The frame rate
+ * @param[in] fps The frame rate
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @pre The camera state must be set to #CAMERA_STATE_CREATED.
* @see camera_start_preview()
- * @see camera_attr_get_preview_fps()
- * @see camera_attr_foreach_supported_fps()
+ * @see camera_attr_get_preview_fps()
+ * @see camera_attr_foreach_supported_fps()
*/
int camera_attr_set_preview_fps(camera_h camera, camera_attr_fps_e fps);
/**
* @brief Gets the frames per second of a preview video stream.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] fps The frames per second of the preview video stream
+ * @param[in] camera The handle to the camera
+ * @param[out] fps The frames per second of the preview video stream
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_attr_set_preview_fps()
- * @see camera_attr_foreach_supported_fps()
+ * @see camera_attr_set_preview_fps()
+ * @see camera_attr_foreach_supported_fps()
*/
int camera_attr_get_preview_fps(camera_h camera, camera_attr_fps_e *fps);
/**
* @brief Retrieves all supported FPS modes by invoking the callback function once for each supported FPS mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to invoke
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @post This function invokes camera_attr_supported_fps_cb() repeatedly to get each supported FPS mode.
- * @see camera_attr_set_preview_fps()
- * @see camera_attr_get_preview_fps()
- * @see camera_attr_supported_fps_cb()
+ * @see camera_attr_set_preview_fps()
+ * @see camera_attr_get_preview_fps()
+ * @see camera_attr_supported_fps_cb()
*/
int camera_attr_foreach_supported_fps(camera_h camera, camera_attr_supported_fps_cb callback, void *user_data);
/**
* @brief Retrieves all supported FPS modes by invoking the callback function once for each supported FPS mode.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @param[in] camera The handle to the camera
- * @param[in] width Required preview resolution's width
- * @param[in] height Required preview resolution's height
- * @param[in] callback The callback function to invoke
+ * @param[in] camera The handle to the camera
+ * @param[in] width Required preview resolution's width
+ * @param[in] height Required preview resolution's height
+ * @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @post This function invokes camera_attr_supported_fps_cb() repeatedly to get each supported FPS mode.
- * @see camera_attr_set_preview_fps()
- * @see camera_attr_get_preview_fps()
- * @see camera_attr_supported_fps_cb()
+ * @see camera_attr_set_preview_fps()
+ * @see camera_attr_get_preview_fps()
+ * @see camera_attr_supported_fps_cb()
*/
int camera_attr_foreach_supported_fps_by_resolution(camera_h camera, int width, int height, camera_attr_supported_fps_cb callback, void *user_data);
* @brief Sets quality of the image.
* @details The range for image quality is 1 to 100. If @a quality is out of range, #CAMERA_ERROR_INVALID_PARAMETER error occurred.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] quality The quality of image (1 ~ 100)
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
* @see camera_start_preview()
- * @see camera_attr_get_image_quality()
+ * @see camera_attr_get_image_quality()
*/
int camera_attr_set_image_quality(camera_h camera, int quality);
/**
* @brief Gets the quality of a still image, which is captured.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] quality The quality of the image(1 ~ 100)
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Gets the bit rate of encoded preview.
* @since_tizen 3.0
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] bitrate The bit rate of encoded preview
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @since_tizen 3.0
* @remarks The recommended range is from 1,000 (1 kbps) to 100,000,000 (100 Mbps). \n
* But, due to codec limitations, it may not apply.
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] bitrate The bit rate of encoded preview
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Gets the GOP (Group Of Pictures) interval of encoded preview.
* @since_tizen 3.0
- * @param[in] camera The handle to the camera
- * @param[out] interval the GOP interval of encoded preview (millisecond)
+ * @param[in] camera The handle to the camera
+ * @param[out] interval The GOP interval of encoded preview (millisecond)
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
* @since_tizen 3.0
* @remarks The recommended range is from 1,000 (1 second) to 600,000 (10 minutes). \n
* But, due to codec limitations, it may not apply.
- * @param[in] camera The handle to the camera
- * @param[in] interval the GOP interval of encoded preview (millisecond)
+ * @param[in] camera The handle to the camera
+ * @param[in] interval The GOP interval of encoded preview (millisecond)
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
* @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.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] camera The handle to the camera
- * @param[in] zoom The zoom level
+ * @param[in] zoom The zoom level
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Gets the zoom level.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] zoom The zoom level
+ * @param[in] camera The handle to the camera
+ * @param[out] zoom The zoom level
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Gets the available zoom level.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks If the min value is greater than the max value, it means that this feature is not supported.
- * @param[in] camera The handle to the camera
- * @param[out] min The minimum zoom level
- * @param[out] max The maximum zoom level
+ * @param[in] camera The handle to the camera
+ * @param[out] min The minimum zoom level
+ * @param[out] max The maximum zoom level
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Sets the auto focus mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] camera The handle to the camera
- * @param[in] mode The auto focus mode
+ * @param[in] mode The auto focus mode
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
- * @see camera_attr_get_af_mode()
- * @see camera_attr_foreach_supported_af_mode()
- * @see #camera_attr_af_mode_e
+ * @see camera_attr_get_af_mode()
+ * @see camera_attr_foreach_supported_af_mode()
+ * @see #camera_attr_af_mode_e
*/
int camera_attr_set_af_mode(camera_h camera, camera_attr_af_mode_e mode);
/**
* @brief Gets the auto focus mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] mode The auto focus mode
+ * @param[in] camera The handle to the camera
+ * @param[out] mode The auto focus mode
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @see camera_attr_foreach_supported_af_mode()
* @see camera_attr_set_af_mode()
- * @see #camera_attr_af_mode_e
+ * @see #camera_attr_af_mode_e
*/
int camera_attr_get_af_mode(camera_h camera, camera_attr_af_mode_e *mode);
* @remarks This API is invalid in the #CAMERA_ATTR_AF_NONE mode.\n
* The coordinates are mapped to preview area.
* @param[in] camera The handle to the camera
- * @param[in] x The x coordinates of the focus area
- * @param[in] y The y coordinates of the focus area
+ * @param[in] x The x coordinates of the focus area
+ * @param[in] y The y coordinates of the focus area
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Retrieves all supported auto focus modes by invoking the callback function once for each supported auto focus mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to invoke
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @post This function invokes camera_attr_supported_af_mode_cb() to get all the supported auto focus modes.
* @see camera_attr_set_af_mode()
* @see camera_attr_get_af_mode()
- * @see camera_attr_supported_af_mode_cb()
+ * @see camera_attr_supported_af_mode_cb()
*/
int camera_attr_foreach_supported_af_mode(camera_h camera, camera_attr_supported_af_mode_cb callback, void *user_data);
* @brief Sets the exposure mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] camera The handle to the camera
- * @param[in] mode The exposure mode
+ * @param[in] mode The exposure mode
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Gets the exposure mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] mode The exposure mode
+ * @param[in] camera The handle to the camera
+ * @param[out] mode The exposure mode
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Retrieves all supported exposure modes by invoking the callback function once for each supported exposure mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to be invoked
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @post This function invokes camera_attr_supported_exposure_mode_cb() to get all the supported exposure modes.
* @see camera_attr_set_exposure_mode()
* @see camera_attr_get_exposure_mode()
- * @see camera_attr_supported_exposure_mode_cb()
+ * @see camera_attr_supported_exposure_mode_cb()
*/
int camera_attr_foreach_supported_exposure_mode(camera_h camera, camera_attr_supported_exposure_mode_cb callback, void *user_data);
* @brief Sets the exposure value.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] camera The handle to the camera
- * @param[in] value The exposure value
+ * @param[in] value The exposure value
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_attr_get_exposure()
+ * @see camera_attr_get_exposure()
*/
int camera_attr_set_exposure(camera_h camera, int value);
/**
* @brief Gets the exposure value.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] value The exposure value
+ * @param[in] camera The handle to the camera
+ * @param[out] value The exposure value
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_attr_set_exposure()
+ * @see camera_attr_set_exposure()
*/
int camera_attr_get_exposure(camera_h camera, int *value);
* @brief Gets the available exposure value.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks If the min value is greater than the max value, it means that this feature is not supported.
- * @param[in] camera The handle to the camera
- * @param[out] min The minimum exposure value
- * @param[out] max The maximum exposure value
+ * @param[in] camera The handle to the camera
+ * @param[out] min The minimum exposure value
+ * @param[out] max The maximum exposure value
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_attr_set_exposure()
+ * @see camera_attr_set_exposure()
*/
int camera_attr_get_exposure_range(camera_h camera, int *min, int *max);
* @brief Sets the ISO level.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] camera The handle to the camera
- * @param[in] iso The ISO level
+ * @param[in] iso The ISO level
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
- * @see camera_attr_get_iso()
+ * @see camera_attr_get_iso()
* @see camera_attr_foreach_supported_iso()
*/
int camera_attr_set_iso(camera_h camera, camera_attr_iso_e iso);
/**
* @brief Gets the ISO level.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] iso The ISO level
+ * @param[in] camera The handle to the camera
+ * @param[out] iso The ISO level
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_attr_set_iso()
+ * @see camera_attr_set_iso()
* @see camera_attr_foreach_supported_iso()
*/
int camera_attr_get_iso(camera_h camera, camera_attr_iso_e *iso);
/**
* @brief Retrieves all supported ISO levels by invoking the callback function once for each supported ISO level.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to be invoked
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to be invoked
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @post This function invokes camera_attr_supported_iso_cb() to get all the supported ISO levels.
- * @see camera_attr_set_iso()
+ * @see camera_attr_set_iso()
* @see camera_attr_get_iso()
- * @see camera_attr_supported_iso_cb()
+ * @see camera_attr_supported_iso_cb()
*/
int camera_attr_foreach_supported_iso(camera_h camera, camera_attr_supported_iso_cb callback, void *user_data);
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks If you want to display the preview image on the external display with the full screen mode, use this function.
* @param[in] camera The handle to the camera
- * @param[in] mode The mode to change
+ * @param[in] mode The theater mode
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @pre This function is valid only when the external display is connected.
- * @see camera_attr_get_theater_mode()
+ * @pre This function is valid only when the external display is connected.
+ * @see camera_attr_get_theater_mode()
*/
int camera_attr_set_theater_mode(camera_h camera, camera_attr_theater_mode_e mode);
/**
* @brief Gets the theater mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] mode Current theater mode
+ * @param[in] camera The handle to the camera
+ * @param[out] mode The theater mode
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_attr_get_theater_mode()
+ * @see camera_attr_get_theater_mode()
*/
int camera_attr_get_theater_mode(camera_h camera, camera_attr_theater_mode_e *mode);
/**
* @brief Retrieves all supported theater modes by invoking callback function once for each supported theater modes.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to be invoked
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @post This function invokes camera_attr_supported_theater_mode_cb() to get all supported theater modes.
* @see camera_attr_set_theater_mode()
* @see camera_attr_get_theater_mode()
- * @see camera_attr_supported_theater_mode_cb()
+ * @see camera_attr_supported_theater_mode_cb()
*/
int camera_attr_foreach_supported_theater_mode(camera_h camera, camera_attr_supported_theater_mode_cb callback, void *user_data);
/**
* @brief Gets the brightness level.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] level The brightness level
+ * @param[in] camera The handle to the camera
+ * @param[out] level The brightness level
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Gets the available brightness level.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks If the min value is greater than the max value, it means that this feature is not supported.
- * @param[in] camera The handle to the camera
- * @param[out] min The minimum brightness level
- * @param[out] max The maximum brightness level
+ * @param[in] camera The handle to the camera
+ * @param[out] min The minimum brightness level
+ * @param[out] max The maximum brightness level
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Sets the contrast level.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] camera The handle to the camera
- * @param[in] level The contrast level
+ * @param[in] level The contrast level
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Gets the contrast level.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] level The contrast level
+ * @param[in] camera The handle to the camera
+ * @param[out] level The contrast level
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Gets the available contrast level.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks If the min value is greater than the max value, it means that this feature is not supported.
- * @param[in] camera The handle to the camera
- * @param[out] min The minimum contrast level
- * @param[out] max The maximum contrast level
+ * @param[in] camera The handle to the camera
+ * @param[out] min The minimum contrast level
+ * @param[out] max The maximum contrast level
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Sets the hue level.
* @since_tizen 5.0
* @param[in] camera The handle to the camera
- * @param[in] level The hue level
+ * @param[in] level The hue level
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Gets the hue level.
* @since_tizen 5.0
- * @param[in] camera The handle to the camera
- * @param[out] level The hue level
+ * @param[in] camera The handle to the camera
+ * @param[out] level The hue level
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Gets the available hue level.
* @since_tizen 5.0
* @remarks If the min value is greater than the max value, it means that this feature is not supported.
- * @param[in] camera The handle to the camera
- * @param[out] min The minimum hue level
- * @param[out] max The maximum hue level
+ * @param[in] camera The handle to the camera
+ * @param[out] min The minimum hue level
+ * @param[out] max The maximum hue level
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Sets the white balance mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] whitebalance The white balance mode
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Gets the white balance mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] whitebalance The white balance mode
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Retrieves all supported white balances by invoking the callback function once for each supported white balance.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to be invoked
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @post This function invokes camera_attr_supported_whitebalance_cb() to get all the supported white balances.
* @see camera_attr_set_whitebalance()
* @see camera_attr_get_whitebalance()
- * @see camera_attr_supported_whitebalance_cb()
+ * @see camera_attr_supported_whitebalance_cb()
*/
int camera_attr_foreach_supported_whitebalance(camera_h camera, camera_attr_supported_whitebalance_cb callback, void *user_data);
/**
* @brief Gets the camera effect mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] effect The camera effect mode
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Retrieves all supported effect modes by invoking the callback function once for each supported effect mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to invoke
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @post This function invokes camera_attr_supported_effect_cb() to get all the supported effect modes.
* @see camera_attr_set_effect()
* @see camera_attr_get_effect()
- * @see camera_attr_supported_effect_cb()
+ * @see camera_attr_supported_effect_cb()
*/
int camera_attr_foreach_supported_effect(camera_h camera, camera_attr_supported_effect_cb callback, void *user_data);
* @brief Sets the scene mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] camera The handle to the camera
- * @param[in] mode The scene mode
+ * @param[in] mode The scene mode
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Gets the scene mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] mode The scene mode
+ * @param[in] camera The handle to the camera
+ * @param[out] mode The scene mode
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_attr_foreach_supported_scene_mode()
+ * @see camera_attr_foreach_supported_scene_mode()
* @see camera_attr_set_scene_mode()
*/
int camera_attr_get_scene_mode(camera_h camera, camera_attr_scene_mode_e *mode);
/**
* @brief Retrieves all supported scene modes by invoking the callback function once for each supported scene mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to invoke
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @post This function invokes camera_attr_supported_scene_mode_cb() to get all the supported scene modes.
- * @see camera_attr_set_scene_mode()
+ * @see camera_attr_set_scene_mode()
* @see camera_attr_get_scene_mode()
* @see camera_attr_supported_scene_mode_cb()
*/
/**
* @brief Gets the value that indicates whether writing EXIF(Exchangeable image file format) tags in a JPEG file is enabled.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] enabled If @c true camera information is enabled, otherwise @c false
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Sets the camera image description in the EXIF(Exchangeable image file format) tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] description The string with description
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @brief Gets the camera image description in EXIF(Exchangeable image file format) tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a description using free().
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] description A pointer to a string
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Sets the camera orientation in the EXIF(Exchangeable image file format) tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] orientation The camera orientation
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_attr_get_tag_orientation()
+ * @see camera_attr_get_tag_orientation()
*/
int camera_attr_set_tag_orientation(camera_h camera, camera_attr_tag_orientation_e orientation);
/**
* @brief Gets the camera orientation in the EXIF(Exchangeable image file format) tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] orientation The camera orientation
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @see camera_attr_set_tag_orientation()
+ * @see camera_attr_set_tag_orientation()
*/
int camera_attr_get_tag_orientation(camera_h camera, camera_attr_tag_orientation_e *orientation);
/**
* @brief Sets the software information in the EXIF(Exchangeable image file format) tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] software The software information tag
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @brief Gets the software information in the EXIF(Exchangeable image file format) tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a software using free().
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] software A pointer to a string
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Sets the geotag(GPS data) in the EXIF(Exchangeable image file format) tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] latitude The latitude data
+ * @param[in] camera The handle to the camera
+ * @param[in] latitude The latitude data
* @param[in] longitude The longitude data
- * @param[in] altitude The altitude data
+ * @param[in] altitude The altitude data
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Gets the geotag(GPS data) in the EXIF(Exchangeable image file format) tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] latitude The latitude data
+ * @param[in] camera The handle to the camera
+ * @param[out] latitude The latitude data
* @param[out] longitude The longitude data
- * @param[out] altitude The altitude data
+ * @param[out] altitude The altitude data
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @remarks Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, while setting the flash mode, if the flash was preempted by other APIs,\n
* then this function returns #CAMERA_ERROR_DEVICE_BUSY error.
* @param[in] camera The handle to the camera
- * @param[in] mode The flash mode
+ * @param[in] mode The flash mode
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @retval #CAMERA_ERROR_DEVICE_BUSY The flash was preempted by other API
* @pre The camera state must be set to #CAMERA_STATE_CREATED or #CAMERA_STATE_PREVIEW.
- * @see camera_attr_foreach_supported_flash_mode()
+ * @see camera_attr_foreach_supported_flash_mode()
* @see camera_attr_get_flash_mode()
*/
int camera_attr_set_flash_mode(camera_h camera, camera_attr_flash_mode_e mode);
/**
* @brief Gets the camera's flash mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] mode The flash mode
+ * @param[in] camera The handle to the camera
+ * @param[out] mode The flash mode
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Retrieves all supported flash modes by invoking the callback function once for each supported flash mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to invoke
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to invoke
* @param[in] user_data The user data passed to the callback registration function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
* @post This function invokes camera_attr_supported_flash_mode_cb() to get all supported flash modes.
- * @see camera_attr_set_flash_mode()
+ * @see camera_attr_set_flash_mode()
* @see camera_attr_get_flash_mode()
- * @see camera_attr_supported_flash_mode_cb()
+ * @see camera_attr_supported_flash_mode_cb()
*/
int camera_attr_foreach_supported_flash_mode(camera_h camera, camera_attr_supported_flash_mode_cb callback, void *user_data);
/**
* @brief Gets the camera len's orientation angle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] angle The orientation angle
+ * @param[in] camera The handle to the camera
+ * @param[out] angle The orientation angle
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Sets the stream rotation.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] rotation The stream rotation
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @pre The camera state must be set to #CAMERA_STATE_CREATED.
+ * @pre The camera state must be set to #CAMERA_STATE_CREATED.
* @see camera_attr_get_stream_rotation()
*/
int camera_attr_set_stream_rotation(camera_h camera, camera_rotation_e rotation);
/**
* @brief Gets the stream rotation.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] rotation The stream rotation
+ * @param[in] camera The handle to the camera
+ * @param[out] rotation The stream rotation
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @pre The camera state must be set to #CAMERA_STATE_CREATED.
+ * @pre The camera state must be set to #CAMERA_STATE_CREATED.
* @see camera_attr_set_stream_rotation()
*/
int camera_attr_get_stream_rotation(camera_h camera, camera_rotation_e *rotation);
/**
* @brief Retrieves all supported stream rotation modes by invoking callback function once for each supported stream rotation mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to invoke
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @brief Sets the stream flip.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] camera The handle to the camera
- * @param[in] flip The stream flip
+ * @param[in] flip The stream flip
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @pre The camera state must be set to #CAMERA_STATE_CREATED.
+ * @pre The camera state must be set to #CAMERA_STATE_CREATED.
* @see camera_attr_set_stream_rotation()
*/
int camera_attr_set_stream_flip(camera_h camera, camera_flip_e flip);
/**
* @brief Gets the stream flip.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] flip The stream flip
+ * @param[in] camera The handle to the camera
+ * @param[out] flip The stream flip
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #CAMERA_ERROR_PERMISSION_DENIED The access to the resources can not be granted
* @retval #CAMERA_ERROR_NOT_SUPPORTED The feature is not supported
* @retval #CAMERA_ERROR_SERVICE_DISCONNECTED The socket to multimedia server is disconnected
- * @pre The camera state must be set to #CAMERA_STATE_CREATED.
+ * @pre The camera state must be set to #CAMERA_STATE_CREATED.
* @see camera_attr_set_stream_rotation()
*/
int camera_attr_get_stream_flip(camera_h camera, camera_flip_e *flip);
/**
* @brief Retrieves all supported stream flip modes by invoking callback function once for each supported stream flip mode.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to invoke
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Called when the HDR capture process is updated.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] percent The progress percentage of HDR capture
+ * @param[in] percent The progress percentage of HDR capture
* @param[in] user_data The user data passed from the callback registration function
* @pre camera_start_capture() will invoke this callback if you register it using camera_attr_set_hdr_capture_progress_cb().
* @see camera_attr_get_hdr_mode()
* If this attribute is set to @c true. camera_attr_hdr_progress_cb() is invoked during capture.\n
* 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.
* @param[in] camera The handle to the camera
- * @param[in] mode The mode of HDR capture
+ * @param[in] mode The mode of HDR capture
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Gets the mode of HDR (High Dynamic Range) capture.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
- * @param[out] mode The mode of HDR capture
+ * @param[in] camera The handle to the camera
+ * @param[out] mode The mode of HDR capture
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Registers a callback function to be called when HDR capture is progressing.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks This callback notifies progress of the HDR process.
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to invoke
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to invoke
* @param[in] user_data The user data passed to the callback registration function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Gets the state of the anti-shake feature.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] enabled The state of anti-shake
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Gets the state of the video stabilization feature.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] enabled The state of video stabilization
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Gets the state of auto contrast.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] enabled The state of auto contrast
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @brief Disables shutter sound.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks In some countries, this operation is not permitted.
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] disable If @c true shutter sound is disabled, otherwise @c false
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Sets the position to move horizontally.
* @since_tizen 3.0
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] move_type The PTZ(Pan Tilt Zoom) move type
- * @param[in] pan_step The step to move the camera
+ * @param[in] pan_step The step to move the camera
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
/**
* @brief Gets the current position of the camera.
* @since_tizen 3.0
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] pan_step The current horizontal distance from the starting point.
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @brief Gets lower limit and upper limit for pan position.
* @since_tizen 3.0
* @remarks If the min value is greater than the max value, it means that this feature is not supported.
- * @param[in] camera The handle to the camera
- * @param[out] min The lower limit for pan
- * @param[out] max The upper limit for pan
+ * @param[in] camera The handle to the camera
+ * @param[out] min The lower limit for pan
+ * @param[out] max The upper limit for pan
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
/**
* @brief Sets the position to move vertically.
* @since_tizen 3.0
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] move_type The PTZ(Pan Tilt Zoom) move type
* @param[in] tilt_step The step to move the camera
* @return @c 0 on success, otherwise a negative error value
/**
* @brief Gets the current position of the camera.
* @since_tizen 3.0
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[out] tilt_step The current vertical distance from the starting point.
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @brief Gets lower limit and upper limit for tilt position.
* @since_tizen 3.0
* @remarks If the min value is greater than the max value, it means that this feature is not supported.
- * @param[in] camera The handle to the camera
- * @param[out] min The lower limit for tilt
- * @param[out] max The upper limit for tilt
+ * @param[in] camera The handle to the camera
+ * @param[out] min The lower limit for tilt
+ * @param[out] max The upper limit for tilt
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @retval #CAMERA_ERROR_INVALID_OPERATION Internal error
/**
* @brief Sets the type of PTZ(Pan Tilt Zoom).
* @since_tizen 3.0
- * @param[in] camera The handle to the camera
+ * @param[in] camera The handle to the camera
* @param[in] ptz_type PTZ type
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Retrieves all supported PTZ(Pan Tilt Zoom) types by invoking callback function once for each supported ptz type.
* @since_tizen 3.0
- * @param[in] camera The handle to the camera
- * @param[in] callback The callback function to invoke
+ * @param[in] camera The handle to the camera
+ * @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
* @remarks The minimum value of width and height are 1.
* @remarks ROI area can be set before setting ROI display mode. (since 4.0)
* @param[in] camera The handle to the camera
- * @param[in] x X coordinate of area
- * @param[in] y Y coordinate of area
- * @param[in] width Width of area
+ * @param[in] x X coordinate of area
+ * @param[in] y Y coordinate of area
+ * @param[in] width Width of area
* @param[in] height Height of area
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful
/**
* @brief Gets the ROI(Region Of Interest) area of display.
* @since_tizen 3.0
- * @param[in] camera The handle to the camera
- * @param[out] x X coordinate of area
- * @param[out] y Y coordinate of area
- * @param[out] width Width of area
+ * @param[in] camera The handle to the camera
+ * @param[out] x X coordinate of area
+ * @param[out] y Y coordinate of area
+ * @param[out] width Width of area
* @param[out] height Height of area
* @return @c 0 on success, otherwise a negative error value
* @retval #CAMERA_ERROR_NONE Successful