<?xml>
The root element for XML, and the first element of an MSML document. Sent by the client.
Parent element: None.
Child elements: None.
Attributes
version Mandatory. Supported value is “1.0”. Any other value will generate an error.
encoding Optional. Anything other than “US-ASCII” will generate an error. Default is “US-ASCII”.
standalone Optional. Supported value is “yes” (the document is self-contained). A value of “no” will return an error. Default is “yes”.

<asn>
Controls active speaker notification on a conference, or changes the properties of active speaker notification. Sent by the client.
Parent element: <audiomix>.
Child elements: None.
Attributes
ri Mandatory. Specifies the minimum interval in seconds that must elapse between reports of changes to the list of active speakers. Format is number units, where number is a number of the form n or n.n, and units is either s (for seconds) or ms (for msec). Supported values are 0 and 2–600 seconds, where a value of 0 disables active speaker notification.
cvd:asth A Convedia extension. Optional. Sets the active speaker threshold in dBm0, which is the level of audio energy a speaker must have to be considered an active speaker. If this threshold is not exceeded, a speaker will not be reported as an active speaker even if the speaker is one of the N-loudest participants. Range is 0 to –96, where –96 dBm0 represents silence. Default is –96 (that is, the threshold is disabled).
<audiomix>
Defines the parameters for mixing audio media in a conference. Sent by the client.
Parent element: <createconference>
<destroyconference>
<modifyconference>
Child elements: <asn> <n-loudest>
Attributes
id Mandatory. An ID of up to 64 alphanumeric characters uniquely identifying the audio mixer.

<clamp> Filters DTMF tones out of a media stream. Sent by the client.
Parent element: <stream>
Child elements: None.
Attributes
dtmf Optional. Specifies whether to remove inband DTMF tones from the media stream. Supported values are true and false. Default is true.
tone Not supported.

<confid>
Reports a media server–assigned conference identifier to the control agent. Sent by the media server.
Parent element: <result>
Child elements: None.
Attributes
This element has no attributes.

<createconference>
Allocates media processing resources for audio or multimedia conferences. Sent by the client.
Parent element: <msml>
Child elements: <audiomix> <videolayout> At least one of <audiomix> and <videolayout> must be included as content of <createconference>.
Attributes
Name Optional. An alphanumeric name of up to 64 characters, which is used to name the conference (for example, myconf1). Do not include the object class in this name. If you do not assign a name, the media server generates and assigns one. Media server–assigned names begin with the string “msml.”, for example msml.1. That, together with the conf object class name, forms a unique full identifier (for example, conf:myconf1 or conf:msml.1) for the conference. Any events generated by the conference are correlated with this identifier.
deletewhen Mandatory. Specifies under what conditions the media server will delete this conference. Values are nomedia and nocontrol. The default is nomedia. If nomedia is specified, the media server deletes the conference when: • At least one connection was joined to the conference after the conference was created AND • There are currently no connections joined to the conference. When a conference is deleted due to a nomedia condition, a msml.conf.nomedia event is sent on the SIP dialog of the SIP request that contained the <createconference> element. If nocontrol is specified, the media server deletes the conference when the SIP dialog that created it no longer exists. All connections to the conference are removed, and a SIP BYE is sent to each connection. Because the control session no longer exists, no event is sent to the control agent.
term Specifies whether to send a BYE message to all dialogs associated with the conference when the conference ends for any reason. Supported values are true and false. Default is true.
mark A token that can be used to identify execution progress in the case of errors. The value of the mark attribute from the last successfully executed MSML element is returned in an error response. Therefore the value of all mark attributes within an MSML document should be unique.

<description>
Parent element: <result>
Child elements: None.
Attributes
This element has no attributes.

<destroyconference>
Deletes a conference, or removes individual mixers from a conference. Sent by the client.
Parent element: <msml>
Child elements: <audiomix> <videolayout>
Attributes
id Mandatory. A fully specified conference identifier (for example, conf:myconf). Wildcards are not supported for specifying the conference, and are rejected.
mark A token that can be used to identify execution progress in the case of errors. The value of the mark attribute from the last successfully executed MSML element is returned in an error response. Therefore the value of all mark attributes within an MSML document should be unique.

<destroyconference>
Deletes a conference, or removes individual mixers from a conference. Sent by the client.
Parent element: <msml>
Child elements: <audiomix> <videolayout>
Attributes
id Mandatory. A fully specified conference identifier (for example, conf:myconf). Wildcards are not supported for specifying the conference, and are rejected.
mark A token that can be used to identify execution progress in the case of errors. The value of the mark attribute from the last successfully executed MSML element is returned in an error response. Therefore the value of all mark attributes within an MSML document should be unique.

<dialogend>
Terminates a dialog. Sent by the client.
Parent element: <result>
Child elements: None.
Attributes
id Mandatory. The fully specified identifier of a dialog (for example, conn:178d9az/dialog:mydialog1).
mark A token that can be used to identify execution progress in the case of errors. The value of the mark attribute from the last successfully executed MSML element is returned in an error response. Therefore the value of all mark attributes within an MSML document should be unique.

