Add remarks to sink APIs which have unnecessary privilege.

Change-Id: If507042bdc3ab43f73b0de76b8f775f418d03cda
Signed-off-by: Hyunsoo, Park <hance.park@samsung.com>

diff --git a/include/scmirroring_sink.h b/include/scmirroring_sink.h
index 78c67e8d860bd790abb0d55014654bc6a212f444..869c35b71361295f94d47ecb57a78ea18ecc6277 100755 (executable)
--- a/include/scmirroring_sink.h
+++ b/include/scmirroring_sink.h
@@ -38,6 +38,7 @@ extern "C" {
  * @since_tizen 2.4
  *
  * @remarks You must release @a scmirroring_sink using scmirroring_sink_destroy().
+ *          http://tizen.org/privilege/internet(public level privilege) is no longer required to use this API since 3.0.
  *
  * @param[out] scmirroring_sink        A newly returned handle to the screen mirroring sink
  * @return @c 0 on success,
@@ -46,6 +47,7 @@ extern "C" {
  * @retval #SCMIRRORING_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #SCMIRRORING_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #SCMIRRORING_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #SCMIRRORING_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SCMIRRORING_ERROR_NOT_SUPPORTED Not supported
  * @retval #SCMIRRORING_ERROR_UNKNOWN Unknown Error
  *
@@ -161,6 +163,8 @@ int scmirroring_sink_set_resolution(scmirroring_sink_h scmirroring_sink, int res
  * @brief Prepares the screen mirroring sink handle and allocates specific resources.
  * @since_tizen 2.4
  *
+ * @remarks http://tizen.org/privilege/internet(public level privilege) is no longer required to use this API since 3.0.
+ *
  * @param[in] scmirroring_sink The handle to the screen mirroring sink
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -168,6 +172,7 @@ int scmirroring_sink_set_resolution(scmirroring_sink_h scmirroring_sink, int res
  * @retval #SCMIRRORING_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #SCMIRRORING_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #SCMIRRORING_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #SCMIRRORING_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SCMIRRORING_ERROR_NOT_SUPPORTED Not supported
  * @retval #SCMIRRORING_ERROR_UNKNOWN Unknown Error
  *
@@ -336,6 +341,8 @@ int scmirroring_sink_disconnect(scmirroring_sink_h scmirroring_sink);
  *
  * @since_tizen 2.4
  *
+ * @remarks http://tizen.org/privilege/internet(public level privilege) is no longer required to use this API since 3.0.
+ *
  * @param[in] scmirroring_sink The handle to the screen mirroring sink
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -343,6 +350,7 @@ int scmirroring_sink_disconnect(scmirroring_sink_h scmirroring_sink);
  * @retval #SCMIRRORING_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #SCMIRRORING_ERROR_OUT_OF_MEMORY Out of memory
  * @retval #SCMIRRORING_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #SCMIRRORING_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SCMIRRORING_ERROR_NOT_SUPPORTED Not supported
  * @retval #SCMIRRORING_ERROR_UNKNOWN Unknown Error
  *
@@ -408,6 +416,8 @@ int scmirroring_sink_destroy(scmirroring_sink_h scmirroring_sink);
  *
  * @since_tizen 2.4
  *
+ * @remarks http://tizen.org/privilege/internet(public level privilege) is no longer required to use this API since 3.0.
+ *
  * @param[in] scmirroring_sink The handle to the screen mirroring sink
  * @param[out] codec Codec of video
  * @return @c 0 on success,
@@ -415,6 +425,7 @@ int scmirroring_sink_destroy(scmirroring_sink_h scmirroring_sink);
  * @retval #SCMIRRORING_ERROR_NONE Successful
  * @retval #SCMIRRORING_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #SCMIRRORING_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #SCMIRRORING_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SCMIRRORING_ERROR_NOT_SUPPORTED Not supported
  * @retval #SCMIRRORING_ERROR_UNKNOWN Unknown Error
  *
@@ -432,6 +443,8 @@ int scmirroring_sink_get_negotiated_video_codec(scmirroring_sink_h *scmirroring_
  *
  * @since_tizen 2.4
  *
+ * @remarks http://tizen.org/privilege/internet(public level privilege) is no longer required to use this API since 3.0.
+ *
  * @param[in] scmirroring_sink The handle to the screen mirroring sink
  * @param[out] width Width of video
  * @param[out] height Height of video
@@ -440,6 +453,7 @@ int scmirroring_sink_get_negotiated_video_codec(scmirroring_sink_h *scmirroring_
  * @retval #SCMIRRORING_ERROR_NONE Successful
  * @retval #SCMIRRORING_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #SCMIRRORING_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #SCMIRRORING_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SCMIRRORING_ERROR_NOT_SUPPORTED Not supported
  * @retval #SCMIRRORING_ERROR_UNKNOWN Unknown Error
  *
@@ -457,6 +471,8 @@ int scmirroring_sink_get_negotiated_video_resolution(scmirroring_sink_h *scmirro
  *
  * @since_tizen 2.4
  *
+ * @remarks http://tizen.org/privilege/internet(public level privilege) is no longer required to use this API since 3.0.
+ *
  * @param[in] scmirroring_sink The handle to the screen mirroring sink
  * @param[out] frame_rate Frame rate of video
  * @return @c 0 on success,
@@ -464,6 +480,7 @@ int scmirroring_sink_get_negotiated_video_resolution(scmirroring_sink_h *scmirro
  * @retval #SCMIRRORING_ERROR_NONE Successful
  * @retval #SCMIRRORING_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #SCMIRRORING_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #SCMIRRORING_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SCMIRRORING_ERROR_NOT_SUPPORTED Not supported
  * @retval #SCMIRRORING_ERROR_UNKNOWN Unknown Error
  *
@@ -481,6 +498,8 @@ int scmirroring_sink_get_negotiated_video_frame_rate(scmirroring_sink_h *scmirro
  *
  * @since_tizen 2.4
  *
+ * @remarks http://tizen.org/privilege/internet(public level privilege) is no longer required to use this API since 3.0.
+ *
  * @param[in] scmirroring_sink The handle to the screen mirroring sink
  * @param[out] codec Codec of audio
  * @return @c 0 on success,
@@ -488,6 +507,7 @@ int scmirroring_sink_get_negotiated_video_frame_rate(scmirroring_sink_h *scmirro
  * @retval #SCMIRRORING_ERROR_NONE Successful
  * @retval #SCMIRRORING_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #SCMIRRORING_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #SCMIRRORING_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SCMIRRORING_ERROR_NOT_SUPPORTED Not supported
  * @retval #SCMIRRORING_ERROR_UNKNOWN Unknown Error
  *
@@ -505,6 +525,8 @@ int scmirroring_sink_get_negotiated_audio_codec(scmirroring_sink_h *scmirroring_
  *
  * @since_tizen 2.4
  *
+ * @remarks http://tizen.org/privilege/internet(public level privilege) is no longer required to use this API since 3.0.
+ *
  * @param[in] scmirroring_sink The handle to the screen mirroring sink
  * @param[out] channel Channel of audio
  * @return @c 0 on success,
@@ -512,6 +534,7 @@ int scmirroring_sink_get_negotiated_audio_codec(scmirroring_sink_h *scmirroring_
  * @retval #SCMIRRORING_ERROR_NONE Successful
  * @retval #SCMIRRORING_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #SCMIRRORING_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #SCMIRRORING_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SCMIRRORING_ERROR_NOT_SUPPORTED Not supported
  * @retval #SCMIRRORING_ERROR_UNKNOWN Unknown Error
  *
@@ -529,6 +552,8 @@ int scmirroring_sink_get_negotiated_audio_channel(scmirroring_sink_h *scmirrorin
  *
  * @since_tizen 2.4
  *
+ * @remarks http://tizen.org/privilege/internet(public level privilege) is no longer required to use this API since 3.0.
+ *
  * @param[in] scmirroring_sink The handle to the screen mirroring sink
  * @param[out] sample_rate Sample rate of audio
  * @return @c 0 on success,
@@ -536,6 +561,7 @@ int scmirroring_sink_get_negotiated_audio_channel(scmirroring_sink_h *scmirrorin
  * @retval #SCMIRRORING_ERROR_NONE Successful
  * @retval #SCMIRRORING_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #SCMIRRORING_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #SCMIRRORING_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SCMIRRORING_ERROR_NOT_SUPPORTED Not supported
  * @retval #SCMIRRORING_ERROR_UNKNOWN Unknown Error
  *
@@ -553,6 +579,8 @@ int scmirroring_sink_get_negotiated_audio_sample_rate(scmirroring_sink_h *scmirr
  *
  * @since_tizen 2.4
  *
+ * @remarks http://tizen.org/privilege/internet(public level privilege) is no longer required to use this API since 3.0.
+ *
  * @param[in] scmirroring_sink The handle to the screen mirroring sink
  * @param[out] bitwidth Bitwidth of audio
  * @return @c 0 on success,
@@ -560,6 +588,7 @@ int scmirroring_sink_get_negotiated_audio_sample_rate(scmirroring_sink_h *scmirr
  * @retval #SCMIRRORING_ERROR_NONE Successful
  * @retval #SCMIRRORING_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #SCMIRRORING_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #SCMIRRORING_ERROR_PERMISSION_DENIED Permission denied
  * @retval #SCMIRRORING_ERROR_NOT_SUPPORTED Not supported
  * @retval #SCMIRRORING_ERROR_UNKNOWN Unknown Error
  *