[API/Tizen] Update the comment for Tizen API

When pipeline string directly accesses the camera or recorder device of
the Tizen, appropriate privilege should be written on configuration
file. This patch new adds the 'remarks' comment for this privilege.

Signed-off-by: Sangjung Woo <sangjung.woo@samsung.com>

diff --git a/api/capi/include/nnstreamer.h b/api/capi/include/nnstreamer.h
index 3184f48..fa2271d 100644 (file)
--- a/api/capi/include/nnstreamer.h
+++ b/api/capi/include/nnstreamer.h
@@ -40,7 +40,7 @@ extern "C" {
 
 /**
  * @brief The virtual name to set the video source of camcorder in Tizen.
- * @details If an application needs to access the camcorder to construct the pipeline, set the virtual name as a video source element.
+ * @details If an application needs to access the camera device to construct the pipeline, set the virtual name as a video source element.
  *          Note that you have to add 'http://tizen.org/privilege/camera' into the manifest of your application.
  * @since_tizen 5.5
  */
@@ -48,8 +48,8 @@ extern "C" {
 
 /**
  * @brief The virtual name to set the audio source of camcorder in Tizen.
- * @details If an application needs to access the camcorder to construct the pipeline, set the virtual name as an audio source element.
- *          Note that you have to add 'http://tizen.org/privilege/camera' into the manifest of your application.
+ * @details If an application needs to access the recorder device to construct the pipeline, set the virtual name as an audio source element.
+ *          Note that you have to add 'http://tizen.org/privilege/recorder' into the manifest of your application.
  * @since_tizen 5.5
  */
 #define ML_TIZEN_CAM_AUDIO_SRC "tizencamaudiosrc"
@@ -237,6 +237,8 @@ typedef void (*ml_pipeline_state_cb) (ml_pipeline_state_e state, void *user_data
  * @remarks If the function succeeds, @a pipe handle must be released using ml_pipeline_destroy().
  * @remarks http://tizen.org/privilege/mediastorage is needed if @a pipeline_description is relevant to media storage.
  * @remarks http://tizen.org/privilege/externalstorage is needed if @a pipeline_description is relevant to external storage.
+ * @remarks http://tizen.org/privilege/camera is needed if @a pipeline_description accesses the camera device.
+ * @remarks http://tizen.org/privilege/recorder is needed if @a pipeline_description accesses the recorder device.
  * @param[in] pipeline_description The pipeline description compatible with GStreamer gst_parse_launch(). Refer to GStreamer manual or NNStreamer (https://github.com/nnsuite/nnstreamer) documentation for examples and the grammar.
  * @param[in] cb The function to be called when the pipeline state is changed. You may set NULL if it's not required.
  * @param[in] user_data Private data for the callback. This value is passed to the callback when it's invoked.
@@ -246,7 +248,7 @@ typedef void (*ml_pipeline_state_cb) (ml_pipeline_state_e state, void *user_data
  * @retval #ML_ERROR_NOT_SUPPORTED Not supported.
  * @retval #ML_ERROR_INVALID_PARAMETER Given parameter is invalid. (Pipeline is not negotiated yet.)
  * @retval #ML_ERROR_STREAMS_PIPE Pipeline construction is failed because of wrong parameter or initialization failure.
- * @retval #ML_ERROR_PERMISSION_DENIED The application does not have the privilege to access to the media storage or external storage.
+ * @retval #ML_ERROR_PERMISSION_DENIED The application does not have the required privilege to access to the media storage, external storage, microphone, or camera.
  *
  * @pre The pipeline state should be #ML_PIPELINE_STATE_UNKNOWN or #ML_PIPELINE_STATE_NULL.
  * @post The pipeline state will be #ML_PIPELINE_STATE_PAUSED in the same thread.
@@ -716,7 +718,7 @@ int ml_tensors_info_set_tensor_dimension (ml_tensors_info_h info, unsigned int i
 int ml_tensors_info_get_tensor_dimension (ml_tensors_info_h info, unsigned int index, ml_tensor_dimension dimension);
 
 /**
- * @brief Gets the byte size of the given handle of tensors information.
+ * @brief Gets the size of tensors data in the given tensors information handle in bytes.
  * @details If an application needs to get the total byte size of tensors, set the @a index '-1'. Note that the maximum number of tensors is 16 (#ML_TENSOR_SIZE_LIMIT).
  * @since_tizen 5.5
  * @param[in] info The handle of tensors information.