MSAudioRecvPayload 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 relating to audio reception. It is described in [MS-QoE] 2.2.1.14.

Syntax

typedef (MSVideoRecvPayload or MSAudioRecvPayload) MSInboundPayload;
dictionary MSAudioRecvPayload : MSPayloadBase {
             unsigned long     samplingRate;
             MSAudioRecvSignal signal;
             float             packetReorderRatio;
             long              packetReorderDepthAvg;
             long              packetReorderDepthMax;
             float             burstLossLength1;
             float             burstLossLength2;
             float             burstLossLength3;
             float             burstLossLength4;
             float             burstLossLength5;
             float             burstLossLength6;
             float             burstLossLength7;
             float             burstLossLength8OrHigher;
             float             fecRecvDistance1;
             float             fecRecvDistance2;
             float             fecRecvDistance3;
             float             ratioConcealedSamplesAvg;
             float             ratioStretchedSamplesAvg;
             float             ratioCompressedSamplesAvg;
};

Standards information

• Object RTC (ORTC) API for WebRTC

MSAudioRecvPayload Dictionary

Member	Type	Description
burstLossLength1	float	Ratio of lost single lost packet over the total number of packets for the session.
burstLossLength2	float	Ratio of two consecutive lost packets over the total number of packets for the session.
burstLossLength3	float	Ratio of three consecutive lost packets over the total number of packets for the session.
burstLossLength4	float	Ratio of four consecutive lost packets over the total number of packets for the session.
burstLossLength5	float	Ratio of five consecutive lost packets over the total number of packets for the session.
burstLossLength6	float	Ratio of six consecutive lost packets over the total number of packets for the session.
burstLossLength7	float	Ratio of seven consecutive lost packets over the total number of packets for the session.
burstLossLength8OrHigher	float	Ratio of eight or more consecutive lost packets over the total number of packets for the session.
fecRecvDistance1	long	Percentage of session where packets with FEC distance of 1 were received.
fecRecvDistance2	long	Percentage of session where packets with FEC distance of 2 were received.
fecRecvDistance3	long	Percentage of session where packets with FEC distance of 3 were received.
packetReorderDepthAvg	long	Average of the number of packets between when the current packet and the out-of-sequence packet was received.
packetReorderDepthMax	long	Maximum of the number of packets between when the current packet and the out-of-sequence packet was received.
packetReorderRatio	float	Ratio of packets received that were out of sequence during the session.
ratioCompressedSamplesAvg	float	Ratio of the number of audio frames with samples that have been compressed to compensate for jitter or loss to the total number of audio frames. Described in [MS-QoE] Section 2.2.1.12.1.
ratioConcealedSamplesAvg	float	Ratio of the number of audio frames with samples generated by packet loss concealment to the total number of audio frames. Described in [MS-QoE] Section 2.2.1.12.1.
ratioStretchedSamplesAvg	float	Ratio of the number of audio frames with samples that have been stretched to compensate for jitter or loss to the total number of audio frames. Described in [MS-QoE] Section 2.2.1.12.1.
samplingRate	unsigned long	Samples per second.
signal	MSAudioRecvSignal,	Metrics regarding signal level and noise.

 

See also

Statistics extensions

Statistics API