Skip to content

Commit

Permalink
Updated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
paullouisageneau committed Sep 27, 2023
1 parent b144cfb commit 07e8bba
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 0 deletions.
28 changes: 28 additions & 0 deletions DOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,20 @@ Arguments:

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

#### rtcGetRemoteMaxMessageSize

```
int rtcGetRemoteMaxMessageSize(int pc)
```

Retrieves the maximum message size for data channels on the peer connection as negotiated with the remote peer.

Arguments:

- `pc`: the Peer Connection identifier

Return value: the maximum message size for data channels 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.
Expand Down Expand Up @@ -519,6 +533,20 @@ Arguments:

Return value: `true` if the channel exists and is closed (not open and not connecting), `false` otherwise

#### rtcGetMaxMessageSize

```
int rtcGetMaxMessageSize(int id)
```

Retrieves the maximum message size for the channel.

Arguments:

- `id`: the channel identifier

Return value: the maximum message size or a negative error code

#### rtcGetBufferedAmount

```
Expand Down
28 changes: 28 additions & 0 deletions pages/content/pages/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -386,6 +386,20 @@ Arguments:

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

#### rtcGetRemoteMaxMessageSize

```
int rtcGetRemoteMaxMessageSize(int pc)
```

Retrieves the maximum message size for data channels on the peer connection as negotiated with the remote peer.

Arguments:

- `pc`: the Peer Connection identifier

Return value: the maximum message size for data channels 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.
Expand Down Expand Up @@ -522,6 +536,20 @@ Arguments:

Return value: `true` if the channel exists and is closed (not open and not connecting), `false` otherwise

#### rtcGetMaxMessageSize

```
int rtcGetMaxMessageSize(int id)
```

Retrieves the maximum message size for the channel.

Arguments:

- `id`: the channel identifier

Return value: the maximum message size or a negative error code

#### rtcGetBufferedAmount

```
Expand Down

0 comments on commit 07e8bba

Please sign in to comment.