@{
@par
- This part describes the APIs with repect to Multimedia Camcorder.
+ This part describes the APIs with respect to Multimedia Camcorder.
Camcorder is for recording audio and video from audio and video input devices, capturing
still image from video input device, and audio recording from audio input
device.
@par
Recording state and paused state exists when the mode of camcorder is
video-capture or audio-capture mode. In case of image-capture mode, CAPTURING state will
- exsit.
+ exist.
@par
<div>
</tr>
<tr>
<td>#MMCAM_TAG_LATITUDE</td>
- <td>Latitude of captured postion (GPS information)</td>
+ <td>Latitude of captured position (GPS information)</td>
</tr>
<tr>
<td>#MMCAM_TAG_LONGITUDE</td>
- <td>Longitude of captured postion (GPS information)</td>
+ <td>Longitude of captured position (GPS information)</td>
</tr>
<tr>
<td>#MMCAM_TAG_ALTITUDE</td>
- <td>Altitude of captured postion (GPS information)</td>
+ <td>Altitude of captured position (GPS information)</td>
</tr>
<tr>
<td>#MMCAM_STROBE_CONTROL</td>
#define MMCAM_CAPTURE_HEIGHT "capture-height"
/**
- * Total count of capturing. If you set this, it will caputre multiple time.
+ * Total count of capturing. If you set this, it will capture multiple time.
*/
#define MMCAM_CAPTURE_COUNT "capture-count"
#define MMCAM_TAG_GPS_ENABLE "tag-gps-enable"
/**
- * Latitude of captured postion. GPS information.
+ * Latitude of captured position. GPS information.
*/
#define MMCAM_TAG_LATITUDE "tag-latitude"
/**
- * Longitude of captured postion. GPS information.
+ * Longitude of captured position. GPS information.
*/
#define MMCAM_TAG_LONGITUDE "tag-longitude"
/**
- * Altitude of captured postion. GPS information.
+ * Altitude of captured position. GPS information.
*/
#define MMCAM_TAG_ALTITUDE "tag-altitude"
#define MMCAM_CAMERA_TILT_ELEC "camera-tilt-elec"
/**
- * The type of PTZ(Pan Tilt Zoom). Mechanical or Electonic PTZ.
+ * The type of PTZ(Pan Tilt Zoom). Mechanical or Electronic PTZ.
*/
#define MMCAM_CAMERA_PTZ_TYPE "camera-ptz-type"
#define MMCAM_DISPLAY_REUSE_ELEMENT "display-reuse-element"
/**
- * The GBbus connection from outside
+ * The GDBus connection from outside
*/
#define MMCAM_GDBUS_CONNECTION "gdbus-connection"
/**
* An enumeration for focus state.
- * When 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED' is delievered through 'MMMessageCallback',
+ * When 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED' is delivered through 'MMMessageCallback',
* this enumeration will be set to 'code' of MMMessageParamType.
*/
enum MMCamcorderFocusStateType {
MM_CAMCORDER_FOCUS_STATE_RELEASED = 0, /**< Focus released.*/
- MM_CAMCORDER_FOCUS_STATE_ONGOING, /**< Focus in pregress*/
+ MM_CAMCORDER_FOCUS_STATE_ONGOING, /**< Focus in progress*/
MM_CAMCORDER_FOCUS_STATE_FOCUSED, /**< Focus success*/
MM_CAMCORDER_FOCUS_STATE_FAILED, /**< Focus failed*/
};
MM_CAMCORDER_FULL, /**< full-screen*/
MM_CAMCORDER_CROPPED_FULL, /**< Cropped full-screen*/
MM_CAMCORDER_ORIGIN_OR_LETTER, /**< Origin size or Letter box*/
- MM_CAMCORDER_CUSTOM_ROI, /**< Explicitely described destination ROI*/
+ MM_CAMCORDER_CUSTOM_ROI, /**< Explicitly described destination ROI*/
};
/**
- * Face detect defailed information
+ * Face detect detailed information
*/
typedef struct _MMCamFaceInfo {
int id; /**< id of each face */
* This function creates handle structure and initialize mutex, attributes, gstreamer.
* When this function success, it will return a handle of newly created object.
* A user have to put the handle when he calls every function of mm_camcorder. \n
- * Second argument of this function is the field to decribe pre-setting information of mm_camcorder such as which camera device it will use.
+ * Second argument of this function is the field to describe pre-setting information of mm_camcorder such as which camera device it will use.
* Normally, MM_VIDEO_DEVICE_CAMERA0 is for Main camera(or Mega camera, Back camera),
* and MM_VIDEO_DEVICE_CAMERA1 is for VGA camera (or Front camera). If you want audio recording,
* please set MM_VIDEO_DEVICE_NONE. (No camera device is needed.)
* mm_camcorder_realize:\n
* Allocate resources for camcorder and initialize it.
* This also creates streamer pipeline. So you have to set attributes that are pivotal to create
- * the pipeline before calling this function. This function also takes a roll to manage confliction
+ * the pipeline before calling this function. This function also takes a roll to manage conflict
* between different applications which use camcorder. For example, if you try to use camcorder when
* other application that is more important such as call application, this function will return
* 'MM_ERROR_POLICY_BLOCKED'. On the contrary, if your application that uses camcorder starts to launch
* mm_camcorder_capture_stop:\n
* Stop capturing of still images. (Image mode only)
* This function notifies the end of capturing and launch preview again.
- * Just as mm_camcorder_capture_start(), this funciton stops still image stream and set preview information such as
+ * Just as mm_camcorder_capture_start(), this function stops still image stream and set preview information such as
* resolution, pixel format, and framerate to camera driver. Then it command to start preview.
* If you don't call this, preview will not be displayed even though capturing was finished.
*
* mm_camcorder_set_video_stream_callback:\n
* Set callback for user defined video stream callback function.
* Users can retrieve video frame using registered callback.
- * The callback function holds the same buffer that will be drawed on the display device.
+ * The callback function holds the same buffer that will be drawn on the display device.
* So if an user change the buffer, it will be displayed on the device.
*
* @param[in] camcorder A handle of camcorder.
/**
* mm_camcorder_set_video_capture_callback:\n
* Set callback for user defined video capture callback function. (Image mode only)
- * mm_camcorder deliever captured image through the callback.\n
- * Normally, this function provides main captured image and thumnail image. But depending on the environment,
- * thumnail would not be available. Information related with main captured image and thumnail image is also included
+ * mm_camcorder deliver captured image through the callback.\n
+ * Normally, this function provides main captured image and thumbnail image. But depending on the environment,
+ * thumbnail would not be available. Information related with main captured image and thumbnail image is also included
* in the argument of the callback function.
* For more detail information of callback, please refer 'mm_camcorder_video_capture_callback'.
*
* mm_camcorder_get_state:\n
* Get the current state of camcorder.
* mm_camcorder is working on the base of its state. An user should check the state of mm_camcorder before calling its functions.
- * If the handle is avaiable, user can retrieve the value.
+ * If the handle is available, user can retrieve the value.
*
* @param[in] camcorder A handle of camcorder.
* @param[out] state On return, it contains current state of camcorder.
* mm_camcorder_init_focusing:\n
* Initialize focusing. \n
* This function stops focusing action and adjust the camera lens to initial position.
- * Some camera applciation requires to initialize its lens position after releasing half shutter. In that case,
+ * Some camera application requires to initialize its lens position after releasing half shutter. In that case,
* this should be a good choice. Comparing with mm_camcorder_stop_focusing, this function not only stops focusing,
* but also initialize the lens. Preview image might be out-focused after calling this function.
* @param[in] camcorder A handle of camcorder.
/**
* mm_camcorder_start_focusing:\n
* Start focusing. \n
- * This function command to start focusing opeartion. Because focusing operation depends on mechanic or electric module,
+ * This function command to start focusing operation. Because focusing operation depends on mechanic or electric module,
* it may take small amount of time. (For ex, 500ms ~ 3sec). \n
* This function works asynchronously. When an user call this function, it will return immediately.
* However, focusing operation will continue until it gets results.
* After finishing operation, you can get 'MM_MESSAGE_CAMCORDER_FOCUS_CHANGED' message.
- * 'param.code' of the message structure describes the fucusing was success or not.
+ * 'param.code' of the message structure describes the focusing was success or not.
*
* @param[in] camcorder A handle of camcorder.
* @return This function returns zero(MM_ERROR_NONE) on success, or negative value with error code.\n
void mm_camcorder_emit_signal(MMHandleType camcorder, const char *object_name,
const char *interface_name, const char *signal_name, int value);
-/* check compatability between codec and file format */
+/* check compatibility between codec and file format */
int mm_camcorder_check_codec_fileformat_compatibility(const char *codec_type, int codec, int file_format);
/* external storage state management */
* MMCamcorder Gstreamer Element
*/
typedef struct {
- unsigned int id; /**< Gstreamer piplinem element name */
+ unsigned int id; /**< Gstreamer pipeline element id */
GstElement *gst; /**< Gstreamer element */
} _MMCamcorderGstElement;
/* gdbus */
GDBusConnection *gdbus_conn; /**< gdbus connection */
- _MMCamcorderGDbusCbInfo gdbus_info_sound; /**< Informations for the gbus cb of sound play */
- _MMCamcorderGDbusCbInfo gdbus_info_solo_sound; /**< Informations for the gbus cb of solo sound play */
+ _MMCamcorderGDbusCbInfo gdbus_info_sound; /**< Information for the gdbus cb of sound play */
+ _MMCamcorderGDbusCbInfo gdbus_info_solo_sound; /**< Information for the gdbus cb of solo sound play */
/* DPM(device policy manager) */
device_policy_manager_h dpm_handle; /**< DPM handle */
int _mmcamcorder_cancel(MMHandleType hcamcorder);
/**
- * This function calls after commiting action finished asynchronously.
+ * This function calls after committing action finished asynchronously.
* In this function, remaining process , such as state change, happens.
*
* @param[in] hcamcorder Specifies the camcorder handle
*
* @param[in] hcamcorder Specifies the camcorder handle
* @param[in] callback Specifies the function pointer of callback function
- * @param[in] user_data Specifies the user poiner for passing to callback function
+ * @param[in] user_data Specifies the user pointer for passing to callback function
*
* @return This function returns zero on success, or negative value with error code.
* @remarks typedef bool (*mm_message_callback) (int msg, mm_messageType *param, void *user_param);@n
*
* @param[in] hcamcorder Specifies the camcorder handle
* @param[in] callback Specifies the function pointer of callback function
- * @param[in] user_data Specifies the user poiner for passing to callback function
+ * @param[in] user_data Specifies the user pointer for passing to callback function
*
* @return This function returns zero on success, or negative value with error code.
* @see mmcamcorder_error_type
*
* @param[in] hcamcorder Specifies the camcorder handle
* @param[in] callback Specifies the function pointer of callback function
- * @param[in] user_data Specifies the user poiner for passing to callback function
+ * @param[in] user_data Specifies the user pointer for passing to callback function
*
* @return This function returns zero on success, or negative value with error code.
* @see mmcamcorder_error_type
*
* @param[in] hcamcorder Specifies the camcorder handle
* @param[in] callback Specifies the function pointer of callback function
- * @param[in] user_data Specifies the user poiner for passing to callback function
+ * @param[in] user_data Specifies the user pointer for passing to callback function
*
* @return This function returns zero on success, or negative value with error code.
* @see mmcamcorder_error_type
*
* @param[in] hcamcorder Specifies the camcorder handle
* @param[in] callback Specifies the function pointer of callback function
- * @param[in] user_data Specifies the user poiner for passing to callback function
+ * @param[in] user_data Specifies the user pointer for passing to callback function
*
* @return This function returns zero on success, or negative value with error code.
* @see mmcamcorder_error_type
*
* @param[in] hcamcorder Specifies the camcorder handle
* @param[in] callback Specifies the function pointer of callback function
- * @param[in] user_data Specifies the user poiner for passing to callback function
+ * @param[in] user_data Specifies the user pointer for passing to callback function
*
* @return This function returns zero on success, or negative value with error code.
*/
/**
* This function is callback function of main pipeline.
* Once this function is registered with certain pipeline using gst_bus_add_watch(),
- * this callback will be called every time when there is upcomming message from pipeline.
+ * this callback will be called every time when there is upcoming message from pipeline.
* Basically, this function is used as error handling function, now.
*
* @param[in] bus pointer of buf that called this function.
/**
* This function is callback function of main pipeline.
* Once this function is registered with certain pipeline using gst_bus_set_sync_handler(),
- * this callback will be called every time when there is upcomming message from pipeline.
+ * this callback will be called every time when there is upcoming message from pipeline.
* Basically, this function is used as sync error handling function, now.
*
* @param[in] bus pointer of buf that called this function.
/**
* This function is callback function of encode pipeline.
* Once this function is registered with certain pipeline using gst_bus_set_sync_handler(),
- * this callback will be called every time when there is upcomming message from pipeline.
+ * this callback will be called every time when there is upcoming message from pipeline.
* Basically, this function is used for EOS and error handling now.
*
* @param[in] bus pointer of buf that called this function.
projects / platform / core / multimedia / libmm-camcorder.git / commitdiff