Skip to main content

Interface: Statistics

Contains internal statistics.

Note that this object will have some undocumented properties, used internally or temporarily, for monitoring and improving the performance of the service.

Properties​

audioBitRate?​

optional audioBitRate: number

Current audio bitrate in bits/second.

audioCodec?​

optional audioCodec: string

Current audio codec being used.

audioRenditionId?​

optional audioRenditionId: number

Id of current audio rendition subscribed to.

bufferingEventsCount​

bufferingEventsCount: number

Total number of buffering events since instantiation.

bufferTime​

bufferTime: number

Current target buffer time if using dynamic buffer. Otherwise, this is the statically set buffer time from instantiation.

bufferTimeAdjustmentCount​

bufferTimeAdjustmentCount: number

Number of time buffer time has been adjusted. This will only happen when using dynamic buffer time (different min/max values of bufferTime).

bytesReceived​

bytesReceived: number

Counter of number of bytes received.

channelGroupId?​

optional channelGroupId: string

Channel group being subscribed to.

channelId​

channelId: string

Current channel ID being subscribed to.

clientId​

clientId: string

Unlike sessionId, clientId will remain the same even after reconnections and represents this unique Vindral instance.

connectCount​

connectCount: number

Total number of connections that have been established since instantiation.

connectionAttemptCount​

connectionAttemptCount: number

Total number of connection attempts since instantiation.

errorCount​

errorCount: number

The total amount of errors being spawned. Note that some media errors can trigger thousands of errors for a single client in a few seconds before recovering. Therefore, consider the number of viewers with errors, not just the total amount. Also, consider the median instead of the mean for average calculation.

estimatedBandwidth​

estimatedBandwidth: number

A very rough initial estimation of minimum available bandwidth.

expectedAudioBitRate?​

optional expectedAudioBitRate: number

Currently expected audio bit rate according to metadata in bits/s.

expectedVideoBitRate?​

optional expectedVideoBitRate: number

Currently expected video bit rate according to metadata in bits/s.

fatalQosCount​

fatalQosCount: number

Number of fatal quality of service events.

frameRate?​

optional frameRate: [number, number]

Frame rate. Example: "frameRate": [24000, 1001].

ip?​

optional ip: string

IP of the client.

isAbrEnabled​

isAbrEnabled: boolean

True if adaptive bitrate (ABR) is enabled.

language?​

optional language: string

Current language. For non-multi language streams, this will often be unset.

renditionLevelChangeCount​

renditionLevelChangeCount: number

Total count of rendition level changes (quality downgrades/upgrades).

rtt​

rtt: MinMaxAverage

RTT (round trip time) between client and server(s).

sessionId?​

optional sessionId: string

A session is bound to a connection. If the client reconnects for any reason (e.g. coming back from inactivity or a problem with network on client side), a new sessionId will be used.

timeSpentBuffering​

timeSpentBuffering: number

Time in milliseconds spent in buffering state. Note that this value will increase while in background if buffering when leaving foreground.

timeSpentRatio​

timeSpentRatio: object

Ratio of time being spent on different bitrates. Example: "timeSpentRatio": { "1160000": 0.2, "2260000": 0.8 } shows 20% spent on 1.16 Mbps, 80% spent on 2.26 Mbps.

Index Signature​

[bitRate: string]: number

timeToFirstFrame?​

optional timeToFirstFrame: number

Time in milliseconds from instantiation to playback of video and audio being started. Note that an actual frame render often happens much quicker, but that is not counted as TTFF.

uptime​

uptime: number

How long in milliseconds since the instance was created.

url​

url: string

URL being used for connecting to the stream.

version​

version: string

Version of the @vindral/web-sdk being used.

videoBitRate?​

optional videoBitRate: number

Current video bitrate in bits/second.

videoCodec?​

optional videoCodec: string

Current video codec being used.

videoHeight?​

optional videoHeight: number

Height of current video rendition (if any).

videoRenditionId?​

optional videoRenditionId: number

Id of current video rendition subscribed to.

videoWidth?​

optional videoWidth: number

Width of current video rendition (if any).