webrtc_doc: Add callback operation description of the data channel module 23/272823/3
authorSangchul Lee <sc11.lee@samsung.com>
Fri, 25 Mar 2022 06:23:34 +0000 (15:23 +0900)
committerSangchul Lee <sc11.lee@samsung.com>
Tue, 29 Mar 2022 11:43:36 +0000 (20:43 +0900)
[Version] 0.3.76
[Issue Type] Documentation

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

index 16a8daf13f6a4cd3c8dd77187adf73a621947ea1..60f080b59d995d60dd4dfc7030e03d9bab65423e 100644 (file)
  * - send/receive bytes or string data to/from the data channel
  * - get notified various states of the data channel
  *
+ * @subsection CAPI_MEDIA_WEBRTC_DATA_CHANNEL_CALLBACK_OPERATIONS Callback(Event) Operations
+ * The callback mechanism is used to notify the application about significant webrtc data channel events.
+ * <div><table class="doxtable" >
+ *     <tr>
+ *         <th><b>REGISTER</b></th>
+ *         <th><b>UNREGISTER</b></th>
+ *         <th><b>CALLBACK</b></th>
+ *         <th><b>DESCRIPTION</b></th>
+ *     </tr>
+ *     <tr>
+ *         <td>webrtc_set_data_channel_cb()</td>
+ *         <td>webrtc_unset_data_channel_cb()</td>
+ *         <td>webrtc_data_channel_cb()</td>
+ *         <td>This callback is used to notify that a data channel is created to the connection by the remote peer</td>
+ *     </tr>
+ *     <tr>
+ *         <td>webrtc_data_channel_set_open_cb()</td>
+ *         <td>webrtc_data_channel_unset_open_cb()</td>
+ *         <td>webrtc_data_channel_open_cb()</td>
+ *         <td>This callback is used to notify that the data channel is opened</td>
+ *     </tr>
+ *     <tr>
+ *         <td>webrtc_data_channel_set_message_cb()</td>
+ *         <td>webrtc_data_channel_unset_message_cb()</td>
+ *         <td>webrtc_data_channel_message_cb()</td>
+ *         <td>This callback is used to notify that a message is received from the data channel</td>
+ *     </tr>
+ *     <tr>
+ *         <td>webrtc_data_channel_set_error_cb()</td>
+ *         <td>webrtc_data_channel_unset_error_cb()</td>
+ *         <td>webrtc_data_channel_error_cb()</td>
+ *         <td>This callback is used to notify that an error occurs from the data channel</td>
+ *     </tr>
+ *     <tr>
+ *         <td>webrtc_data_channel_set_close_cb()</td>
+ *         <td>webrtc_data_channel_unset_close_cb()</td>
+ *         <td>webrtc_data_channel_close_cb()</td>
+ *         <td>This callback is used to notify that the data channel is closed</td>
+ *     </tr>
+ *     <tr>
+ *         <td>webrtc_data_channel_set_buffered_amount_low_cb()</td>
+ *         <td>webrtc_data_channel_unset_buffered_amount_low_cb()</td>
+ *         <td>webrtc_data_channel_buffered_amount_low_cb()</td>
+ *         <td>This callback is used to notify that the number of bytes of data currently queued to be sent over the data channel falls below the threshold</td>
+ *     </tr>
+ * </table></div>
+ *
 */
 
 /**
index 1826b4da47376be0f2363764f93635693f0e216f..f2726013453844a0d0a44df0d49e71f7bc9b5e10 100644 (file)
@@ -1,6 +1,6 @@
 Name:       capi-media-webrtc
 Summary:    A WebRTC library in Tizen Native API
-Version:    0.3.75
+Version:    0.3.76
 Release:    0
 Group:      Multimedia/API
 License:    Apache-2.0