...
| Parameter | Description |
|---|---|
| appKey | Server application key to communicate with backend server while session goes |
| mediaProviders | List of suppoted publication or playback technologies |
| clientVersion | Client SDK version |
| clientOSVersion | Client OS version |
| clientBrowserVersion | Client browser version |
...
| Parameter | Description |
|---|---|
| mediaSessionId | WebRTC media session Id |
| name | Stream name to play |
| published | Stream is published |
| hasVideo | Stream has video |
| hasAudio | Stream has audio |
| status | Stream status |
| audioCodec | Audio codec |
| videoCodec | Video codec |
| info | Stream status text description |
| record | Stream is recorded on server |
| width | Picture width (set while playing if 0) |
| height | Picture height (set while playing if 0) |
| bitrate | Bitrate (will set while playing if 0) |
| minBitrate | Minimum bitrate (no limits if 0) |
| maxBitrate | Maximum bitrate (no limits if 0) |
| quality | Stream quality |
| createDate | Creation date as integer |
| streamInfo | Additional stream information |
| mediaProvider | Publishing technology |
Publishing/playback stream metrics
Since build 5.2.576, main publishing/playback stream metrics were added to messages inboundVideoRate, outboundVideoRate, which are intended to control publishing/playback channel quality:
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"message":"inboundVideoRate",
"data":
[
{
"mediaSessionId":"a12145d0-7eee-11ea-9833-9da59e0cc100",
"videoRate":704856,
"fps":31,
"nack":0,
"pli":0,
"lostPackets":0,
"width":640,
"height":360
}
]
}
{
"message":"outboundVideoRate",
"data":
[
{
"mediaSessionId":"0040ed40-7eef-11ea-9833-9da59e0cc100",
"videoRate":685256,
"fps":30,
"nack":0,
"pli":13,
"lostPackets":0,
"width":640,
"height":360
}
]
} |
Messages parameters
| Parameter | Description |
|---|---|
| mediaSessionId | WebRTC media session Id |
| videoRate | Video bitrate, bps |
| fps | FPS |
| nack | NACK packets count |
| pli | PLI queries count |
| lostPackets | Lost packets count |
| width | Picture width |
| height | Picture height |
Stream availability checking
To check if a stream is available on the server, client should send availableStream message
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"mediaSessionId": "2f693140-7d54-11eb-91fe-1fd0fb28f180",
"name": "test"
}
] |
Message parameters
| Parameter | Description |
|---|---|
| mediaSessionId | WebRTC media session Id |
| name | Stream name |
The server will respond with availableStream message
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"status": "false",
"info": "Restricted access",
"id": "2f693140-7d54-11eb-91fe-1fd0fb28f180"
}
] |
Message parameters
| Parameter | Description |
|---|---|
| status | true if stream is available false if stream is not available |
| info | The unavailability reason phrase |
| id | WebRTC media session Id |
The unavailability reason phrase is supported since build 5.2.911