{
public:
/**
- * This is the default constructor for this class.
+ * This is the default constructor for this class. @n
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.0
- *
- * @remarks
- * -The object is not fully constructed after this constructor is called. For full construction,
- * the Construct() method must be called right after calling this constructor.
*/
Camera(void);
/**
* This is the destructor for this class. @n
* All allocated resources are deallocated by this method. This method must be called in the same thread
- * where the Construct() method is called.This polymorphic destructor should be overridden if required.
+ * where the Construct() method is called.@n This polymorphic destructor should be overridden if required.
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
* @exception E_SYSTEM A system error has occurred.
* @exception E_DEVICE_BUSY The camera is under use by other application or already used in this application.
* @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @remarks Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, int& value) with CAMERA_COUNT key.
*/
result Construct(ICameraEventListener& listener, CameraSelection camSel = CAMERA_PRIMARY);
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @remarks
- * -reserved configurations are set in this method.
+ * @remarks Reserved configurations are set in this method.
* @see PowerOff()
*/
result PowerOn(void);
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @see PowerOn()
*/
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @remarks
- * -The overlay region retrieved by the buffer information must be the topmost window when this method is called. @n
- * -The ICameraEventListener::OnCameraPreviewed() method can be delayed or dropped depending on
- * the system's performance. @n
- * -For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
+ * - The overlay region retrieved by the buffer information must be the topmost window when this method is called.
+ * - The ICameraEventListener::OnCameraPreviewed() method can be delayed or dropped depending on
+ * the system's performance.
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ *
state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
">here</a>.
- * @see StopPreview()
- * @see ICameraEventListener::OnCameraPreviewed()
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * with CAMERA_PRIMARY_SUPPORT_PREVIEW or CAMERA_SECONDARY_SUPPORT_PREVIEW keys.
+ * @see StopPreview()
+ * @see ICameraEventListener::OnCameraPreviewed()
*/
result StartPreview(const Tizen::Graphics::BufferInfo* pBufferInfo, bool previewedData = false);
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @remarks
- * - For more information on the relationship between this method and the PowerOn() method, and the
+ * @remarks For more information on the relationship between this method and the PowerOn() method, and the
* state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
">here</a>.
* @see StartPreview()
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* -For more information on the relationship between this method and the PowerOn() method, and the
* state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * with CAMERA_PRIMARY_SUPPORT_CAPTURE or CAMERA_SECONDARY_SUPPORT_CAPTURE keys.
* -In a zero-shutter-lag camera, the state changes to ::CAMERA_STATE_PREVIEW after capturing.
* -The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
* ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -The default brightness level is @c 5. @n
- * -The device's supported range for the brightness level is from @c 0 to @c 9. @n
- * -This method works correctly when PowerOn() is executed. @n@n
- * -For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * - The default brightness level is @c 5.
+ * - The device's supported range for the brightness level is from @c 0 to @c 9.
+ * - This method works correctly when PowerOn() is executed. @n
+ * For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * with CAMERA_PRIMARY_SUPPORT_BRIGHTNESS or CAMERA_SECONDARY_SUPPORT_BRIGHTNESS keys.
* @see GetBrightness()
*/
result SetBrightness(int brightness);
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -The default contrast level is @c 5. @n
- * -The device's supported range for the contrast level is from @c 0 to @c 9. @n
- * -This method works correctly when PowerOn() is executed. @n@n
- * -For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * - The default contrast level is @c 5.
+ * - The device's supported range for the contrast level is from @c 0 to @c 9.
+ * - This method works correctly when PowerOn() is executed. @n
+ * For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * with CAMERA_PRIMARY_SUPPORT_CONTRAST or CAMERA_SECONDARY_SUPPORT_CONTRAST keys.
* @see GetContrast()
*/
result SetContrast(int contrast);
*
* @return The current contrast level @n
* The returned value ranges from @c 0 to @c 9.
- * @remarks
- * -The device's supported range for the contrast level is from @c 0 to @c 9.
+ * @remarks The device's supported range for the contrast level is from @c 0 to @c 9.
* @see SetContrast()
*/
int GetContrast(void) const;
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -This method returns E_UNSUPPORTED_OPERATION in the Emulator.
- * -If Camera supports only ::CAMERA_ZOOM_TYPE_SMART, the zoom ratio can differ according
- * to the preview, capture, and recording resolutions.
- * -The supported zoom types can be obtained by using the
- * MediaCapability::GetValueN(CAMERA_PRIMARY_ZOOM_TYPE) method. @n@n
- * -For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * with CAMERA_PRIMARY_SUPPORT_ZOOM or CAMERA_SECONDARY_SUPPORT_ZOOM keys.
+ * - If Camera supports only ::CAMERA_ZOOM_TYPE_SMART, the zoom ratio can differ according
+ * to the preview, capture, and recording resolutions.
+ * - The supported zoom types can be obtained by using the
+ * MediaCapability::GetValueN(CAMERA_PRIMARY_ZOOM_TYPE) method.
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* @see ZoomOut()
* @see GetZoomLevel()
* @see GetMaxZoomLevel()
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -This method returns E_UNSUPPORTED_OPERATION in the Emulator.
- * -If CameraZoomType supports only ::CAMERA_ZOOM_TYPE_SMART, zoom ratio can differ according to
- * the preview, capture, and recording resolutions.
- * -The supported zoom types can be obtained by using the
- * MediaCapability::GetValueN(CAMERA_PRIMARY_ZOOM_TYPE) method. @n@n
- * -For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * with CAMERA_PRIMARY_SUPPORT_ZOOM or CAMERA_SECONDARY_SUPPORT_ZOOM keys.
+ * - If CameraZoomType supports only ::CAMERA_ZOOM_TYPE_SMART, zoom ratio can differ according to
+ * the preview, capture, and recording resolutions.
+ * - The supported zoom types can be obtained by using the
+ * MediaCapability::GetValueN(CAMERA_PRIMARY_ZOOM_TYPE) method.
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* @see ZoomIn()
* @see GetZoomLevel()
* @see GetMaxZoomLevel()
* @since 2.0
*
* @return The current zoom level
- * @remarks
- * -The zoom level is different for each camera device.
+ * @remarks The zoom level is different for each camera device.
* @see ZoomIn()
* @see ZoomOut()
* @see GetMaxZoomLevel()
*
* @since 2.0
*
- * @return The maximum zoom level
- * @remarks
- * -The zoom level is different for each camera device.
- * @see ZoomIn()
+ * @return The maximum zoom level
+ * @remarks The zoom level is different for each camera device.
+ * @see ZoomIn()
* @see ZoomOut()
* @see GetZoomLevel()
*/
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * -The specific error code can be accessed using the GetLastResult() method. @n
- * -The return value and each item in the list must be deleted by the caller.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value and each item in the list must be deleted by the caller.
* @see SetPreviewResolution()
* @see GetPreviewResolution()
*/
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * -The specific error code can be accessed using the GetLastResult() method. @n
- * -The return value and each item in the list must be deleted by the caller.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value and each item in the list must be deleted by the caller.
* @see SetCaptureResolution()
* @see GetCaptureResolution()
*/
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c effect is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -The default effect is ::CAMERA_EFFECT_NONE.
- * -This method returns E_UNSUPPORTED_OPERATION in the Emulator.
+ * -The default effect is @c CAMERA_EFFECT_NONE.
+ * -This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
* -This method works correctly when PowerOn() is executed. @n@n
- * -For more information on the relationship between this method and the PowerOn() method, and the
+ * For more information on the relationship between this method and the PowerOn() method, and the
* state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
+ * with CAMERA_PRIMARY_EFFECT or CAMERA_SECONDARY_EFFECT keys.
* @see GetEffect()
*/
result SetEffect(CameraEffect effect);
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
* -The flash is switched on when the camera captures a picture. If the value of @c flashOn is
- * set to @c true, this method returns E_UNSUPPORTED_OPERATION in the Emulator. @n
- * -SetFlash(true) works same as SetFlashMode(CAMERA_FLASH_MODE_ON) and SetFlash(false) works same as SetFlashMode(CAMERA_FLASH_MODE_OFF).
- * -For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
- * - In a zero-shutter-lag camera, only the default preview format applies this feature.
+ * set to @c true, this method returns @c E_UNSUPPORTED_OPERATION in the Emulator. @n
+ * SetFlash(true) works same as SetFlashMode(CAMERA_FLASH_MODE_ON) and SetFlash(false) works same as SetFlashMode(CAMERA_FLASH_MODE_OFF).
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * with CAMERA_PRIMARY_SUPPORT_FLASH or CAMERA_SECONDARY_SUPPORT_FLASH keys.
+ * -In a zero-shutter-lag camera, only the default preview format applies this feature.
* @see IsFlashOn()
- * @see SetFlashMode()
- * @see CameraFlashMode
- * @}
+ * @see SetFlashMode()
+ * @see CameraFlashMode
+ *
* @endif
+ * @}
*/
result SetFlash(bool flashOn)
{
*
* @return @c true if the flash light is on, @n
* else @c false
- * @remarks
- * -This method works same as return (GetFlashMode()!=CAMERA_FLASH_MODE_OFF).
+ * @remarks This method works same as return (GetFlashMode()!=CAMERA_FLASH_MODE_OFF).
* @see SetFlash()
* @see GetFlashMode()
* @see CameraFlashMode
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c flashMode is not supported.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -Normally the flash splashes before the camera captures a picture. @n
- * ::CAMERA_FLASH_MODE_CONTINUOUS keeps the flash turned on after the method is called until ::CAMERA_FLASH_MODE_OFF is set. @n
- * -This method returns E_UNSUPPORTED_OPERATION in the Emulator.
- * -In a zero-shutter-lag camera, the default preview format applies this feature correctly. The other preview formats are not guaranteed.
- * -The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
- * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
+ * - Normally the flash splashes before the camera captures a picture. @n
+ * @c CAMERA_FLASH_MODE_CONTINUOUS keeps the flash turned on after the method is called until @c CAMERA_FLASH_MODE_OFF is set.
+ * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
+ * with CAMERA_PRIMARY_FLASH_MODE or CAMERA_SECONDARY_FLASH_MODE keys.
+ * - In a zero-shutter-lag camera, the default preview format applies this feature correctly. The other preview formats are not guaranteed.
+ * - The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
+ * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
* @see GetFlashMode()
*/
result SetFlashMode(CameraFlashMode flashMode);
* @since 2.0
*
* @return The flash mode of the camera
- * @remarks
- * -If the %Camera doesn't support the flash mode, this method always returns ::CAMERA_FLASH_MODE_OFF.
+ * @remarks If the %Camera doesn't support the flash mode, this method always returns @c CAMERA_FLASH_MODE_OFF.
* @see SetFlashMode()
*/
CameraFlashMode GetFlashMode(void) const;
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -The default exposure level is @c 5.
- * -The supported range for exposure level is from @c 0 to @c 9.
- * -This method returns E_UNSUPPORTED_OPERATION in the Emulator.
- * -This method works correctly when PowerOn() is executed. @n@n
- * -For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * - The default exposure level is @c 5.
+ * - The supported range for exposure level is from @c 0 to @c 9.
+ * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
+ * - This method works correctly when PowerOn() is executed. @n
+ * For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * with CAMERA_PRIMARY_SUPPORT_EXPOSURE or CAMERA_SECONDARY_SUPPORT_EXPOSURE keys.
* @see GetExposure()
*/
result SetExposure(int exposure);
*
* @return An integer value representing the exposure level of the camera @n
* The returned value ranges from @c 0 to @c 9.
- * @remarks
- * -The supported range for exposure level is from @c 0 to @c 9.
+ * @remarks The supported range for exposure level is from @c 0 to @c 9.
* @see SetExposure()
*/
int GetExposure(void) const;
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c whiteBalance is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -The default white balance is ::CAMERA_WHITE_BALANCE_AUTO.
- * -This method returns E_UNSUPPORTED_OPERATION in the Emulator.
- * -This method works correctly when PowerOn() is executed. @n@n
- * -For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * - The default white balance is @c CAMERA_WHITE_BALANCE_AUTO.
+ * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
+ * - This method works correctly when PowerOn() is executed. @n
+ * For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
+ * with CAMERA_PRIMARY_WHITE_BALANCE or CAMERA_SECONDARY_WHITE_BALANCE keys.
* @see GetWhiteBalance()
*/
result SetWhiteBalance(CameraWhiteBalance whiteBalance);
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -The default quality is ::CAMERA_QUALITY_NORMAL.
- * -This method works correctly when PowerOn() is executed. @n@n
- * -For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * - The default quality is @c CAMERA_QUALITY_NORMAL.
+ * - This method works correctly when PowerOn() is executed. @n
+ * For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm>here</a>.
* @see GetQuality()
*/
result SetQuality(CameraQuality quality);
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_INVALID_ARG The specified focus mode is invalid.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c focusMode is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -::CAMERA_FOCUS_MODE_NONE always throws E_INVALID_ARG.
+ * - @c CAMERA_FOCUS_MODE_NONE always throws @c E_INVALID_ARG.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
+ * with CAMERA_PRIMARY_FOCUS_MODE or CAMERA_SECONDARY_FOCUS_MODE keys.
+
* @see GetFocusMode()
*/
result SetFocusMode(CameraFocusMode focusMode);
* @since 2.0
*
* @return The %Camera focus mode
- * @remarks
- * -If the %Camera does not support the focus mode, this method always returns ::CAMERA_FOCUS_MODE_NONE.
+ * @remarks If the %Camera does not support the focus mode, this method always returns @c CAMERA_FOCUS_MODE_NONE.
* @see SetFocusMode()
*/
CameraFocusMode GetFocusMode(void) const;
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE This method is not supported for the current focus mode.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -This method works fine when the current focus mode is @c CAMERA_FOCUS_MODE_NORMAL or @c CAMERA_FOCUS_MODE_MACRO.@n
- * -If the input parameter has a empty list, the focus area is changed to the center.
+ * - This method works fine when the current focus mode is ::CAMERA_FOCUS_MODE_NORMAL or ::CAMERA_FOCUS_MODE_MACRO.
+ * - If the input parameter has a empty list, the focus area is changed to the center.
* @see GetAutoFocusPointN()
*/
result SetAutoFocusPoint(const Tizen::Base::Collection::IList& pointList);
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * -The specific error code can be accessed using the GetLastResult() method. @n
- * -The return value and each item in the list must be deleted by the caller.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value and each item in the list must be deleted by the caller.
* @see SetAutoFocusPoint()
*/
Tizen::Base::Collection::IList* GetAutoFocusPointN(void) const;
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -If @c callback is set to @c false, the ICameraEventListener::OnCameraAutoFocused() method is not called.
- * -This method throws @c E_UNSUPPORTED_OPERATION in the emulator. @n
- * -For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * - If @c callback is set to @c false, the ICameraEventListener::OnCameraAutoFocused() method is not called.
+ * - This method throws @c E_UNSUPPORTED_OPERATION in the emulator.
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * with CAMERA_PRIMARY_SUPPORT_FOCUS or CAMERA_SECONDARY_SUPPORT_FOCUS keys.
*/
result SetAutoFocus(bool callback);
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks
- * -This method works correctly when PowerOn() is executed.
+ * @remarks This method works correctly when PowerOn() is executed.
* @see GetCaptureFormat()
*/
result SetCaptureFormat(const Tizen::Graphics::PixelFormat format);
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * -The specific error code can be accessed using the GetLastResult() method. @n
- * -The return value must be deleted.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be deleted.
* @see SetCaptureFormat()
* @see GetCaptureFormat()
*/
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -This method works in ::CAMERA_STATE_INITIALIZED state. @n@n
- * -For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * - This method works in ::CAMERA_STATE_INITIALIZED state.
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* @see GetPreviewFormat()
* @see GetSupportedPreviewFormatListN()
*/
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * -The specific error code can be accessed using the GetLastResult() method. @n
- * -The return value must be deleted.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be deleted.
* @see SetPreviewFormat()
* @see GetPreviewFormat()
*/
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c isoLevel is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -In some devices this method works in the ::CAMERA_STATE_PREVIEW state.
- * -This method throws E_UNSUPPORTED_OPERATION in the Emulator. @n@n
- * -For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * - In some devices this method works in the ::CAMERA_STATE_PREVIEW state.
+ * - This method throws @c E_UNSUPPORTED_OPERATION in the Emulator.
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
+ * with CAMERA_PRIMARY_ISO_LEVEL or CAMERA_SECONDARY_ISO_LEVEL keys.
* @see GetIsoLevel()
*/
result SetIsoLevel(CameraIsoLevel isoLevel);
* @feature %http://tizen.org/feature/camera
*
* @return An error code
- * @param[in] fps The frame rate per second
+ * @param[in] fps The frame rate per second @n
+ * It must be one of the fps extracted using GetSupportedPreviewFrameRateListN().
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_OUT_OF_RANGE The specified @c fps is out of range on this device.
* @exception E_DEVICE_BUSY The camera is under use by other application.
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -This method works in ::CAMERA_STATE_INITIALIZED state. @n@n
- * -For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * - This method works in ::CAMERA_STATE_INITIALIZED state.
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* @see GetPreviewFrameRate()
- * @see GetSupportedPreviewFrameRateListN()
- * @see FRAME_RATE_AUTO
*/
result SetPreviewFrameRate(int fps);
* @since 2.0
*
* @return The frame rate of the camera @n
- * If the frame rate is not set using SetPreviewFrameRate(), the system-dependent default frame rate is returned.
+ * If the frame rate is not set using SetPreviewFrameRate(), the system-dependent default frame rate is returned.
* @see GetSupportedPreviewFrameRateListN()
*/
int GetPreviewFrameRate(void) const;
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * -The specific error code can be accessed using the GetLastResult() method. @n
- * -The return value must be deleted by the caller. @n
- * -This method returns fps list that can be supported by all resolutions.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be deleted by the caller.
+ * - This method returns fps list that can be supported by all resolutions.
* @see SetPreviewFrameRate()
* @see GetPreviewFrameRate()
* @see FRAME_RATE_AUTO
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * -The specific error code can be accessed using the GetLastResult() method. @n
- * -The return value must be deleted by the caller. @n
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be deleted by the caller.
* @see SetPreviewFrameRate()
* @see GetPreviewFrameRate()
* @see GetSupportedPreviewFrameRateListN(void) const
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_OUT_OF_RANGE The input value is out of range.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_SYSTEM A system error has occurred.
* @remarks
- * -The default value of orientation is @c CAMERA_EXIF_ORIENTATION_TOP_LEFT. @n
- * -This method works correctly when PowerOn() is executed. The orientation value set by this method can be obtained using the
- * Tizen::Content::ImageData::GetOrientation() method after writing the captured data to a file.
+ * - The default value of orientation is @c CAMERA_EXIF_ORIENTATION_TOP_LEFT.
+ * - This method works correctly when PowerOn() is executed. The orientation value set by this method can be obtained using the
+ * Tizen::Content::ImageData::GetOrientation() method after writing the captured data to a file.
*/
result SetExifOrientation(CameraExifOrientation orientation);
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_OUT_OF_RANGE The input value is out of range.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_SYSTEM A system error has occurred.
* @remarks
* -This method sets the GPS coordinates and enables entering the coordinates into the Exchangeable Image File Format (EXIF).
* -By default, the GPS coordinates are not entered in JPEG's EXIF.
* -The GPS coordinates that are set using this method are entered in every call to the
- * Capture() method, until DisableExifGpsCoordinates() is called or this instance is destroyed. @n
- * -This method works correctly when PowerOn() is executed. @n
- * -The values set by this method can result in an error as compared to the values stored in the Exchangeable Image File Format (EXIF) field.
+ * Capture() method, until DisableExifGpsCoordinates() is called or this instance is destroyed.
+ * - This method works correctly when PowerOn() is executed.
+ * - The values set by this method can result in an error as compared to the values stored in the Exchangeable Image File Format (EXIF) field.
*/
result SetExifGpsCoordinates(double latitude, double longitude, float altitude);
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_OUT_OF_RANGE The input value is out of range.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_SYSTEM A system error has occurred.
* @see SetExifGpsCoordinates()
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_INVALID_ARG The input value is out of range.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c flip is not supported.
* @exception E_SYSTEM A system error has occurred.
* @remarks
* -This method works in the ::CAMERA_STATE_INITIALIZED state.
* -Finally the last specified type is applied even with the several types applicable.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
+ * with CAMERA_PRIMARY_FLIP or CAMERA_SECONDARY_FLIP keys.
* -In a zero-shutter-lag camera, the default preview format is not guaranteed to apply this feature correctly.
* -The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
- * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
+ * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
* @see GetFlip()
*/
result SetFlip(CameraFlipType flip);
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_INVALID_ARG The input value is out of range.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c rotation is not supported.
* @exception E_SYSTEM A system error has occurred.
* @remarks
- * -This method works in the ::CAMERA_STATE_INITIALIZED state.
- * -The last specified type is applied even with the several types applicable.
- * -This method rotates the preview and recording data but not the captured image. @n
- * The captured image's orientation is always following the physical rotation.
- * -When the preview is rotated, the preview callback data's width and height can be changed. @n
- * Thus the application must recognize these changes when it uses the preview data in ICameraEventListener::OnCameraPreviewed() callback.
+ * - This method works in the ::CAMERA_STATE_INITIALIZED state.
+ * - The last specified type is applied even with the several types applicable.
+ * - This method rotates the preview and recording data but not the captured image. @n
+ * The captured image's orientation is always following the physical rotation.
+ * - When the preview is rotated, the preview callback data's width and height can be changed. @n
+ * Thus the application must recognize these changes when it uses the preview data in ICameraEventListener::OnCameraPreviewed() callback.
* - For the intended view of preview, Tizen::Ui::Controls::OverlayRegion::OVERLAY_REGION_TYPE_NORMAL must be selected when Tizen::Ui::Controls::OverlayRegion is created.
- * -In a zero-shutter-lag camera, the default preview format is not guaranteed to apply this feature correctly.
- * -The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
- * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
+ * with CAMERA_PRIMARY_PREVIEW_ROTATION or CAMERA_SECONDARY_PREVIEW_ROTATION keys.
+ * - In a zero-shutter-lag camera, the default preview format is not guaranteed to apply this feature correctly.
+ * - The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
+ * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
* @see GetPreviewRotation()
*
*/
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_INVALID_ARG The specified metering mode is invalid.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c meteringMode is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -::CAMERA_METERING_MODE_NONE always throws E_INVALID_ARG.
+ * - @c CAMERA_METERING_MODE_NONE always throws @c E_INVALID_ARG.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
+ * with CAMERA_PRIMARY_METERING_MODE or CAMERA_SECONDARY_METERING_MODE keys.
* @see GetMeteringMode()
*/
result SetMeteringMode(CameraMeteringMode meteringMode);
*
* @return The %Camera metering mode
* @remarks
- * -If the %Camera does not support the metering mode, this method always returns ::CAMERA_METERING_MODE_NONE.
+ * If the %Camera does not support the metering mode, this method always returns @c CAMERA_METERING_MODE_NONE.
* @see SetMeteringMode()
*/
CameraMeteringMode GetMeteringMode(void) const;
* @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_INVALID_ARG The specified @c sceneMode is invalid.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c sceneMode is not supported.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -In a specific scene mode, camera's attributes such as brightness, metering mode, iso level, white balance, flash, and focus are changed to the ones that are pre-defined by each scene mode. @n
- * -In a specific scene mode, if an application sets any attribute that is related to the scene, the mode can be changed to ::CAMERA_SCENE_OFF. @n
- * Thus, it is recommended that the application check the current scene mode after setting the attributes. @n
- * -In case that the scene mode is changed to ::CAMERA_SCENE_OFF, all the attributes set by the application are reloaded.
+ * - In a specific scene mode, camera's attributes such as brightness, metering mode, iso level, white balance, flash, and focus are changed to the ones that are pre-defined by each scene mode.
+ * - In a specific scene mode, if an application sets any attribute that is related to the scene, the mode can be changed to @c CAMERA_SCENE_OFF. @n
+ * Thus, it is recommended that the application check the current scene mode after setting the attributes. @n
+ * In case that the scene mode is changed to @c CAMERA_SCENE_OFF, all the attributes set by the application are reloaded.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
+ * with CAMERA_PRIMARY_SCENE_MODE or CAMERA_SECONDARY_SCENE_MODE keys.
*/
result SetSceneMode(CameraSceneMode sceneMode);
* @exception E_OBJ_ALREADY_EXIST The filter already exists.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @remarks IVideoStreamFilter::ProcessVideoStream() will be called when the video frame is ready.
+ * @remarks IVideoStreamFilter::ProcessVideoStream() will be called when the video frame is ready.
*/
result AddVideoStreamFilter(Tizen::Media::IVideoStreamFilter& filter);
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The filter is not found.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
* For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
*/
result RemoveVideoStreamFilter(Tizen::Media::IVideoStreamFilter& filter);
*
* @since 2.0
*
- * @remarks
- * -The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
+ * @remarks The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
* @see Construct()
*/
Camera(const Camera& rhs);
*
* @since 2.0
*
- * @remarks
- * -The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
+ * @remarks The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
*
*/
Camera& operator =(const Camera& rhs);
projects / platform / framework / native / media.git / commitdiff