Browse Source

Doc: Clarified default track message format

Paul-Louis Ageneau 3 years ago
parent
commit
023821a21f
2 changed files with 10 additions and 2 deletions
  1. 5 1
      DOC.md
  2. 5 1
      pages/content/pages/reference.md

+ 5 - 1
DOC.md

@@ -389,6 +389,8 @@ int rtcSetMessageCallback(int id, rtcMessageCallbackFunc cb)
 
 
 It is called when the channel receives a message. While it is set, messages can't be received with `rtcReceiveMessage`.
 It is called when the channel receives a message. While it is set, messages can't be received with `rtcReceiveMessage`.
 
 
+Track: By default, the track receives data as RTP packets.
+
 ```
 ```
 int rtcSetBufferedAmountLowCallback(int id, rtcBufferedAmountLowCallbackFunc cb)
 int rtcSetBufferedAmountLowCallback(int id, rtcBufferedAmountLowCallbackFunc cb)
 ```
 ```
@@ -425,7 +427,7 @@ The message is sent immediately if possible, otherwise it is buffered to be sent
 
 
 Data Channel and WebSocket: If the message may not be sent immediately due to flow control or congestion control, it is buffered until it can actually be sent. You can retrieve the current buffered data size with `rtcGetBufferedAmount`.
 Data Channel and WebSocket: If the message may not be sent immediately due to flow control or congestion control, it is buffered until it can actually be sent. You can retrieve the current buffered data size with `rtcGetBufferedAmount`.
 
 
-Track: There is no flow or congestion control, messages are never buffered and `rtcGetBufferedAmount` always returns 0.
+Track: By default, the track expects RTP packets. There is no flow or congestion control, packets are never buffered and `rtcGetBufferedAmount` always returns 0.
 
 
 #### rtcClose
 #### rtcClose
 
 
@@ -514,6 +516,8 @@ Return value: `RTC_ERR_SUCCESS` or a negative error code (In particular, `RTC_ER
 
 
 If `buffer` is `NULL`, the message is not copied and kept pending but the size is still written to `size`.
 If `buffer` is `NULL`, the message is not copied and kept pending but the size is still written to `size`.
 
 
+Track: By default, the track receives data as RTP packets.
+
 #### rtcGetAvailableAmount
 #### rtcGetAvailableAmount
 
 
 ```
 ```

+ 5 - 1
pages/content/pages/reference.md

@@ -392,6 +392,8 @@ int rtcSetMessageCallback(int id, rtcMessageCallbackFunc cb)
 
 
 It is called when the channel receives a message. While it is set, messages can't be received with `rtcReceiveMessage`.
 It is called when the channel receives a message. While it is set, messages can't be received with `rtcReceiveMessage`.
 
 
+Track: By default, the track receives data as RTP packets.
+
 ```
 ```
 int rtcSetBufferedAmountLowCallback(int id, rtcBufferedAmountLowCallbackFunc cb)
 int rtcSetBufferedAmountLowCallback(int id, rtcBufferedAmountLowCallbackFunc cb)
 ```
 ```
@@ -428,7 +430,7 @@ The message is sent immediately if possible, otherwise it is buffered to be sent
 
 
 Data Channel and WebSocket: If the message may not be sent immediately due to flow control or congestion control, it is buffered until it can actually be sent. You can retrieve the current buffered data size with `rtcGetBufferedAmount`.
 Data Channel and WebSocket: If the message may not be sent immediately due to flow control or congestion control, it is buffered until it can actually be sent. You can retrieve the current buffered data size with `rtcGetBufferedAmount`.
 
 
-Track: There is no flow or congestion control, messages are never buffered and `rtcGetBufferedAmount` always returns 0.
+Track: By default, the track expects RTP packets. There is no flow or congestion control, packets are never buffered and `rtcGetBufferedAmount` always returns 0.
 
 
 #### rtcClose
 #### rtcClose
 
 
@@ -517,6 +519,8 @@ Return value: `RTC_ERR_SUCCESS` or a negative error code (In particular, `RTC_ER
 
 
 If `buffer` is `NULL`, the message is not copied and kept pending but the size is still written to `size`.
 If `buffer` is `NULL`, the message is not copied and kept pending but the size is still written to `size`.
 
 
+Track: By default, the track receives data as RTP packets.
+
 #### rtcGetAvailableAmount
 #### rtcGetAvailableAmount
 
 
 ```
 ```