MSAudioLocalClientEvent Dictionary object

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Contains information about the quality events detected by the endpoint. It is described in [MS-QoE] Section 2.2.1.29.

Syntax

dictionary MSAudioLocalClientEvent : MSLocalClientEventBase {
             float         networkSendQualityEventRatio;
             float         networkDelayEventRatio;
             float         cpuInsufficientEventRatio;
             float         deviceHalfDuplexAECEventRatio;
             float         deviceRenderNotFunctioningEventRatio;
             float         deviceCaptureNotFunctioningEventRatio;
             float         deviceGlitchesEventRatio;
             float         deviceLowSNREventRatio;
             float         deviceLowSpeechLevelEventRatio;
             float         deviceClippingEventRatio;
             float         deviceEchoEventRatio;
             float         deviceNearEndToEchoRatioEventRatio;
             float         deviceRenderZeroVolumeEventRatio;
             float         deviceRenderMuteEventRatio;
             unsigned long deviceMultipleEndpointsEventCount;
             unsigned long deviceHowlingEventCount;
};

Standards information

• Object RTC (ORTC) API for WebRTC

MSAudioLocalClientEvent Dictionary

Member	Type	Description
cpuInsufficientEventRatio	float	Fraction of the call that the reporting endpoint detected the CPU resources available were insufficient and caused poor quality of the audio sent and received.
deviceCaptureNotFunctioningEventRatio	float	Fraction of the call that the reporting endpoint detected the capture device was not working properly.
deviceClippingEventRatio	float	Fraction of the call that the reporting endpoint detected clipping in the captured audio that caused poor quality of the audio being sent.
deviceEchoEventRatio	float	Fraction of the call that the reporting endpoint detected echo that caused poor quality of the audio being sent.
deviceGlitchesEventRatio	float	Fraction of the call that the reporting endpoint detected glitches or gaps in the audio played or captured that caused poor quality of the audio being sent or received.
deviceHalfDuplexAECEventRatio	float	Fraction of the call that the reporting endpoint detected issues and operated the acoustic echo canceller in half-duplex mode, which impacted the ability to have real-time two-way communication.
deviceHowlingEventCount	unsigned long	Number of times during the call that the reporting endpoint detected two or more endpoints in the same room or acoustic environment that caused poor quality audio in the form of howling or screeching audio.
deviceLowSNREventRatio	float	Fraction of the call that the reporting endpoint detected low speech to noise level that caused poor quality of the audio being sent.
deviceLowSpeechLevelEventRatio	float	Fraction of the call that the reporting endpoint detected low speech level that caused poor quality of the audio being sent.
deviceMultipleEndpointsEventCount	unsigned long	Number of times during the call that the reporting endpoint detected mutliple endpoints in the same room or acoustic environment.
deviceNearEndToEchoRatioEventRatio	float	Fraction of the call that the reporting endpoint detected a ratio of the near end signal level to the echo level that caused poor quality of the audio being sent.
deviceRenderMuteEventRatio	float	Fraction of the call that device render is muted.
deviceRenderNotFunctioningEventRatio	float	Fraction of the call that the reporting endpoint detected the render device was not working properly.
deviceRenderZeroVolumeEventRatio	float	Fraction of the call that device render volume is set to 0.
networkDelayEventRatio	float	Fraction of the call that the reporting endpoint detected the network delay was significant enough to impact the ability to have real-time two-way communication.
networkSendQualityEventRatio	float	Fraction of the call that the reporting endpoint detected the network was causing poor quality of the audio sent.

 

See also

Statistics extensions

Statistics API