Browse Source

Doc: Added rtcGetMaxDataChannelStream to C API reference

Paul-Louis Ageneau 3 years ago
parent
commit
1f7db02395
2 changed files with 26 additions and 2 deletions
  1. 13 1
      DOC.md
  2. 13 1
      pages/content/pages/reference.md

+ 13 - 1
DOC.md

@@ -339,7 +339,7 @@ If `buffer` is `NULL`, the address is not copied but the size is still returned.
 int rtcGetSelectedCandidatePair(int pc, char *local, int localSize, char *remote, int remoteSize)
 ```
 
-Retrieve the currently selected candidate pair. The call may fail if the state is not `RTC_CONNECTED`, and the selected candidate pair might change if the state is not `RTC_COMPLETED`.
+Retrieves the currently selected candidate pair. The call may fail if the state is not `RTC_CONNECTED`, and the selected candidate pair might change if the state is not `RTC_COMPLETED`.
 
 Arguments:
 
@@ -353,6 +353,18 @@ Return value: the maximun length of strings copied in buffers (including the ter
 
 If `local`, `remote`, or both, are `NULL`, the corresponding candidate is not copied, but the maximum length is still returned.
 
+#### rtcGetMaxDataChannelStream
+```
+int rtcGetMaxDataChannelStream(int pc);
+```
+
+Retrieves the maximum stream ID a Data Channel may use. It is useful to create user-negotiated Data Channels with `negotiated=true` and `manualStream=true`. The maximum is negotiated during connection, therefore the final value after connection might be lower than before connection if the remote maximum is lower.
+
+Arguments:
+- `pc`: the Peer Connection identifier
+
+Return value: the maximum stream ID (`stream` for a Data Channel may be set from 0 to this value included) or a negative error code
+
 ### Channel (Common API for Data Channel, Track, and WebSocket)
 
 The following common functions might be called with a generic channel identifier. It may be the identifier of either a Data Channel, a Track, or a WebSocket.

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

@@ -343,7 +343,7 @@ If `buffer` is `NULL`, the address is not copied but the size is still returned.
 int rtcGetSelectedCandidatePair(int pc, char *local, int localSize, char *remote, int remoteSize)
 ```
 
-Retrieve the currently selected candidate pair. The call may fail if the state is not `RTC_CONNECTED`, and the selected candidate pair might change if the state is not `RTC_COMPLETED`.
+Retrieves the currently selected candidate pair. The call may fail if the state is not `RTC_CONNECTED`, and the selected candidate pair might change if the state is not `RTC_COMPLETED`.
 
 Arguments:
 
@@ -357,6 +357,18 @@ Return value: the maximun length of strings copied in buffers (including the ter
 
 If `local`, `remote`, or both, are `NULL`, the corresponding candidate is not copied, but the maximum length is still returned.
 
+#### rtcGetMaxDataChannelStream
+```
+int rtcGetMaxDataChannelStream(int pc);
+```
+
+Retrieves the maximum stream ID a Data Channel may use. It is useful to create user-negotiated Data Channels with `negotiated=true` and `manualStream=true`. The maximum is negotiated during connection, therefore the final value after connection might be lower than before connection if the remote maximum is lower.
+
+Arguments:
+- `pc`: the Peer Connection identifier
+
+Return value: the maximum stream ID (`stream` for a Data Channel may be set from 0 to this value included) or a negative error code
+
 ### Channel (Common API for Data Channel, Track, and WebSocket)
 
 The following common functions might be called with a generic channel identifier. It may be the identifier of either a Data Channel, a Track, or a WebSocket.