AudioStats

Description

Audio stats from the client.

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

Classes

AudioStreamStats

Properties

Name Type Summary
pingMs number Read-only.
inputReadMsMax number Read-only.
inputUnplayedMsMax number Read-only.
outputUnplayedMsMax number Read-only.
sentTimegapMsMax number Read-only.
sentTimegapMsAvg number Read-only.
sentTimegapMsMaxWindow number Read-only.
sentTimegapMsAvgWindow number Read-only.
clientStream AudioStats.AudioStreamStats Read-only.
mixerStream AudioStats.AudioStreamStats Read-only.

Signals

Name Summary
clientStreamChanged
injectorStreamsChanged
inputReadMsMaxChanged
inputUnplayedMsMaxChanged
mixerStreamChanged
outputUnplayedMsMaxChanged
pingMsChanged
sentTimegapMsAvgChanged
sentTimegapMsAvgWindowChanged
sentTimegapMsMaxChanged
sentTimegapMsMaxWindowChanged

Signal Details

clientStreamChanged( )
Returns: Signal

injectorStreamsChanged( )
Returns: Signal

inputReadMsMaxChanged( inputReadMsMax )
Returns: Signal

Parameters

Name Type Description
inputReadMsMax number
inputUnplayedMsMaxChanged( inputUnplayedMsMax )
Returns: Signal

Parameters

Name Type Description
inputUnplayedMsMax number
mixerStreamChanged( )
Returns: Signal

outputUnplayedMsMaxChanged( outputUnplayedMsMax )
Returns: Signal

Parameters

Name Type Description
outputUnplayedMsMax number
pingMsChanged( pingMs )
Returns: Signal

Parameters

Name Type Description
pingMs number
sentTimegapMsAvgChanged( sentTimegapMsAvg )
Returns: Signal

Parameters

Name Type Description
sentTimegapMsAvg number
sentTimegapMsAvgWindowChanged( sentTimegapMsAvgWindow )
Returns: Signal

Parameters

Name Type Description
sentTimegapMsAvgWindow number
sentTimegapMsMaxChanged( sentTimegapMsMax )
Returns: Signal

Parameters

Name Type Description
sentTimegapMsMax number
sentTimegapMsMaxWindowChanged( sentTimegapMsMaxWindow )
Returns: Signal

Parameters

Name Type Description
sentTimegapMsMaxWindow number