AudioStreamStats - Vircadia API Docs

Description

Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts

Statistics for an audio stream.

Provided in properties of the AudioStats API.

Properties

Name	Type	Summary
dropCount	number	The number of silent or old audio frames dropped. Read-only.
framesAvailable	number	The number of audio frames containing data available. Read-only.
framesAvailableAvg	number	The time-weighted average of audio frames containing data available. Read-only.
framesDesired	number	The desired number of audio frames for the jitter buffer. Read-only.
lastStarveDurationCount	number	The most recent number of consecutive times that audio frames have not been available for processing. Read-only.
lossCount	number	The total number of audio packets lost. Read-only.
lossCountWindow	number	The number of audio packets lost since the previous statistic. Read-only.
lossRate	number	The ratio of the total number of audio packets lost to the total number of audio packets expected. Read-only.
lossRateWindow	number	The ratio of the number of audio packets lost to the number of audio packets expected since the previous statistic. Read-only.
overflowCount	number	The number of times that the audio ring buffer has overflowed. Read-only.
starveCount	number	The total number of times that audio frames have not been available for processing. Read-only.
timegapMsAvg	number	The overall average time between data packets, in ms. Read-only.
timegapMsAvgWindow	number	The recent average time between data packets, in ms. Read-only.
timegapMsMax	number	The overall maximum time between data packets, in ms. Read-only.
timegapMsMaxWindow	number	The recent maximum time between data packets, in ms. Read-only.
unplayedMsMax	number	The duration of audio waiting to be played, in ms. Read-only.

Signals

Name	Summary
`dropCountChanged`	Triggered when the number of silent or old audio frames dropped changes.
`framesAvailableAvgChanged`	Triggered when the time-weighted average of audio frames containing data available changes.
`framesAvailableChanged`	Triggered when the number of audio frames containing data available changes.
`framesDesiredChanged`	Triggered when the desired number of audio frames for the jitter buffer changes.
`lastStarveDurationCountChanged`	Triggered when the most recenbernumber of consecutive times that audio frames have not been available for processing changes.
`lossCountChanged`	Triggered when the total number of audio packets lost changes.
`lossCountWindowChanged`	Triggered when the number of audio packets lost since the previous statistic changes.
`lossRateChanged`	Triggered when the ratio of the total number of audio packets lost to the total number of audio packets expected changes.
`lossRateWindowChanged`	Triggered when the ratio of the number of audio packets lost to the number of audio packets expected since the previous statistic changes.
`overflowCountChanged`	Triggered when the number of times that the audio ring buffer has overflowed changes.
`starveCountChanged`	Triggered when the total number of times that audio frames have not been available for processing changes.
`timegapMsAvgChanged`	Triggered when the overall average time between data packets changes.
`timegapMsAvgWindowChanged`	Triggered when the recent average time between data packets changes.
`timegapMsMaxChanged`	Triggered when the overall maximum time between data packets changes.
`timegapMsMaxWindowChanged`	Triggered when the recent maximum time between data packets changes.
`unplayedMsMaxChanged`	Triggered when the duration of audio waiting to be played changes.

Signal Details

dropCountChanged( dropCount )
Returns: Signal

Triggered when the number of silent or old audio frames dropped changes.

Parameters

Name	Type	Description
`dropCount`	number	The number of silent or old audio frames dropped.

framesAvailableAvgChanged( framesAvailableAvg )
Returns: Signal

Triggered when the time-weighted average of audio frames containing data available changes.

Parameters

Name	Type	Description
`framesAvailableAvg`	number	The time-weighted average of audio frames containing data available.

framesAvailableChanged( framesAvailable )
Returns: Signal

Triggered when the number of audio frames containing data available changes.

Parameters

Name	Type	Description
`framesAvailable`	number	The number of audio frames containing data available.

framesDesiredChanged( framesDesired )
Returns: Signal

Triggered when the desired number of audio frames for the jitter buffer changes.

Parameters

Name	Type	Description
`framesDesired`	number	The desired number of audio frames for the jitter buffer.

lastStarveDurationCountChanged( lastStarveDurationCount )
Returns: Signal

Triggered when the most recenbernumber of consecutive times that audio frames have not been available for processing changes.

Parameters

Name	Type	Description
`lastStarveDurationCount`	number	The most recent number of consecutive times that audio frames have not been available for processing.

lossCountChanged( lossCount )
Returns: Signal

Triggered when the total number of audio packets lost changes.

Parameters

Name	Type	Description
`lossCount`	number	The total number of audio packets lost.

lossCountWindowChanged( lossCountWindow )
Returns: Signal

Triggered when the number of audio packets lost since the previous statistic changes.

Parameters

Name	Type	Description
`lossCountWindow`	number	The number of audio packets lost since the previous statistic.

lossRateChanged( lossRate )
Returns: Signal

Triggered when the ratio of the total number of audio packets lost to the total number of audio packets expected changes.

Parameters

Name	Type	Description
`lossRate`	number	The ratio of the total number of audio packets lost to the total number of audio packets expected.

lossRateWindowChanged( lossRateWindow )
Returns: Signal

Triggered when the ratio of the number of audio packets lost to the number of audio packets expected since the previous statistic changes.

Parameters

Name	Type	Description
`lossRateWindow`	number	The ratio of the number of audio packets lost to the number of audio packets expected since the previous statistic.

overflowCountChanged( overflowCount )
Returns: Signal

Triggered when the number of times that the audio ring buffer has overflowed changes.

Parameters

Name	Type	Description
`overflowCount`	number	The number of times that the audio ring buffer has overflowed.

starveCountChanged( starveCount )
Returns: Signal

Triggered when the total number of times that audio frames have not been available for processing changes.

Parameters

Name	Type	Description
`starveCount`	number	The total number of times that audio frames have not been available for processing.

timegapMsAvgChanged( timegapMsAvg )
Returns: Signal

Triggered when the overall average time between data packets changes.

Parameters

Name	Type	Description
`timegapMsAvg`	number	The overall average time between data packets, in ms.

timegapMsAvgWindowChanged( timegapMsAvgWindow )
Returns: Signal

Triggered when the recent average time between data packets changes.

Parameters

Name	Type	Description
`timegapMsAvgWindow`	number	The recent average time between data packets, in ms.

timegapMsMaxChanged( timegapMsMax )
Returns: Signal

Triggered when the overall maximum time between data packets changes.

Parameters

Name	Type	Description
`timegapMsMax`	number	The overall maximum time between data packets, in ms.

timegapMsMaxWindowChanged( timegapMsMaxWindow )
Returns: Signal

Triggered when the recent maximum time between data packets changes.

Parameters

Name	Type	Description
`timegapMsMaxWindow`	number	The recent maximum time between data packets, in ms.

unplayedMsMaxChanged( unplayedMsMax )
Returns: Signal

Triggered when the duration of audio waiting to be played changes.

Parameters

Name	Type	Description
`unplayedMsMax`	number	The duration of audio waiting to be played, in ms.