<dialogid>
Returns a media server–assigned dialog name to the control agent. Sent by the media server.
Parent element: <result>
Child elements: None.
Attributes
This element has no attributes.

<dialogstart>
Initiates a dialog. Sent by the client.
Parent element: <msml>
Child elements: Supported MOML elements.
Attributes
target Mandatory. The fully specified identifier of the conference (for example, conf:myconf) or connection (for example, conn:178d9az) that will interact with the dialog. The identifier must not contain wildcards.
src Not supported.
type Mandatory. A MIME type which identifies the type of language in which the dialog is expressed. Supported value: application/moml+xml, which represents MOML.
name Optional. An alphanumeric name of up to 64 characters, which is used to name the dialog (for example, playCollect1). Do not include the object class in this name. Once the dialog is started, the full identifier will be the ID of the target (conference or connection) plus the ID of the dialog (consisting of the class name dialog plus the name you assign to this dialog instance—for example dialog:playCollect1). These will be separated by a slash, for example: conn:178d9az/dialog:playCollect1 If the name is not specified, the media server generates and assigns a unique dialog name, and returns the full dialog identifier in the <dialogid> element. This name will begin with the string “msml.”, for example msml.1.
mark A token that can be used to identify execution progress in the case of errors. The value of the mark attribute from the last successfully executed MSML element is returned in an error response. Therefore the value of all mark attributes within an MSML document should be unique.

<event>
Sent by the media server to inform the control agent of an event.
Parent element: <msml>
Child elements: <name> <value>
Attributes
name The type or name of the event. Event types predefined in MSML are as follows: • msml.dialog.exit is generated when an executing MSML dialog terminates. This event type can include information returned to the MSML dialog by the MOML <exit> element. • msml.conf.asn reports the current set of active speakers for a conference. • msml.conf.nomedia is generated when a conference is deleted because there are no media streams remaining in the conference. (These events are described in more detail in the section “Events Generated by Pre-Defined Conditions,” which begins on page 20.) If the event contains information forwarded from an MOML <send> element, the event name will be app.event_name, where event_name was defined by the application as part of the <send> element.
id Mandatory. The identifier of the conference or dialog that generated the event, or caused the event to be generated

<gain>
Allows you to adjust the volume (gain) of an audio media stream, mute or unmute the stream, or apply automatic gain control to the stream. Sent by the client.
Parent element: <stream>
Child elements: None.
Attributes
amt Exactly one of agc and amt must be specified. If both agc and amt are specified, an error is generated and the request is rejected. Specifies the specific gain to apply to the media stream in dB. Range is from –96 to 96. The string mute can be used to mute the stream. To unmute the stream, re-issue the <gain> element specifying a specific gain amount using amt.
agc Exactly one of agc and amt must be specified. If both agc and amt are specified, an error is generated and the request is rejected. Specifies whether or not to apply automatic gain control to the stream. Supported value is true. To disable automatic gain control, re-issue the <gain> element specifying a specific gain amount using amt.
tgtlvl Mandatory if agc is specified; forbidden otherwise. If agc is not specified, an error is generated and the request is rejected. Specifies the desired target level for automatic gain control in dBm0. Range of values is –40 to 0. Default: 10
maxgain Optional if agc is specified; forbidden otherwise. If mentioned when agc is not specified, an error is generated and the request is rejected. Sets a limit on the maximum gain that can be applied when automatic gain control is in effect, in dB. Range of values is 0 to 40. If agc is set to true and maxgain is not specified, then the default is applied. The default is

<join>
Creates a media stream between two media objects. Sent by the client.
Parent element: <msml>
Child elements: <stream>
Attributes
id1 Mandatory. The identifier of a connection or conference. Exactly one of id1 and id2 must refer to a connection; the other must refer to a conference. Wildcards are not supported.
id2 Mandatory. The identifier of a connection or conference. Exactly one of id1 and id2 must refer to a connection; the other must refer to a conference. Wildcards are not supported.
mark A token that can be used to identify execution progress in the case of errors. The value of the mark attribute from the last successfully executed MSML element is returned in an error response. Therefore the value of all mark attributes within an MSML document should be unique.

<modifyconference>
Allows you to change the properties of a conference that has already been established. Sent by the client.
Parent element: <msml>
Child elements: <audiomix> <videolayout>
Attributes
id Mandatory. A fully specified conference identifier (for example, conf:myconf). Wildcards are not supported in specifying the conference, and are rejected.
mark A token that can be used to identify execution progress in the case of errors. The value of the mark attribute from the last successfully executed MSML element is returned in an error response. Therefore the value of all mark attributes within an MSML document should be unique.

<modifystream>
Changes the volume (gain) or DTMF filtering properties of an existing audio stream. Sent by the client.
Parent element: <msml>
Child elements: <stream>
Attributes
id1 Mandatory. The identifier of a connection or conference. Exactly one of id1 and id2 must refer to a connection; the other must refer to a conference. Wildcards are supported for the connection. id2 Mandatory. The identifier of a connection or conference. Exactly one of id1 and id2 must refer to a connection; the other must refer to a conference. Wildcards are supported for the connection. mark A token that can be used to identify execution progress in the case of errors. The value of the mark attribute from the last successfully executed MSML element is returned in an error response. Therefore the value of all mark attributes within an MSML document should be unique.

