change comment for secondary sink

Signed-off-by: SeokHoon LEE <andy.shlee@samsung.com>
Change-Id: I895c95e923ce74c8b21cf8f1f5b9006995d7548a

diff --git a/include/scmirroring_secondary_sink.h b/include/scmirroring_secondary_sink.h
index 71c66071f884f62c8f9e4ba27ceaa0760924ae69..446a8db1d6ca7d7fe6bcaadcd99df5b4c6e6a54d 100644 (file)
--- a/include/scmirroring_secondary_sink.h
+++ b/include/scmirroring_secondary_sink.h
@@ -1,5 +1,5 @@
 /*
-* Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
+* Copyright (c) 2018 Samsung Electronics Co., Ltd All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
@@ -34,12 +34,12 @@ extern "C" {
  */
 
 /**
- * @brief Creates a new screen mirroring sink handle.
- * @since_tizen 2.4
+ * @brief Creates a new screen mirroring secondary sink handle.
+ * @since_tizen 5.5
  *
  * @remarks You must release @a scmirroring_secondary_sink using scmirroring_secondary_sink_destroy().
  *
- * @param[out] scmirroring_secondary_sink      A newly returned handle to the screen mirroring sink
+ * @param[out] scmirroring_secondary_sink      A newly returned handle to the screen mirroring secondary sink
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SCMIRRORING_ERROR_NONE Successful
@@ -59,9 +59,9 @@ int scmirroring_secondary_sink_create(scmirroring_secondary_sink_h *scmirroring_
  * @brief Registers a callback function to be called when state change happens.
  * @details This function registers user callback and this callback is called when each status is changed.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @param[in] callback The callback function to invoke
  * @param[in] user_data The user data passed to the callback registration function
  * @return @c 0 on success,
@@ -83,9 +83,9 @@ int scmirroring_secondary_sink_set_state_changed_cb(scmirroring_secondary_sink_h
 /**
  * @brief Sets server IP and port.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @param[in] ip The server IP address to connect to
  * @param[in] port The server port to connect to
  * @return @c 0 on success,
@@ -109,9 +109,9 @@ int scmirroring_secondary_sink_set_ip_and_port(scmirroring_secondary_sink_h scmi
  * @details This function will use handle created by the application to set the overlay &
  *          display on the surface passed by the application
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @param[in] type Surface type(x11/evas)
  * @param[in] display_surface The display_surface created by application to force sink to display content over it
  * @return @c 0 on success,
@@ -131,15 +131,15 @@ int scmirroring_secondary_sink_set_ip_and_port(scmirroring_secondary_sink_h scmi
 int scmirroring_secondary_sink_set_display(scmirroring_secondary_sink_h scmirroring_secondary_sink, scmirroring_display_type_e type, void *display_surface);
 
 /**
- * @brief Sets resolutions of screen mirroring sink.
+ * @brief Sets resolutions of screen mirroring secondary sink.
  * @details This function sets resolutions of screen mirroring sink using scmirroring_resolution_e as following.
  *          (ex. SCMIRRORING_RESOLUTION_1920x1080_P30 | SCMIRRORING_RESOLUTION_1280x720_P30)
  *          Use it only when you want to set specific resolutions but if screen mirroring source dose not support
  *          the resolutions which you set, the screen mirroring sink will be disconnected.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @param[in] resolution Resolution of screen mirroring sink
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -159,9 +159,9 @@ int scmirroring_secondary_sink_set_resolution(scmirroring_secondary_sink_h scmir
 
 /**
  * @brief Prepares the screen mirroring sink handle and allocates specific resources.
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SCMIRRORING_ERROR_NONE Successful
@@ -184,11 +184,11 @@ int scmirroring_secondary_sink_prepare(scmirroring_secondary_sink_h scmirroring_
 /**
  * @brief Creates connection and prepare for receiving data from SCMIRRORING source.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  * @privlevel public
  * @privilege %http://tizen.org/privilege/internet
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SCMIRRORING_ERROR_NONE Successful
@@ -214,11 +214,11 @@ int scmirroring_secondary_sink_connect(scmirroring_secondary_sink_h scmirroring_
 /**
  * @brief Starts receiving data from the SCMIRRORING source and display it(mirror).
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  * @privlevel public
  * @privilege %http://tizen.org/privilege/internet
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SCMIRRORING_ERROR_NONE Successful
@@ -248,11 +248,11 @@ int scmirroring_secondary_sink_start(scmirroring_secondary_sink_h scmirroring_se
  * @details This function pauses receiving data from the SCMIRRORING source,
  *     which means it sends RTSP PAUSE message to source.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  * @privlevel public
  * @privilege %http://tizen.org/privilege/internet
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SCMIRRORING_ERROR_NONE Successful
@@ -278,11 +278,11 @@ int scmirroring_secondary_sink_pause(scmirroring_secondary_sink_h scmirroring_se
  * @brief Resumes receiving data from the SCMIRRORING source.
  * @details This function pauses receiving data from the SCMIRRORING source, which means it sends RTSP PLAY message to source.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  * @privlevel public
  * @privilege %http://tizen.org/privilege/internet
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SCMIRRORING_ERROR_NONE Successful
@@ -303,11 +303,11 @@ int scmirroring_secondary_sink_resume(scmirroring_secondary_sink_h scmirroring_s
 /**
  * @brief Disconnects and stops receiving data from the SCMIRRORING source.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  * @privlevel public
  * @privilege %http://tizen.org/privilege/internet
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SCMIRRORING_ERROR_NONE Successful
@@ -334,9 +334,9 @@ int scmirroring_secondary_sink_disconnect(scmirroring_secondary_sink_h scmirrori
  * @brief Unprepares screen mirroring.
  * @details This function unprepares screen mirroring, which closes specific resources.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SCMIRRORING_ERROR_NONE Successful
@@ -360,9 +360,9 @@ int scmirroring_secondary_sink_unprepare(scmirroring_secondary_sink_h scmirrorin
 /**
  * @brief Unregisters the callback function user registered.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SCMIRRORING_ERROR_NONE Successful
@@ -381,11 +381,11 @@ int scmirroring_secondary_sink_unprepare(scmirroring_secondary_sink_h scmirrorin
 int scmirroring_secondary_sink_unset_state_changed_cb(scmirroring_secondary_sink_h scmirroring_secondary_sink);
 
 /**
- * @brief Destroys screen mirroring sink handle.
+ * @brief Destroys screen mirroring secondary sink handle.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #SCMIRRORING_ERROR_NONE Successful
@@ -403,12 +403,12 @@ int scmirroring_secondary_sink_unset_state_changed_cb(scmirroring_secondary_sink
 int scmirroring_secondary_sink_destroy(scmirroring_secondary_sink_h scmirroring_secondary_sink);
 
 /**
- * @brief Gets negotiated video codec of screen mirroring sink.
+ * @brief Gets negotiated video codec of screen mirroring secondary sink.
  * @details The video codec is negotiated by screen mirroring source.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @param[out] codec Codec of video
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -427,12 +427,12 @@ int scmirroring_secondary_sink_destroy(scmirroring_secondary_sink_h scmirroring_
 int scmirroring_secondary_sink_get_negotiated_video_codec(scmirroring_secondary_sink_h *scmirroring_secondary_sink, scmirroring_video_codec_e *codec);
 
 /**
- * @brief Gets negotiated video resolution of screen mirroring sink.
+ * @brief Gets negotiated video resolution of screen mirroring secondary sink.
  * @details The video resolution is negotiated by screen mirroring source.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @param[out] width Width of video
  * @param[out] height Height of video
  * @return @c 0 on success,
@@ -452,12 +452,12 @@ int scmirroring_secondary_sink_get_negotiated_video_codec(scmirroring_secondary_
 int scmirroring_secondary_sink_get_negotiated_video_resolution(scmirroring_secondary_sink_h *scmirroring_secondary_sink, int *width, int *height);
 
 /**
- * @brief Gets negotiated frame rate of screen mirroring sink.
+ * @brief Gets negotiated frame rate of screen mirroring secondary sink.
  * @details The video frame rate is negotiated by screen mirroring source.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @param[out] frame_rate Frame rate of video
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -476,12 +476,12 @@ int scmirroring_secondary_sink_get_negotiated_video_resolution(scmirroring_secon
 int scmirroring_secondary_sink_get_negotiated_video_frame_rate(scmirroring_secondary_sink_h *scmirroring_secondary_sink, int *frame_rate);
 
 /**
- * @brief Gets negotiated audio codec of screen mirroring sink.
+ * @brief Gets negotiated audio codec of screen mirroring secondary sink.
  * @details The audio codec is negotiated by screen mirroring source.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @param[out] codec Codec of audio
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -500,12 +500,12 @@ int scmirroring_secondary_sink_get_negotiated_video_frame_rate(scmirroring_secon
 int scmirroring_secondary_sink_get_negotiated_audio_codec(scmirroring_secondary_sink_h *scmirroring_secondary_sink, scmirroring_audio_codec_e *codec);
 
 /**
- * @brief Gets negotiated audio channel of screen mirroring sink.
+ * @brief Gets negotiated audio channel of screen mirroring secondary sink.
  * @details The audio channel is negotiated by screen mirroring source.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @param[out] channel Channel of audio
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -524,10 +524,10 @@ int scmirroring_secondary_sink_get_negotiated_audio_codec(scmirroring_secondary_
 int scmirroring_secondary_sink_get_negotiated_audio_channel(scmirroring_secondary_sink_h *scmirroring_secondary_sink, int *channel);
 
 /**
- * @brief Gets negotiated audio sample rate of screen mirroring sink.
+ * @brief Gets negotiated audio sample rate of screen mirroring secondary sink.
  * @details The audio sample rate is negotiated by screen mirroring source.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
  * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
  * @param[out] sample_rate Sample rate of audio
@@ -548,12 +548,12 @@ int scmirroring_secondary_sink_get_negotiated_audio_channel(scmirroring_secondar
 int scmirroring_secondary_sink_get_negotiated_audio_sample_rate(scmirroring_secondary_sink_h *scmirroring_secondary_sink, int *sample_rate);
 
 /**
- * @brief Gets negotiated audio bitwidth of screen mirroring sink.
+ * @brief Gets negotiated audio bitwidth of screen mirroring secondary sink.
  * @details The audio bitwidth is negotiated by screen mirroring source.
  *
- * @since_tizen 2.4
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @param[out] bitwidth Bitwidth of audio
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -572,12 +572,12 @@ int scmirroring_secondary_sink_get_negotiated_audio_sample_rate(scmirroring_seco
 int scmirroring_secondary_sink_get_negotiated_audio_bitwidth(scmirroring_secondary_sink_h *scmirroring_secondary_sink, int *bitwidth);
 
 /**
- * @brief Gets the current state of screen mirroring sink.
+ * @brief Gets the current state of screen mirroring secondary sink.
  * @details The current state of screen mirroring sink is changed by calling CAPIs. And it provides the state of screen mirroring sink the time this api is called.
  *
- * @since_tizen 5.0
+ * @since_tizen 5.5
  *
- * @param[in] scmirroring_secondary_sink The handle to the screen mirroring sink
+ * @param[in] scmirroring_secondary_sink The handle to the screen mirroring secondary sink
  * @param[out] state The current state of screen mirroring sink
  *
  * @return @c 0 on success,

diff --git a/src/scmirroring_secondary_sink.c b/src/scmirroring_secondary_sink.c
index 139142f6e2aceea0336a8d326569d31a1a7464da..029dba391ab073463cd02771e35a32f9bd28a955 100644 (file)
--- a/src/scmirroring_secondary_sink.c
+++ b/src/scmirroring_secondary_sink.c
@@ -1,5 +1,5 @@
 /*
-* Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
+* Copyright (c) 2018 Samsung Electronics Co., Ltd All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.