Typedefs
- InitOptions :
Object - RoomOptions :
Object - CreateLocalTrackOptions :
Object - TrackStats
- PeerConnectionStats
InitOptions : Object
Represents the options to create a ProCONF Connection.
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| domain | string | The domain for backend server deployment. |
| [loglevel] | LogLevel | The log level for the ProCONF SDK. |
| [pcStatsInterval] | number | Stats polling interval for ProCONF SDK. |
RoomOptions : Object
Represents the options to create a ProCONF Room.
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| [roomName] | string | The name of the room to be created. If not provided, a random room name will be generated. |
| [participantName] | string | The name of the participant. If not provided, a random participant name will be generated. |
CreateLocalTrackOptions : Object
Represents the options to create a media track.
Kind: global typedef
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| [devices] | Array.<string> | array with the devices - "desktop", "video" and "audio". If not specified all available devices will be fetched | |
| [videoName] | string | The name to be provided for the video track | |
| [audioName] | string | The name to be provided for the audio track | |
| [cameraDeviceId] | string | "'default'" | the deviceID for the video device that is going to be used |
| [micDeviceId] | string | "'default'" | the deviceID for the audio device that is going to be used |
TrackStats
TrackStats interface represents the structure for statistics data related to a track.
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| trackId | string | The unique identifier for the track |
| trackSid | string | The server identifier for the track |
| timestamp | number | The timestamp when the statistics were collected |
| ssrc | string | The synchronization source for the track |
| packetsLost | number | The number of packets lost |
| codec | string | The codec used for the track |
| [bytesReceived] | number | The number of bytes received (optional) |
| [packetsReceived] | number | The number of packets received (optional) |
| roundTripTime | number | The round trip time |
| [dimensions] | Object | The dimensions of the track (optional) |
| [captureDimensions] | Object | The captured dimensions of the track (optional) |
| [frameRate] | number | The frame rate of the track (optional) |
| [captureFrameRate] | number | The captured frame rate of the track (optional) |
| [audioLevel] | number | The audio level of the track (optional) |
| [jitter] | number | The jitter of the track (optional) |
PeerConnectionStats
PeerConnectionStats interface represents the structure for statistics data related to both local and remote audio and video tracks.
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| peerConnectionId | string | The unique identifier for the peer connection |
| localAudioTrackStats | Array.<TrackStats> | An array of statistics for local audio tracks |
| localVideoTrackStats | Array.<TrackStats> | An array of statistics for local video tracks |
| remoteAudioTrackStats | Array.<TrackStats> | An array of statistics for remote audio tracks |
| remoteVideoTrackStats | Array.<TrackStats> | An array of statistics for remote video tracks |