Properties element (StartOrUpdateType complexType)

(Lync SDN API Schema A)

Properties of the started or updated media stream.

Applies to: Lync 2013

Element information

Element type

Not defined

Namespace

Schema file

LyncSdnApi.Schema.A.xsd

Definition

<xs:element name="Properties" minOccurs="0">
    <xs:complexType>
        <xs:sequence>
            <xs:element name="Protocol" type="xs:string"></xs:element>
            <xs:element name="Codec" type="CodecType" maxOccurs="unbounded"></xs:element>
        </xs:sequence>
    </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

Start

StartOrUpdateType

Event that a media stream is started. Every Start element contains a report about a particular media stream. This event is raised when the call is established, i.e., when the call is picked up and the SIP INVITE is answered with a 200 OK response. The LyncDiagnostics element will not contain any event elements (e.g., Invite, LRSInvite, Start, Update, etc.), when all media streams are inactive (usually when the call is on-hold).

Update

StartOrUpdateType

Event that a media stream is started. Every Start element contains a report about a particular media stream. This event is raised when the call is established, i.e., when the call is picked up and the SIP INVITE is answered with a 200 OK response. The LyncDiagnostics element will not contain any event elements (e.g., Invite, LRSInvite, Start, Update, etc.), when all media streams are inactive (usually when the call is on-hold).

Child elements

Element

Type

Description

Codec

CodecType

Codec and estimates for the bandwidth that the codecs will use. This list contains all codecs that are agreed upon by the two endpoints. Both end-points may decide to switch amoung these codecs at any time (without additional signalling).

Protocol

xs:string

Transmission protocol of the media stream such as TCP or UDP.

Attributes

None.