Skip to main content

Interface: IWebrtcIngestStats

The statistics for the session. Useful for indicating stability issues to the sender.

Properties​

audio​

• Optional audio: RTCStatsReport

RTCStatsReport for audio (docs link)

audioScore​

• Optional audioScore: number

A score between 0-10 of how the audio stream is performing; 0 being the worst possible performance, 10 being best the possible. Note that score not only looks at connection but also how well the local sender's device encoder is working.

broadcastScore​

• Optional broadcastScore: number

A score between 0-10 of how the broadcast is performing; 0 being the worst possible performance, 10 being best the possible.

channelId​

• Optional channelId: string

Value of channelId, only used if additional stream auth is used

id​

• Optional id: string

The session ID, unique per sender session

score​

• Optional score: number

A score between 0-10 of how the entire session is doing; 0 being the worst possible performance, 10 being best the possible. This takes all aspects of the session into account.

streamKey​

• Optional streamKey: string

Used if channelId/additional auth is not used.

url​

• url: string

Url used to connect

version​

• version: string

WebRTC Ingest SDK version.

video​

• Optional video: RTCStatsReport

RTCStatsReport for video (docs link)

videoScore​

• Optional videoScore: number

A score between 0-10 of how the video stream is performing; 0 being the worst possible performance, 10 being best the possible. Note that score not only looks at connection but also how well the local sender's device encoder is working.

webrtc​

• Optional webrtc: RTCStatsReport

RTCStatsReport for webrtc (docs link)

webrtcUrl​

• Optional webrtcUrl: string

Url to webrtc host