<msml>
The root element for MSML. Defines the set of actions that form a single MSML transaction, or contains the results of a request. Sent by the client.
Parent element: None. The root element for MSML.
Child elements: <createconference> <destroyconference> <dialogid> <dialogstart> <event> <join> <modifyconference> <modifystream> <reset> <result> <unjoin>
Attributes
version Mandatory. Supported value is “1.1”.

<n-loudest>
Sets the number of N-loudest speakers in a conference. Sent by the client.
Parent element: <audiomix>
Child elements: None.
Attributes
n Mandatory. The number of speakers who are able to contribute the audio mix. Supported values are 1 to 16. The value set here is also used to set the number of active speakers reported in the active speaker list when active speaker notification is enabled.

<name>
Specifies the name of an information element forwarded in an MSML event as part of a name/value pair reporting results from MOML document execution or reporting the active speaker list. Sent by the client.
Parent element: <event>
Child elements: None
Attributes
This element has no attributes.

<reset>
Terminates all existing SIP/MSML contexts and releases all resources associated with the SIP/MSML call legs. Convedia extension. Sent by the client.
Parent element: <msml>
Child elements: None.
Attributes
context Mandatory. Specifies the SIP context types that are to be released along with any internal associated resources. In this release, only the msml context type is supported.

<result>
Reports the results of an MSML transaction. Sent by the media server.
Parent element: <msml>
Child elements: <confid> <description> <dialogid>
Attributes
response Mandatory. A three-digit numeric response code representing the overall success or failure of the transaction and, in the case of failure, an indication of the reason.
mark A token that can be used to identify execution progress in the case of errors. The value of the mark attribute from the last successfully executed MSML element is returned in an error response. Therefore the value of all mark attributes within an MSML document should be unique.

<root>
Defines the video parameters of the root window. Sent by the client.
Parent element: <selector>
Child elements: None.
Attributes
size Mandatory. Specifies the size of the root window. Supported values are CIF and QCIF. backgroundcolor Not supported.
backgroundimage Not supported.
cvd:codec A Convedia extension. Mandatory. Specifies the video codec to be used. Supported value is H263 (base H.263 video codec).
cvd:bandwidth A Convedia extension. Mandatory. Specifies the bandwidth for the video window in kilobits per second. Range is 20 to 768.
cvd:mpi A Convedia extension. Mandatory. Specifies the minimum picture interval. Supported values are 1 to 32.

<selector>
Allows you to specify the parameters of the window displaying the video mix. Sent by the client.
Parent element: <videolayout>
Child elements: <root>
Attributes
id Mandatory. An ID of up to 64 alphanumeric characters uniquely identifying the selector. method Mandatory. Specifies the mechanism to be used to select a stream. Supported value is vas (voice activated switching).
blankothers Not supported.
si Optional. The switching interval. Specifies the minimum time interval in msec that must elapse before video can be switched to the active speaker. Range is 500ms to 600s (where ms is milliseconds and s is seconds). Values are rounded up to the nearest 0.1 second. Default is 1 second.
speakersees Optional. Specifies whether the speaker sees himself or herself (when he or she is the active presenter) or whether he or she sees the previous presenter. Valid values are current or previous. Default is current (the speaker sees himself or herself).

<stream>
Allows you to specify the properties of an individual audio or video stream, or remove a stream. Sent by the client.
Parent element: <join> <modifystream> <unjoin>
Child elements: <clamp> <gain>
Attributes
media Mandatory. Specifies the type of media used by the stream. Supported values are audio and video.
dir Optional. Specifies the direction of media dataflow for this stream. Only required for uni-directional streams. Supported values are from-id1 and to-id1. By default, if no direction is specified, a bi-directional stream is established.
compressed Not supported.
display Not supported.
preferred Not supported.

<unjoin>
Removes a media stream from between two objects. Sent by the client.
Parent element: <msml>
Child elements: <stream>
Attributes
id1 Mandatory. The identifier of a connection or a conference. Either id1 or id2 must represent a connection. The other must represent a conference. Wildcards are not supported.
id2 Mandatory. The identifier of a connection or a conference. Either id1 or id2 must represent a connection. The other must represent a conference. Wildcards are not supported.
mark A token that can be used to identify execution progress in the case of errors. The value of the mark attribute from the last successfully executed MSML element is returned in an error response. Therefore the value of all mark attributes within an MSML document should be unique.

<value>
Specifies the value of an MOML shadow variable forwarded in an MSML event. Sent by the client.
Parent element: <event>
Child elements: None
Attributes
This element has no attributes.

<videolayout>
Defines the composition of a video window. Sent by the client.
Parent element: <createconference> <destroyconference> <modifyconference> Child elements: <selector>
Attributes
id Mandatory. An ID of up to 64 alphanumeric characters uniquely identifying the video mixer. type Mandatory. Specifies the language used to define the layout. Supported value is text/msml-basic-layout.