QualityUpdate element

(LyncDiagnostics element) (Lync SDN API Schema A)

Specifies the event that a SIP call has ended and contains an updated report of the quality metrics of individual media streams. These quality metrics for a stream may include updates provided by other endpoints during the call. By default, LDL raises this event (and thus reports the quality updates) only if the call quality is under the quality thresholds defined in the QoE database or in the LDL configuration file. Alterantively, you can configure Lync Dialog Listener (LDL) to send all quality updates. Quality updates are based on individual streams instead of the call.

Applies to: Lync 2013

Element information

Element type	Not defined
Namespace
Schema file	LyncSdnApi.Schema.A.xsd

Definition

<xs:element name="QualityUpdate" minOccurs="0" maxOccurs="unbounded">
    <xs:complexType>
        <xs:sequence>
            <xs:element name="From" type="QualityEndPointType"></xs:element>
            <xs:element name="To" type="QualityEndPointType"></xs:element>
            <xs:element name="Properties">
                <xs:complexType>
                    <xs:sequence maxOccurs="unbounded">
                        <xs:element name="RelativeOneWayAverage">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="VideoFrameLossRate"></xs:element>
                        <xs:element name="VideoPacketLossRate">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="BurstGapDensity"></xs:element>
                        <xs:element name="SpoiledTilePercentTotal">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="PacketLossRateMax"></xs:element>
                        <xs:element name="JitterInterArrival">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="Codec" type="CodecType"></xs:element>
                        <xs:element name="BurstGapDuration" type="xs:string"></xs:element>
                        <xs:element name="RecvSignalLevel" type="xs:string"></xs:element>
                        <xs:element name="SendListenMOS"></xs:element>
                        <xs:element name="RelativeOneWayBurstDensity">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="DegradationAvg">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="VGAQualityRatio"></xs:element>
                        <xs:element name="HealerPacketDropRatio" type="xs:string"></xs:element>
                        <xs:element name="EchoPercentSend" type="xs:string"></xs:element>
                        <xs:element name="SpoiledTilePercentAverage" type="xs:decimal"></xs:element>
                        <xs:element name="RecvListenMOSMin"></xs:element>
                        <xs:element name="RoundTrip">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="RecvListenMOS"></xs:element>
                        <xs:element name="PacketLossRate">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="RDPTileProcessingLatencyAverage">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="ConversationalMOS" type="xs:string"></xs:element>
                        <xs:element name="SendListenMOSMin"></xs:element>
                        <xs:element name="EchoReturn"></xs:element>
                        <xs:element name="LowResolutionCallPercent">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="VideoLocalFrameLossPercentageAvg">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="DegradationPacketLossAvg"></xs:element>
                        <xs:element name="BurstDuration"></xs:element>
                        <xs:element name="OverallAvgNetworkMOS" type="xs:string"></xs:element>
                        <xs:element name="JitterInterArrivalMax" type="xs:string"></xs:element>
                        <xs:element name="HDQualityRatio"></xs:element>
                        <xs:element name="LowFrameRateCallPercent">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="Protocol" type="xs:string"></xs:element>
                        <xs:element name="EchoEventCauses"></xs:element>
                        <xs:element name="DegradationMax" type="xs:string"></xs:element>
                        <xs:element name="RecvFrameRateAverage">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="OverallMinNetworkMOS" type="xs:string"></xs:element>
                        <xs:element name="AppliedBandwidthLimit" type="xs:unsignedInt" minOccurs="0"></xs:element>
                        <xs:element name="PacketUtilization" type="xs:string"></xs:element>
                        <xs:element name="BurstDensity"></xs:element>
                        <xs:element name="RDPTileProcessingLatencyBurstDensity">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="RatioConcealedSamplesAvg">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                        <xs:element name="RecvNoiseLevel" type="xs:string"></xs:element>
                        <xs:element name="FrameRate" type="xs:decimal"></xs:element>
                        <xs:element name="BitRateMax" type="xs:string"></xs:element>
                        <xs:element name="LocalFrameLossPercentageAvg" type="xs:string"></xs:element>
                        <xs:element name="DegradationJitterAvg" type="xs:string"></xs:element>
                        <xs:element name="BitRateAvg" type="xs:string"></xs:element>
                        <xs:element name="EchoPercentMicIn" type="xs:string"></xs:element>
                        <xs:element name="RoundTripMax" type="xs:string"></xs:element>
                        <xs:element name="DynamicCapabilityPercent">
                            <xs:attribute name="Limit" type="xs:decimal" use="optional" />
                        </xs:element>
                    </xs:sequence>
                </xs:complexType>
            </xs:element>
        </xs:sequence>
        <xs:attribute name="Type" type="xs:string" use="required" />
    </xs:complexType>
</xs:element>

Elements and attributes

If the schema defines specific requirements, such as sequence, minOccurs, maxOccurs, and choice, see the definition section.

Parent elements

Element	Type	Description
LyncDiagnostics	Not defined	The root element for output from the Lync SDN Manager.

Child elements

Element	Type	Description
From	QualityEndPointType	The source of the reported media stream.
Properties	Not defined	Properties of the media stream, including a selected set of quality metrics reported and thresholds that are used to determinine a bad call.
To	QualityEndPointType	Destination of the media stream.

Attributes

Attribute	Type	Required	Description	Possible values
Type	xs:string	required	Modelity or media type for which the quality metrics are reported. The supported options are audio, video and applicationsharing.	Values of the xs:string type.