webrtc: Improve description 87/251987/4
authorSangchul Lee <sc11.lee@samsung.com>
Thu, 21 Jan 2021 08:19:36 +0000 (17:19 +0900)
committerSangchul Lee <sc11.lee@samsung.com>
Mon, 25 Jan 2021 06:30:18 +0000 (15:30 +0900)
Fix wrong sentence in webrtc_start().

Add precondition to webrtc_set_transceiver_direction() and
webrtc_get_transceiver_direction().

[Version] 0.1.85
[Issue Type] Doxygen

Change-Id: Ibf3fe67f43c09b1324088ece4d616892de4fccb0
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>
include/webrtc.h
packaging/capi-media-webrtc.spec

index b2e5f25c8da5a2b6686aacf489ff68b6f5fa7ae5..1cef52b68bcef916fced7027ccc1ed71e37ce86d 100644 (file)
@@ -392,7 +392,7 @@ int webrtc_create(webrtc_h *webrtc);
  * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation
  * @retval #WEBRTC_ERROR_INVALID_STATE Invalid state
  * @pre webrtc_ice_candidate_cb() must be set by calling webrtc_set_ice_candidate_cb().
- * @pre webrtc_media_packet_source_set_format() must be set by calling webrtc_set_ice_candidate_cb().
+ * @pre webrtc_media_packet_source_set_format() must be called if @a webrtc has a media packet source.
  * @pre @a webrtc state must be set to #WEBRTC_STATE_IDLE.
  * @post @a webrtc state will be #WEBRTC_STATE_NEGOTIATING.
  * @see webrtc_create()
@@ -564,6 +564,7 @@ int webrtc_media_packet_source_push_packet(webrtc_h webrtc, unsigned int source_
  * @retval #WEBRTC_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation
  * @pre Add media source to @a webrtc to get @a source_id by calling webrtc_add_media_source().
+ * @pre webrtc_media_packet_source_set_format() must be called if @a source_id is a media source of #WEBRTC_MEDIA_SOURCE_TYPE_MEDIA_PACKET.
  * @see webrtc_set_transceiver_direction()
  */
 int webrtc_get_transceiver_direction(webrtc_h webrtc, unsigned int source_id, webrtc_media_type_e media_type, webrtc_transceiver_direction_e *direction);
@@ -582,6 +583,7 @@ int webrtc_get_transceiver_direction(webrtc_h webrtc, unsigned int source_id, we
  * @retval #WEBRTC_ERROR_INVALID_OPERATION Invalid operation
  * @retval #WEBRTC_ERROR_INVALID_STATE Invalid state
  * @pre Add media source to @a webrtc to get @a source_id by calling webrtc_add_media_source().
+ * @pre webrtc_media_packet_source_set_format() must be called if @a source_id is a media source of #WEBRTC_MEDIA_SOURCE_TYPE_MEDIA_PACKET.
  * @pre @a webrtc state must be set to #WEBRTC_STATE_IDLE.
  * @see webrtc_get_transceiver_direction()
  */
index 198c77251a7ac77909ba727acc0c32f3bffb5c24..2eeabf324f3b7d0db08c6ab22a3bfaf6d1e92fe3 100644 (file)
@@ -1,6 +1,6 @@
 Name:       capi-media-webrtc
 Summary:    A WebRTC library in Tizen Native API
-Version:    0.1.84
+Version:    0.1.85
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0