Add remarks for recommended setting value for some APIs

[Version] 0.4.14
[Profile] Common
[Issue Type] Update
[Dependency module] N/A

Change-Id: Ic0eb3ddabb39364c0ad879238aa6823ad9978c19
Signed-off-by: Jeongmo Yang <jm80.yang@samsung.com>

diff --git a/include/camera.h b/include/camera.h
index c25ecc9..c5223f4 100644 (file)
--- a/include/camera.h
+++ b/include/camera.h
@@ -2332,6 +2332,8 @@ int camera_attr_get_encoded_preview_bitrate(camera_h camera, int *bitrate);
 /**
  * @brief Sets the bit rate of encoded preview.
  * @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] bitrate The bit rate of encoded preview
  * @return @c 0 on success, otherwise a negative error value
@@ -2355,13 +2357,15 @@ int camera_attr_set_encoded_preview_bitrate(camera_h camera, int bitrate);
  * @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
- * @see camera_attr_get_encoded_preview_gop_interval()
+ * @see camera_attr_set_encoded_preview_gop_interval()
  */
 int camera_attr_get_encoded_preview_gop_interval(camera_h camera, int *interval);
 
 /**
  * @brief Sets the GOP(Group Of Pictures) interval of encoded preview.
  * @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)
  * @return @c 0 on success, otherwise a negative error value
@@ -2370,7 +2374,7 @@ int camera_attr_get_encoded_preview_gop_interval(camera_h camera, int *interval)
  * @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
- * @see camera_attr_set_encoded_preview_gop_interval()
+ * @see camera_attr_get_encoded_preview_gop_interval()
  */
 int camera_attr_set_encoded_preview_gop_interval(camera_h camera, int interval);
 

diff --git a/packaging/capi-media-camera.spec b/packaging/capi-media-camera.spec
index ab5f6cb..4edd005 100644 (file)
--- a/packaging/capi-media-camera.spec
+++ b/packaging/capi-media-camera.spec
@@ -1,6 +1,6 @@
 Name:       capi-media-camera
 Summary:    A Camera API
-Version:    0.4.13
+Version:    0.4.14
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0