idnits 2.17.1 

draft-saleem-msml-06.txt:

  Checking boilerplate required by RFC 5378 and the IETF Trust (see
  https://trustee.ietf.org/license-info):
  ----------------------------------------------------------------------------

  ** It looks like you're using RFC 3978 boilerplate.  You should update this
     to the boilerplate described in the IETF Trust License Policy document
     (see https://trustee.ietf.org/license-info), which is required now.

  -- Found old boilerplate from RFC 3978, Section 5.1 on line 18.

  -- Found old boilerplate from RFC 3978, Section 5.5, updated by RFC 4748 on
     line 9154.

  -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 9120.

  -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 9127.

  ** The document seems to lack an RFC 3978 Section 5.4 Reference to BCP 78
     -- however, there's a paragraph with a matching beginning. Boilerplate
     error?

  ** The document seems to lack an RFC 3979 Section 5, para. 3 IPR Disclosure
     Invitation -- however, there's a paragraph with a matching beginning.
     Boilerplate error?


  Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt:
  ----------------------------------------------------------------------------

     No issues found here.

  Checking nits according to https://www.ietf.org/id-info/checklist :
  ----------------------------------------------------------------------------

  == There are 10 instances of lines with non-RFC2606-compliant FQDNs in the
     document.

  == There are 4 instances of lines with private range IPv4 addresses in the
     document.  If these are generic example addresses, they should be changed
     to use any of the ranges defined in RFC 6890 (or successor): 192.0.2.x,
     198.51.100.x or 203.0.113.x.


  Miscellaneous warnings:
  ----------------------------------------------------------------------------

  == The copyright year in the IETF Trust Copyright Line does not match the
     current year

  == Line 443 has weird spacing: '...   Core  packa...'

  == Line 2711 has weird spacing: '...collect   agc ...'

  == Line 4826 has weird spacing: '...   code    len...'

  == Line 6107 has weird spacing: '...  <msml  versi...'

  == Line 6158 has weird spacing: '...  <msml  versi...'

  == (1 more instance...)

  -- The document seems to lack a disclaimer for pre-RFC5378 work, but may
     have content which was first submitted before 10 November 2008.  If you
     have contacted all the original authors and they are all willing to grant
     the BCP78 rights to the IETF Trust, then this is fine, and you can ignore
     this comment.  If not, you may need to add the pre-RFC5378 disclaimer. 
     (See the Legal Provisions document at
     https://trustee.ietf.org/license-info for more information.)

  -- The document date (February 2008) is 5915 days in the past.  Is this
     intentional?

  -- Found something which looks like a code comment -- if you have code
     sections in the document, please surround them with '<CODE BEGINS>' and
     '<CODE ENDS>' lines.


  Checking references for intended status: Informational
  ----------------------------------------------------------------------------

     No issues found here.

     Summary: 3 errors (**), 0 flaws (~~), 9 warnings (==), 7 comments (--).

     Run idnits with the --verbose option for more detailed information about
     the items above.

--------------------------------------------------------------------------------

1	Internet-draft       Media Server Markup Language        February 2008
2	                                 (MSML)

4	   SIPPING                                                    A. Saleem
5	   Internet Draft                                                Y. Xin
6	   Intended status: Informational                               Radisys
7	   Expires: August 09, 2008                                 G. Sharratt
8	                                                      February 11, 2008

10	                    Media Server Markup Language (MSML)
11	                           draft-saleem-msml-06

13	Status of this Memo

15	   By submitting this Internet-Draft, each author represents that any
16	   applicable patent or other IPR claims of which he or she is aware
17	   have been or will be disclosed, and any of which he or she becomes
18	   aware will be disclosed, in accordance with Section 6 of BCP 79.

20	   Internet-Drafts are working documents of the Internet Engineering
21	   Task Force (IETF), its areas, and its working groups. Note that other
22	   groups may also distribute working documents as Internet-Drafts.

24	   Internet-Drafts are draft documents valid for a maximum of six months
25	   and may be updated, replaced, or obsoleted by other documents at any
26	   time. It is inappropriate to use Internet-Drafts as reference
27	   material or to cite them other than as "work in progress."

29	   The list of current Internet-Drafts can be accessed at
30	   http://www.ietf.org/ietf/1id-abstracts.txt.

32	   The list of Internet-Draft Shadow Directories can be accessed at
33	   http://www.ietf.org/shadow.html.

35	   This Internet-Draft will expire on August 09, 2008.

37	Copyright Notice

39	   Copyright (C) The IETF Trust (2008).

41	Abstract

43	   The Media Server Markup Language (MSML) is used to control and invoke
44	   many different types of services on IP Media Servers. Clients can use
45	   it to define how multimedia sessions interact on a Media Server and
46	   to apply services to individuals or groups of users. MSML can be
47	   used, for example, to control Media Server conferencing features such
48	   as video layout and audio mixing, create sidebar conferences or

50	Internet-draft       Media Server Markup Language        February 2008
51	                                 (MSML)

53	   personal mixes, and set the properties of media streams. As well,
54	   clients can use MSML to define media processing dialogs, which may be
55	   used as parts of application interactions with users or conferences.
56	   Transformation of media streams to and from users or conferences as
57	   well as IVR dialogs are examples of such interactions, which are
58	   specified using MSML. MSML clients may also invoke dialogs with
59	   individual users or with groups of conference participants using
60	   VoiceXML.

62	Table of Contents

64	   1. Introduction...................................................4
65	   2. Conventions used in this document..............................5
66	   3. Glossary.......................................................5
67	   4. MSML SIP Usage.................................................6
68	      4.1 SIP INFO...................................................7
69	      4.2 SIP Control Framework......................................8
70	   5. Language Structure............................................15
71	      5.1 Package Scheme............................................15
72	      5.2 Profile Scheme............................................19
73	   6. Execution Flow................................................19
74	   7. Media Server Object Model.....................................21
75	      7.1 Objects...................................................21
76	      7.2 Identifiers...............................................24
77	   8. MSML Core Package.............................................26
78	      8.1 <msml>....................................................26
79	      8.2 <send>....................................................26
80	      8.3 <result>..................................................27
81	      8.4 <event>...................................................27
82	   9. MSML Conference Core Package..................................28
83	      9.1 Conferences...............................................28
84	      9.2 Media Streams.............................................29
85	      9.3 <createconference>........................................31
86	      9.4 <modifyconference>........................................33
87	      9.5 <destroyconference>.......................................35
88	      9.6 <audiomix>................................................35
89	      9.7 <videolayout>.............................................37
90	      9.8 <join>....................................................43
91	      9.9 <modifystream>............................................45
92	      9.10 <unjoin>.................................................46
93	      9.11 <monitor>................................................47
94	      9.12 <stream>.................................................48
95	   10. MSML Dialog Packages.........................................51
96	      10.1 Overview.................................................51
97	      10.2 Primitives...............................................53
98	      10.3 Events...................................................55

100	Internet-draft       Media Server Markup Language        February 2008
101	                                 (MSML)

103	      10.4 MSML Dialog Usage with SIP...............................56
104	      10.5 MSML Dialog Structure and Modularity.....................57
105	      10.6 MSML Dialog Core Package.................................58
106	      10.7 MSML Dialog Base Package.................................63
107	      10.8 MSML Dialog Group Package................................81
108	      10.9 MSML Dialog Transform Package............................85
109	      10.10 MSML Dialog Speech Package..............................88
110	      10.11 MSML Dialog Fax Detection Package.......................92
111	      10.12 MSML Dialog Fax Send/Receive Package....................93
112	   11. MSML Audit Package..........................................100
113	      11.1 MSML Audit Core Package.................................100
114	      11.2 MSML Audit Conference Package...........................102
115	      11.3 MSML Audit Connection Package...........................105
116	      11.4 MSML Audit Dialog Package...............................108
117	      11.5 MSML Audit Stream Package...............................110
118	   12. Response Codes..............................................111
119	   13. MSML Conference Examples....................................113
120	      13.1 Establishing a Dial-in Conference.......................113
121	      13.2 Example of a Sidebar Audio Conference...................117
122	      13.3 Example of Removing a Conference........................118
123	      13.4 Example of Modifying Video Layout.......................119
124	   14. MSML Dialog Examples........................................120
125	      14.1 Announcement............................................120
126	      14.2 Voice Mail Retrieval....................................120
127	      14.3 Play and Record.........................................121
128	      14.4 Speech Recognition......................................123
129	      14.5 Play and Collect........................................124
130	      14.6 User Controlled Gain....................................125
131	   15. MSML Audit Examples.........................................126
132	      15.1 Audit All Conferences...................................126
133	      15.2 Audit Conference Dialogs................................127
134	      15.3 Audit Conference Streams................................128
135	      15.4 Audit All Connections...................................128
136	      15.5 Audit Connection Dialogs................................129
137	      15.6 Audit Connection Streams................................129
138	      15.7 Audit Connection With Selective States..................130
139	   16. Change Summary..............................................131
140	   17. Future Work.................................................133
141	   18. XML Schema..................................................133
142	      18.1 MSML Core...............................................135
143	      18.2 MSML Conference Core Package............................139
144	      18.3 MSML Dialog Packages....................................147
145	      18.4 MSML Audit Packages.....................................169
146	   19. Security Considerations.....................................175
147	   20. IANA Considerations.........................................175
148	      20.1 IANA registrations for 'application' MIME Media Type....175
149	      20.2 IANA registrations for 'text' MIME Media Type...........176
150	      20.3 URN Sub-Namespace Registration..........................177

152	Internet-draft       Media Server Markup Language        February 2008
153	                                 (MSML)

155	      20.4 XML Schema Registration.................................177
156	   21. Normative References........................................177
157	   22. Informative References......................................178
158	   Acknowledgments.................................................179
159	   Authors' Addresses..............................................179
160	   Intellectual Property Statement.................................180
161	   Full Copyright Statement........................................180
162	   Disclaimer of Validity..........................................181
163	   Acknowledgement.................................................181

165	1.  Introduction

167	   Media servers contain dynamic pools of media resources. Control
168	   Agents and other users of media servers (called media server clients)
169	   can define and create many different services based on how they
170	   configure and use those resources. Often, that configuration and the
171	   ways in which those resources interact will be changed dynamically
172	   over the course of a call, to reflect changes in the way that an
173	   application interacts with a user.

175	   For example, a call may undergo an initial IVR dialog before being
176	   placed into a conference. Calls may be moved from a main conference
177	   to a sidebar conference and then back again. Individual calls may be
178	   directly bridged to create small n-way calls or simple sidebars. None
179	   of these change the SIP [n1] dialog or RTP [i3] session. Yet these do
180	   affect the media flow and processing internal to the media server.

182	   The Media Server Markup Language (MSML) is an XML [n2] language used
183	   to control the flow of media streams and services applied to media
184	   streams within a media server. It is used to invoke many different
185	   types of services on individual sessions, groups of sessions, and
186	   conferences. MSML allows the creation of conferences, bridging
187	   different sessions together, and bridging sessions into conferences.

189	   MSML may also be used to create user interaction dialogs and allows
190	   the application of media transforms to media streams. Media
191	   interaction dialogs created using MSML allow construction of IVR
192	   dialog sessions to individual users as well as to groups of users
193	   participating in a conference. Dialogs may also be specified using
194	   other languages, VoiceXML [n5], which support complete single-party
195	   application logic to be executed on the Media Server.

197	   MSML is a transport independent language, such that it does not rely
198	   on underlying transport mechanisms and language semantics are
199	   independent of transport. However, SIP is a typical and commonly used
200	   transport mechanism for MSML, invoked using the SIP URI scheme. This

202	Internet-draft       Media Server Markup Language        February 2008
203	                                 (MSML)

205	   specification defines using MSML Dialogs using SIP as the transport
206	   mechanism.

208	   A network connection may be established with the media server using
209	   SIP. Media received and transmitted on that connection will flow
210	   through different media resources on the media server depending on
211	   the requested service. Basic Network Media Services with SIP [n7]
212	   defines conventions for associating a basic service with a SIP
213	   Request-URI. MSML allows services to be dynamically applied and
214	   changed by a Control Agent during the lifetime of the SIP dialog.

216	   MSML has been designed to address the control and manipulation of
217	   media processing operations (e.g., announcement, IVR, play and
218	   record, ASR/TTS, fax, video), as well as control and relationships of
219	   media streams (e.g., simple and advanced conferencing). It provides a
220	   general-purpose media server control architecture. MSML can
221	   additionally be used to invoke other more complex IVR languages such
222	   as VoiceXML.

224	2.  Conventions used in this document

226	   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
227	   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
228	   document are to be interpreted as described in RFC 2119 [i14].

230	3.  Glossary

232	   Media Server: a general-purpose platform for executing real-time
233	   media processing tasks. This is a logical function that maps either
234	   to a single physical device or to a portion of a physical device.

236	   Media Server Client: an application which originates MSML requests to
237	   a media server and also referred to as a Control Agent in this
238	   specification.

240	   Network Connection: a participant that represents the termination on
241	   a media server of one or more RTP [i3] sessions (for example audio
242	   and video) associated with a call. Network connections are
243	   established and removed using a session establishment protocol such
244	   as SIP. An instance of a network connection is independent of MSML
245	   processing instructions applied to it.

247	   Dialog: an automated IVR participant. Examples of dialogs may be
248	   announcement players, IVR interfaces, or voice recorders. Dialogs may
249	   be defined in MSML or using VoiceXML [n5].

251	   Conference: an intermediary function that provides multimedia mixing
252	   and other advanced conferencing services. This specification

254	Internet-draft       Media Server Markup Language        February 2008
255	                                 (MSML)

257	   currently considers conferences with audio and/or video media types,
258	   but is extensible to other media types.

260	   Identifier: a name that is used to refer to a specific instance of an
261	   object on the media server, such as a conference or a dialog.
262	   Identifiers are composed of one or more terms where each term
263	   identifies an object class and instance.

265	   Object: the generic term for a media server entity that terminates,
266	   originates, or processes media. This specification defines four
267	   classes of objects and specifies mechanisms to create them, join them
268	   together, and destroy them.

270	   Participant Object: an object in a media server that sources original
271	   media in a call and/or receives and terminates media in a call.

273	   Intermediary Object: an object in a media server that acts on media
274	   within a call for the benefit of the participants.

276	   Independent Object: an object that can exist on a media server
277	   independent of other objects.

279	   Operator: an intermediary transformer that modifies or transforms a
280	   media stream. Examples of operators may be audio gain controls, video
281	   scaling, or voice masking. MSML defines operators as media transform
282	   objects, which transform media using operations such as gain control,
283	   when applied to media streams.

285	   Media Stream: a single media flow between two objects. A media stream
286	   has a media type and may be unidirectional or bidirectional.

288	4.  MSML SIP Usage

290	   SIP is used to create and modify media sessions with a media server
291	   according to the procedures defined in RFC 3261 [n1]. Often, SIP
292	   third party call control [i4] will be used to create sessions to a
293	   media server on behalf of end users. MSML is used to define and
294	   change the service which a user connected to a media server will
295	   receive. MSML clients are application servers, softswitches, or other
296	   forms of control agents, and SHOULD have an authorized security
297	   relationship with the media server. MSML itself does not define
298	   authorization mechanisms.

300	   MSML transactions are originated based upon events that occur in the
301	   application domain. These events may be independent from any media or
302	   user interaction. For example, an application may wish to play an
303	   announcement to a conference warning that its scheduled completion
304	   time is approaching. Applications themselves are structured in many

306	Internet-draft       Media Server Markup Language        February 2008
307	                                 (MSML)

309	   different ways. Their structure and requirements contribute to their
310	   selection of protocols and languages. To accommodate differing
311	   application needs, MSML has been designed to be neutral to other
312	   languages and independent of the transport used to carry it.

314	   MSML language is purposely designed to be transport independent. In
315	   this release of the specification, SIP INFO [i5] and SIP Control
316	   Framework [i13] have been chosen for transport mechanisms for MSML,
317	   as described in the following sections.

319	4.1   SIP INFO

321	   SIP INVITE and INFO [i5] requests and responses MAY be used to carry
322	   MSML. INFO requests allow asynchronous mid-call messages within SIP
323	   with few additional semantics. In addition, there are existing widely
324	   deployed implementations of that method, it aids in initial
325	   developments which are closely coupled with SIP session
326	   establishment, and it allows MSML to be directly associated with user
327	   dialogs when third party call control is used.

329	   Although INFO is sometimes considered to not be a suitable general-
330	   purpose transport mechanism for messages within SIP, there have been
331	   proposals to make it more acceptable. MSML may evolve to include
332	   other SIP usage and/or to work with other protocols or as a stand-
333	   alone protocol established through SIP, in future releases of this
334	   document.

336	   MSML supports several models for client interaction. When clients use
337	   3PCC to establish media sessions on behalf of end users, clients will
338	   have a SIP dialog for each media session. MSML MAY be sent on these
339	   dialogs. However the targets of MSML actions are not inferred from
340	   the session associated with the SIP dialog. The targets of MSML
341	   actions are always explicitly specified using identifiers as
342	   previously defined.

344	   An application, after interacting with a user, may want to affect
345	   multiple objects within a media server. For example, tones or
346	   messages are often played to a conference when connections are added
347	   or removed. A separate message may also be played to a participant as
348	   they are joined, or to moderators. Explicit identifiers, that is, not
349	   inferred from a transport mechanism allow these multiple actions to
350	   be easily grouped into a single transaction sent on any SIP dialog.

352	   MSML also supports a model of dedicated control associations. This
353	   supports decoupled application architectures where a client can
354	   control media server services without also establishing all of the
355	   media sessions itself. Control associations are created using SIP but
356	   they do not have any associated media session. Although initially

358	Internet-draft       Media Server Markup Language        February 2008
359	                                 (MSML)

361	   INFO messages will be sent on this SIP dialog, just as with dialogs
362	   associated with media sessions, it is possible that in the future,
363	   the SIP dialog will be used to establish a separate control session
364	   (defined in SDP [n9]) that does not use SIP as the transport for MSML
365	   messages.

367	   A media server using MSML also sends asynchronous events to a client
368	   using MSML scripts in SIP INFO. Events are sent based on previous
369	   MSML requests and are sent within the SIP dialog on which the MSML
370	   request that caused the event to be generated was received. If this
371	   dialog no longer exists when the event is generated, the event is
372	   discarded.

374	   Events may be generated during the execution of a dialog created by a
375	   <dialogstart> element. For example, dialogs can send events based on
376	   user input. VoiceXML dialogs, on the other hand, generally interact
377	   with other servers outside of MSML using HTTP.

379	   An event is also generated when the execution of a dialog terminates,
380	   either because of completion or failure. The exact information
381	   returned is dependent on the dialog language, the capabilities of the
382	   dialog execution environment, and what was requested by the dialog.
383	   Both MSML and VoiceXML [n5] allow information to be returned when
384	   they exit. These events may be sent in a SIP INFO or a SIP BYE. SIP
385	   BYE is used when the dialog itself specifies that the connection
386	   should be disconnected, for example through the use of the
387	   <disconnect> element.

389	   Conferences may also generate events based upon their configuration.
390	   An example of this is the notification of the set of active speakers.

392	4.2   SIP Control Framework

394	   The SIP Control Framework [i13] MAY be used as a transport mechanism
395	   for MSML.

397	   The Control Framework provides a generic approach for establishment
398	   and reporting capabilities of remotely initiated commands. The
399	   framework utilizes many functions provided by the Session Initiation
400	   Protocol [n1] (SIP) for the rendezvous and establishment of a
401	   reliable channel for control interactions. Compared to SIP INFO, the
402	   SIP Control Framework is a more general purpose transport mechanism
403	   and one which is not constrained by limitations of the SIP INFO
404	   mechanism.

406	   The Control Framework also introduces the concept of a Control
407	   Package, which is an explicit usage of the Control Framework for a
408	   particular interaction set. This specification has already specified

410	Internet-draft       Media Server Markup Language        February 2008
411	                                 (MSML)

413	   a list of packages for MSML to control the Media Server in many
414	   aspects, including basic dialog, advanced conferencing, advanced
415	   dialog and audit service. Each of these packages has a unique Control
416	   Package name assigned in order for MSML to be used with the Control
417	   Framework.

419	   This section fulfills the mandatory requirement for information that
420	   MUST be specified during the definition of a Control Framework
421	   Package, as detailed in SIP Control Framework [i13].

423	4.2.1    Control Framework Package Names

425	   The Control Framework [i13] requires a Control Package definition to
426	   specify and register a unique name.

428	   MSML specification defines Control Package names using a hierarchical
429	   scheme to indicate the inherited relationship across packages. For
430	   example, package "msml-x" is derived from package "msml", and package
431	   "msml-x-y" is derived from package "msml-x".

433	   The following is a list of Control Package names reserved by the MSML
434	   specification.

436	            "msml": this Control Package supports MSML Core package as
437	                     specified in section 8.

439	            "msml-conf": this Control Package supports MSML Conference
440	                     Core package as specified in section 9.

442	            "msml-dialog": this Control Package supports MSML Dialog
443	                     Core  package as specified in section 10.6.

445	            "msml-dialog-base": this Control Package supports MSML
446	                     Dialog Base package as specified in section 10.7.

448	            "msml-dialog-transform": this Control Package supports MSML
449	                     Dialog Transform package as specified in section
450	                     10.9.

452	            "msml-dialog-group": this Control Package supports MSML
453	                     Dialog Group package as specified in section 10.8.

455	            "msml-dialog-speech": this Control Package supports MSML
456	                     Dialog Speech package as specified in section
457	                     10.10.

459	Internet-draft       Media Server Markup Language        February 2008
460	                                 (MSML)

462	            "msml-dialog-fax-detect": this Control Package supports MSML
463	                     Dialog Fax Detection package as specified in
464	                     section 10.11.

466	            "msml-dialog-fax-sendrecv": this Control Package supports
467	                     MSML Dialog Fax Send/Receive package as specified
468	                     in section 10.12.

470	            "msml-audit": this Control Package supports MSML Audit Core
471	                     Package as specified in section 11.1.

473	            "msml-audit-conf": this Control Package supports MSML Audit
474	                     Conference Package as specified in section 11.2.

476	            "msml-audit-conn": this Control Package supports MSML Audit
477	                     Connection Package as specified in section 11.3.

479	            "msml-audit-dialog": this Control Package supports MSML
480	                     Audit Dialog Package as specified in section 11.4.

482	            "msml-audit-stream": this Control Package supports MSML
483	                     Audit Stream Package as specified in section 11.5.

485	   An Application Server using the Control Framework as transport for
486	   MSML, MUST use one or multiple package names, depending on the
487	   service required from the Media Server. The package name(s) are
488	   identified in the "Control-Packages" SIP header that is present in
489	   the SIP INVITE dialog request that creates the control channel, as
490	   specified in [i13]. The "Control-Packages" value MAY be re-negotiated
491	   via the SIP re-INVITE mechanism.

493	4.2.2    Control Framework Messages

495	   The usage of CONTROL, response and REPORT messages, as defined in
496	   [i13], by each Control Package defined in MSML is different and
497	   described separately in the following sections.

499	      MSML Core Package "msml"

501	         The Application Server may send CONTROL message with a body of
502	         MSML request using following elements to the MS:

504	          <msml>: the root element that may contain a list of child
505	          elements which request a specific operation. The child
506	          elements are defined in extended packages (eg. "msml-conf" and
507	          "msml-dialog"). This element is also the root element which
508	          contains MSML result and event.

510	Internet-draft       Media Server Markup Language        February 2008
511	                                 (MSML)

513	          <send>: sends an event to the specified recipient within the
514	          Media Server. Specific event types are defined within the
515	          extended packages.

517	         The Media Server replies with a response message containing a
518	         MSML result using the following elements:

520	          <result>: reports the results of an MSML transaction.

522	         The Media Server MAY send MSML event to the Application
523	         Server, in a REPORT or CONTROL message, using element <event>.
524	         The actual content of the <event> and which Control Framework
525	         message to use is defined within the extended packages.

527	      MSML Conference Core Package "msml-conf"

529	         This package extends the MSML Core Package to define a
530	         framework for creation, manipulation and deletion of a
531	         conference.

533	         AS can send CONTROL message with a body of MSML request which
534	         contains one or multiple conference related commands to MS. MS
535	         then replies with a response message with a body of MSML
536	         result to indicate if the request has been fulfilled or not.

538	         During the lifetime of a conference, whenever an event occurs,
539	         the Media Server MAY send CONTROL messages containing MSML
540	         events to notify the Application Server. The Application
541	         Server SHOULD reply with a response message with no MSML body
542	         to acknowledge the event has been received.

544	         This package does NOT use the REPORT message.

546	      Dialog Core Package "msml-dialog"

548	         This package extends the MSML Core Package to define the
549	         structural framework and abstractions for MSML dialogs.

551	         The Application Server MAY send CONTROL messages containing a
552	         MSML request using following elements:

554	          <dialogstart>: instantiate an MSML media dialog on a
555	          connection or a conference.

557	          <dialogend>: terminates a MSML dialog.

559	Internet-draft       Media Server Markup Language        February 2008
560	                                 (MSML)

562	          <send>: sends an event and an optional namelist to the dialog,
563	          dialog group, or dialog primitive.

565	          <exit>: used by the dialog description language to cause the
566	          execution of the MSML dialog to terminate.

568	         For the <dialogstart> command, the response message MUST
569	         contain a MSML result which indicates that the dialog has been
570	         started successfully. The MSML result MAY contain <dialogid>
571	         to return dialog identifier, if the identifiers was assigned
572	         by the Media Server. Subsequently, zero of more MSML events
573	         MAY be initiated by the Media Server in (update) REPORT
574	         messages to report information gathered during the dialog.
575	         Finally, a MSML event "msml.dialog.exit" SHOULD be generated
576	         in a (terminate) REPORT message when the dialog terminates
577	         (eg. MSML execution of <exit>).

579	         For the <dialogend> and <send> commands, the response message
580	         contains the final MSML result which indicates that the
581	         request has either been fulfilled or rejected.

583	      Dialog Base Package "msml-dialog-base"

585	         This package extends the MSML Dialog Core Package to define a
586	         set of base functionality for MSML dialogs. The extension
587	         defines individual media primitives, including <play>,
588	         <dtmfgen>, <tonegen>, <record>, <dtmf> and <collect>, to be
589	         used as child element of <dialogstart>. This package does not
590	         change the framework message usage as defined by the MSML
591	         Dialog Core Package.

593	      Dialog Transform Package "msml-dialog-transform"

595	         This package extends the MSML Dialog Core Package to define a
596	         set of transform primitives which works as filter on half
597	         duplex media streams. The extension defines transform
598	         primitives, including <vad>, <gain>, <agc>, <gate>, <clamp>
599	         and <relay>, which MAY be used as child elements of
600	         <dialogstart>. This package does not change the framework
601	         message usage as defined by the MSML Dialog Core Package.

603	      Dialog Group Package "msml-dialog-group"

605	         This package extends the MSML Dialog Core, Base and Transform
606	         Packages to define a single control flow construct that

608	Internet-draft       Media Server Markup Language        February 2008
609	                                 (MSML)

611	         specifies concurrent execution of multiple media primitives.
612	         The extension defines the <group> element which MAY be used as
613	         a child element of <dialogstart> to enclose multiple media
614	         primitives, such that they can be executed concurrently. This
615	         package does not change the framework message usage as defined
616	         by the MSML Dialog Core Package.

618	      Dialog Speech Package "msml-dialog-speech"

620	         This package extends the MSML Dialog Core and MSML Base
621	         Package to define functionality which MAY be used for
622	         automatic speech recognition and text-to-speech. The extension
623	         extends the <dialogstart> and the <play> elements.

625	         For <dialogstart>, it defines a new child element <speech> to
626	         activate grammars or user input rules associated with speech
627	         recognition. For <play>, it defines a new child element <tts>
628	         to initiate the text-to-speech service.

630	         This package does not change the framework message usage as
631	         defined by the MSML Dialog Core Package.

633	      Dialog Fax Detection Package "msml-dialog-fax-detect"

635	         This package extends the MSML Dialog Core Package to define
636	         primitives provide fax detection service. The extension
637	         defines a primitive <faxdetect> to be used as a child element
638	         of <dialogstart>. This package does not change the framework
639	         message usage as defined by the MSML Dialog Core Package.

641	      Dialog Fax Send/Receive Package "msml-dialog-fax-sendrecv"

643	         This package extends the MSML Dialog Core Package to define
644	         primitives which allow a media server to provide fax send or
645	         receive service. The extension defines new primitives
646	         <faxsend> and <faxrcv>, to be used as child element of
647	         <dialogstart>. This package does not change the framework
648	         message usage as defined in MSML Dialog Core Package.

650	      Dialog Audit Core Package "msml-audit"

652	Internet-draft       Media Server Markup Language        February 2008
653	                                 (MSML)

655	         This package extends the MSML Core Package to define a
656	         framework for auditing media resource(s) allocated on the
657	         Media Server.

659	         This package follows a simple request/response transaction,
660	         allowing the Application Server to send CONTROL messages
661	         containing MSML <audit> requests. The Media Server MUST reply
662	         with a response message containing the result. The result is
663	         contained within the <auditresult> element, returning the
664	         queried state information.

666	         This package does NOT use the REPORT message.

668	      Dialog Audit Conference Package "msml-audit-conf"

670	         This package extends the MSML Audit Core Package to define
671	         conference specific states which MAY be queried via the
672	         <audit> command and the corresponding response MUST be
673	         returned by the <auditresult> element. This package does not
674	         change the framework message usage as defined by the MSML
675	         Audit Core Package.

677	      Dialog Audit Connection Package "msml-audit-conn"

679	         This package extends the MSML Audit Core Package to define
680	         connection specific states which MAY be queried via the
681	         <audit> command and the corresponding response MUST be
682	         returned by the <auditresult> element. This package does not
683	         change the framework message usage as defined by the MSML
684	         Audit Core Package.

686	      Dialog Audit Dialog Package "msml-audit-dialog"

688	         This package extends the MSML Audit Core Package to define
689	         dialog specific states which MAY be queried via the <audit>
690	         command and the corresponding response MUST be returned by the
691	         <auditresult> element. This package does not change the
692	         framework message usage as defined by the MSML Audit Core
693	         Package.

695	      Dialog Audit Stream Package "msml-audit-stream"

697	         This package extends the MSML Audit Core Package to define
698	         stream specific states which MAY be queried via the <audit>

700	Internet-draft       Media Server Markup Language        February 2008
701	                                 (MSML)

703	         command and the corresponding response MUST returned by the
704	         <auditresult> element. This package does not change the
705	         framework message usage as defined by the MSML Audit Core
706	         Package.

708	4.2.3    Common XML Support

710	   The XML schema described in [i13] MUST be supported by all Control
711	   Packages defined by MSML. However, the "connection-id" value MUST be
712	   constructed as defined by MSML (i.e. the identifier MUST contain
713	   local dialog tag only, while the SIP Control Framework [i13] requires
714	   that the "connection-id" contain both local and remote dialog tags).

716	4.2.4    Control Message Body

718	   A valid CONTROL body message MUST conform to the MSML schema, as
719	   included in this specification, for the MSML package(s) used.

721	4.2.5    REPORT Message Body

723	   A valid REPORT body message MUST conform to the MSML schema, as
724	   included in this specification, for the MSML package(s) used.

726	5.  Language Structure

728	5.1   Package Scheme

730	   The primary mechanism for extending MSML is the "package". A package
731	   is an integrated set of one or more XML schemas that define
732	   additional features and functions via new or extended use of elements
733	   and attributes. Each package, except for those defined in the current
734	   document, is defined in a separate standards document, e.g., an
735	   Internet Draft or an RFC. All packages, that extend the base MSML
736	   functionality, MUST include references to the MSML base set of
737	   schemas provided in the Internet drafts. A schema in a package MUST
738	   only extend MSML, this is, it must not alter the existing
739	   specification.

741	   A particular MSML script will include references to all the schemas
742	   defining the packages whose elements and attributes it makes use of.
743	   A particular script MUST reference MSML base and optionally extension
744	   package(s). See IANA Considerations section.

746	   Each package MUST define its own namespace so that elements or
747	   attributes with the same name in different packages do not conflict.
748	   A script using a particular element or attribute MUST prefix the
749	   namespace name on that element or attribute's name if it is defined
750	   in a package (as opposed to being defined in the base).

752	Internet-draft       Media Server Markup Language        February 2008
753	                                 (MSML)

755	   MSML consists of a core package which provides structure without
756	   support for any specific feature set. Additional packages, relying on
757	   the core package, provide functional features. Any combination of
758	   additional packages may be used along with the core package. The
759	   following describes the set of MSML packages defined in this
760	   document.

762	              +--------------------------------------------------------+
763	              |                     MSML Core                          |
764	              +--------------------------------------------------------+
765	                    /                           \                 \
766	                +--------+                   +--------+        +-------+
767	                | Dialog |                   | Conf   |        | Audit |
768	                | Core   |                   | Core   |        | Core  |
769	                +--------+                   +--------+        +-------+
770	           ________  \_______________________________________      |
771	           ------------------------------------------------        |
772	          /         \          \         \          \      \       |
773	      +------+  +---------+ +------+ +------+ +------+ +-------+   |
774	      |Dialog|  |Dialog   | |Dialog| |Dialog| |Dialog| |Dialog |   |
775	      |Base  |  |Transform| |Group | |Speech| |Fax   | |Fax    |   |
776	      +------+  +---------+ +------+ +------+ |Detect| |Send/  |   |
777	                                              +------+ |Receive|   |
778	                                                       +-------+   |
779	                                           ________________________|
780	                                           -------------------------
781	                                          /       \       \         \
782	                                      +-----+ +-----+ +------+ +------+
783	                                      |Audit| |Audit| |Audit | |Audit |
784	                                      |Conf | |Conn | |Dialog| |Stream|
785	                                      +-----+ +-----+ +------+ +------+

787	      o MSML Core package (Mandatory)

789	         Describes the minimum base framework which MUST be implemented
790	         to support additional core packages.

792	      o MSML Conference Core package (Conditionally Mandatory, for
793	         Conferencing)

795	         Describes the audio and multimedia basic and advanced
796	         conferencing package, which MAY be implemented.

798	      o MSML Dialog Core package (Conditionally Mandatory, for Dialogs)

800	         Describes the dialog core package which MUST be implemented for
801	         any dialog services. However, systems supporting conferencing

803	Internet-draft       Media Server Markup Language        February 2008
804	                                 (MSML)

806	         only, MAY omit support for MSML dialogs. The MSML dialog core
807	         package specifies the framework within which additional dialog
808	         packages are supported. The MSML dialog base package MUST be
809	         supported, while all other dialog packages MAY be supported.

811	         o MSML Dialog Base package (Conditionally Mandatory, for
812	         Dialogs)

814	         o MSML Dialog Group package (Optional)

816	         o MSML Dialog Transform package (Optional)

818	         o MSML Dialog Fax Detection package (Optional)

820	         o MSML Dialog Fax Send/Receive package (Optional)

822	         o MSML Dialog Speech package (Optional)

824	      o MSML Audit Core package (Conditionally Mandatory, for Auditing)

826	         Describes the audit core package which MUST be implemented to
827	         support auditing services. The MSML audit core package
828	         specifies the framework within which additional audit packages
829	         are supported.

831	         o MSML Audit Conference package (Conditionally Mandatory, for
832	         Auditing Conference, Conference Dialog and Conference Stream)

834	         o MSML Audit Connection package (Conditionally Mandatory, for
835	         Auditing Connection, Connection Dialog and Connection Stream)

837	         o MSML Audit Dialog package (Conditionally Mandatory, for
838	         Auditing Dialog, and MUST be used with either MSML Audit
839	         Conference Package or MSML Audit Connection Package)

841	         o MSML Audit Stream package (Conditionally Mandatory, for
842	         Auditing Stream, and MUST be used with either MSML Audit
843	         Conference Package or MSML Audit Connection Package)

845	   The formal process for defining extensions to MSML Dialogs is to
846	   define a new package. The new package MUST provide a text description
847	   of what extensions are included and how they work. It MUST also
848	   define an XML schema file (if applicable) that defines the new
849	   package (which may be through extension, restriction of an existing
850	   package, or a specific profile of an existing package). Dependencies
851	   upon other packages MUST be stated. For example a package that
852	   extends or restricts has a dependency on the original package

854	Internet-draft       Media Server Markup Language        February 2008
855	                                 (MSML)

857	   specification. Finally, the new package MUST be assigned a unique
858	   name and version.

860	   The types of things which can be defined in new packages are:

862	      o  new primitives

864	      o  extensions to existing primitives (events, shadow variables,
865	         attributes, content)

867	      o  new recognition grammars for existing primitives

869	      o  new markup languages for speech generation

871	      o  languages for specifying a topology schema

873	      o  new pre-defined topology schemas

875	      o  new variables / segment types (sets & languages)

877	      o  new control flow elements

879	   MSML Packages are assembled together to form a specific MSML profile
880	   that is shared between different implementations. The base MSML
881	   Dialog profiles which are defined in this document consist of the
882	   MSML Core package, MSML Dialog Core package, MSML Dialog Base
883	   package, MSML Dialog Group package, MSML Transform package, MSML Fax
884	   packages, and the MSML Speech package.

886	   MSML extension packages, which define primitives, MUST define the
887	   following for each primitive within the package:

889	      o  the function which the primitive performs

891	      o  the attributes which may be used to tailor its behavior

893	      o  the events which it is capable of understanding

895	      o  the shadow variables which provide access to information
896	         determined as a result of the primitive's operation.

898	   The mechanism used to insure that a media server and its client share
899	   a compatible set of packages is not defined. Currently it is expected
900	   that provisioning will be used, possibly coupled with a future
901	   auditing capability. Additionally, when used in SIP networks,
902	   packages could be defined using feature tags and the procedures
903	   defined for Indicating User Agent Capabilities in SIP [i1] used to

905	Internet-draft       Media Server Markup Language        February 2008
906	                                 (MSML)

908	   allow a media server to describe its capabilities to other user
909	   agents.

911	5.2   Profile Scheme

913	   Not all devices and applications using MSML will need to support the
914	   entire MSML schema. For example, a media processing device might
915	   support only audio announcements, only audio simple conferencing, or
916	   only multimedia IVR. It is highly desirable to have a system for
917	   describing what portion of MSML a particular media processing device
918	   or Control Agent supports.

920	   The Package scheme described earlier allows MSML functionality to be
921	   functionally grouped, relying on the MSML core package. This scheme
922	   allows a portion of the complete MSML specification to be
923	   implemented, on a per package basis and also creates a framework for
924	   future extension packages. However, within a given package, in some
925	   cases, only a subset of the package functionality may be required. In
926	   order to support subsets of packages, with greater degree of
927	   granularity than at the package level, a profile scheme is required.

929	   MSML package profiles would identify a subset of a given MSML package
930	   with specific definitions of elements and attributes. Each MSML
931	   package profile MUST be accompanied by one or more corresponding
932	   schemas. To use the examples above, there could be an audio
933	   announcements profile of the MSML Dialog Base package, an audio
934	   simple conferencing profile of the MSML Conference Core package, and
935	   a multimedia IVR profile of the MSML Dialog Base package.

937	   MSML package profiles MUST be published separately from the MSML
938	   specification, in one or more standards documents (e.g., Internet
939	   Drafts or RFCs) dedicated to MSML package profiles. Profiles would
940	   not be registered with IANA and any organization would additionally
941	   be free to create its own profile(s) if required.

943	6.  Execution Flow

945	   MSML assumes a model where there is a single control context within a
946	   media server for MSML processing. That context may have one or many
947	   SIP [n1] dialogs associated with it. It is assumed that any SIP
948	   dialogs associated with the MSML control context have been
949	   authorized, as appropriate, by mechanisms outside the scope of MSML.

951	   A media server control context maintains information about the state
952	   of all media objects and media streams within a media server. It
953	   receives and processes all MSML requests from authorized SIP dialogs
954	   and receives all events generated internally by media objects and
955	   sends them on the appropriate SIP dialog. An MSML request is able to

957	Internet-draft       Media Server Markup Language        February 2008
958	                                 (MSML)

960	   create new media objects and streams, and to modify or destroy any
961	   existing media objects and streams.

963	   An MSML request may simply specify a single action for a media server
964	   to undertake. In this case, the document is very similar to a simple
965	   command request. Often, though, it may be more natural for a client
966	   to request multiple actions at one time, or the client would like
967	   several actions to be closely coordinated by the media server.
968	   Multiple MSML elements received in a single request MUST be processed
969	   sequentially in document order.

971	   An example of the first scenario would be to create a conference and
972	   join it with an initial participant. An example of the second case
973	   would be to unjoin one or more participants from a main conference
974	   and join them to a sidebar conference. In the first scenario, network
975	   latencies may not be an issue, but it is simpler for the client to
976	   combine the requests. In the second case, the added network latency
977	   between separate requests could mean perceptible audio loss to the
978	   participant.

980	   Each MSML request is processed as a single transaction. A media
981	   server MUST ensure that it has the necessary resources available to
982	   carry out the complete transaction before executing any elements of
983	   the request. If it does not have sufficient resources, it MUST return
984	   a 520 response and MUST NOT execute the transaction.

986	   The MSML request MUST be checked for well-formedness and validated
987	   against the schema prior to executing any elements. This allows XML
988	   [n2] errors to reported immediately and minimizes failures within a
989	   transaction and the corresponding execution of only part of the
990	   transaction.

992	   Each element is expected to execute immediately. Elements such as
993	   <dialogstart>, which take an unpredictable amount of time, are
994	   "forked" and executed in a separate thread (see MSML Dialog
995	   packages). Once successfully forked, execution continues with the
996	   element following the </dialogstart>. As such, MSML does not provide
997	   mechanisms to sequence or coordinate other operations with dialog
998	   elements.

1000	   Processing within a transaction MUST stop if any errors occur.
1001	   Elements that were executed prior to the error are not rolled back.
1002	   It is the responsibility of the client to determine appropriate
1003	   actions based upon the results indicated in the response. Most
1004	   elements MAY contain an optional "mark" attribute. The value of that
1005	   attribute from the last successfully executed element MUST be
1006	   returned in an error response. Note that errors that occur during the

1008	Internet-draft       Media Server Markup Language        February 2008
1009	                                 (MSML)

1011	   execution of a dialog occur outside the context of an MSML
1012	   transaction. These errors will be indicated in an asynchronous event.

1014	   Transaction results are returned as part of the SIP request response.
1015	   The transaction results indicate the success or failure of the
1016	   transaction. The result MUST also include identifiers for any objects
1017	   created by a media server for which the client did not provide an
1018	   instance name. Additionally, if the transaction fails, the reason for
1019	   the failure MUST be returned, as well as an indication of how much of
1020	   the transaction was executed before the failure occurred SHOULD be
1021	   returned.

1023	7.  Media Server Object Model

1025	   Media servers are general-purpose platforms for executing real-time
1026	   media processing tasks. These tasks range in complexity from simple
1027	   ones such as serving announcements, to complex ones, such as speech
1028	   interfaces, centralized multimedia conferencing, and sophisticated
1029	   gaming applications.

1031	   Calls are established to a media server using SIP. Clients will often
1032	   use SIP third party call control (3PCC) [i4] to establish calls to a
1033	   media server on behalf of end users. However MSML does not require
1034	   that 3PCC be used; only that the client and the media server share a
1035	   common identifier for the call and its associated RTP [i3] sessions.

1037	   Objects represent entities which source, sink, or modify media
1038	   streams. A media streams is a bidirectional or unidirectional media
1039	   flow between objects on a media server. The following subsections
1040	   define the classes of objects that exist on a media server and the
1041	   way these are identified in MSML.

1043	7.1   Objects

1045	   A media object is an endpoint of one or more media streams. It may be
1046	   a connection that terminates RTP sessions from the network or a
1047	   resource that transforms or manipulates media. MSML defines four
1048	   classes of media objects. Each class defines the basic properties of
1049	   how object instances are used within a media server. However, most
1050	   classes require that the function of specific instances be defined by
1051	   the client, using MSML or other languages such as VoiceXML.

1053	   The following classes of media processing objects are defined. The
1054	   class names are given in parentheses:

1056	         o network connection (conn)

1058	         o conference (conf)

1060	Internet-draft       Media Server Markup Language        February 2008
1061	                                 (MSML)

1063	         o dialog (dialog)

1065	   Network connection is an abstraction for the media processing
1066	   resources involved in terminating the RTP session(s) of a call. For
1067	   audio services a connection instance presents a full-duplex audio
1068	   stream interface within a media server. Multimedia connections have
1069	   multiple media streams of different media types, each corresponding
1070	   to an RTP session. Network connections get instantiated through SIP
1071	   [n1].

1073	   A conference represents the media resources and state information
1074	   required for a single logical mix of each media type in the
1075	   conference (e.g. audio and video). MSML models multiple mixes/views
1076	   of the same media type as separate conferences. Each conference has
1077	   multiple inputs. Inputs may be divided into classes that allow an
1078	   application to request different media treatment for different
1079	   participants. For example, the video streams for some participants
1080	   may be assigned to fixed regions of the screen while those for other
1081	   participants may only be shown when they are speaking.

1083	   A conference has a single logical output per media type. For each
1084	   participant, it consists of the audio conference mix, less any
1085	   contributed audio of the participant, and the video mix shared by all
1086	   conference participants. Video conferences using voice activated
1087	   switching have an optional ability to show the previous speaker to
1088	   the current speaker.

1090	   Conferences are instantiated using the <createconference> element.
1091	   The content of the <createconference> element specifies the
1092	   parameters of the audio and/or video mixes.

1094	   Dialogs are a class of objects that represent automated participants.
1095	   They are similar to network connections from a media flow perspective
1096	   and may have one or more media streams as the abstraction for their
1097	   interface within a media server. Unlike connections however, dialogs
1098	   are created and destroyed through MSML, and the media server itself
1099	   implements the dialog participant. Dialogs are instantiated through
1100	   the <dialogstart> element. Contents of the <dialogstart> element
1101	   define the desired or expected dialog behavior. Dialogs may also be
1102	   invoked by referencing VoiceXML as the dialog description language.

1104	   Operators are functions that are used to filter or transform a media
1105	   stream. The function that an instance of an operator fulfills is
1106	   defined as a property of the media stream. Operators may be
1107	   unidirectional or bidirectional and have a media type. Unidirectional
1108	   operators reflect simple atomic functions such as automatic gain
1109	   control, filtering tones from conferences, or applying specific gain
1110	   values to a stream. Unidirectional operators have a single media

1112	Internet-draft       Media Server Markup Language        February 2008
1113	                                 (MSML)

1115	   input, which is connected to the media stream from one object, and a
1116	   single media output, which is connected to the media stream of a
1117	   different object.

1119	   Bidirectional operators have two media inputs and two media outputs.
1120	   One media input and output is associated with the stream to one
1121	   object and the other input and output is associated with a stream to
1122	   a different object. Bidirectional objects may treat the media
1123	   differently in each direction. For example, an operator could be
1124	   defined which changed the media sent to a connection based upon
1125	   recognized speech or DTMF received from the connection. Operators are
1126	   implicitly instantiated when streams are created or modified using
1127	   the elements <join> and <modifystream> respectively.

1129	   The relationships between the different object classes (conf, conn,
1130	   and dialog) are shown in the figure below.

1132	                   +--------------------------------------+
1133	                   |           Media Server               |
1134	                   |                                      |
1135	                   |------+                      ,---.    |
1136	                   |      |      +------+       /     \   |
1137	        <== RTP ==>| conn |<---->| oper |<---->( conf  )  |
1138	                   |      |      +------+       \     /   |
1139	                   |------+                      `---'    |
1140	                   |   ^                           ^      |
1141	                   |   |                           |      |
1142	                   |   |   +------+    +------+    |      |
1143	                   |   |   |      |    |      |    |      |
1144	                   |   +-->|dialog|    |dialog|<---+      |
1145	                   |       |      |    |      |           |
1146	                   |       +------+    +------+           |
1147	                   +--------------------------------------+

1149	   A single, full-duplex instance of each object class is shown together
1150	   with common relationships between them. An operator (such as gain) is
1151	   shown between a connection and a conference and dialogs are shown
1152	   participating both with an individual connection and with a
1153	   conference. The figure is not meant to imply only one to one
1154	   relationships. Conferences will often have hundreds of participants,
1155	   and either connections or conferences may be interacting with more
1156	   than one dialog. For example, one dialog may be recording a
1157	   conference while other dialogs announce participants joining or
1158	   leaving the conference.

1160	Internet-draft       Media Server Markup Language        February 2008
1161	                                 (MSML)

1163	7.2   Identifiers

1165	   Objects are referenced using identifiers that are composed of one or
1166	   more terms. Each term specifies an object class and names a specific
1167	   instance within that class. The object class and instance are
1168	   separated by a colon ":" in an identifier term.

1170	   Identifiers are assigned to objects when they are first created. In
1171	   general, either the MSML client or a media server may specify the
1172	   instance name for an object. Objects for which a client does not
1173	   assign an instance name will be assigned one by a media server. Media
1174	   server assigned instance names are returned to the client as a
1175	   complete object identifier in the response to the request that
1176	   created the object.

1178	   It is meaningful for some classes of objects to exist independently
1179	   on a media server. Network connections may be created through SIP at
1180	   any time. MSML can then be used to associate their media with other
1181	   objects as required to create services. Conferences may be created
1182	   and have specific resources reserved waiting for participant
1183	   connections.

1185	   Objects from these two classes, connections and conferences, are
1186	   considered independent objects since they can exist on a standalone
1187	   basis. Identifiers for independent objects consist of single term as
1188	   defined above. For example, identifiers for a conference and
1189	   connection could be "conf:abc" or "conn:1234" respectively. Clients
1190	   which choose to assign instance names to independent objects must use
1191	   globally unique instance names. One way to create globally unique
1192	   names is to include the domain name of the client as part of the
1193	   name.

1195	   Dialogs are created to provide a service to independent objects.
1196	   Dialogs may act as a participant in a conference or interact with a
1197	   connection similar to a two participant call. Dialogs depend upon the
1198	   existence of independent objects and this is reflected in the
1199	   composition of their identifiers. Operators modify the media flow
1200	   between other objects, such as application of gain between a
1201	   connection and a conference. As operators are merely media transform
1202	   primitives defined as properties of the media stream, they are not
1203	   represented by identifiers and created implicitly.

1205	   Identifiers for dialogs are composed of a structured list of slash
1206	   ('/') separated terms. The left-most term of the identifier must
1207	   specify a conference or connection. This serves as the root for the
1208	   identifier. An example of an identifier for a dialog acting as a
1209	   conference participant could be:

1211	Internet-draft       Media Server Markup Language        February 2008
1212	                                 (MSML)

1214	         conf:abc/dialog:recorder

1216	   All objects except connections are created using MSML. Connections
1217	   are created when media sessions get established through SIP. There
1218	   are several options clients and media servers can use to establish a
1219	   shared instance name for a connection and its media streams.

1221	   When media servers support multiple media types, the instance name
1222	   SHOULD be a call identifier that can be used to identify the
1223	   collection of RTP sessions associated with a call. When MSML is used
1224	   in conjunction with SIP and third party call control, the call
1225	   identifier MUST be the same as the local tag assigned by the media
1226	   server to identify the SIP dialog. This will be the tag the media
1227	   server adds to the "To" header in its response to an initial invite
1228	   transaction. RFC 3261 requires the tag values to be globally unique.

1230	   An example of a connection identifier is: conn:74jgd63956ts.

1232	   With third party call control, the MSML client acts as a back to back
1233	   user agent (B2BUA) to establish the media sessions. SIP dialogs are
1234	   established between the client and the media server allowing the use
1235	   of the media server local tag as a connection identifier. If third
1236	   party call control is not used, a SIP event package MAY be used to
1237	   allow a media server to notify new sessions to a client that has
1238	   subscribed to this information.

1240	   Identifiers as described above allow every object in a media server
1241	   to be uniquely addressed. They can also be used to refer to multiple
1242	   objects. There are two ways in which this can currently be done:

1244	         wildcards

1246	         common instance names

1248	   An identifier can reference multiple objects when a wildcard is used
1249	   as an instance name. MSML reserves the instance name comprised of a
1250	   single asterisk ('*') to mean all objects that have the same
1251	   identifier root and class. Instance names containing an asterisk
1252	   cannot be created. Wildcards MUST only be used as the right most term
1253	   of an identifier and MUST NOT be used as part of the root for dialog
1254	   identifiers. Wildcards are only allowed where explicitly indicated
1255	   below.

1257	   The following are examples of valid wildcards:

1259	         conf:abc/dialog:*

1261	         conn:*

1263	Internet-draft       Media Server Markup Language        February 2008
1264	                                 (MSML)

1266	   Examples of illegal wildcard usage are:

1268	         conf:*/dialog:73849

1270	   Although identifiers share a common syntax, MSML elements restrict
1271	   the class of objects which are valid in a given context. As an
1272	   example, although it is valid to join two connections together, it is
1273	   not valid to join two IVR dialogs.

1275	8.  MSML Core Package

1277	   This section describes the core MSML package which MUST be supported
1278	   in order to use any other MSML packages. The core MSML package
1279	   defines a framework, without explicit functionality, over which
1280	   functional packages are used.

1282	8.1   <msml>

1284	   <msml> is the root element. When received by a media server, it
1285	   defines the set of operations that form a single MSML request.
1286	   Operations are requested by the contents of the element. Each
1287	   operation MAY appear zero or more times as children of <msml>.
1288	   Specific operations are defined within the Conference package and in
1289	   the set of Dialog packages.

1291	   The results of a request or the contents of events sent by a media
1292	   server are also enclosed within the <msml> element. The results of
1293	   the transaction are included as a body in the response to the SIP
1294	   request that contained the transaction. This response will contain
1295	   any identifiers that the media server assigned to newly created
1296	   objects. All messages that a media server generates are correlated to
1297	   an object identifier. Objects and identifiers are discussed in
1298	   section 7 (Media Server Object Model).

1300	   Attributes:

1302	         version: "1.1" Mandatory

1304	8.2   <send>

1306	   Events are used to affect the behavior of different objects within a
1307	   media server. The <send> element is used to send an event to the
1308	   specified recipient within the Media Server.

1310	   Attributes:

1312	         event: the name of an event. Mandatory.

1314	Internet-draft       Media Server Markup Language        February 2008
1315	                                 (MSML)

1317	         target: an object identifier. When the identifier is for a
1318	         dialog, it may optionally be appended with a slash "/" followed
1319	         by the target to be included in a MSML Dialog <send>.
1320	         Mandatory.

1322	         valuelist: a list of zero or more parameters that are included
1323	         with the event.

1325	         mark: a token that can be used to identify execution progress
1326	         in the case of errors. The value of the mark attribute from the
1327	         last successfully executed MSML element is returned in an error
1328	         response. Therefore the value of all mark attributes within an
1329	         MSML document should be unique.

1331	8.3   <result>

1333	   The <result> element is used to report the results of an MSML
1334	   transaction. It is included as a body in the final response to the
1335	   SIP request which initiated the transaction. An optional child
1336	   element <description> may include text which expands on the meaning
1337	   of error responses. Response codes are defined in section 11
1338	   (Response Codes).

1340	   Attributes:

1342	         response: a numeric code indicating the overall success or
1343	         failure of the transaction, and in the case of failure, an
1344	         indication of the reason. Mandatory.

1346	         mark: in the case of an error, the value of the mark attribute
1347	         from the last successfully executed element that included the
1348	         mark attribute.

1350	   In the case of failure, a description of the reason SHOULD be
1351	   provided using the child element <description>.

1353	   Three other child elements allow the response to include identifiers
1354	   for objects created by the request but which did not have instance
1355	   names specified by the client. Those elements are <confid> and
1356	   <dialogid>, for objects created though a <createconference> and
1357	   <dialogstart> respectively.

1359	8.4   <event>

1361	   The <event> element is used to notify an event to a media server
1362	   client. Three types of events are defined by MSML Core package;
1363	   "msml.dialog.exit", "msml.conf.nomedia", and "msml.conf.asn". These
1364	   correspond to the termination of an executing dialog, a conference

1366	Internet-draft       Media Server Markup Language        February 2008
1367	                                 (MSML)

1369	   being automatically deleted when the last participant has left, and
1370	   the notification of the current set of active speakers for a
1371	   conference, respectively. Events may also be generated by an
1372	   executing dialog. In this case the event type is specified by the
1373	   dialog. (see MSML Dialog Core Package <send>).

1375	   Attributes:

1377	         name: the type of event. If the event is generated because of
1378	         the execution MSML Dialog <send>, the value MUST be the value
1379	         of the "event" attribute from the <send> element within the
1380	         MSML Dialog Core package. If the event is generated because of
1381	         the execution of an <exit>, the value MUST be "moml.exit". If
1382	         the event is generated because of the execution of a
1383	         <disconnect>, the value MUST be "moml.disconnect". If the event
1384	         is generated because of an error, the value must be
1385	         "moml.error". Mandatory.

1387	         id: the identifier of the conference or dialog that generated
1388	         the event or caused the event to be generated. Mandatory.

1390	         <event> has two children, <name> and <value>, which contain the
1391	         name and value respectively of each namelist item associated
1392	         with the event.

1394	9.  MSML Conference Core Package

1396	9.1   Conferences

1398	   A conference has a mixer for each type of media that the conference
1399	   supports. Each mix has a corresponding description that defines how
1400	   the media from participants contributes to that mix. A mixer has
1401	   multiple inputs that are combined in a media specific way to create a
1402	   single logical output.

1404	   The elements that describe the mix for each media type are called
1405	   mixer description elements. They are:

1407	   <audiomix> defines the parameters for mixing audio media.

1409	   <videolayout> defines the composition of a video window.

1411	   These elements, defined in sections 9.6 (Audio Mix) and 9.7 (Video
1412	   Layout) respectively, are used as content of the <createconference>
1413	   element to establish the initial properties of a conference. The
1414	   elements are used within the <modifyconference> element to change the
1415	   properties of a conference once it has been created, or within the

1417	Internet-draft       Media Server Markup Language        February 2008
1418	                                 (MSML)

1420	   <destroyconference> element to remove individual mixes from the
1421	   conference.

1423	   Conferences may be terminated by an MSML client using the
1424	   <destroyconference> element to remove the entire conference or by
1425	   removing the last mixer(s) associated with the conference.
1426	   Conferences can also be terminated automatically by a media server
1427	   based on criteria specified when the conference is created. When the
1428	   conference is deleted, any remaining participants will have their
1429	   associated SIP dialogs left unchanged or deleted based on the value
1430	   of the "term" attribute specified when the conference was created.

1432	9.2   Media Streams

1434	   Objects have at least one media input and output for each type of
1435	   media that they support. Each object class defines the number of
1436	   inputs and outputs objects of that class support. Media streams are
1437	   created when objects are joined, either explicitly using <join>, or
1438	   implicitly when dialogs are created using <dialogstart>. Dialog
1439	   creation has two stages, allocating and configuring the resources
1440	   required for the dialog instance, and implicitly joining those
1441	   resources to the dialog target during the dialog execution. Refer to
1442	   MSML Dialog Base package.

1444	   A join operation by default creates a bidirectional audio stream
1445	   between two objects. Video and unidirectional streams may also be
1446	   created. A media stream is created by connecting the output from one
1447	   object to the input of another object and vice versa (assuming a
1448	   bidirectional or full-duplex join).

1450	   Many objects may only support a single input for each type of media.
1451	   Within this specification, only the conference object class supports
1452	   an arbitrary number of inputs. When a stream is requested to be
1453	   created to an object that already has a stream of the same type
1454	   connected to its single input, the result of the request depends upon
1455	   the type of the media stream.

1457	   Audio mixing is done by summing audio signals. Automatically mixing
1458	   audio streams has common and straight forward applications. For
1459	   example, the ability to bridge two streams allows for the easy
1460	   creation of simple three-way calls or to bridge private announcements
1461	   with a [whispered] conference mix for an individual participant. In
1462	   the case of general conferences however, an MSML client SHOULD create
1463	   an audio conference and then join participants to the conference.
1464	   Conference mixers SHOULD subtract the audio of each participant from
1465	   the mix so that they do not hear themselves.

1467	Internet-draft       Media Server Markup Language        February 2008
1468	                                 (MSML)

1470	   A media server that receives a request that requires joining an audio
1471	   stream to the single audio input of an object that already has an
1472	   audio stream connected, SHOULD automatically bridge the new stream
1473	   with the existing stream, creating a mix of the two audio streams.
1474	   The maximum number of streams that may be bridged in this manner is
1475	   implementation-specific. It is RECOMMENDED that a media server
1476	   support bridging at least two streams. A media server that cannot
1477	   bridge a new stream with any existing streams MUST fail the operation
1478	   requesting the join.

1480	   Unlike audio mixing, there are many different ways that two video
1481	   streams may be combined and presented. For example, they may be
1482	   presented side by side in separate panes, picture in picture, or in a
1483	   single pane which displays only a single stream at a time based on a
1484	   heuristic such as active speaker. Each of these options creates a
1485	   very different presentation and require significantly different media
1486	   resources.

1488	   A join operation does not describe how a new stream can be combined
1489	   with an existing stream. Therefore automatic bridging of video is not
1490	   supported. A media server MUST fail requests to join a new video
1491	   stream to an object that only supports a single video input and
1492	   already has a video stream connected to that input. For an object to
1493	   have multiple video streams joined to it, the object itself must be
1494	   capable in supporting multiple video streams. Conference objects can
1495	   support multiple video streams and provide a way to specify the
1496	   mixing presentation for the video streams.

1498	   A media server MUST NOT establish any streams unless the media server
1499	   is able to create all the streams requested by an operation. Streams
1500	   are only able to be created if both objects support a media type and
1501	   at least one of the following conditions is true:

1503	      1. each object that is to receive media is not already receiving a
1504	         stream of that type.

1506	      2. any object that is to receive media and is already receiving a
1507	         stream of that type supports receiving an additional stream of
1508	         that type. The only class of objects defined in this
1509	         specification that directly support receiving multiple streams
1510	         of the same type are conferences.

1512	      3. the media server is able to automatically bridge media streams
1513	         for an object that is to receive media and that is already
1514	         receiving a stream of the requested type. The only type of
1515	         media defined in this specification that MAY be automatically
1516	         bridged is audio.

1518	Internet-draft       Media Server Markup Language        February 2008
1519	                                 (MSML)

1521	   The directionality of media streams associated with a connection are
1522	   modeled independently from what SDP [n9] allows for the corresponding
1523	   RTP [i3] sessions. Media servers MUST respect the SDP in what they
1524	   actually transmit but MUST NOT allow the SDP to affect the
1525	   directionality when joining streams internal to the media server.

1527	9.3   <createconference>

1529	   <createconference> is used to allocate and configure the media mixing
1530	   resources for conferences. A description of the properties for each
1531	   type of media mix required for the conference is defined within the
1532	   content of the <createconference> element. Mixer descriptions are
1533	   described in Audio Mix and Video Layout sections. When no mixer
1534	   descriptions are specified, the default behavior MUST be equivalent
1535	   to inclusion of a single <audiomix>.

1537	   Clients can request that a media server automatically delete a
1538	   conference when a specified condition occurs by using the
1539	   "deletewhen" attribute. A value of "nomedia" indicates that the
1540	   conference MUST be deleted when no participants remain into the
1541	   conference. When this occurs, an "msml.conf.nomedia" event MUST be
1542	   notified to the MSML client. A value of "nocontrol" indicates the
1543	   conference MUST be deleted when the SIP [n1] dialog that carries the
1544	   <createconference> element is terminated. When this occurs, a media
1545	   server MUST terminate all participant dialogs by sending a BYE for
1546	   their associated SIP dialog. A value of "never" MUST leave the
1547	   ability to delete a conference under the control of the MSML client.

1549	   Attributes:

1551	         name: the instance name of the conference. If the attribute is
1552	         not present, the media server MUST assign a globally unique
1553	         name for the conference. If the attribute is present but the
1554	         name is already in use, an error (432) will result and MSML
1555	         document execution MUST stop. Events which the conference
1556	         generates use this name as the value of their "id" attribute
1557	         (see section 5.6.2 (<event>)).

1559	         deletewhen: defines whether a media server should automatically
1560	         delete the conference. Possible values are "nomedia",
1561	         "nocontrol", and "never". Default is "nomedia".

1563	         term: when true, the media server MUST send a BYE request on
1564	         all SIP dialogs still associated with the conference when the
1565	         conference is deleted. Setting term equal to false allows
1566	         clients to start dialogs on connections once the conference has
1567	         completed. Default true.

1569	Internet-draft       Media Server Markup Language        February 2008
1570	                                 (MSML)

1572	         mark: a token which MAY be used to identify execution progress
1573	         in the case of errors. The value of the mark attribute from the
1574	         last successfully executed MSML element is returned in an error
1575	         response. Therefore the value of all mark attributes within an
1576	         MSML document should be unique.

1578	   An example of creating an audio conference is shown below. This
1579	   conference allows at most two participants to contend to be heard and
1580	   reports the set of active speakers no more frequently than every ten
1581	   seconds.

1583	            <?xml version="1.0" encoding="UTF-8"?>
1584	            <msml version="1.1">
1585	               <createconference name="example">
1586	                  <audiomix>
1587	                     <n-loudest n="3"/>
1588	                     <asn ri="10s"/>
1589	                  </audiomix>
1590	               </createconference>
1591	            </msml>

1593	9.3.1    <reserve>

1595	   Conference resources may be reserved by including the <reserve>
1596	   element as a child of <createconference>. <reserve> allows the
1597	   specification of a set of resources which a media server will reserve
1598	   for the conference. Any requests for resources beyond those that have
1599	   been reserved should be honored on a best-effort basis by a media
1600	   server.

1602	   Attributes:

1604	         required: boolean that specifies whether <createconference>
1605	         should fail if the requested resources are not available. When
1606	         set to false, the conference will be created, with no reserved
1607	         resources, if the complete reservation cannot be honored.
1608	         Default true.

1610	9.3.1.1      <resource>

1612	   The resources to be reserved are defined using <resource>. The
1613	   contents of these elements describe a resource that is to be
1614	   reserved. Descriptions are implementation-dependent. Media servers
1615	   that support MSML Dialogs may use the elements from that package as
1616	   the basis for resource descriptions. Each resource element may use
1617	   the attribute "n" to define the quantity of the resource to reserve.

1619	Internet-draft       Media Server Markup Language        February 2008
1620	                                 (MSML)

1622	   For example, the following creates a conference and reserves two
1623	   types of resources. One resource element may represent resources that
1624	   are shared by all participants of the conference while the other may
1625	   represent resources that are reserved for each of the expected
1626	   participants.

1628	   Attributes:

1630	         n: number of resources to be reserved. Default 1.

1632	         type: specifies whether the resource is to be reserved by each
1633	         individual participant or reserved as a shared conference
1634	         resource. Valid values for this attribute are "individual" or
1635	         "shared". Default "individual".

1637	      <createconference>
1638	         <reserve>
1639	            <resource n="20">
1640	              <!--description of resources used by each participant-->
1641	            </resource>
1642	            <resource n="2" type="shared">
1643	              <!--description of the shared conference resources-->
1644	            </resource>
1645	         </reserve>
1646	      </createconference>

1648	9.4   <modifyconference>

1650	   All of the properties of an audio mix or the presentation of a video
1651	   mix may be changed during the life of a conference using the
1652	   <modifyconference> element. Changes to an audio mix are requested by
1653	   including an <audiomix> element as a child of <modifyconference>.
1654	   This may also be used to add an audio mixer to the conference if none
1655	   was previously allocated. Changes to a video presentation are
1656	   requested by including a <videolayout> element as a child of
1657	   <modifyconference>. Similar to an audio mixer, this may be used to
1658	   add a video mixer if none was previously allocated.

1660	   Mixers are removed by including a mixer description element within
1661	   <destroyconference/>.

1663	   Features and presentation aspects are enabled/added or modified by
1664	   including the element(s) that define the feature or presentation
1665	   aspect within a mixer description. The complete specification of the
1666	   element must be included just as it would be included when the
1667	   conference is created. The new definition completely replaces any
1668	   previous definition that existed. Only things that are defined by
1669	   elements included in the mixer descriptions are affected. Any

1671	Internet-draft       Media Server Markup Language        February 2008
1672	                                 (MSML)

1674	   existing configuration aspects of a conference, which are not
1675	   specified within the <modifyconference/> element, MUST maintain their
1676	   current state in the Media Server.

1678	   For example, if an MSML client wanted to change the minimum reporting
1679	   interval for active speaker notification from that shown in the
1680	   Conference Examples section (<createconference>) it would send the
1681	   following to the media server:

1683	            <?xml version="1.0" encoding="UTF-8"?>
1684	            <msml version="1.1">
1685	               <modifyconference id="conf:example">
1686	                  <audiomix>
1687	                     <asn ri="4"/>
1688	                  </audiomix>
1689	               </modifyconference>
1690	            </msml>

1692	   This would also enable active speaker notification if it had not
1693	   previously been enabled. The N-loudest mixing is unaffected.

1695	   Multiple elements MAY be included in the mixer descriptions similar
1696	   to when conferences are created. For example, in a video conference,
1697	   the video mix description (<videolayout>) could specify that the
1698	   layout of the video being displayed should change such that the
1699	   regions currently displaying participants get smaller and new
1700	   region(s) are created to support additional participants. A media
1701	   server MUST make all of the requested changes or none of the
1702	   requested changes.

1704	   Additional examples of modifying conferences are presented in the
1705	   Conference Examples section.

1707	   Attributes:

1709	         id: the identifier for a conference. Wildcards MUST NOT be
1710	         used. Mandatory.

1712	         mark: a token which can be used to identify execution progress
1713	         in the case of errors. The value of the mark attribute from the
1714	         last successfully executed MSML element is returned in an error
1715	         response. Therefore the value of all "mark" attributes within
1716	         an MSML document SHOULD be unique.

1718	Internet-draft       Media Server Markup Language        February 2008
1719	                                 (MSML)

1721	9.5   <destroyconference>

1723	   Destroy conference is used to delete mixers or to delete the entire
1724	   conference and all state and shared resources. When a mixer is
1725	   removed, all of the streams joined to that mixer are unjoined. When a
1726	   conference is destroyed, SIP dialogs for any remaining participants
1727	   MUST be maintained or removed based on the value of the "term"
1728	   attribute when the conference was created.

1730	   When there is no element content, <destroyconference/> deletes the
1731	   entire conference. Individual mixer(s) are removed by including a
1732	   mixer description element identifying the mix(es) to be removed as
1733	   content to <destroyconference/>. <audiomix/> is used remove audio
1734	   mixers and <videolayout/> is used remove video mixers. When one or
1735	   more mixer descriptions are specified, then Media Server MUST only
1736	   delete the specified mixer and MUST NOT affect any other existing
1737	   mixers. When <audiomix/> or <videolayout/> are identified for
1738	   individual removal, other feature aspects of the mix MUST NOT be
1739	   included. If specified, the Media Server MUST ignore any such
1740	   elements. When the last mixer is removed from a conference, a media
1741	   server MUST remove all conference state, leaving or removing any
1742	   remaining SIP dialogs as described above.

1744	   Attributes:

1746	         id: the identifier for a conference. Mandatory.

1748	         mark: a token which can be used to identify execution progress
1749	         in the case of errors. The value of the mark attribute from the
1750	         last successfully executed MSML element is returned in an error
1751	         response. Therefore the value of all "mark" attributes within
1752	         an MSML document SHOULD be unique.

1754	9.6   <audiomix>

1756	   The properties of the overall audio mix are specified using the
1757	   <audiomix> element.

1759	   Attributes:

1761	         id: an optional identifier for the audio mix.

1763	         samplerate: Integer value specifies the sample rate (in Hz) for
1764	         the audio mixer. Optional, default value of 8000.

1766	   An example of the description for an audio mix is:

1768	      <audiomix id="mix1">

1770	Internet-draft       Media Server Markup Language        February 2008
1771	                                 (MSML)

1773	         <asn ri="10s"/>
1774	         <n-loudest n="3"/>
1775	      </audiomix>

1777	9.6.1    <n-loudest>

1779	   The <n-loudest> element defines that participants contend to be
1780	   included in the conference mix based upon their audio energy. When
1781	   the element is not present, all participants are mixed.

1783	   Attributes:

1785	         n: the number of participants that will be included in the
1786	         audio mix based upon having the greatest audio energy.
1787	         Mandatory.

1789	9.6.2    <asn>

1791	   The <asn> element enables notification of active speakers. Active
1792	   speakers MUST be notified using the <event> element with an event
1793	   name of "msml.conf.asn". The namelist of the event consists of the
1794	   set of active speakers. The name of each item is the string "speaker"
1795	   with a value of the connection identifier for the connection.

1797	   Attributes:

1799	         ri: the minimum reporting interval defines the minimum duration
1800	         of time which must pass before changes to active speakers will
1801	         be reported. A value of zero disables active speaker
1802	         notification.

1804	         asth: specifies the active speaker threshold (in unit of dBm0).
1805	         Valid value range is 0 to -96. Optional, default is -96.

1807	   An example of an active speaker notification is:

1809	      <event name="msml.conf.asn" id="conf:example">
1810	         <name>speaker</name>
1811	         <value>conn:hd93tg5hdf</value>
1812	         <name>speaker</name>
1813	         <value>conn:w8cn59vei7</value>
1814	         <name>speaker</name>
1815	         <value>conn:p78fnh6sek47fg</value>
1816	      </event>

1818	Internet-draft       Media Server Markup Language        February 2008
1819	                                 (MSML)

1821	9.7   <videolayout>

1823	   A video layout is specified using the <videolayout> element. It is
1824	   used as a container to hold elements that describe all of the
1825	   properties of a video mix. The parameters of the window that displays
1826	   the video mix are defined by the <root> element. When the video mix
1827	   in composed of multiple panes, the location and characteristics of
1828	   the panes are defined by one or more <region> elements. A <region>
1829	   element is not required when only a single video stream is displayed
1830	   at one time and none of the visual attributes of regions are
1831	   required.

1833	   Some regions may be used to display a video stream based on a
1834	   selection criteria rather than having a video stream of a single
1835	   participant continuously presented in the region. One such an example
1836	   is a distance learning lecture where the instructor sees each of the
1837	   students periodically displayed in a region. When a region is used to
1838	   display one of a number of streams, it is placed as a child of a
1839	   <selector> element.

1841	   Attributes:

1843	         type: specifies the language used to define the layout. Layouts
1844	         defined using MSML MUST use the value "text/msml-basic-layout".
1845	         This is the same convention as defined for the layout package
1846	         from the W3C SMIL 2.0 specification [i6]. The default when
1847	         omitted is "text/msml-basic-layout".

1849	         id: an optional identifier for the video layout.

1851	9.7.1    <root>

1853	   The <root> element describes the root window or virtual screen in
1854	   which the conference video mix will be displayed. Simple conferences
1855	   can display participant video directly within the root window but
1856	   more complex conferences will use regions for this purpose. Areas of
1857	   the window which are not used to display video will show the root
1858	   window background.

1860	   All video presentations require a root window. It MUST be present
1861	   when a video mix is created and it cannot be deleted, however its
1862	   attributes MAY be changed using the <modifyconference> element.

1864	   Attributes:

1866	         size: the size of the root window specified as one of the five
1867	         standard common intermediate formats (e.g. CIF, QCIF, etc.).

1869	Internet-draft       Media Server Markup Language        February 2008
1870	                                 (MSML)

1872	         backgroundcolor: the color for the root window background
1873	         defined using the values for the "background-color" property of
1874	         the CSS2 specification [n10].

1876	         backgroundimage: the URI for an image to be displayed as the
1877	         root window background. Transparent portions of the image allow
1878	         the background color to show through.

1880	9.7.2    <region>

1882	   <region> elements define video panes that are used to display
1883	   participant video streams. Regions are rendered on top of the root
1884	   window.

1886	   The size of a region is specified relative to the size of the root
1887	   window using the "relativesize" attribute. Relative sizes are
1888	   expressed as fractions (e.g. 1/4, 1/3) that preserve the aspect ratio
1889	   of the original video stream while allowing for efficient scaling
1890	   implementations.

1892	   Regions are located on the root window based on the value of the
1893	   position attributes "top" and "left". These attributes define the
1894	   position of the top left corner of the region as an offset from the
1895	   top left corner of the root window. Their values may be expressed
1896	   either as a number of pixels or as a percent of the vertical or
1897	   horizontal dimension of the root window. Percent values are appended
1898	   with a percent ('%') character. Percent values of "33%" and "67%"
1899	   should be interpreted as "1/3" and "2/3" to allow easy alignment of
1900	   regions whose size is expressed relative to the size of the root
1901	   window.

1903	   An example of a video layout with six regions is:

1905	         +-------+---+
1906	         |       | 2 |
1907	         |   1   +---+
1908	         |       | 3 |
1909	         +---+---+---+
1910	         | 6 | 5 | 4 |
1911	         +---+---+---+

1913	      <videolayout type="text/msml-basic-layout">
1914	         <root size="CIF"/>
1915	         <region id="1" left="0" top="0" relativesize="2/3"/>
1916	         <region id="2" left="67%" top="0" relativesize="1/3"/>
1917	         <region id="3" left="67%" top="33%" relativesize="1/3">
1918	         <region id="4" left="67%" top="67%" relativesize="1/3"/>

1920	Internet-draft       Media Server Markup Language        February 2008
1921	                                 (MSML)

1923	         <region id="5" left="33%" top="67%" relativesize="1/3"/>
1924	         <region id="6" left="0" top="67%" relativesize="1/3"/>
1925	      </videolayout>

1927	   The area of the root window covered by a region is a function of the
1928	   region's position and its size. When areas of different regions
1929	   overlap, they are layered in order of their "priority" attribute. The
1930	   region with the highest value for the "priority" attribute is below
1931	   all other regions and will be hidden by overlapping regions. The
1932	   region with the lowest non-zero value for the "priority" attribute is
1933	   on top of all other regions and will not be hidden by overlapping
1934	   regions. The priority attribute may be assigned values between 0 and
1935	   1. A value of zero disables the region, freeing any resources
1936	   associated with the region, and unjoining any video stream displayed
1937	   in the region.

1939	   Regions that do not specify a priority will be assigned a priority by
1940	   a media server when a conference is created. The first region within
1941	   the <videolayout> element that does not specify a priority will be
1942	   assigned a priority of one, the second a priority of two, etc. In
1943	   this way, all regions that do not explicitly specify a priority will
1944	   be underneath all regions that do specify a priority. As well, within
1945	   those regions that do not specify a priority, they will be layered
1946	   from top to bottom, in the order they appear within the <videolayout>
1947	   element.

1949	   For example, if a layout was specified as follows:

1951	      <videolayout>
1952	         <root size="CIF"/>
1953	         <region id="a" ... priority=".3" .../>
1954	         <region id="b" ... />
1955	         <region id="c" ... priority=".2" ...>
1956	         <region id="d" ... />
1957	      </videolayout>

1959	   Then the regions would be layered, from top to bottom, c,a,b,d.

1961	   Portions of regions that extend beyond the root window will be
1962	   cropped. For example, a layout specified as:

1964	      <videolayout>
1965	         <root size="CIF"/>
1966	         <region id="foo" left="50%" top="50%" relativesize="2/3"/>
1967	      </videolayout>

1969	Internet-draft       Media Server Markup Language        February 2008
1970	                                 (MSML)

1972	   would appear similar to:

1974	         +-----------+
1975	         |   root    |
1976	         |background |
1977	         |     +-----+--
1978	         |     |     |//
1979	         |     | foo |//
1980	         +-----+-----+//
1981	               |////////

1983	   Visual attributes are used to define aspects of the visual appearance
1984	   of individual regions. A border may be defined together with a title
1985	   and/or logo. Text and logos are displayed as images on top of the
1986	   region's video, below all regions with a lower priority. The visual
1987	   attributes are "title", "titletextcolor", "titlebackgroundcolor",
1988	   "bordercolor", "borderwidth", and "logo".

1990	   Visual attributes can also be defined for individual streams (Video
1991	   Stream Properties). When visual attributes are specified as part of
1992	   both a region and a stream, those associated with the stream MUST
1993	   take precedence. This allows streams that are chosen for display
1994	   automatically (Stream Selection) to have proper text and logos
1995	   displayed. The region visual attributes are displayed when no stream
1996	   is associated with the region.

1998	   Two other attributes associated with a region, "blank" and "freeze",
1999	   define the state of the video displayed in the region. When the blank
2000	   or freeze attribute is assigned the value "true", then the Media
2001	   Server MUST display the region either as a blank region, or the video
2002	   image frozen at the last received frame.

2004	   These attributes are specified for a region and not allowed for
2005	   streams because that appears to be the common use case. Applying them
2006	   to streams would allow only that stream to be affected within a
2007	   selector while other streams continue to display normally. Except for
2008	   personal mixing scenarios, the same effect can be achieved by having
2009	   the participant mute their own transmission to the media server.

2011	   Attributes: associated with each region:

2013	         id: a name that can be used to refer to the region.

2015	         left: the position of the region from the left side of the root
2016	         window.

2018	Internet-draft       Media Server Markup Language        February 2008
2019	                                 (MSML)

2021	         top: the position of the region from the top of the root
2022	         window.

2024	         relativesize: the size of the region expressed as a fraction of
2025	         the root window size.

2027	         priority: a number between 0 and 1 that is used to define the
2028	         precedence when rendering overlapping regions. A value of zero
2029	         disables the region.

2031	         title: text to be displayed as the title for the region

2033	         titletextcolor: the color of the text

2035	         titlebackgroundcolor: the color of the text background

2037	         bordercolor: the color of the region border

2039	         borderwidth: the width of the region border

2041	         logo: the URI of an image file to be displayed

2043	         freeze: a boolean value, with a default of false, that defines
2044	         whether the video image should be frozen at the currently
2045	         displayed frame

2047	         blank: a boolean value, with a default of false, that defines
2048	         whether the region should display black instead of the
2049	         associated video stream

2051	9.7.3    <selector>

2053	   It is often desired that one of several video streams be
2054	   automatically selected to be displayed. The <selector> element is
2055	   used to define the selection criteria and its associated parameters.
2056	   The selection algorithm is specified by the "method" attribute.
2057	   Currently defined selection methods allow for voice activated
2058	   switching and to iterate sequentially through the set of associated
2059	   video streams.

2061	   The regions that will display the selected video stream are placed as
2062	   child elements of the <selector> element. Including regions within a
2063	   <selector> element does not affect their layout with respect to
2064	   regions not subject to the selection. For simple video conferences
2065	   that display the video directly in the root window, the <root>
2066	   element can be placed as a child of <selector>. Region elements MUST
2067	   NOT be used in this case.

2069	Internet-draft       Media Server Markup Language        February 2008
2070	                                 (MSML)

2072	   For example, below is a common video layout that allows the video
2073	   stream from the currently active speaker to be displayed in the large
2074	   region ("1") at the top left of the layout while the streams from
2075	   five other participants are displayed in regions located at the
2076	   layout periphery.

2078	         +-------+---+
2079	         |       | 2 |
2080	         |   1   +---+
2081	         |       | 3 |
2082	         +---+---+---+
2083	         | 6 | 5 | 4 |
2084	         +---+---+---+

2086	      <videolayout type="text/msml-basic-layout">
2087	         <root size="CIF"/>
2088	         <selector id="switch" method="vas">
2089	            <region id="1" left="0" top="0" relativesize="2/3"/>
2090	         </selector>
2091	         <region id="2" left="67%" top="0" relativesize="1/3"/>
2092	         <region id="3" left="67%" top="33%" relativesize="1/3">
2093	         <region id="4" left="67%" top="67%" relativesize="1/3"/>
2094	         <region id="5" left="33%" top="67%" relativesize="1/3"/>
2095	         <region id="6" left="0" top="67%" relativesize="1/3"/>
2096	      </videolayout>

2098	   All selector methods must be defined so that they work if only a
2099	   single region is a child of the selector. Selector methods that
2100	   support more than one child region MUST specify how the method works
2101	   across multiple regions. Media server implementations MAY support
2102	   only a single region for methods that are defined to allow multiple
2103	   regions.

2105	   The selector or region for a participant's video is defined using the
2106	   "display" attribute of <stream> during a join operation. Specifying a
2107	   selector allows the stream to be displayed according to the criteria
2108	   defined by the selector method. Specifying a region supports
2109	   continuous presence display of participants. Some streams may be
2110	   joined with both a selector and a region. In this case, the value of
2111	   <blankothers> attribute defines whether the streams associated with a
2112	   continuous presence region should be blanked when the stream is
2113	   selected for display in one of the selector regions.

2115	   Attributes: common to all selector methods are:

2117	Internet-draft       Media Server Markup Language        February 2008
2118	                                 (MSML)

2120	         id: a name that can be used to refer to the selector.

2122	         method: the name of the method used to select the video stream.
2123	         A value of "vas" (see section on Voice Activated Switching) MAY
2124	         be specified.

2126	         status: specifies whether the selector is "active" or
2127	         "disabled".

2129	         blankothers: when "true", video streams that are also displayed
2130	         in continuous presence regions will have the continuous
2131	         presence regions blanked when the stream is displayed in a
2132	         selection region.

2134	9.7.3.1      Voice Activate Switching (vas)

2136	   Voice activated switching (VAS) is used to display the video stream
2137	   that correlates with the participant who is currently speaking. It is
2138	   specified using a selector method value of "vas".

2140	   If the video stream associated with the active speaker is not
2141	   currently displayed in a selection region, then it replaces the video
2142	   in the region that is displaying the video of the speaker that was
2143	   least recently active. If the video of the active speaker is
2144	   currently displayed in a selection region, then there is no change to
2145	   any region. When VAS is applied to a single region, this has the
2146	   effect that the current speaker is displayed in that region.

2148	   Attributes:

2150	         si: switching interval is the minimum period of time that must
2151	         elapse before allowing the video to switch to the active
2152	         speaker.

2154	         speakersees: defines whether the active speaker sees the
2155	         "current" speaker (themselves) or the "previous" speaker.

2157	9.8   <join>

2159	   <join> is used to create one or more streams between two independent
2160	   objects. Streams may be audio or video and may be bidirectional or
2161	   unidirectional. A bidirectional stream is implicitly composed of two
2162	   unidirectional streams that can be manipulated independently. The
2163	   streams to be established are specified by <stream> elements (section
2164	   <stream>) as the content of <join>.

2166	   Without any content, <join> by default establishes a bidirectional
2167	   audio stream. When only a stream of a single type has previously been

2169	Internet-draft       Media Server Markup Language        February 2008
2170	                                 (MSML)

2172	   created between two objects, or when only a unidirectional stream
2173	   exists, <join> can be used to add a stream of another media type or
2174	   make the stream bidirectional by including the necessary <stream>
2175	   elements. Bidirectional streams are made unidirectional by using
2176	   <unjoin> (section <unjoin>) to remove the unidirectional stream for
2177	   the direction that is no longer required.

2179	   In addition to defining the media type and direction of streams,
2180	   <stream> elements are also used to establish the properties of
2181	   streams, such as gain, voice masking, or tone clamping of audio
2182	   streams, or labels and other visual characteristics of video streams.
2183	   Properties are often defined asymmetrically for a single direction of
2184	   a stream. Creating a bidirectional stream requires two <stream>
2185	   elements within the <join>, one for each direction, if one direction
2186	   is to have different properties from the other direction.

2188	   If a media server can provide services using both compressed or
2189	   uncompressed media, the MSML client may need to distinguish within
2190	   requests which format is to be used. When compressed streams are
2191	   created, both objects must use the same media format or an error
2192	   response (450) is generated.

2194	   Attributes:

2196	         id1: an identifier of either a connection or conference.
2197	         Wildcards MUST NOT be used. Mandatory. Any other object class
2198	         results in a 440 error.

2200	         id2: an identifier of either a connection or conference.
2201	         Wildcards MUST NOT be used. Mandatory. Any other object class
2202	         results in a 440 error.

2204	         mark: a token which can be used to identify execution progress
2205	         in the case of errors. The value of the mark attribute from the
2206	         last successfully executed MSML element is returned in an error
2207	         response. Therefore the value of all mark attributes within an
2208	         MSML document SHOULD be unique.

2210	   For example, consider a call center coaching scenario where a
2211	   supervisor can listen to the conversation between an agent and a
2212	   customer, and provide hints to the agent, which are not heard by the
2213	   customer. One join establishes a stream between the agent and the
2214	   customer and another join establishes a stream between the agent and
2215	   the supervisor. A third join is used to establish a half-duplex
2216	   stream from the customer to the supervisor. The media server
2217	   automatically bridges the media streams from the customer and the
2218	   supervisor for the agent, and from the customer and the agent for the
2219	   supervisor.

2221	Internet-draft       Media Server Markup Language        February 2008
2222	                                 (MSML)

2224	   Assuming the following connections, each with a single audio stream:

2226	         conn:supervisor

2228	         conn:agent

2230	         conn:customer

2232	   The following would create the media flows previously described:

2234	      <?xml version="1.0" encoding="UTF-8"?>
2235	      <msml version="1.1">
2236	         <join id1="conn:supervisor" id2="conn:agent"/>
2237	         <join id1="conn:agent" id2="conn:customer"/>
2238	         <join id1="conn:supervisor" id2="conn:customer">
2239	            <stream media="audio" dir="to-id1"/>
2240	         </join>
2241	      </msml>

2243	   The following example, shows joining a participant to a multimedia
2244	   conference. It assumes that the conference has a video presentation
2245	   region named "topright". The "display" attribute is explained in
2246	   section Video Stream Properties.

2248	      <?xml version="1.0" encoding="UTF-8"?>
2249	      <msml version="1.1">
2250	         <join id1="conn:hd83t5hf7g3" id2="conf:example">
2251	            <stream media="audio"/>
2252	            <stream media="video" dir="from-id1" display="topright"/>
2253	            <stream media="video" dir="to-id1"/>
2254	         </join>
2255	      </msml>

2257	9.9   <modifystream>

2259	   Media streams can have different properties such as the gain for an
2260	   audio stream or a visual label for a video stream. These properties
2261	   are specified as the content of <stream> elements (section <stream>).
2262	   <modifystream> is used to change the properties of a stream by
2263	   including one or more <stream> elements that are to have their
2264	   properties changed.

2266	   Stream properties MUST be set as specified by the element <stream> as
2267	   a child element of <modifystream> element. Any properties not
2268	   included in the <stream> element when modifying a stream MUST remain
2269	   unchanged. Setting a property for only one direction of a
2270	   bidirectional stream MUST NOT affect the other direction. The

2272	Internet-draft       Media Server Markup Language        February 2008
2273	                                 (MSML)

2275	   directionality of streams can be changed using issuing an <unjoin>
2276	   followed by a <join>. Any streams that exist between the two objects
2277	   that are not included within <modifystream> MUST NOT be affected.

2279	   Attributes:

2281	         id1: an identifier of either a conference or a connection. The
2282	         instance name MUST NOT contain a wildcard if "id2" contains a
2283	         wildcard. Mandatory.

2285	         id2: an identifier of either a conference or a connection. The
2286	         instance name MUST NOT contain a wildcard if "id1" contains a
2287	         wildcard. Mandatory.

2289	         mark: a token which can be used to identify execution progress
2290	         in the case of errors. The value of the mark attribute from the
2291	         last successfully executed MSML element is returned in an error
2292	         response. Therefore the value of all mark attributes within an
2293	         MSML document are RECOMMENDED to be unique.

2295	9.10    <unjoin>

2297	   Unjoin removes one or more media streams between two objects. In the
2298	   absence of any content in <stream> element, all media streams between
2299	   the objects MUST be removed. Individual streams may be removed by
2300	   specifying them using <stream> elements, while the unspecified
2301	   streams MUST NOT be removed. A bidirectional stream is changed to a
2302	   unidirectional stream by unjoining the direction that is no longer
2303	   required, using the <unjoin> element. Operator elements MUST NOT be
2304	   specified within <stream> elements when streams are being unjoined
2305	   using the <unjoin> element. Any specified stream operators MUST be
2306	   ignored.

2308	   <unjoin> and <join> may be used together to move a media stream, such
2309	   as from a main conference to a sidebar conference.

2311	   Attributes:

2313	         id1: an identifier of either a conference or a connection. The
2314	         instance name MUST NOT contain a wildcard if "id2" contains a
2315	         wildcard. Mandatory.

2317	         id2: an identifier of either a conference or a connection. The
2318	         instance name MUST NOT contain a wildcard if "id1" contains a
2319	         wildcard. Mandatory.

2321	         mark: a token which can be used to identify execution progress
2322	         in the case of errors. The value of the mark attribute from the

2324	Internet-draft       Media Server Markup Language        February 2008
2325	                                 (MSML)

2327	         last successfully executed MSML element is returned in an error
2328	         response. Therefore the value of all mark attributes within an
2329	         MSML document SHOULD be unique.

2331	   The following removes a participant from a conference and plays a
2332	   leave tone for the remaining participants in the conference.

2334	            <?xml version="1.0" encoding="UTF-8"?>
2335	            <msml version="1.1">
2336	               <unjoin id1="conn:jd73ht89sf489f" id2="conf:1"/>
2337	               <dialogstart target="conf:1" type="application/moml+xml">
2338	                  <play>
2339	                     <audio uri="file://leave_tone.wav"/>
2340	                  </play>
2341	               </dialogstart>
2342	            </msml>

2344	9.11    <monitor>

2346	   Monitor is a specialized unidirectional join that copies the media
2347	   that is destined for a connection object. One example of the use for
2348	   <monitor> may be quality monitoring within a conference. The media
2349	   stream may be removed using the <unjoin> element (see section
2350	   <unjoin>).

2352	   Attributes:

2354	         id1: an identifier of the connection to be monitored.
2355	         Mandatory. Any other object class results in a 440 error.
2356	         Wildcards MUST NOT be used.

2358	         id2: an identifier of the object which is to receive the copy
2359	         of the media destined to id1. id2 may be a connection or a
2360	         conference. Mandatory. Any other object class results in a 440
2361	         error. Wildcards MUST NOT be used.

2363	         compressed: "true" or "false". Specifies whether the join
2364	         should occur before or after compression. When "true", id2 must
2365	         be a connection using the same media format as id1 or an error
2366	         response (450) is generated. Default is "false.

2368	         mark: a token which can be used to identify execution progress
2369	         in the case of errors. The value of the mark attribute from the
2370	         last successfully executed MSML element is returned in an error
2371	         response. Therefore the value of all mark attributes within an
2372	         MSML document SHOULD be unique.

2374	Internet-draft       Media Server Markup Language        February 2008
2375	                                 (MSML)

2377	9.12    <stream>

2379	   Individual streams are specified using the <stream> element. They MAY
2380	   be included as a child element in any of the stream manipulation
2381	   elements <join>, <modifystream>, or <unjoin>.

2383	   The type of the stream is specified using a "media" attribute that
2384	   uses values corresponding to the top-level MIME media types as
2385	   defined in RFC 2046 [i7]. This specification only addresses audio and
2386	   video media. Other specifications may define procedures for
2387	   additional types.

2389	   A bidirectional stream is identified when no direction attribute
2390	   "dir" is present. A unidirectional stream is identified when a
2391	   direction attribute is present. The "dir" attribute MUST have a value
2392	   of "from-id1" or "to-id1" depending on the required direction. These
2393	   values are relative to the identifier attributes of the parent
2394	   element.

2396	   The compressed attribute is used to distinguish the compressed nature
2397	   of the stream when necessary. It is implementation specific what is
2398	   used when the attribute is not present. Joining compressed streams
2399	   acts much like an RTP [i3] relay.

2401	   The properties of the media streams are specified as the content of
2402	   <stream> elements when the element is used as a child of <join> or
2403	   <modifystream>. Stream elements MUST NOT have any content when they
2404	   are used as a child of <unjoin> to identify specific streams to
2405	   remove.

2407	   Some properties are defined within MSML as additional attributes or
2408	   child elements of <stream> that are media type specific. Ones for
2409	   audio streams and video streams are defined in the following two sub-
2410	   sections. Operators, viewed as properties of the media stream, MAY be
2411	   specified as child elements of the <stream> element.

2413	   Attributes:

2415	         media: "audio" or video". Mandatory

2417	         dir: "from-id1" or "to-id1".

2419	         compressed: "true" or "false". Specifies whether the stream
2420	         uses compressed media. Default is implementation specific.

2422	Internet-draft       Media Server Markup Language        February 2008
2423	                                 (MSML)

2425	9.12.1     Audio Stream Properties

2427	   Audio mixes can be specified to only mix the N-loudest participants.
2428	   However there may be some "preferred" participants that are always
2429	   able to contribute. When audio streams are joined to a conference
2430	   that uses N-loudest audio mixing, preferred streams need to be
2431	   identified.

2433	   A preferred audio stream is identified using the "preferred"
2434	   attribute. The "preferred" attribute MAY be used for an audio stream
2435	   that is input to a conference and MUST NOT be used for other streams.

2437	   Additional attributes of the <stream> element for audio streams are:

2439	   Attributes:

2441	         preferred: a boolean value that defines whether the stream does
2442	         not contend for N-loudest mixing. A value of "true" means that
2443	         the stream MUST always be mixed while a value of "false" means
2444	         that the stream MAY contend for mixing into a conference when
2445	         N-loudest mixing is enabled. Default "false".

2447	   There are two elements that can be used to change the characteristics
2448	   of an audio stream as defined below.

2450	9.12.1.1      <gain>

2452	   The <gain> element may be used to adjust the volume of an audio media
2453	   stream. It may be set to a specific gain amount, to automatically
2454	   adjust the gain to a desired target level, or to mute the stream.

2456	   Attributes:

2458	         id: an optional identifier which may be referenced elsewhere
2459	         for sending events to the gain primitive.

2461	         amt: a specific gain to apply specified in dB or the string
2462	         "mute" indicating that the stream should be muted. This
2463	         attribute MUST NOT be used if "agc" is present.

2465	         agc: boolean indicating whether automatic gain control is to be
2466	         used. This attribute MUST NOT be used if "amt" is present.

2468	         tgtlvl: the desired target level for AGC specified in dBm0.
2469	         This attribute MUST be specified if "agc" is set to "true".
2470	         This attribute MUST NOT be specified if "agc" is not present.

2472	Internet-draft       Media Server Markup Language        February 2008
2473	                                 (MSML)

2475	         maxgain: the maximum gain that AGC may apply. Maxgain is
2476	         specified in dB. This attribute MUST be used if "agc" is
2477	         present and MUST NOT be used when "agc" is not present.

2479	9.12.1.2      <clamp>

2481	   The <clamp> element is used to filter tones and/or audio-band dtmf
2482	   from a media stream.

2484	   Attributes:

2486	         dtmf: boolean indicating whether DTMF tones should be removed.

2488	         tone: boolean indicating whether other tones should be removed.

2490	9.12.2     Video Stream Properties

2492	   Video mixes define a presentation that may have multiple regions,
2493	   such as a quad-split. Each region displays the video from one or more
2494	   participants. When video streams are joined to such a conference, the
2495	   region that will display the video needs to be specified as part of
2496	   the join operation.

2498	   The region that will display the video is specified using the
2499	   "display" attribute. The "display" attribute MUST be used for a video
2500	   stream that is input to a conference and MUST NOT be used for other
2501	   streams. The value of the attribute MUST identify a <region> (see
2502	   section <region>) or a <selector> (see section <selector>) that is
2503	   defined for the conference. A stream MUST NOT be directly joined to a
2504	   region that is defined within a selector. Changing the value of the
2505	   "display" attribute can be used to change where in a video
2506	   presentation layout a video stream is displayed.

2508	   Additional attributes of the <stream> element for video streams are:

2510	   Attributes:

2512	         display: the identifier of a video layout region or selector
2513	         that is to be used to display the video stream.

2515	         override: specifies whether or not the given video stream is
2516	         the override source in the region defined by "display"
2517	         attribute. Valid values are: "true" or "false". Optional,
2518	         default value is "false". Only a video stream that is input to
2519	         a conference can be the override source. A particular region
2520	         can have at most one override source at a time. The most
2521	         recently joined video stream with this attribute set to "true"
2522	         becomes the override source. When there's an override source in

2524	Internet-draft       Media Server Markup Language        February 2008
2525	                                 (MSML)

2527	         place, its video is always displayed in the region, regardless
2528	         of what video selection algorithm (either a selector or
2529	         continuous presence mode) is configured for that region. Once
2530	         the override source is cleared, the conference MUST revert back
2531	         to original video selection algorithm.

2533	9.12.2.1      <visual>

2535	   Some regions of video conferences may display different streams
2536	   automatically, such as when voice activated switching is used.
2537	   Connections MAY also be joined directly without the use of video
2538	   mixing. In these cases, the <visual> element may be used to define
2539	   visual display properties for a stream.

2541	   The <visual> element MAY use any of the visual attributes defined for
2542	   regions (see section <region>). This allows the visual aspects of
2543	   regions within a <selector> to be tailored to the selected video
2544	   stream, or for streams that are directly joined to display a name or
2545	   logo.

2547	10.   MSML Dialog Packages

2549	10.1    Overview

2551	   MSML Dialog Packages define an XML [n2] language for composing
2552	   complex media objects from a vocabulary of simple media resource
2553	   objects called primitives. It is primarily a descriptive or
2554	   declarative language to describe media processing objects. MSML
2555	   dialogs operate on a single or multiple streams which are identified
2556	   by the MSML document outside the scope of the MSML dialog package.

2558	   MSML Dialogs are intended to be used in different environments. As
2559	   such, the language itself does not define how an MSML Dialog is used.
2560	   Each environment in which MSML Dialog is used must define how it is
2561	   used, the set of services provided and the mechanism for passing
2562	   information between the environment and MSML Dialog. The specific
2563	   mechanisms used to realize the interface between MSML Dialog and its
2564	   environment are platform specific.

2566	   MSML Dialog packages provide two models for access to media resources
2567	   and service creation building blocks. Both models MAY be used in
2568	   conjunction with each other in a complementary manner. The first
2569	   model (referred to as "Media Primitives and Composites", part of the
2570	   mandatory MSML Dialog Base package) contains media primitives (such
2571	   as digit collection and announcements) and composite functions (such
2572	   as play and collect combined as a single operation). The second model
2573	   (referred to as "Media Groups", part of the optional MSML Dialog
2574	   Group package) allows the ability to define complex customized

2576	Internet-draft       Media Server Markup Language        February 2008
2577	                                 (MSML)

2579	   interactions, via event passing mechanisms, between media primitives,
2580	   if required.

2582	      MSML Dialog Core Package

2584	         Defines core framework over which all MSML dialog packages
2585	         operate.

2587	      MSML Dialog Base Package

2589	         Media Primitives
2590	            <dtmf> or <collect>
2591	                        DTMF digit collection
2592	            <play>
2593	                        Playing of Announcements
2594	            <dtmfgen>
2595	                        Generation of DTMF digits
2596	            <tonegen>
2597	                        Tone genration
2598	            <record>
2599	                        Media recording

2601	         Media Composites
2602	            <collect>
2603	                        Supports play and collect operation.
2604	                        Composite function with inclusion of play.
2605	            <record>
2606	                        Supports play and record operation.
2607	                        Composite function with inclusion of play.

2609	      MSML Dialog Group Package

2611	            <group>
2612	                        Allows grouping of media primitives for parallel
2613	                        execution, with an event exchange mechanism
2614	                        between the media primitives to achieve
2615	                        customized media operations. All the above media
2616	                        primitive elements are accepted within the
2617	                        group.

2619	   Following operations MUST be supported using elements described above
2620	   using either the MSML Dialog Base Package or MSML Dialog Group
2621	   Package.

2623	         Announcement only
2624	                           <play>
2625	               Collection only
2626	                           <dtmf> or <collect>

2628	Internet-draft       Media Server Markup Language        February 2008
2629	                                 (MSML)

2631	               Recording only
2632	                           <record>

2634	               Play and Collect
2635	                           <collect>
2636	                              <play/>
2637	                           </collect>

2639	               Play and Record
2640	                           <record>
2641	                              <play/>
2642	                           </record>

2644	   Additional MSML Dialog packages are:

2646	      O MSML Dialog Transform Package

2648	      O MSML Dialog Speech Package

2650	      O MSML Fax Detection Package

2652	      O MSML Fax Send/Receive Package

2654	   MSML Dialogs MAY be used to simply expose primitive media resource
2655	   objects but will be used more often to describe dialog operations and
2656	   media transformation objects which can be controlled via user
2657	   interaction.

2659	   MSML Dialogs do not contain any computation or flow control
2660	   constructs. There are no results automatically generated when media
2661	   operations complete. Results MUST be explicitly requested using a
2662	   <send> or <exit> element within the definition of the MSML Dialog.

2664	10.2    Primitives

2666	   Primitives perform a single function on a media stream or multiple
2667	   streams such as generating audio/video, recognizing speech or DTMF,
2668	   or adjusting the gain. They may be composed so that primitives
2669	   execute concurrently. Primitives not composed for concurrent
2670	   execution MUST simply execute sequentially in the order they occur in
2671	   a MSML document. All concurrently executing primitives in the same
2672	   MSML object (defined in one MSML document) MAY interact with each
2673	   other through events (see MSML Dialog Group package).

2675	   Primitives are categorized into one of the following descriptive
2676	   categories.

2678	Internet-draft       Media Server Markup Language        February 2008
2679	                                 (MSML)

2681	      o  recognizers have a media input but no output. They allow
2682	         different things within a media stream to be recognized or
2683	         detected and for events to be generated based upon received
2684	         media.

2686	      o  transformers have one media input and output and may send and
2687	         receive events;

2689	      o  sources and sinks generate or consume media. They have either a
2690	         media input or a media output but not both. They may receive
2691	         and generate events.

2693	      o  composites combine underlying primitives to provide higher-
2694	         level user interaction, without the need for specific event
2695	         based exchange between the primitives. The composite elements
2696	         provide a simpler mechanism for more commonly used services,
2697	         such as play and collect or play and record.

2699	   Primitives may define different media processing behavior (states)
2700	   based upon the events which they receive. Primitives which support
2701	   different processing states must define their default starting state
2702	   and should support the "initial" attribute to allow that state to be
2703	   specified when the primitive is instantiated. All primitives must
2704	   support the "terminate" event class.

2706	   The following types of primitives are defined within this
2707	   specification:

2709	       Recognizers    Transformers   Source/Sink   Composites
2710	       ------------------------------------------------------
2711	        dtmf/collect   agc            play          dtmf/collect
2712	        faxdetect      clamp          record        record
2713	        speech         gain           dtmfgen
2714	        vad            gate           tonegen
2715	                       relay          faxsend
2716	                                      faxrcv

2718	   Primitives have shadow variables, similar to those within VoiceXML
2719	   [n5], which are automatically assigned values when the primitives are
2720	   used. Upon initialization of an MSML Dialog context, all shadow
2721	   variables have the string value "undefined". Each primitive has its
2722	   own instance of shadow variables which are global in scope to the
2723	   entire MSML Dialog context.

2725	   Names SHOULD be assigned to individual primitives when more than one
2726	   primitive of the same type is used within one MSML document. Shadow
2727	   variables are overwritten if the primitive has not been named and is
2728	   instantiated a second time.

2730	Internet-draft       Media Server Markup Language        February 2008
2731	                                 (MSML)

2733	   Shadow variables cannot be modified under user control. They may be
2734	   returned from the MSML Dialog context using the <send> element.

2736	10.3    Events

2738	   Events provide the mechanism for primitives to interact with each
2739	   other and for a MSML context to interact with its external
2740	   environment. The external environment is defined by the way in which
2741	   a MSML context has been invoked. This will often be through MSML but
2742	   other languages and protocols such as SIP may also be used.

2744	   Every primitive and group conceptually implements their own event
2745	   queue. Events sent to them get placed into their associated queue.
2746	   Events are removed from their queues and processed in order.
2747	   Primitives within a group conceptually have their own thread of
2748	   execution. Due to the asynchronous nature of servicing events from
2749	   multiple queues, it cannot be assumed that several events sent in
2750	   sequence to different queues, will be processed in the order in which
2751	   they were sent. For example, if recognition of something led to
2752	   sending events to both a <play> and a <record> in that order, it is
2753	   possible that the <record> may process its event before the <play>.

2755	   Primitives each define the set of events which they support and the
2756	   behavior associated with their handling of each event. This allows
2757	   many types of behaviors to be defined. For example, VCR type controls
2758	   can be constructed by defining primitives which support events
2759	   corresponding to each control. Media recognition/detection can be
2760	   used to cause those events to be generated.

2762	   Alternatively, events can be originated elsewhere, such as from a
2763	   Control Agent, and simply received by the primitive implementing the
2764	   control. Examples of the use of events include adjusting volume
2765	   (gain) and pause and resume of both announcement playout and record
2766	   creation.

2768	   Primitives act on events based upon the longest match of an event
2769	   name. Event names are a period '.' delimited sequence of tokens. The
2770	   first token, or the root of the name, can be considered an event
2771	   class. Matching allows a standard meaning to be defined and then
2772	   extended based upon what triggers an event's generation. For example,
2773	   a record primitive has different behavior depending upon whether it
2774	   completed because a user stopped speaking or because it was
2775	   cancelled. The recording is retained in the first case but not the
2776	   second.

2778	   Longest match allows new recognizers to be created and used without
2779	   changing how existing primitives are defined. For example, a face
2780	   recognition capability could be created which generates a

2782	Internet-draft       Media Server Markup Language        February 2008
2783	                                 (MSML)

2785	   terminate.frowning event when a user looks puzzled. Although no
2786	   primitive directly defines this event, it will still effect a generic
2787	   terminate action. Primitives which require specialized behavior based
2788	   upon frowning may be extended to support this. As well, the event can
2789	   still be exported from the MSML context without requiring that
2790	   primitives receiving the event understand facial expressions.

2792	10.4    MSML Dialog Usage with SIP

2794	   MSML Dialogs MAY be used directly with SIP for dialog interactions
2795	   (e.g., IVR or fax). It can be initially invoked as part of the
2796	   "Prompt and Collect" service described in "Basic Network Media
2797	   Services with SIP" [n7]. That defines service indicators for a small
2798	   number of well defined services using the user part of the SIP
2799	   Request-URI (R-URI).

2801	   The prompt and collect service uses "dialog" as the service
2802	   indicator. URI parameters further refine the specific IVR request.
2803	   This document defines an additional parameter "msml-param" for the
2804	   dialog service indicator as follows:

2806	   dialog-parameters = ";" ( dialog-param [ vxml-parameters ] )
2807	                           | moml-param
2808	   dialog-param      = "voicexml=" dialog-url
2809	   moml-param        = "moml=" moml-url

2811	   There are no additional URI parameters when MSML is used as the
2812	   dialog language.

2814	   MSML Dialogs defines discrete IVR dialog commands. These commands MAY
2815	   be included directly in the body of the INVITE to the "dialog"
2816	   service indicator by using the "cid" [n8] URL scheme. This scheme
2817	   identifies a message body part which in this case would contain the
2818	   MSML Dialog request. Note that a multipart message body, containing a
2819	   single part, MUST be present even if the INVITE does not contain an
2820	   SDP offer. Subsequent MSML Dialog requests are sent in the body of
2821	   SIP INFO messages as are all messages from a media server.

2823	   An example of SIP URI as described above is:

2825	      sip:dialog@mediaserver.example.net;\
2826	          moml=cid:14864099865376@appserver.example.net

2828	   The body part that contained the MSML Dialog referenced by the URL
2829	   would have a Content-Id header of:

2831	      Content-Id: <14864099865376@appserver.example.net>

2833	Internet-draft       Media Server Markup Language        February 2008
2834	                                 (MSML)

2836	   The results of executing an <exit> or <disconnect>, or of executing a
2837	   <send> which has a "target" attribute value equal to "source", are
2838	   notified in SIP INFO messages using the <event> element from MSML
2839	   Core package. No messages are sent if execution completes normally
2840	   without executing one of these elements.

2842	   If there is an error during validation or execution, then a media
2843	   server MUST notify the error as described above and must include the
2844	   namelist items "moml.error.status" and "moml.error.description". The
2845	   values for these items are defined in section 12.

2847	   A restricted subset of MSML Dialogs can also be used with the
2848	   "Announcement" service defined in [n7]. This service uses "annc" as
2849	   the service indicator and defines parameters that describe an
2850	   announcement. The "play=" parameter identifies the URL of a prompt or
2851	   a provisioned announcement sequence. The value of the "play="
2852	   parameter can refer to a MSML Dialog body part using a "cid" URL as
2853	   described above. That body part must only contain the <play>
2854	   primitive.

2856	   Using MSML Dialogs enhances the announcement service by allowing the
2857	   client to specify a sequence of audio segments rather than requiring
2858	   each sequence to be provisioned as well as support for video.
2859	   Moreover, MSML Dialogs define a standard set of variables in contrast
2860	   to [n7] which defines a parameterization mechanism but does not
2861	   formally specify any semantics.

2863	   If a media server does not understand the "cid" scheme or does not
2864	   understand MSML Dialogs, it must respond with the SIP response code
2865	   "488 - not acceptable here". If the MSML Dialog body contains
2866	   elements other than the <play> primitive, or there are errors during
2867	   validation, a media server must respond with a SIP response code "400
2868	   - bad request". Finally, if there is a discrepancy between parameters
2869	   specified in the Request-URI and corresponding attributes defined in
2870	   the MSML Dialog body, the Request-URI parameters must be silently
2871	   ignored.

2873	   MSML Dialogs MUST NOT change the operation of the announcement
2874	   service from that defined in [n7]. When the announcement completes, a
2875	   media server issues a SIP BYE request. The INFO method MUST NOT used
2876	   with the announcement service.

2878	10.5    MSML Dialog Structure and Modularity

2880	   MSML is structured as a set of packages. Only the core and base
2881	   packages are required. The Dialog Core package, defines the framework
2882	   for MSML requests to a media server, without specific functionality.
2883	   It consists of the "primitive" abstraction, an abstract element for

2885	Internet-draft       Media Server Markup Language        February 2008
2886	                                 (MSML)

2888	   control flow, the sequential execution model, and the <send> element.
2889	   That is, the MSML Dialog Core package allows for the execution of a
2890	   sequence of one or more media processing primitives with the ability
2891	   to notify events to the invocation environment.

2893	   Primitives are contained within the MSML Dialog Base package, which
2894	   defines the basic <play>, <record>, <dtmf>, <dtmfgen>, <tonegen> and
2895	   <collect> elements. Another package, the MSML Dialog Transform
2896	   package, defines the simple half duplex filters. More advanced
2897	   primitives are defined in the speech and fax packages. The MSML
2898	   speech package depends on the MSML Dialog base package as it extends
2899	   the capability of <play> by adding synthesized speech. Finally, the
2900	   group execution model, which is currently the only element which
2901	   changes the flow of control is defined in a separate MSML Dialog
2902	   Group package. All of these packages are optional with the exception
2903	   that MSML Dialog Core and MSML Dialog Base packages MUST be
2904	   implemented to provide the minimal functionality.

2906	10.6    MSML Dialog Core Package

2908	   The MSML Dialog Core package defines the structural framework and
2909	   abstractions for MSML Dialogs(via its schema). It also defines the
2910	   basic elements which are not part of the core primitive or control
2911	   abstractions. This package is dependent on the MSML Core package.
2912	   Events generated by MSML Dialogs, such as prompt completion, digits
2913	   collected, or dialog termination, etc, are communicated by the Media
2914	   Server via the MSML Core Package (see MSML Core Package <event>).

2916	   MSML Dialogs are executed independently from the MSML core context.
2917	   When an MSML Dialog is started, MSML allocates the dialog control
2918	   resources, and if successful, starts those resources executing. MSML
2919	   core execution then continues without waiting for the MSML dialog to
2920	   complete. This forking of MSML dialog invocation from the MSML core
2921	   context is done via the <dialogstart> element. Media streams are
2922	   created between the MSML dialog target and other internal media
2923	   server resources as part of dialog execution. Stream creation is
2924	   subject to the requirements defined in MSML Core package and media
2925	   streams as defined in MSML Conference Core package.

2927	10.6.1     <dialogstart>

2929	   The <dialogstart> element is used to instantiate an MSML media dialog
2930	   on connections or conferences. The dialog is specified either inline
2931	   or by a URI [n6]. Inline dialogs MUST be composed of any of the MSML
2932	   Dialog packages. MSML dialogs MAY be defined externally as VoiceXML
2933	   [n5]. The MSML dialog description MUST NOT be inline if the src
2934	   attribute, containing a URI, is present.

2936	Internet-draft       Media Server Markup Language        February 2008
2937	                                 (MSML)

2939	   The originator of the MSML dialog is notified using a
2940	   "msml.dialog.exit" event when the dialog completes. Any results
2941	   returned by the dialog when it exits are sent as a namelist to the
2942	   event.

2944	   The "msml.dialog.exit" event is also used when dialogs fail due to
2945	   errors encountered fetching external documents or errors that occur
2946	   within the dialog execution thread. In this case, a namelist
2947	   containing the items "dialog.exit.status" and
2948	   "dialog.exit.description" is returned with the event to inform the
2949	   client of the failure and the failure reason. The values of these
2950	   items are defined within this package and the MSML Core package.
2951	   Information from the failed dialog may be returned as additional
2952	   namelist items.

2954	   Attributes:

2956	         target: an identifier of a connection or a conference which
2957	         will interact with the dialog. The identifier must not contain
2958	         wildcards. Mandatory.

2960	         src: the URL of the dialog description. MUST NOT be used if the
2961	         MSML dialog description is inline. Otherwise an error (422)
2962	         will result and MSML document execution will stop.

2964	         type: a MIME type which identifies the type of language used to
2965	         describe the dialog. application/moml+xml and
2966	         application/vxml+xml are used to identify MSML Dialogs and
2967	         VoiceXML [n5] respectively. Mandatory.

2969	         name: an instance name for the dialog. If the attribute is not
2970	         present, the media server will assign an identifier to the
2971	         dialog. If the attribute is present but the name is already
2972	         associated with the target, an error (431) will result and MSML
2973	         document execution will stop. Any results that a dialog
2974	         generates will be correlated to its identifier.

2976	         mark: a token which can be used to identify execution progress
2977	         in the case of errors. The value of the mark attribute from the
2978	         last successfully executed MSML element is returned in an error
2979	         response. Therefore the value of all "mark" attributes within
2980	         an MSML document should be unique.

2982	   The following sections show examples of initiating an external MSML
2983	   dialog, an in-line embedded MSML dialog, and an MSML initiated
2984	   VoiceXML dialog.

2986	   The following example starts a MSML dialog on a connection.

2988	Internet-draft       Media Server Markup Language        February 2008
2989	                                 (MSML)

2991	        <?xml version="1.0" encoding="UTF-8"?>
2992	        <msml version="1.1">
2993	           <dialogstart target="conn:abcd1234"
2994	                 type="application/moml+xml"
2995	                 name="sample"
2996	                 src="http://server.example.com/scripts/foo.moml"/>
2997	         </msml>

2999	   The following example starts an in-line embedded MSML dialog on a
3000	   connection.
3001	         <?xml version="1.0" encoding="UTF-8"?>
3002	         <msml version="1.1">
3003	           <dialogstart target="conn:abcd1234" name="sample">
3004	              <play>
3005	                 <audio uri="file://clip1.wav"/>
3006	                 <audio uri="http://host1/clip2.wav"/>
3007	                 <tts uri="http://host2/text.ssml"/>
3008	                 <var type="date" subtype="mdy" value="20030601"/>
3009	              </play>
3010	              <send target="source"
3011	                     event="done"
3012	                     namelist="play.amt play.end"/>
3013	            </dialogstart>
3014	         </msml>

3016	   The following example starts a VoiceXML dialog on a connection.

3018	         <?xml version="1.0" encoding="UTF-8"?>
3019	         <msml version="1.1">
3020	            <dialogstart target="conn:abcd1234"
3021	                type="application/vxml+xml"
3022	                name="sample"
3023	                src="http://server.example.com/scripts/foo.vxml"/>
3024	         </msml>

3026	   If this dialog fails once its execution thread had begun, for example
3027	   the fetch of the VoiceXML document failed, an example of the event
3028	   which would be returned would be:

3030	         <?xml version="1.0" encoding="UTF-8"?>
3031	         <event name="msml.dialog.exit"
3032	                id="conn:abcd1234/dialog:sample">
3033	            <name>dialog.exit.status</name>
3034	            <value>423</value>
3035	            <name>dialog.exit.description</name>
3036	            <value>External document fetch error</value>

3038	Internet-draft       Media Server Markup Language        February 2008
3039	                                 (MSML)

3041	         </event>

3043	10.6.2     <dialogend>

3045	   Dialog end is used to terminate a MSML dialog created through
3046	   <dialogstart> before it completes of its own accord. The operation of
3047	   <dialogend> depends on the dialog language being used by the
3048	   executing context. When that context is VoiceXML, a
3049	   "connection.disconnected" event will be thrown to the VoiceXML
3050	   application. When that context is MSML Dialog, a "terminate" event
3051	   will be sent to the MSML core context.

3053	   <dialogend> allows the executing dialog the opportunity to gracefully
3054	   complete before generating a "msml.dialog.exit" event. Dialog results
3055	   may be returned and will be contained as a namelist to that event.

3057	   Attributes:

3059	         id: the identifier of a dialog. Mandatory.

3061	         mark: a token which can be used to identify execution progress
3062	         in the case of errors. The value of the mark attribute from the
3063	         last successfully executed MSML Dialog element is returned in
3064	         an error response. Therefore the value of all "mark" attributes
3065	         within an MSML document should be unique.

3067	   For example, if the dialog from the previous example was still
3068	   executing, the following would terminate the dialog and generate a
3069	   "msml.dialog.exit" event.

3071	            <?xml version="1.0" encoding="UTF-8"?>
3072	            <msml version="1.1">
3073	               <dialogend id="conn:abcd1234/dialog:sample"/>
3074	            </msml>

3076	10.6.3     <send>

3078	   Sends an event and optional namelist to the recipient identified by
3079	   the target attribute. Event names are defined by the recipient. In
3080	   the case where the recipient is an MSML Dialog group or primitive,
3081	   the events are defined within this document. Other recipients MAY use
3082	   names that are suitable for their environment.

3084	   The "target" attribute specifies the recipient of the event.
3085	   Recipients MAY be other MSML Dialog primitives or groups executing

3087	Internet-draft       Media Server Markup Language        February 2008
3088	                                 (MSML)

3090	   within the object, the object itself, or the environment which
3091	   invoked the MSML Dialog. Sending events to media primitives or groups
3092	   is supported by the MSML Dialog Group package. Any target which is
3093	   unknown within the object is assumed to be destined to the external
3094	   environment. By convention, the string "source" SHOULD used to
3095	   address that environment but any target name distinct from the MSML
3096	   Dialog namespace MAY be used.

3098	      Attributes:

3100	         event: the name of an event. Mandatory.

3102	         target: the recipient of the event. The recipient MUST be a
3103	         MSML Dialog primitive, the currently executing group, or the
3104	         MSML Dialog environment. A primitive is specified by a
3105	         primitive type, optionally appended by a period '.' followed by
3106	         the identifier of a primitive. Identifiers are only needed when
3107	         more than one primitive of the same type exists in the object.
3108	         The executing group is specified using the token "group". The
3109	         environment is specified using the token "source", optionally
3110	         appended by a period '.' followed by any environment specific
3111	         target. Mandatory.

3113	         namelist: a list of zero or more shadow variables which are
3114	         included with the event.

3116	10.6.4     <exit>

3118	   Exit causes execution of the MSML Dialog to terminate.

3120	      Attributes:

3122	         namelist: a list of one or more shadow variables which MAY
3123	         optionally be sent to the context which invoked the MSML Dialog
3124	         object.

3126	10.6.5     <disconnect>

3128	   Disconnect is similar to <exit> but has the additional semantics of
3129	   indicating to the context which invoked the MSML Dialog, that it
3130	   should disconnect from a media server, the media stream associated
3131	   with the object. The method of disconnection depends upon how the
3132	   media stream was initially established. If SIP was used, a
3133	   <disconnect> would cause a media server to issue a BYE request. The
3134	   request would be sent for the SIP dialog associated with media
3135	   session on which the MSML Dialog was operating.

3137	      Attributes:

3139	Internet-draft       Media Server Markup Language        February 2008
3140	                                 (MSML)

3142	         namelist: a list of one or more shadow variables which MAY
3143	         optionally be sent to the context which invoked the MSML Dialog
3144	         object.

3146	10.7    MSML Dialog Base Package

3148	   The MSML Dialog Base package defines a required set of base
3149	   functionality for Media Server. It support individual media
3150	   primitives, such as playing an announcement or collection digits, as
3151	   well as composite operations such as play and collect. When this
3152	   package is used in conjunction with MSML Dialog Group package the
3153	   event based mechanism is used to control primitives. This package may
3154	   also be used in conjunction with MSML Speech package to extend the
3155	   functionality of prompts to include TTS and user input collection to
3156	   include ASR.

3158	   In the following sections, subsections of a primitive define child
3159	   elements of that primitive and are not themselves considered
3160	   primitives. They do not receive events or populate shadow variables.

3162	10.7.1     <play>

3164	   Play is used to generate an audio or video stream. It MUST play in
3165	   sequence the media created by the child media elements <audio>,
3166	   <video>, <media>, <tts>, and <var>. When the play stops, either
3167	   because the terminate event is received or all media generation has
3168	   completed, the <playexit> element, if present, is executed. At least
3169	   one media generation element must be present.

3171	   Play supports two states; generate and suspend. Media generation
3172	   occurs in the generate state and is suspended in the suspend state.
3173	   Once in the suspend state, media generation continues upon receiving
3174	   the generate event. The default initial state is generate.

3176	   Audio MAY be generated in different languages by specifying the
3177	   xml:lang attribute for <play> and/or the child elements of <play>.
3178	   The language is inherited by the child elements but each child MAY
3179	   specify its own language. Except for physical audio clips, it is an
3180	   error if a language is specified but the media server can not render
3181	   the audio in the requested language.

3183	      Attributes:

3185	         id: an optional identifier which may be referenced elsewhere
3186	         for sending events to the play primitive.

3188	Internet-draft       Media Server Markup Language        February 2008
3189	                                 (MSML)

3191	         interval: specifies the delay between stopping one iteration
3192	         and beginning another. The attribute has no effect if iterate
3193	         is not also specified. Default is no interval.

3195	         iterate: specifies the number of times the media specified by
3196	         the child media elements should be played. Each iteration is a
3197	         complete play of each of the child media elements in document
3198	         order. Defaults to once '1'.

3200	         initial: defines the initial state for the play element.
3201	         Default is "generate".

3203	         maxtime: defines the maximum allowed time for the <play> to
3204	         complete.

3206	         barge: defines whether or not audio announcements may be
3207	         interrupted by DTMF detection during play-out. The DTMF digit
3208	         barging the announcement is stored in the digit buffer. Valid
3209	         values for barge are "true" or "false", and the attribute is
3210	         mandatory. When barge is applied to a conference target, DTMF
3211	         digit detected from any conference participant MUST terminate
3212	         the announcement.

3214	         cleardb: defines whether the digit buffer is cleared or not,
3215	         prior to starting the announcement. Valid values for cleardb
3216	         are "true" or "false", and the attribute is mandatory.

3218	         offset: defines an offset, measured in units of time, where the
3219	         <play> is to begin media generation. Offset is only valid when
3220	         all child media elements are <audio>.

3222	         skip: an amount, expressed in time, which will be used to skip
3223	         through the media when "forward" and "backward" events are
3224	         received. Default is 3s (three seconds).

3226	         xml:lang: specifies the language to use for content which can
3227	         be rendered in different languages.

3229	      Events:

3231	         Following describes input events to the media primitive object.
3232	         The MSML Dialog Group package allows an event exchange
3233	         mechanism between primitives.

3235	         pause: causes the play to enter the suspend state.

3237	         resume: causes play to enter the generate state.

3239	Internet-draft       Media Server Markup Language        February 2008
3240	                                 (MSML)

3242	         forward: skips forward through the media. Only has effect when
3243	         all child media elements are <audio>.

3245	         backward: skips backward through the media. Only has effect
3246	         when all child media elements are <audio>.

3248	         restart: skips to the beginning of the media. Only has effect
3249	         when all child media elements are <audio>.

3251	         toggle-state: causes the suspend / generate state to toggle.

3253	         terminate: terminates the play and assigns values to the shadow
3254	         variables.

3256	      Shadow Variables:

3258	         play.amt: identifies the length of time for which media was
3259	         generated before the play was stopped. This does not include
3260	         time which may have elapsed while the play was in the suspend
3261	         state.

3263	         play.end: contains the event which caused the play to stop.
3264	         When the play stops because all media generation has completed,
3265	         end is assigned the value "play.complete".

3267	   Note: Attributes barge and cleardb provide a simplified mechanism for
3268	   controlling play operations with implicit DTMF without the use of
3269	   <group> and event exchange mechanism. When using the <play> element
3270	   within the group framework and barge is specified, detection of barge
3271	   condition generates an implicit terminate event to the play
3272	   primitive.

3274	   Following sections describe the child elements of <play>.

3276	10.7.1.1      <audio>

3278	   Identifies pre-recorded audio to play. Local URI references may
3279	   resolve to a single physical audio clip, a logical clip, or a
3280	   provisioned sequence of clips (physical or logical). A logical clip
3281	   is one which can be rendered differently based on the language
3282	   attribute. Logical clips are provisioned for each of the languages
3283	   that a media server supports. Remote URI references are resolved
3284	   according to the capabilities of the remote server.

3286	      Attributes:

3288	         uri: Identifies the location of the audio to be played. The
3289	         file and http schemes are supported. Mandatory.

3291	Internet-draft       Media Server Markup Language        February 2008
3292	                                 (MSML)

3294	         format: defines the encoding and file type of the audio
3295	         resource. The format attribute is defined as a string type of
3296	         form "audio/<filetype>;codecs=<codec>". The keyword 'audio'
3297	         identifies an audio content. The codecs field identifies the
3298	         audio file's codec to be used for decoding the audio content.
3299	         If format attribute is not specified, the filetype MUST be
3300	         determined from the URI and the codec information MUST be
3301	         determined from the media resource.

3303	         audiosamplerate: Identifies audio sample rate in kHz. If not
3304	         specified, the sample rate SHOULD be determined from the media
3305	         resource.

3307	         audiosamplesize: Identifies audio sample size in bits. If not
3308	         specified, the sample size SHOULD be determined from the media
3309	         resource.

3311	         iterate: specifies the number of times the audio is to be
3312	         played. Defaults to once '1'.

3314	         xml:lang: specifies the language to use when the URI identifies
3315	         a logical clip, either directly, or as part of a sequence.

3317	10.7.1.2      <video>

3319	   Identifies pre-recorded multimedia to play. Contents identified by
3320	   the URI attribute may contain audio only, video only, or both audio
3321	   and video. Media Server SHOULD attempt to play both audio and video
3322	   from the identified URI, if both are available in the content.

3324	      Attributes:

3326	         uri: Identifies the location of the video or multimedia to be
3327	         played. The file and http schemes are supported. Mandatory.

3329	         format: defines the encoding and file type of the video or
3330	         multimedia resource. The format attribute is defined as a
3331	         string type of form
3332	         "video/<filetype>;codecs=<codecx>,<codecy>". The keyword
3333	         'video' identifies video only media or media containing audio
3334	         and video. The "codecs" field identifies the audio and/or video
3335	         codecs to be used for decoding the file content, where the
3336	         order of the codec values is not significant. In the event of
3337	         audio and video content, using 'video' keyword, the
3338	         codecs=<codecx>,<codecy> field MAY be used to identify the
3339	         audio codec and the video codec. If not specified, the codec
3340	         information SHOULD be determined from the media file.

3342	Internet-draft       Media Server Markup Language        February 2008
3343	                                 (MSML)

3345	         audiosamplerate: Identifies audio sample rate in kHz. If not
3346	         specified, the sample rate SHOULD be determined from the media
3347	         file.

3349	         audiosamplesize: Identifies audio sample size in bits. If not
3350	         specified, the sample size SHOULD be determined from the media
3351	         file.

3353	         codecconfig: Identifies an optional special instruction string
3354	         for codec configuration. Default is to send no special
3355	         configuration string to the codec.

3357	         profile: Identifies a video profile name specific to the codec.
3358	         If not specified, default video profile of the codec SHOULD be
3359	         selected.

3361	         level: Identifies a video profile level to the codec. Default
3362	         is to send no profile information to the codec and allow the
3363	         codec to select an internal default.

3365	         imagewidth: Identifies the width of video image in pixels.
3366	         Default is to use image width information from media file.

3368	         imageheight: Identifies the height of video image in pixels.
3369	         Default is to use image height information from media file.

3371	         maxbitrate: Identifies the bitrate of the video signal in kbps.
3372	         Default is to use maximum bitrate information from the media
3373	         file.

3375	         framerate: Identifies the video frame rate in frames per
3376	         second. Default is to use frame rate information from the media
3377	         file.

3379	         iterate: specifies the number of times the media content is to
3380	         be played. Defaults to once '1'.

3382	10.7.1.3      <media>

3384	   Identifies multimedia content for play. All content of <media>
3385	   element MUST start to play concurrently. This element may be used to
3386	   generate a multi-media stream from two independent media resources,
3387	   one identifying audio and the other identifying video.

3389	   The <media> element MUST contain at least one child element. Valid
3390	   child elements of <media> are <audio> and <video>, as described
3391	   earlier. <media> element MUST contain at most one <audio> element or
3392	   at most one <video> element.

3394	Internet-draft       Media Server Markup Language        February 2008
3395	                                 (MSML)

3397	10.7.1.4      <var>

3399	   Specifies the generation of audio from a variable using prerecorded
3400	   audio segments. A variable represents a semantic concept (such as
3401	   date or number) and dynamically produces the appropriate speech.

3403	   Prerecorded audio allows an application vendor or service provider to
3404	   choose the exact voice for their audio and therefore completely
3405	   control the "sound and feel" of the service provided to end users. It
3406	   provides very high audio quality and allows the variables to blend
3407	   seamlessly into the surrounding audio segments.

3409	   Text to speech (TTS) using SSML [n11] may also be used to render
3410	   variables, but may not provide as good quality, or allow as complete
3411	   control of the "sound and feel" or user experience. TTS is normally
3412	   used for reading text such as emails and for very large vocabularies
3413	   such as stock names. TTS results in a very clear difference between
3414	   the variables and the surrounding audio segments. (See MSML Dialog
3415	   Speech package).

3417	      Attributes:

3419	         type: specifies the type of variable. Mandatory. Variable type
3420	         must be one of "date", "digits", "duration", "month", "money",
3421	         "number", "silence", "time", or "weekday".

3423	         subtype: specifies an optional clarification of type. Specific
3424	         values depend upon the type.

3426	         value: text which should be rendered appropriate to the type
3427	         and subtype attributes. Mandatory.

3429	         xml:lang: specifies the language to use when rendering the
3430	         variable.

3432	10.7.1.5      <playexit>

3434	   The <playexit> element MUST be invoked when generation of all content
3435	   of the <play> has come to completion. The contents of this element
3436	   MAY be used to send events.

3438	      Attributes:

3440	         none

3442	10.7.2     <dtmfgen>

3444	   DTMF generator originates one or more DTMF digits in sequence.

3446	Internet-draft       Media Server Markup Language        February 2008
3447	                                 (MSML)

3449	      Attributes:

3451	         id: an optional identifier which may be referenced elsewhere
3452	         for sending events to the dtmfgen primitive.

3454	         digits: A string of characters from the alphabet "0-9a-d#*"
3455	         which correspond to a sequence of DTMF tones. Mandatory.

3457	         level: used to define the power level for which the tones will
3458	         be generated. Expressed in dBm0 in a range of 0 to -96 dBm0.
3459	         Larger negative values express lower power levels. Note that
3460	         values lower than -55 dBm0 will be rejected by most receivers
3461	         (TR-TSY-000181, ITU-T Q.24A). Default is -6 dBm0.

3463	         dur: the duration in milliseconds for which each tone should be
3464	         generated. Implementations may round the value if they only
3465	         support discrete durations. Default 100 ms.

3467	         interval: the duration in milliseconds of a silence interval
3468	         following each generated tone. Implementations may round the
3469	         value if they only support discrete durations. Default 100 ms.

3471	      Events:

3473	         terminate: terminates DTMF generation and assigns values to the
3474	         shadow variables.

3476	      Shadow Variables:

3478	         dtmfgen.end: contains the event which caused DTMF generation to
3479	         stop.

3481	   The following sections describe the child elements of <dtmfgen>.

3483	10.7.2.1      <dtmfgenexit>

3485	   The <dtmfgenexit> element MUST be invoked when the DTMF generation
3486	   operation completes or is terminated as a result of receiving the
3487	   terminate event. The <dtmfgenexit> element MAY be used to send events
3488	   when the DTMF generation has completed.

3490	      Attributes:

3492	         None

3494	Internet-draft       Media Server Markup Language        February 2008
3495	                                 (MSML)

3497	10.7.3     <tonegen>

3499	   Tone generator allows customized tone generation. A sequence of
3500	   varying tones with optional silence intervals can be composed using
3501	   the <tonegen> element. Child elements of <tonegen>, namely <tone> and
3502	   <silence> specify a single tone or sequence of tones.

3504	      Attributes:

3506	         id: an optional identifier which may be referenced elsewhere
3507	         for sending events to the tonegen primitive.

3509	         iterate: A numeric value specifying the total number of
3510	         iterations. A value of 'forever' represents infinite
3511	         repetitions. Optional. Default 1.

3513	      Events:

3515	         terminate: terminates tone generation and assigns values to the
3516	         shadow variables.

3518	      Shadow Variables:

3520	         tonegen.end: contains the event which caused tone generation to
3521	         stop.

3523	   The following sections describe the child elements of <tonegen>.

3525	10.7.3.1      <tone>

3527	   The <tone> element specifies a single tone with an optional silence
3528	   interval. The tone specification consists of two tone frequencies,
3529	   their attenuation values, a duration of the tone, and the number of
3530	   times to repeat the tone.

3532	      Attributes:

3534	         duration: time duration or length of the individual tone,
3535	         specified in "ms" or "s" in increments of 10ms. A value of 0
3536	         represents an infinite duration. Mandatory.

3538	         iterate: specifies the number of times to execute the contents
3539	         of <tone> element. A value of 'forever' represents infinite
3540	         repetitions. Optional. Default 1.

3542	      Events:

3544	         none

3546	Internet-draft       Media Server Markup Language        February 2008
3547	                                 (MSML)

3549	      Child Elements:

3551	         The child elements of <tone> element specify a single tone and
3552	         an optional silence interval to be inserted at the end of tone
3553	         generation. A tone is defined by <tone1> and <tone2> elements.
3554	         Each <tone> element MUST contain at least one of <tone1> or
3555	         <tone2>, or MAY contain <tone1> and <tone2> exactly once.

3557	         <tone1>

3559	            Attributes:

3561	               freq: specifies the frequency of the first tone in "hz",
3562	               ranging from 0 - 3999 hz. Mandatory.

3564	               atten: specifies the attenuation level expressed in dBm0,
3565	               ranging from 0 to -96 dBm0. Mandatory.

3567	         <tone2>

3569	            Attributes:

3571	               freq: specifies the frequency of the second tone in "hz",
3572	               ranging from 0 - 3999 hz. Mandatory.

3574	               atten: specifies the attenuation level expressed in dBm0,
3575	               ranging from 0 to -96 dBm0. Mandatory.

3577	          <silence> - Refer to the silence element definition below.

3579	10.7.3.2      <silence>

3581	   The <silence> element inserts a silence interval as optional content
3582	   of <tonegen> or <tone> elements.

3584	      Attributes:

3586	         duration: specifies the amount of silence interval in "ms" or
3587	         "s", in increments of 10ms. Mandatory.

3589	      Events:

3591	         none

3593	10.7.3.3      <tonegenexit>

3595	   The <tonegenexit> element MUST be invoked when the tone generation
3596	   operation completes or is terminated as a result of receiving the

3598	Internet-draft       Media Server Markup Language        February 2008
3599	                                 (MSML)

3601	   terminate event. The <tonegenexit> element MAY be used to send events
3602	   when the tone generation has completed.

3604	      Attributes:

3606	         none

3608	10.7.4     <record>

3610	   Record creates a recording. Similar to play, <record> supports two
3611	   states; create and suspend. Received media becomes part of the
3612	   recording when <record> is in the create state and is discarded when
3613	   it is in the suspend state.

3615	   Recording MUST be terminated when a terminate event is received or
3616	   when a nospeech event is received and no audio has yet been recorded.
3617	   <record> differentiates different types of terminate events.

3619	   An optional <play> element MAY be specified as a child element of
3620	   <record>. This mechanism provides a complete play-record operation,
3621	   where the prompt(s) specified within the <play> element are played in
3622	   advance of start of recording.

3624	   Note: Attributes prespeech, postspeech, and termkey provide a
3625	   simplified mechanism for controlling record operations using implicit
3626	   DTMF and VAD, without the use of <group> and event exchange
3627	   mechanism.

3629	      Attributes:

3631	         id: an optional identifier which may be referenced elsewhere
3632	         for sending events to the record primitive.

3634	         append: a boolean which defines whether the recording is
3635	         allowed to be appended to an existing file if dest already
3636	         exists. Default is "false". The attribute is ignored if the
3637	         scheme is http.

3639	         dest: the destination for the recording, which will contain
3640	         either audio only, video only, or both audio and video
3641	         depending on the stream(s) being recorded. Recording MAY be
3642	         either local or external based upon the attribute value. File
3643	         and http schemes are supported.

3645	         audiodest: the destination for the audio only recording.
3646	         Recording MAY be either local or external based upon the
3647	         attribute value. All combinations of dest, audiodest, and
3648	         videodest are valid. File and http schemes are supported.

3650	Internet-draft       Media Server Markup Language        February 2008
3651	                                 (MSML)

3653	         videodest: the destination for the video only recording.
3654	         Recording MAY be either local or external based upon the
3655	         attribute value. All combinations of dest, audiodest, and
3656	         videodest are valid. File and http schemes are supported.

3658	         format: defines the encoding and file type of the recording.
3659	         The format attribute is defined as a string type of form
3660	         "audio|video/filetype;codecs=x,y". The keyword 'audio'
3661	         identifies an audio only recording, while the keyword 'video'
3662	         identifies video only recording or an audio plus video
3663	         recording. The codecs field identifies the audio and/or video
3664	         codecs to be used for the recording, where the order of the
3665	         codec values is not significant. In the event of audio and
3666	         video recording, using 'video' keyword, the codecs=x,y field
3667	         MAY be used to identify the audio codec and the video codec.
3668	         Mandatory.

3670	         codecconfig: Identifies an optional special instruction string
3671	         for codec configuration. Default is to send no special
3672	         configuration string to the codec.

3674	         audiosamplerate: Identifies audio sample rate in kHz. If not
3675	         specified, the sample rate SHOULD be determined from the media
3676	         source.

3678	         audiosamplesize: Identifies audio sample size in bits. If not
3679	         specified, the sample size SHOULD be determined from the media
3680	         source.

3682	         profile: Identifies a video profile name specific to the codec.
3683	         If not specified, default video profile of the codec SHOULD be
3684	         selected for the recording.

3686	         level: Identifies a video profile level to the codec. Default
3687	         is to send no profile information to the codec and allow the
3688	         codec to select an internal default.

3690	         imagewidth: Identifies the width of video image in pixels.
3691	         Default is to use image width information from the media
3692	         source.

3694	         imageheight: Identifies the height of video image in pixels.
3695	         Default is to use image height information from the media
3696	         source.

3698	         maxbitrate: Identifies the bitrate of the video signal in kbps.
3699	         Default is to use maximum bitrate information from the media
3700	         source.

3702	Internet-draft       Media Server Markup Language        February 2008
3703	                                 (MSML)

3705	         framerate: Identifies the video frame rate in frames per
3706	         second. Default is to use frame rate information from the media
3707	         source.

3709	         initial: defines the initial state for the record element.
3710	         Default is "create", which starts the recording as soon as the
3711	         <record> element is executed. The "initial" attribute is
3712	         applicable only when <record> is used within the <group>
3713	         structure.

3715	         maxtime: defines the maximum length of the recording in units
3716	         of time. Mandatory.

3718	         prespeech: defines a timer value, in seconds, for detection of
3719	         absence of audio energy at the start of the record operation.
3720	         If no audio energy is detection for the amount of time
3721	         specified by prespeech, the recording is terminated. Default is
3722	         "0s", which does not activate the prespeech timer.

3724	         postspeech: defines a timer value, in seconds, for detection of
3725	         absence of audio energy while the recoding is in progress.
3726	         During an in progress recording, if absence of audio energy is
3727	         detected as specified by the postspeech timer, the recording is
3728	         terminated. Default is "0s", which disables the ability to
3729	         terminate a recording due to postspeech silence.

3731	         termkey: defines a single DTMF key which when detection
3732	         terminates the recording. Absence of this attribute prevents
3733	         the recording from being terminated due to detection of DTMF
3734	         digits. When termkey is specified, the detected DTMF digit
3735	         terminates the recording and the DTMF digit is not entered in
3736	         the digit buffer.

3738	      Events:

3740	         Following describes input events to the media primitive object.
3741	         The MSML Dialog Group package allows an event exchange
3742	         mechanism between primitives.

3744	         pause: causes the record to enter the suspend state. Received
3745	         media is discarded.

3747	         resume: causes record to resume if it was suspended. It has no
3748	         effect otherwise.

3750	         toggle-state: causes the suspend / create state to toggle.

3752	Internet-draft       Media Server Markup Language        February 2008
3753	                                 (MSML)

3755	         terminate: terminates the recording and assigns values to the
3756	         shadow variables.

3758	         terminate.cancelled: terminates the recording and assigns
3759	         values to the shadow variables. If the dest attribute used the
3760	         file scheme, the local recording is deleted. Applications are
3761	         responsible for removing external files created using the http
3762	         scheme.

3764	         terminate.finalsilence: terminates the recording and assigns
3765	         values to the shadow variables. If the dest attribute used the
3766	         file scheme, the final silence is removed from the recording.

3768	         nospeech: terminates the recording and assigns values to the
3769	         shadow variables if it is received and no recording has yet
3770	         been created. The "nospeech" event is ignored if audio has
3771	         already been recorded.

3773	      Shadow Variables:

3775	         record.len: the actual length of the recording measured in
3776	         units of time. This does not include time which may have
3777	         elapsed while the record was in the suspend state.

3779	         record.end: contains the event which caused the record to
3780	         terminate. When the record terminates because maxtime is
3781	         exceeded, end is assigned the value
3782	         "record.complete.maxlength".

3784	         record.recordid: contains the value of "dest" attribute, if
3785	         supplied, otherwise contains a Media Server assigned record
3786	         identifier.

3788	         Record termination due to prespeech silence, results in
3789	         assigned value of "record.failed.prespeech"

3791	         Record termination due to postspeech silence, results in
3792	         assigned value of "record.complete.postspeech"

3794	         Record termination due to DTMF detection, results in assigned
3795	         value of "record.complete.termkey"

3797	   The following sections describe the child elements of <record>.

3799	10.7.4.1      <play>

3801	   The optional <play> element as a child element of <record> allows a
3802	   prompt to be played prior to start of recording. The record operation

3804	Internet-draft       Media Server Markup Language        February 2008
3805	                                 (MSML)

3807	   starts at the end of the play sequence or if the play is barged by
3808	   DTMF, assuming that barge=true is specified for <play>. For a
3809	   complete description, refer to <play> element.

3811	10.7.4.2      <tonegen>

3813	   The optional <tonegen> element as a child element of <record> allows
3814	   a tone or sequence of tones to be played prior to start of recording.
3815	   The record operation starts at the end of the tone generation. For a
3816	   complete description, refer to <tonegen> element.

3818	10.7.4.3      <recordexit>

3820	   The <recordexit> element MUST be invoked when the record operation
3821	   completes or when the recording is terminated as a result of
3822	   receiving the terminate event. The <recordexit> element MAY be used
3823	   to send events when the recording has completed.

3825	      Attributes:

3827	         none

3829	10.7.5     <dtmf> or <collect>

3831	   DTMF input fulfils several roles within MSML Dialogs. It is used to
3832	   trigger events which will affect the media processing operation of
3833	   other primitives. It is also used to collect DTMF digits from a media
3834	   stream which are to be reported back to the user of MSML Dialog.
3835	   Often DTMF detection is used for both purposes. Barge is the most
3836	   common example, where a prompt is stopped based upon DTMF input but
3837	   more digits may remain to be collected.

3839	   DTMF detection supports multiple simultaneous recognition patterns.
3840	   Different patterns can be used to trigger sending different events in
3841	   order to implement DTMF controls. Alternatively one pattern may be
3842	   used to represent a collection and another pattern, a substring of
3843	   the first, used as a barge indication.

3845	   An optional <play> element MAY be specified as a child element of
3846	   <dtmf> or <collect>. This mechanism provides a complete play-collect
3847	   operation, where the prompt(s) specified within the <play> element
3848	   are played in advance of DTMF digit collection.

3850	   Note that all patterns share the same digit collection buffer, inter-
3851	   digit timing, a single <nomatch> element, and a single <noinput>
3852	   element. As such, multiple patterns may not be suitable to support
3853	   simultaneous collections for different purposes. When this is
3854	   required, separate <dtmf> elements should be used instead.

3856	Internet-draft       Media Server Markup Language        February 2008
3857	                                 (MSML)

3859	   <dtmf> terminates if any of the <pattern>, <noinput>, or <nomatch>
3860	   elements are matched the maximum number of times that they are
3861	   allowed. The number of times they may match may be specified as an
3862	   attribute of <dtmf> or of the individual child elements.

3864	   Element identifier <dtmf> is equivalent to <collect>. However,
3865	   <collect> is the preferred name. MSML clients SHOULD use <collect>,
3866	   while MSML servers SHOULD support both.

3868	      Attributes:

3870	         id: an optional identifier which may be referenced elsewhere
3871	         for sending events to this primitive.

3873	         cleardb: a boolean indication of whether the buffer for digit
3874	         collection should be cleared of any collected digits when the
3875	         element is instantiated. If set to false, any digits currently
3876	         in the buffer MUST be immediately compared against the pattern
3877	         elements.

3879	         fdt: defines the first-digit timer value. The first-digit timer
3880	         is started when DTMF detection is initially invoked. If no DTMF
3881	         digits are detected during this initial interval, the <noinput>
3882	         element MUST be invoked. Optional, default 0s (wait forever for
3883	         the first digit).

3885	         idt: defines the inter-digit timer to be used when digits are
3886	         being collected. When specified, the timers is started when the
3887	         first digit is detected and restarted on each subsequent digit.
3888	         Timer expiration is applied to all patterns. After that, if any
3889	         patterns remain active and a nomatch element is specified, the
3890	         nomatch is executed and DTMF input MUST terminate. The idt
3891	         attribute should only be used when digit collection is being
3892	         performed. Optional, default 4s.

3894	         edt: defines the extra-digit timer value. Specifies the length
3895	         of time the media server MUST wait after a match to detect a
3896	         termination key, if one is specified by the <pattern> element.
3897	         Optional, default 4s.

3899	         starttimer: boolean value which defines whether the first digit
3900	         timer (fdt) is started initially. When set to false, the
3901	         starttimer event must be received for it to start. Default
3902	         false.

3904	         iterate: specifies the number of times the <pattern>,
3905	         <noinput>, and <nomatch> elements may be executed unless those
3906	         elements specify differently. The value "forever" MAY be used

3908	Internet-draft       Media Server Markup Language        February 2008
3909	                                 (MSML)

3911	         to indicate that these may be executed any number of times.
3912	         Default is once '1'.

3914	         ldd: defines the minimum duration for a digit to be held in
3915	         order for it to be detected as a long DTMF digit. A long DTMF
3916	         digit event MUST be treated as a single DTMF event, and MUST
3917	         contain an extra character 'L' at the end to be distinguished
3918	         from the other regular digit events. For example, "#L" and "#"
3919	         are different DTMF events. Optional, default of 0s. A value of
3920	         0s disables long DTMF digit detection and reporting. Attribute
3921	         value is an integer with a valid range from 100ms to 100s
3922	         (units MUST be supplied).

3924	      Events:

3926	         Following describes input events to the media primitive object.
3927	         The MSML Dialog Group package allows an event exchange
3928	         mechanism between primitives.

3930	         starttimer: starts the first digit timer (fdt) if it has not
3931	         already been started. Has no effect otherwise.

3933	         terminate: terminates the DTMF input and assigns values to the
3934	         shadow variables.

3936	      Shadow Variables:

3938	         dtmf.digits: the string of DTMF digits which have been received
3939	         (the contents of the digit buffer).

3941	         dtmf.len: the number of digits in the digit buffer.

3943	         dtmf.last: the last digit in the digit buffer.

3945	         dtmf.end: contains the event which caused the <dtmf> to
3946	         terminate or is assigned one of "dtmf.match", "dtmf.noinput",
3947	         or "dtmf.nomatch" depending upon which of the corresponding
3948	         elements reached its maximum.

3950	   The following sections describe the child elements of <dtmf> or
3951	   <collect>.

3953	10.7.5.1      <play>

3955	   The optional <play> element as a child element of <dtmf> or <collect>
3956	   allows a prompt to be played prior to DTMF digit collection. DTMF
3957	   digit collection starts at the end of the play sequence or if the

3959	Internet-draft       Media Server Markup Language        February 2008
3960	                                 (MSML)

3962	   play is barged by DTMF, assuming that barge=true is specified for
3963	   <play>. For a complete description, refer to <play> element.

3965	10.7.5.2      <pattern>

3967	   The pattern element describes one or more DTMF digits that are to be
3968	   recognized. When the pattern is matched, the child elements MUST be
3969	   executed.

3971	      Attributes:

3973	         digits: The digit pattern which should be matched. Mandatory.

3975	         format: an enumerated value which defines the format used to
3976	         express the digit pattern. The format may be "mgcp" or "megaco"
3977	         for patterns expressed as digit map from those specifications,
3978	         or as one of the simple built-in formats defined within this
3979	         specification. Currently, a single built-in format
3980	         "moml+digits" is defined which allows a match based on either
3981	         one or more specific digits, or based upon a specific length
3982	         specification with an optional return key. "moml+digits" is the
3983	         default.

3985	         iterate: specifies the number of times the <pattern> may be
3986	         matched. The value "forever" may be used to indicate that
3987	         <pattern> may be matched any number of times. This value
3988	         overrides any specified in <dtmf>. Default is once '1'.

3990	10.7.5.3      <detect>

3992	   The contents of the <detect> element MUST be executed whenever any
3993	   DTMF is first detected. It MUST be matched at most once.

3995	      Attributes:

3997	         none

3999	10.7.5.4      <noinput>

4001	   The <noinput> element is used when DTMF is being collected. Children
4002	   of the <noinput> element MUST be executed when DTMF has not been
4003	   detected and the first digit timeout occurs.

4005	      Attributes:

4007	         iterate: specifies the number of times the <noinput> may be
4008	         triggered. The value "forever" may be used to indicate that

4010	Internet-draft       Media Server Markup Language        February 2008
4011	                                 (MSML)

4013	         <noinput> may be triggered any number of times. This value
4014	         overrides any specified in <dtmf>. Default is once '1'.

4016	10.7.5.5      <nomatch>

4018	   The <nomatch> element is used when DTMF is being collected. Children
4019	   of the <nomatch> element MUST be executed when it is determined that
4020	   none of the individual patterns can be matched.

4022	      Attributes:

4024	         iterate: specifies the number of times the <nomatch> may be
4025	         triggered. The value "forever" may be used to indicate that
4026	         <nomatch> may be triggered any number of times. This value
4027	         overrides any specified in <dtmf>. Default is once '1'.

4029	10.7.5.6      <dtmfexit>

4031	   The <dtmfexit> element MUST be invoked when the dtmf input completes
4032	   because one of <pattern>, <noinput>, or <nomatch> occurred its
4033	   maximum number of times.

4035	      Attributes:

4037	         None

4039	10.7.6     <moml>

4041	   The root element <moml> MUST be used when the document is a stand-
4042	   alone MSML Dialog, where the invoking application media type
4043	   indicates 'application/moml+xml'. Additionally, for backwards
4044	   compatibility, the <moml> element MUST be used within <dialogstart>
4045	   which contains an in-line embedded MSML dialog.

4047	   Valid contents of <moml> are all elements described within this MSML
4048	   Dialog Base package.

4050	      Attributes:

4052	         version: "1.0" Mandatory.

4054	         id: an identifier unique to this object. Events returned from
4055	         MSML dialog (the "target" attribute of a <send> is equal to
4056	         "source") will be correlated with this identifier. Mandatory.

4058	      Events:

4060	Internet-draft       Media Server Markup Language        February 2008
4061	                                 (MSML)

4063	         terminate: terminates the MOML context. A terminate event gets
4064	         sent to the currently executing <group> or primitive.

4066	10.8    MSML Dialog Group Package

4068	   The group package defines a single control flow construct that
4069	   specifies concurrent execution. Primitives are composed for
4070	   concurrent execution by placing them within a <group> element. Groups
4071	   define how media flows between multiple concurrently executing
4072	   primitives. They have one or more inputs and one or more outputs. A
4073	   <group> represents the declaration of a complex media processing
4074	   operation. The event interaction between primitives (see the
4075	   following sub-section) is defined within the context of one or more
4076	   groups. However groups themselves do not scope events, they simply
4077	   define that primitives are concurrently executing and a primitive
4078	   must be executing in order to receive an event.

4080	   Placing primitives within a group structure is an optional feature of
4081	   this specification. It allows for complex services to created using
4082	   the event exchange mechanism between the primitives. For simpler
4083	   services, such as play/collect or play/record, the use of group
4084	   mechanism is not necessary. MSML Dialog Group package is dependent on
4085	   the MSML Dialog Base package.

4087	   Groups may also be used to describe media objects which transform a
4088	   media stream while optionally allowing application or user control of
4089	   the transformation. For example a gain control could be defined which
4090	   responds to user speech or DTMF input. In this case a recognition
4091	   primitive would send events to a gain control primitive.

4093	   Groups have one attribute which defines the media flow within them.
4094	   They also have a dimension which defines how many media inputs and
4095	   outputs they have. Currently dimensions of 1 and 2 are supported
4096	   based upon the group topology. These correspond to a group with one
4097	   input and one output and a group with two inputs and two outputs.

4099	   Media flow to and from the primitives within the group is based upon
4100	   a topology attribute of the <group> element. The topology attribute
4101	   defines a topology schema and implies the group dimension.

4103	   There are several common ways in which primitives are often connected
4104	   together. A schema provides a convenient template which can be
4105	   applied to multiple primitives without having to define all of the
4106	   individual media relationships. The following two schemas are
4107	   initially defined for 1 dimensional groups:

4109	Internet-draft       Media Server Markup Language        February 2008
4110	                                 (MSML)

4112	   o  parallel: specifies that media sent to the group is sent to every
4113	   primitive which has an input. The group bridges the output from every
4114	   primitive which has an output into a single common group output;

4116	   o  serial: specifies that the first primitive listed in the group
4117	   receives the media sent to the group. Its output is to be connected
4118	   to the input of the next primitive defined within the group and so on
4119	   until the last primitive within the group which becomes the group
4120	   output.

4122	   Groups with these topologies are shown in the two diagrams below. The
4123	   group on the left has a parallel topology and that on the right has a
4124	   serial topology.

4126	           /-> P1 --\
4127	          /          \
4128	   G(in) +---> P2 ----> G(out)     G(in) --> P1 --> P2 --> P3 --> G(out)
4129	          \          /
4130	           \-> P3 --/

4132	   More complex media flows MAY be created by nesting groups of serial
4133	   and parallel topologies within each other. For example, the diagram
4134	   below has a group with a serial topology nested within a star
4135	   topology.

4137	                  /-----> P1 ------------------------\
4138	                 /                                    \
4139	         Gs(in) +-> Gp(in) --> P2 --> P3 --> Gp(out) -+> Gs(out)

4141	   This combination could be used to create record operation where DTMF
4142	   was to be clamped from the recording itself, but a DTMF key press is
4143	   still used to stop the recording. In this case, P1 would be a DTMF
4144	   recognizer, P2 would be a clamp primitive, and P3 a recorder as shown
4145	   by the following example. This example omits child elements and
4146	   attributes not concerned with the core concept. The following section
4147	   discusses sending events and the details of each of the primitives is
4148	   defined in section 4.

4150	         <group topology="parallel">
4151	            <dtmf/>
4152	            <group topology="serial">
4153	               <clamp/>

4155	Internet-draft       Media Server Markup Language        February 2008
4156	                                 (MSML)

4158	               <record/>
4159	            </group>
4160	         </group>

4162	   A single schema, "fullduplex" is defined for a two dimensional group.
4163	   A full-duplex two dimensional group is has exactly two immediate
4164	   children. Those children may be primitives or other one dimensional
4165	   groups. A "fullduplex" group must only be used as the top most group
4166	   and must not be nested. Each primitive (P1) and group (G2) becomes
4167	   half of the full-duplex group as shown in the diagram below.

4169	                 G-A(in1)  +-> G2 --> G-B(out1)

4171	                 G-A(out2) <-- P1 <-+ G-B(in2)

4173	   Full duplex groups are symmetrical when both halves are the same.
4174	   They are asymmetrical when they differ. Asymmetric groups need to
4175	   have a name associated with each side. The left side is defined as
4176	   the input of the first child of the full-duplex group combined with
4177	   the output of the second child. The right side is reverse. These
4178	   sides were labeled A and B respectively in the preceding diagram.

4180	   An example of a full-duplex group is the user operated gain control
4181	   mentioned at the beginning of this sub-section. The gain should
4182	   operate on the audio which a user hears, but the gain is controlled
4183	   by recognizing things such as DTMF or spoken commands in media which
4184	   the user originates. The following shows the XML tag grouping which
4185	   would accomplish this and corresponds to the media flow shown in the
4186	   diagram above. If the user's audio is not required for anything other
4187	   than control of the gain, then the <relay> is not required and the
4188	   internal group could be omitted. A complete XML description for this
4189	   is included in the examples section.

4191	         <group topology="fullduplex">
4192	            <group topology="parallel">
4193	               <dtmf/>
4194	               <relay/>
4195	            </group>
4196	            <gain/>
4197	         </group>

4199	   Primitives within a group MUST begin concurrently but MAY finish
4200	   asynchronously based upon events which they receive or their task
4201	   completes. A group MUST terminate when all of the primitives within
4202	   it have completed. If the group contains a <groupexit> element, then

4204	Internet-draft       Media Server Markup Language        February 2008
4205	                                 (MSML)

4207	   the contents of that element MUST be executed as part of group
4208	   termination.

4210	   A group itself MAY receive a terminate event requesting termination.
4211	   A terminate event sent to the group causes a terminate event to be
4212	   sent to each of its currently active primitives. The <groupexit>
4213	   element is not executed until all primitives have processed their
4214	   respective terminate events.

4216	10.8.1     <group>

4218	   The <group> element allows the contained primitives to be executed
4219	   concurrently.

4221	   Attributes:

4223	         topology: specifies a schema which defines the flow of media
4224	         within the group. Three schemas are initially defined.
4225	         "fullduplex" is specified for use with two dimensional groups.
4226	         "parallel" and "serial" are for use with one dimensional
4227	         groups. The definition of these topologies is defined in
4228	         section 2. Mandatory.

4230	         id: identifies name of the group. Mandatory when groups are
4231	         nested.

4233	   Events:

4235	         terminate: causes a terminate event to be sent to each element
4236	         contained within the group.

4238	10.8.2     <groupexit>

4240	   The <groupexit> element allows events to be sent when group
4241	   processing completes. Group processing completes when all contained
4242	   primitives terminate.

4244	   Attributes:

4246	         none

4248	   Events:

4250	         none

4252	Internet-draft       Media Server Markup Language        February 2008
4253	                                 (MSML)

4255	10.9    MSML Dialog Transform Package

4257	   The MSML Dialog Transform package gathers together the simple
4258	   primitives which work as filters on half duplex media streams.

4260	10.9.1     <vad>

4262	   Voice activity detection (VAD) is used to detect voice and silence
4263	   when speech recognition is not required. Similar to both speech and
4264	   DTMF, a VAD has different media conditions which it can match. Those
4265	   conditions can be qualified by a minimum length of time which is
4266	   required for them to be considered recognized.

4268	      Attributes:

4270	         id: an optional identifier which may be referenced elsewhere
4271	         for sending events to the vad primitive.

4273	         starttimer: boolean value which defines whether the timer is
4274	         started to allow recognition of the initial condition (voice,
4275	         silence). When set to false, the starttimer event must be
4276	         received in order for the initial condition to be recognized.
4277	         The timer does not affect recognition of the transition
4278	         conditions. Default false.

4280	      Events:

4282	         starttimer: starts the timer to allow recognition of the
4283	         initial condition if it has not already been started. Has no
4284	         effect otherwise.

4286	         terminate: terminates voice activity detection.

4288	      Shadow Variables:

4290	         none

4292	   The following sections describe the child elements of <vad>.

4294	10.9.1.1      <voice>, <silence>, <tvoice>, <tsilence>

4296	   Each child element corresponds to a condition which a VAD can detect.
4297	   The first two detect when voice or silence has been initially present
4298	   for a minimum length of time since the VAD was started. The second
4299	   two require that a transition to the voice or silence condition first
4300	   occur.

4302	      Attributes:

4304	Internet-draft       Media Server Markup Language        February 2008
4305	                                 (MSML)

4307	         len: the length of time the condition must persist in order to
4308	         be recognized. Mandatory. In the case of <tvoice> and
4309	         <tsilence>, the length of time applies only to the final
4310	         recognized condition.

4312	         sen: the maximum length of time the condition not being
4313	         detected may occur without causing the detector to begin
4314	         measuring that condition.

4316	10.9.2     <gain>

4318	   Gain MAY be used to adjust of the gain of a media stream by a
4319	   specific amount. Application of <gain> removes any previous
4320	   connection AGC setting used by the <agc> element

4322	      Attributes:

4324	         id: an optional identifier which may be referenced elsewhere
4325	         for sending events to the gain primitive.

4327	         incr: an increment, expressed in dB, which will be used to
4328	         adjust the gain when "louder" and "softer" events are received.
4329	         Default is 3 dB.

4331	         amt: a specific gain to apply specified in dB. Mandatory.

4333	      Events:

4335	         mute: self explanatory.

4337	         unmute: self explanatory.

4339	         reset: sets the gain to zero dB.

4341	         louder: makes the audio on a stream louder.

4343	         softer: makes the audio on a stream quieter.

4345	         amt: sets the gain to the specified value between -96 dB and 96
4346	         dB.

4348	10.9.3     <agc>

4350	   Automatic gain control MAY be used to have a media server
4351	   automatically adjust the gain of a media stream. Application of <agc>
4352	   removes any previous connection gain setting used by the <gain>
4353	   element

4355	Internet-draft       Media Server Markup Language        February 2008
4356	                                 (MSML)

4358	      Attributes:

4360	         id: an optional identifier which may be referenced elsewhere
4361	         for sending events to the gain primitive.

4363	         tgtlvl: the desired target level for AGC, specified in dBm0
4364	         with a valid range of -40 to 0. Mandatory.

4366	         maxgain: an optional attribute used to specify the maximum gain
4367	         that AGC will apply, specified in dBm0 with a valid range of 0
4368	         to 40, with a default of 10.

4370	      Events:

4372	         mute: self explanatory.

4374	         unmute: self explanatory.

4376	10.9.4     <gate>

4378	   A simple filter which will pass or halt media, regardless of the
4379	   format of the media stream, based on the events it receives. <gate>
4380	   shares the same mute and unmute events for compatibility with the
4381	   gain primitives <gain> and <agc>.

4383	      Attributes:

4385	         id: an optional identifier which may be referenced elsewhere
4386	         for sending events to the gate primitive.

4388	         initial: the values "pass" and "halt" define whether media is
4389	         initially allowed to pass. Default is to pass.

4391	      Events:

4393	         mute: halts media flow through the primitive.

4395	         unmute: allows media to pass through the primitive.

4397	10.9.5     <clamp>

4399	   This element MAY be used to filter DTMF tones from a media stream.
4400	   Media other than DTMF tones is passed unchanged.

4402	      Attributes:

4404	         id: an optional identifier which may be referenced elsewhere
4405	         for sending events to the clamp primitive.

4407	Internet-draft       Media Server Markup Language        February 2008
4408	                                 (MSML)

4410	      Events:

4412	         none.

4414	10.9.6     <relay>

4416	   This element is a simple primitive which copies its input to its
4417	   output.

4419	      Attributes:

4421	         id: an optional identifier which may be referenced elsewhere
4422	         for sending events to the relay primitive.

4424	      Events:

4426	         none.

4428	10.10     MSML Dialog Speech Package

4430	   The MSML speech package defines functionality which MAY be used for
4431	   automatic speech recognition <speech> and extends the <play>
4432	   primitive defined in the MSML Dialog Base package to include speech
4433	   synthesis. As such, this package depends on the MSML Dialog Base
4434	   package.

4436	10.10.1      <speech>

4438	   Activates grammars or user input rules associated with speech
4439	   recognition. If multiple grammars are specified, all are activated.
4440	   All active grammars share the same timers, recognition attributes,
4441	   and <noinput> and <nomatch> elements. Each grammar may have its own
4442	   <match> element.

4444	   <speech> terminates if any of the <grammar>, <noinput>, or <nomatch>
4445	   elements are matched the maximum number of times that they are
4446	   allowed. The number of times they may match may be specified as an
4447	   attribute of <speech> or of the individual child elements.

4449	      Attributes:

4451	         id: an optional identifier which may be referenced elsewhere
4452	         for sending events to the speech primitive.

4454	         noint: specifies a time period during which speech input must
4455	         be started, otherwise the associated <noinput> element is
4456	         invoked.

4458	Internet-draft       Media Server Markup Language        February 2008
4459	                                 (MSML)

4461	         norect: specifies a maximum time period during in which speech
4462	         must begin to be matched, otherwise the associated <nomatch>
4463	         element is invoked.

4465	         spcmplt: specifies the length of silence necessary after speech
4466	         before a result will be finalized in the case where there is a
4467	         complete match of an active grammar. Following the silence, the
4468	         appropriate <match> element will be triggered if the result is
4469	         above the confidence level. Otherwise a <nomatch> element will
4470	         be triggered.

4472	         spincmplt: specifies the length of silence necessary after
4473	         speech before a result will be finalized in the case where
4474	         there is a incomplete match of all active grammars. Following
4475	         the silence, the <nomatch> element will be triggered.

4477	         confidence: the minimum confidence level which the recognizer
4478	         must have to consider a recognition result as matching a
4479	         grammar. Expressed as an integer between 1-100.

4481	         sens: specifies the sensitivity of the recognizer to determine
4482	         whether speech is present. Lower sensitivity may be required
4483	         for the recognizer to work well in the presence of high
4484	         background noise or line echo.

4486	         starttimer: boolean value which defines whether the no input
4487	         (noint) and no recognition (norect) are started initially. When
4488	         set to false, the starttimer event must be received in order to
4489	         start them. Default false.

4491	         iterate: specifies the number of times the <grammar>,
4492	         <noinput>, and <nomatch> elements may be executed unless those
4493	         elements specify differently. The value "forever" may be used
4494	         to indicate that these may be executed any number of times.
4495	         Default is once '1'.

4497	      Events:

4499	         sens: sets the sensitivity of the recognizer as described
4500	         above.

4502	         starttimer: starts the no input (noint) and no recognition
4503	         (norect) timers if they have not already been started. Has no
4504	         effect otherwise.

4506	         terminate: terminates the speech input and assigns values to
4507	         the shadow variables.

4509	Internet-draft       Media Server Markup Language        February 2008
4510	                                 (MSML)

4512	      Shadow Variables:

4514	         speech.end: contains the event which caused the <speech> to
4515	         terminate or is assigned one of "speech.match",
4516	         "speech.noinput", or "speech.nomatch" depending upon which of
4517	         the corresponding elements reached its maximum.

4519	         speech.results: contains the results of a matched grammar. The
4520	         results are formatted using the Natural Language Semantics
4521	         Markup Language (NLSML) [n4]. When this variable is referenced
4522	         to return results, the results are returned as a separate MIME
4523	         entity.

4525	   The following sections describe the child elements of <speech>.

4527	10.10.1.1       <grammar>

4529	   Specifies and activates a speech grammar based on Speech Recognition
4530	   Grammar Specification (SRGS) [n3] XML notation. Grammars may be
4531	   referenced by a URI or defined inline. Child elements of <match> MUST
4532	   be executed when the specified speech grammar is matched.

4534	      Attributes:

4536	         uri: specifies the location of an SRGS grammar when the grammar
4537	         is not defined inline.

4539	         iterate: specifies the number of times the <grammar> may be
4540	         matched. The value "forever" MAY be used to indicate that
4541	         <grammar> may be matched any number of times. This value
4542	         overrides any specified in <speech>. Default is once '1'.

4544	10.10.1.2       <match>

4546	   <match> is a child of <grammar> and specifies the actions to take
4547	   when the corresponding grammar is matched.

4549	10.10.1.3       <noinput>

4551	   The <noinput> element is used when speech is being recognized.
4552	   Children of the <noinput> element MUST be executed when speech has
4553	   not been detected and the no input timeout (noint) occurs.

4555	      Attributes:

4557	         iterate: specifies the number of times the <noinput> may be
4558	         triggered. The value "forever" may be used to indicate that

4560	Internet-draft       Media Server Markup Language        February 2008
4561	                                 (MSML)

4563	         <noinput> may be triggered any number of times. This value
4564	         overrides any specified in <speech>. Default is once '1'.

4566	10.10.1.4       <nomatch>

4568	   The <nomatch> element is used when speech is being recognized.
4569	   Children of the <nomatch> element MUST be executed when it is
4570	   determined that none of the active grammars will match.

4572	      Attributes:

4574	         iterate: specifies the maximum number of times the <nomatch>
4575	         may be triggered. The value "forever" MAY be used to indicate
4576	         that <nomatch> may be triggered any number of times. This value
4577	         overrides any specified in <speech>. Default is once '1'.

4579	10.10.1.5       <speechexit>

4581	   The <speechexit> element MUST be invoked when the speech input
4582	   completes because one of <grammar>, <noinput>, or <nomatch> occurred
4583	   its maximum number of times.

4585	      Attributes:

4587	         none

4589	10.10.2      <play>

4591	   The <play> element, as defined in the MSML Dialog Base package, is
4592	   extended with a new child element for synthesizing speech. From an
4593	   XML perspective, <tts> is a member of a media substitution group. See
4594	   the schema at the end of this document for details.

4596	   The following sections describe the child elements of <play>.

4598	10.10.2.1       <tts>

4600	   Contents of the <tts> element are rendered using Text To Speech
4601	   services and must be compliant to the SSML specification [n11].
4602	   Element content MAY be plain text, contain the SSML <speak> element,
4603	   or the uri attribute should identify the location of text to be
4604	   rendered.

4606	      Attributes:

4608	         uri: Identifies the location of the text to be rendered. The
4609	         file and http schemes are supported.

4611	Internet-draft       Media Server Markup Language        February 2008
4612	                                 (MSML)

4614	         iterate: specifies the number of times the text to speech block
4615	         is to be rendered. Defaults to once '1'.

4617	         xml:lang: specifies the language to use when it is not
4618	         explicitly specified as an attribute for <speak>.

4620	10.11     MSML Dialog Fax Detection Package

4622	   The fax detection package defines primitives which allow a media
4623	   server to provide facsimile detection services.

4625	10.11.1      <faxdetect>

4627	   Fax tone detection is used to detect the presence of the T.30 CNG or
4628	   CED tone in a media stream. Child elements of <faxdetectexit> MUST be
4629	   executed when a CNG tone is detected.

4631	      Attributes:

4633	         id: an optional identifier which may be referenced elsewhere
4634	         for sending events to the faxdetect primitive.

4636	      Events:

4638	         terminate: terminates fax tone detection and assigns values to
4639	         the associated shadow variables.

4641	      Shadow Variables:

4643	         faxdetect.tone: A string that specifies the fax tone type
4644	         detected by the Media Server. Values supported SHOULD include
4645	         "CED", "CNG", or empty string. The empty string MUST be used if
4646	         fax tone detection terminated before detection of a fax tone,
4647	         resulting in execution of <faxdetectexit> element.

4649	         faxdetect.end: A string value that specifies the reason for
4650	         termination of <faxdetect>. Values supported SHOULD include
4651	         "faxdetect.complete" (due to detection of CED or CNG tone),
4652	         "faxdetect.failed.noresource" (failed due to lack of resources
4653	         on the Media Server), "faxdetect.failed" (failed due to any
4654	         other reason) "faxdetect.terminated" (terminated by
4655	         <dialogend>), or undefined.

4657	Internet-draft       Media Server Markup Language        February 2008
4658	                                 (MSML)

4660	10.11.2      <faxdetectexit>

4662	   The <faxdetectexit> element MUST be invoked when fax detection,
4663	   invoked via <faxdetect>, terminates. Child elements of
4664	   <faxdetectexit>, <send> and <exit>, allow events to be reported by
4665	   the Media Server.

4667	      Attributes:

4669	         None

4671	10.12     MSML Dialog Fax Send/Receive Package

4673	10.12.1      <faxsend>

4675	   The <faxsend> primitive provides the functionality of a calling fax
4676	   terminal. This typically means sending a set of pages. However, it
4677	   can also mean requesting the called terminal to send pages instead
4678	   of, or in addition to, receiving pages. The fax images to send are
4679	   defined by the <sendobj> elements, described below.

4681	   Requesting the called terminal to send pages happens when the
4682	   <rxpoll> element is included as part of <faxsend>. This element may
4683	   be included in addition to, or instead of, the <sendobj> element. One
4684	   <sendobj> (at a minimum) or <rxpoll> element must be present. When
4685	   both are present, a media server will first send pages and will then
4686	   poll the other terminal, requesting pages.

4688	   Because fax is a distinct media type, the <faxsend> primitive is not
4689	   expected to interact with other primitives. Rather, it will interact
4690	   using fax protocols with a remote fax terminal (or gateway) and will
4691	   send requested status events to its invoking environment. During fax
4692	   operation, shadow variables are used to record the progress and
4693	   parameters of the varying stages of fax operation.

4695	   Status events are requested by including one or more status request
4696	   elements. These elements correspond to different stages or events in
4697	   fax operation and cause pre-defined events to be sent to the invoking
4698	   environment when they occur. Since the only recipient of these events
4699	   is expected to be a fax Control Agent, requests are simplified by
4700	   associating a pre-defined namelist of shadow variables with each
4701	   event. This decision may be revisited to allowed tailored namelists
4702	   based on further implementation experience. Status requests apply
4703	   both to sending and polling operation.

4705	      Attributes:

4707	Internet-draft       Media Server Markup Language        February 2008
4708	                                 (MSML)

4710	         lclid: the identifier that a media server uses to identify
4711	         itself.

4713	         minspeed: the minimum acceptable speed to negotiate for the
4714	         operation.

4716	         maxspeed: the maximum speed to negotiate for the operation.
4717	         This attribute is primarily for testing purposes.

4719	         ecm: specifies whether Error Correction Mode (ECM) is allowed
4720	         to be used if supported by the remote terminal. Defaults to
4721	         "true".

4723	      Events:

4725	         terminate: terminates the fax send operation.

4727	      Shadow Variables:

4729	         fax.rmtid: the identifier of the remote fax terminal.

4731	         fax.rate: the negotiated speed for the operation.

4733	         fax.resolution: identifies the resolution of the image. Both
4734	         metric and inch based resolutions are defined. Metric based
4735	         resolutions are: 75x75, 150x150, 204x98, 204x196, 204x391,
4736	         408x391. Inch based resolutions are: 200x200, 300x300, 400x400,
4737	         600x600.

4739	         fax.pagesize: identifies the negotiated page size. Metric sizes
4740	         are "A3", "A4", "A5", "A6", and "B4". Inch based page sizes are
4741	         "Letter" and "Legal".

4743	         fax.encoding: identifies the image encoding utilized. Valid
4744	         values are "MH", "R", "MMR", and "JPEG".

4746	         fax.ecm: identifies whether ECM operation was used.

4748	         fax.pagebadlines: the number of bad lines in a page.

4750	         fax.objbadlines: the number of bad lines in an object.

4752	         fax.opbadlines: the number of bad lines in an operation.

4754	         fax.objuri: the objuri of the current object.

4756	         fax.resendcount: the number of pages resent due to errors.

4758	Internet-draft       Media Server Markup Language        February 2008
4759	                                 (MSML)

4761	         fax.totalpages: the number of pages processed or stored.

4763	         fax.totalobjects: the count of the objects used in the
4764	         operation.

4766	         fax.duration: the duration of the operation expressed as a
4767	         duration in seconds and milliseconds (e.g. "23s250ms").

4769	         fax.result: contains the reason which caused the fax operation
4770	         to complete. When the operation completes successfully, the
4771	         value will be assigned "fax.success". Other values include:
4772	         "fax.partial", "fax.nofax", "fax.remotedisconnect",
4773	         "fax.uri.access.error", and "fax.invalid.startpage".

4775	   The following sections describe the child elements of <faxsend>.

4777	10.12.1.1       <sendobj>

4779	   <sendobj> is used to define a fax transmission. There MAY be multiple
4780	   instances of the element which will be transmitted in order.

4782	      Attributes:

4784	         objuri: a URI that points to the fax image that will be
4785	         transmitted. Mandatory.

4787	         startpage: the first page of a multi-page objuri to send.

4789	         pagecount: page count.

4791	10.12.1.2       <hdrfooter>

4793	   <hdrfooter> describes the header/footer that a media server MAY put
4794	   on pages. The header or footer may be defined as the content of the
4795	   <format> child element. The <format> element is only allowed if the
4796	   type attribute has a value of "header" or "footer".

4798	      Attributes:

4800	         type: specifies whether a header or a footer should be put on
4801	         pages and identifies the source of the header or footer. The
4802	         following enumerated values may be used:

4804	            "header" indicates that the media server should put a header
4805	                     on pages using the contents of the <format>
4806	                     element.

4808	            "nohdr"  indicates that there should be no header or footer.

4810	Internet-draft       Media Server Markup Language        February 2008
4811	                                 (MSML)

4813	            "footer" indicates that the media server should put a footer
4814	                     on pages using the contents of the <format>
4815	                     element.

4817	         style: defines the style of insertion onto a fax page that a
4818	         media server should use for the header or footer. Valid styles
4819	         are "append", "overlay", or "replace".

4821	   <format> is a child of the <hdrfooter> element that defines the style
4822	   format to be used for the header or footer. It uses a "C" language
4823	   style format statement (as shown below) to define the contents and
4824	   layout of the header or footer.

4826	           code    length   name              format
4827	            %a       3     day of week       3-character abbreviation
4828	            %d       2     date              01-31
4829	            %m       2     month             01-12
4830	            %y       2     year              00-99
4831	            %Y       4     year              0000-9999
4832	            %I       2     12 hour           01-12
4833	            %H       2     24 hour           00-23
4834	            %M       2     minute            00-59
4835	            %S       2     seconds           00-59
4836	            %p       2     AM/PM             AM or PM
4837	            %P       2     page number       01-99
4838	            %T       2     total pages       01-99
4839	            %l       20    local ID (sender) 0-9, + or spaces
4840	            %r       20    remote ID (rcvr)  0-9, + or spaces
4841	            %%       1     percent           display % in header/ftr
4842	10.12.1.3       <rxpoll>

4844	   <rxpoll> provides the information necessary for a receive polling
4845	   operation to occur. The object(s) to be received are defined by one
4846	   or more <rcvobj> elements. The <rcvobj> is defined further under the
4847	   child elements of <faxrcv>. The <rxpoll> element MAY also include a
4848	   description of the header/footer that a media server SHOULD put on
4849	   received pages. The <hdrfooter> element and it's usage is described
4850	   above.

4852	      Attributes:

4854	Internet-draft       Media Server Markup Language        February 2008
4855	                                 (MSML)

4857	         rmtid: specifies the identifier of the remote fax terminal that
4858	         to be associated with a polling operation. A media server MUST
4859	         NOT execute a polling operation unless the value of rmtid
4860	         matches that of the connected remote machine. Mandatory.

4862	10.12.1.4       <faxstart>

4864	   Requests that an event be sent when fax operation has begun. When
4865	   triggered, the following will be executed:

4867	   <send target="source" event="fax.start"/>

4869	10.12.1.5       <faxnegotiate>

4871	   Requests that an event be sent when a negotiation has been completed.
4872	   Multiple events MAY be sent each time a DCS frame is sent or
4873	   received. When triggered, the following will be executed:

4875	   <send target="source" event="fax.negotiate"
4876	      namelist="fax.rmtid
4877	         fax.rate
4878	         fax.resolution
4879	         fax.pagesize
4880	         fax.encoding
4881	         fax.ecm"/>

4883	10.12.1.6       <faxpagedone>

4885	   Requests that an event be sent when a page has been sent or received.
4886	   When triggered, the following will be executed:

4888	   <send target="source" event="fax.pagedone"
4889	         namelist="fax.resolution
4890	         fax.pagesize
4891	         fax.encoding
4892	         fax.pagebadlines
4893	         fax.resendcount"/>

4895	10.12.1.7       <faxobjectdone>

4897	   Requests that an event be sent when an objuri has been completed.
4898	   When triggered, the following will be executed:

4900	Internet-draft       Media Server Markup Language        February 2008
4901	                                 (MSML)

4903	   <send target="source" event="fax.objectdone"
4904	         namelist="fax.objuri
4905	         fax.objbadlines
4906	         fax.resendcount
4907	         fax.totalpages
4908	         fax.result"/>

4910	10.12.1.8       <faxopcomplete>

4912	   Requests that an event be sent when an operation has been completed.
4913	   When triggered, the following will be executed:

4915	   <send target="source" event="fax.opcomplete"
4916	         namelist="fax.totalpages
4917	         fax.opbadlines
4918	         fax.resendcount
4919	         fax.totalobjects
4920	         fax.duration
4921	         fax.result"/>

4923	10.12.1.9       <faxpollstarted>

4925	   Requests that an event be sent when a polling operation has started.
4926	   When triggered, the following will be executed:

4928	   <send target="source" event="fax.opcomplete"
4929	         namelist="fax.rmtid
4930	         fax.rate
4931	         fax.resolution
4932	         fax.pagesize
4933	         fax.encoding
4934	         fax.ecm"/>

4936	10.12.2      <faxrcv>

4938	   The <faxrcv> primitive provides the functionality of a called fax
4939	   terminal. Typically this type of operation is to receive pages.
4940	   However, it can include sending pages instead of, or in addition to,
4941	   receiving them. The fax objects to receive are defined by the
4942	   <rcvobj> elements, described below.

4944	   A media server SHOULD send pages as a polled terminal when the
4945	   <txpoll> element is included as part of <faxrcv>. This element may be
4946	   included in addition to, or instead of, the <rcvobj> element. One
4947	   <rcvobj> or <txpoll> element must be present. When both are present,
4948	   a media server SHOULD first receive pages and will then allow the
4949	   other terminal to poll the media server, requesting pages.

4951	Internet-draft       Media Server Markup Language        February 2008
4952	                                 (MSML)

4954	   Because fax is a distinct media type, the <faxrcv> primitive is not
4955	   expected to interact with other primitives. Rather, it will interact
4956	   using fax protocols with a remote fax terminal and will send
4957	   requested status events to its invoking environment. During fax
4958	   operation, shadow variables are used to record the progress and
4959	   parameters of the varying stages of fax operation.

4961	   Status events are requested by including one or more status request
4962	   elements. These elements correspond to different stages or events in
4963	   fax operation and cause pre-defined events to be sent to the invoking
4964	   environment when they occur. Since the only recipient of these events
4965	   is expected to be a fax Control Agent, requests are simplified by
4966	   associating a pre-defined namelist of shadow variables with each
4967	   event. This decision may be revisited to allowed tailored namelists
4968	   based on further implementation experience. Status requests apply
4969	   both to receiving and polling operation.

4971	      Attributes:

4973	         id: an optional identifier which may be referenced elsewhere
4974	         for sending events to the faxrecv primitive.

4976	         lclid: the identifier that a media server uses to identify
4977	         itself.

4979	         ecm: specifies whether ECM mode is allowed to be used if
4980	         supported by the remote terminal. Defaults to "true".

4982	      Events:

4984	         terminate: terminates the fax reception operation.

4986	      Shadow Variables:

4988	         <faxrcv> supports the same set of shadow variables as <faxsend>

4990	   The following sections describe the child elements of <faxrcv>.

4992	   In addition to the elements defined below, <faxrcv> MAY also have the
4993	   following child elements which were defined under <faxsend>:

4995	      o  <hdrfooter>
4996	      o  <faxstart>
4997	      o  <faxnegotiate>
4998	      o  <faxpagedone>
4999	      o  <faxobjectdone>
5000	      o  <faxopcomplete>
5001	      o  <faxpollstarted>

5003	Internet-draft       Media Server Markup Language        February 2008
5004	                                 (MSML)

5006	   Their meaning and usage is the same as previously defined.

5008	10.12.2.1       <rcvobj>

5010	   <rcvobj> is used to define fax objects that a media server will
5011	   receive. There may be multiple instances of the element which will be
5012	   used in order.

5014	      Attributes:

5016	         objuri: a URI that points to the location that a received image
5017	         is to be stored. Mandatory.

5019	         maxpages: the maximum number of pages that will be stored in
5020	         objuri.

5022	10.12.2.2       <txpoll>

5024	   <txpoll> provides the information for a polling operation to occur as
5025	   part of a fax receive operation. Multiple object(s) to be sent may be
5026	   supplied by one or more <sendobj> elements. In the event of multiple
5027	   occurrences, a media server MUST select the <sendobj> element whose
5028	   rmtid attribute matches that of the remote terminal.

5030	   The <sendobj> element was defined previously as a child element of
5031	   <faxsend>. The <txpoll> element is extended with an rmtid attribute
5032	   that specifies the identifier of the remote fax terminal and is used
5033	   to select the specific <sendobj> to send.

5035	   A media server SHOULD put a header/footer on transmitted pages based
5036	   on any <hdrfooter> element included as part of <txpoll>.

5038	      Attributes:

5040	         rmtid: specifies the identifier of the remote fax terminal that
5041	         to be associated with a polling operation. A media server MUST
5042	         NOT execute a polling operation unless the value of rmtid
5043	         matches that of the connected remote machine. Mandatory.

5045	11.   MSML Audit Package

5047	11.1    MSML Audit Core Package

5049	   This section describes the MSML audit core package which MAY be
5050	   implemented to support auditing services.

5052	   Audit requests and results may vary based on the information being
5053	   audited. The MSML audit core package specifies the framework to send

5055	Internet-draft       Media Server Markup Language        February 2008
5056	                                 (MSML)

5058	   audit request, defines a state list, and builds audit results. The
5059	   additional audit packages define package specific state lists and
5060	   associated audit result content. The additional audit packages MUST
5061	   be defined within the framework specified by the Audit Core package.

5063	11.1.1     <audit>

5065	   The <audit> element is an optional child element of <msml>, which MAY
5066	   be used by MSML clients to perform state auditing of current media
5067	   resources allocated and in use by the Media Server. The requested
5068	   state information is returned in a MSML response.

5070	   Attributes:

5072	         queryid: The identifier of the MSML object being queried by the
5073	         MSML client. Mandatory. Supported object types: conference or
5074	         connection. Wildcards are allowed.

5076	         statelist: A list of one ore more state parameters which are
5077	         being queried. Optional. If not present, the Media Server
5078	         SHOULD return the id of audited object only. Each object type
5079	         may contain a set of states. If the "statelist" contains any
5080	         state which does not match the audited object type, the request
5081	         MUST be rejected.

5083	         mark: in the case of an error, the value of the mark attribute
5084	         from the last successfully executed element that included the
5085	         mark attribute.

5087	   State Parameters:

5089	         The state parameter MUST be named using a dot-notation format
5090	         "audit.X.a.b.c...", where X is the mandatory field that
5091	         indicates the class name of the object (e.g. "conf" or "conn")
5092	         and the "a.b.c..." is the optional field used to describe the
5093	         actual name of the state parameter in a hierarchical manner.
5094	         The wildcard "*" MAY be used as part of a state name, however,
5095	         it MUST only be used in the last field of the dot-notation
5096	         (e.g. "audit.conf.*" is valid, but "audit.conf.*.a" is
5097	         invalid). When a wildcard is used, it is equivalent to querying
5098	         all the states below the specified level. Each field (e.g.
5099	         within "a.b.c...") will result in individual element names <a>,
5100	         <b> and <c> in the audit result to contain corresponding state
5101	         value. The parent/child relationship between these elements
5102	         follow the hierarchy of the state name (i.e. <c> is child
5103	         element of <b>, and <b> is child element of <a>).

5105	Internet-draft       Media Server Markup Language        February 2008
5106	                                 (MSML)

5108	11.1.2     <auditresult>

5110	   The <auditresult> element is an optional child element of <result>,
5111	   which MUST be used by the Media Server to return the audit result. A
5112	   specific instance of <auditresult> element contains the state
5113	   information of a single active object. Therefore, if multiple objects
5114	   are within the scope of the audit request, then one <auditresult>
5115	   element per object MUST be present. A Zero occurrence of
5116	   <auditresult> element indicates that there are no active resources
5117	   within the scope of the audit request.

5119	   Attributes:

5121	         targetid: the identifier of a conference or connection.
5122	         Mandatory. Wildcard is not allowed.

5124	   The <auditresult> may contain child element(s) which return
5125	   additional state information, corresponding to the "statelist"
5126	   attribute in the <audit> request. The child element names correspond
5127	   to the fields of the state parameter name (e.g. "a.b.c..."),
5128	   following the same hierarchical structure.

5130	11.2    MSML Audit Conference Package

5132	   This section describes the MSML Audit Conference package which MUST
5133	   be implemented to support auditing of conference services. The MSML
5134	   Audit Conference package follows the framework specified by the MSML
5135	   Audit Core package. This package defines the state parameter list and
5136	   audit result for conference auditing.

5138	11.2.1     State Parameters

5140	   All conference state parameter names MUST be prefixed by
5141	   "audit.conf".

5143	         confconfig: query the conferences general configuration.

5145	         confconfig.audiomix: query the audio mixer's general
5146	         configuration in the conference.

5148	         confconfig.audiomix.asn: query the current ASN setting in the
5149	         audio mixer.

5151	         confconfig.audiomix.n-loudest: query the current n-loudest
5152	         setting in the audio mixer.

5154	         confconfig.videolayout: query the video layout's general
5155	         configuration in the conference.

5157	Internet-draft       Media Server Markup Language        February 2008
5158	                                 (MSML)

5160	         confconfig.videolayout.root: query the root window setting of
5161	         the video layout.

5163	         confconfig.videolayout.selector: query video stream selector
5164	         setting of the video layout.

5166	         confconfig.controller: query who is the conference controller.

5168	         dialog: query the active dialog information on the conference.
5169	         See MSML Audit Dialog package for details.

5171	         stream: query the active stream information on the conference.
5172	         See MSML Audit Stream package for details.

5174	11.2.2     <auditresult>

5176	   The <auditresult> attribute of "targetid" is required to indicate
5177	   results for auditing a conference.

5179	   The <auditresult> element may optionally contain the following child
5180	   elements, returning additional conference state information, if
5181	   corresponding states are queried and available.

5183	11.2.2.1      confconfig

5185	   The <confconfig> element is used to return the general configuration
5186	   state(s) of a conference, using following attributes.

5188	   Attributes:

5190	         deletewhen: as defined by <createconference> element in MSML
5191	         Conference Core package.

5193	         term: as defined by <createconference> element in MSML
5194	         Conference Core package.

5196	11.2.2.2      confconfig.audiomix

5198	   The <audiomix> element contains general audio mixer configuration
5199	   using following attributes.

5201	   Attributes:

5203	         id: as defined by <audiomix> element in MSML Conference Core
5204	         package.

5206	         samplerate: as defined by <audiomix> element in MSML Conference
5207	         Core package.

5209	Internet-draft       Media Server Markup Language        February 2008
5210	                                 (MSML)

5212	11.2.2.3      confconfig.audiomix.asn

5214	   The <asn> element contains the current ASN setting of an audio mixer,
5215	   if ASN is enabled. The state values are included in following
5216	   attributes.

5218	   Attributes:

5220	         ri: as defined by <asn> element in MSML Conference Core
5221	         package.

5223	         asth: as defined by <asn> element in MSML Conference Core
5224	         package.

5226	11.2.2.4      confconfig.audiomix.n-loudest

5228	   The <n-loudest> element contains the current n-loudest setting of the
5229	   audio mixer. The state values are included in following attributes.

5231	   Attributes:

5233	         n: as defined by <n-loudest> element in MSML Conference Core
5234	         package.

5236	11.2.2.5      confconfig.videolayout

5238	   The <videolayout> element contains general video layout configuration
5239	   using following attributes.

5241	   Attributes:

5243	         id: as defined by <videolayout> in MSML Conference Core
5244	         Package.

5246	         type: as defined by <videolayout> in MSML Conference Core
5247	         package.

5249	11.2.2.6      confconfig.videolayout.root

5251	   The <root> element is used to contain root window settings.

5253	   Attributes:

5255	         size: as defined by <root> element in MSML Conference Core
5256	         package.

5258	         backgroundcolor: as defined by <root> element in MSML
5259	         Conference Core package.

5261	Internet-draft       Media Server Markup Language        February 2008
5262	                                 (MSML)

5264	         Backgroundimage: as defined by <root> element in MSML
5265	         Conference Core package.

5267	11.2.2.7      confconfig.videolayout.selector

5269	   The <selector> element is used to contain selector settings.

5271	   Attributes:

5273	         id: as defined by <selector> element in MSML Conference Core
5274	         package.

5276	         method: as defined by <selector> element in MSML Conference
5277	         Core package.

5279	         status: as defined by <selector> element in MSML Conference
5280	         Core package.

5282	         blankothers: as defined by <selector> element in MSML
5283	         Conference Core package.

5285	         si: as defined by <selector> element in MSML Conference Core
5286	         package when selector method is "vas".

5288	         speakersees: as defined by <selector> element in MSML
5289	         Conference Core package when selector method is "vas".

5291	11.2.2.8      confconfig.controller

5293	   The <controller> element is used to return the conference controller
5294	   id in its content. The conference controller is the SIP dialog that
5295	   carries the <createconference> request. The return value is the MSML
5296	   connection id.

5298	11.2.2.9      dialog

5300	   If conference dialog state is queried, the audit result is returned
5301	   using <dialog> element as specified in MSML Audit Dialog Package.

5303	11.2.2.10       stream

5305	   If conference stream state is queried, the audit result is returned
5306	   using <stream> element as specified in MSML Audit Stream Package.

5308	11.3    MSML Audit Connection Package

5310	   This section describes the MSML Audit Connection package which MAY be
5311	   implemented to support auditing connection services. The MSML Audit

5313	Internet-draft       Media Server Markup Language        February 2008
5314	                                 (MSML)

5316	   Connection package follows the framework specified by the MSML Audit
5317	   Core package. This package defines the state parameter list and audit
5318	   result for connection auditing.

5320	11.3.1     State Parameters

5322	   Connection state parameter names are prefixed by "audit.conn".

5324	         sipdialog: queries the identifier of the SIP dialog which the
5325	         connection is associated with.

5327	         sipdialog.localseq: queries one of the SIP dialog states -
5328	         local sequence number.

5330	         sipdialog.remoteseq: queries one of the SIP dialog states -
5331	         remote sequence number.

5333	         sipdialog.localURI: queries one of the SIP dialog states -
5334	         local URI.

5336	         sipdialog.remoteURI: queries one of the SIP dialog states -
5337	         remote URI.

5339	         sipdialog.remotetarget: queries one of the SIP dialog states -
5340	         remote target.

5342	         sipdialog.routeset: queries one of the SIP dialog states -
5343	         route set.

5345	         localsdp: queries the local SDP body of the connection.

5347	         remotesdp: queries the remote SDP body of the connection.

5349	         dialog: queries the active dialog information on the
5350	         connection. See MSML Audit Dialog package for details.

5352	         stream: queries the active stream information on the
5353	         connection. See MSML Audit Stream package for details.

5355	11.3.2     <auditresult>

5357	   The <auditresult> attribute "targetid" MUST specify a connection
5358	   identifier for a connection result.

5360	   The <auditresult> element MAY contain following child elements
5361	   optionally to return additional connection state information if the
5362	   corresponding states are queried and are available.

5364	Internet-draft       Media Server Markup Language        February 2008
5365	                                 (MSML)

5367	11.3.2.1      sipdialog

5369	   The <sipdialog> element contains the associated SIP dialog
5370	   information. The SIP dialog ID information is returned using
5371	   following attributes.

5373	      Attributes:

5375	         callid: Call-ID value as defined in [n1]. Mandatory.

5377	         localtag: local-tag value as defined in [n1]. Mandatory.

5379	         remotetag: remote-tag value as defined in [n1]. Mandatory.

5381	   This element can contain following child elements optionally to
5382	   return additional SIP dialog state information to the client if the
5383	   corresponding states are queried and available.

5385	11.3.2.2      sipdialog.localseq

5387	   The <localseq> element contains the local sequence number. The local
5388	   sequence number is one of the SIP dialog states as defined in [n1].

5390	11.3.2.3      sipdialog.remoteseq

5392	   The <remoteseq> element contains the remote sequence number. The
5393	   remote sequence number is one of the SIP dialog states as defined in
5394	   [n1].

5396	11.3.2.4      sipdialog.localuri

5398	   The <localuri> element contains the local URI value. The local URI is
5399	   one of the SIP dialog states as defined in [n1].

5401	11.3.2.5      sipdialog.remoteuri

5403	   The <remoteuri> element contains the remote URI value. The remote URI
5404	   is one of the SIP dialog states as defined in [n1].

5406	11.3.2.6      sipdialog.remotetarget

5408	   The <remotetarget> element contains the remote target value. The
5409	   remote target is one of the SIP dialog states as defined in [n1].

5411	Internet-draft       Media Server Markup Language        February 2008
5412	                                 (MSML)

5414	11.3.2.7      sipdialog.routeset

5416	   The <routeset> element contains the route-set value (an ordered list
5417	   of URIs separated by comma). The route set is one of the SIP dialog
5418	   states as defined in [n1].

5420	11.3.2.8      localsdp

5422	   The <localsdp> element contains the local SDP body.

5424	11.3.2.9      remotesdp

5426	   The <remotesdp> element contains the remote SDP body.

5428	11.3.2.10       dialog

5430	   If the connection dialog state is queried, the audit result returns
5431	   the queried information using the <dialog> element, as specified in
5432	   MSML Audit Dialog package.

5434	11.3.2.11       stream

5436	   If the connection stream state is queried, the audit result returns
5437	   the queried information using the <stream> element, as specified in
5438	   MSML Audit Stream package.

5440	11.4    MSML Audit Dialog Package

5442	   This section describes the MSML Audit Dialog package which MAY be
5443	   implemented to support auditing dialogs. The MSML Audit Dialog
5444	   package follows the framework specified by the MSML Audit Core
5445	   package.

5447	   The MSML Audit Dialog package must be used together with either MSML
5448	   Audit Conference package or MSML Audit Connection package, since the
5449	   dialogs are applicable to conferences or connections.

5451	11.4.1     State Parameters

5453	   Dialog state parameter names are prefixed by "dialog". Since this
5454	   package must be used together with MSML Audit Conference package or
5455	   MSML Audit Connection package, the complete dialog state name must be
5456	   prefixed by "audit.conf.dialog" or "audit.conn.dialog", depending on
5457	   the context within which the dialog state is queried.

5459	   dialog: queries the number of active dialog(s) running on the target
5460	   (a conference or connection), basic dialog information will be
5461	   returned.

5463	Internet-draft       Media Server Markup Language        February 2008
5464	                                 (MSML)

5466	   dialog.duration: queries the amount of time a dialog has been
5467	   running.

5469	   dialog.primitive: queries the media primitive currently being
5470	   executed by the dialog.

5472	   dialog.controller: queries the dialog controller.

5474	11.4.2     <dialog>

5476	   The <dialog> element is a child element of <auditresult>, which
5477	   contains the active dialog information on the target identified by
5478	   the attribute "targetid" of <audioresult> element.

5480	   Basic dialog information is returned using the following attributes.

5482	   Attributes:

5484	         src: as defined by <dialogstart> element in MSML Dialog Core
5485	         package.

5487	         type: as defined by <dialogstart> element in MSML Dialog Core
5488	         package. Mandatory.

5490	         name: as defined by <dialogstart> element in MSML Dialog Core
5491	         package. Mandatory.

5493	   This element may contain following child elements optionally to
5494	   return additional dialog information if the corresponding state
5495	   parameter has been queried and the state value is available.

5497	11.4.2.1      <duration>

5499	   The <duration> element returns the duration a dialog has been running
5500	   on the specified target. The duration value is included in the
5501	   element content. It is a positive integer value (in unit of seconds).

5503	11.4.2.2      <primitive>

5505	   The <primitive> element returns the currently active media primitive
5506	   in its content. The active media primitive is the primitive that is
5507	   currently being executed. Possible return values are: play, dtmf,
5508	   collect, dtmfgen, tonegen, record, or none.

5510	Internet-draft       Media Server Markup Language        February 2008
5511	                                 (MSML)

5513	11.4.2.3      <controller>

5515	   The <controller> element returns the dialog controller id in its
5516	   content. The dialog controller is the SIP dialog that carries the
5517	   <dialogstart> request. The returned value is the MSML connection id.

5519	11.5    MSML Audit Stream Package

5521	   This section describes the MSML Audit Stream package which MAY be
5522	   implemented to support auditing stream. The MSML audit stream package
5523	   follows the framework specified by the MSML Audit Core package.

5525	   The MSML Audit Stream package MUST be used together with either the
5526	   MSML Audit Conference package or the MSML Audit Connection package,
5527	   since the stream is applicable between conferences, between
5528	   connections, or between conferences and connections.

5530	11.5.1     State Parameters

5532	   Stream state parameter names are prefixed by "stream". Since this
5533	   package must be used together with MSML Audit Conference package or
5534	   MSML Audit Connection package, the complete stream state name must be
5535	   prefixed by "audit.conf.stream" or "audit.conn.stream", depends on
5536	   the context within which the stream state is queried.

5538	   stream: queries the number of active streams created on the audited
5539	   object, basic stream information will be returned.

5541	   stream.clamp: queries the clamping status

5543	   stream.gain: queries the gain control information

5545	   stream.visual: queries the visual setting

5547	11.5.2     <stream>

5549	   The <stream> element is child element of <auditresult>, contains the
5550	   active stream information on the target identified by the attribute
5551	   "targetid" of <audioresult> element.

5553	   Basic stream information is returned using the following attributes.

5555	   Attributes:

5557	         joinwith: an identifier of either a connection or a conference
5558	         which the audited object is joined with. Mandatory. Wildcard is
5559	         not allowed.

5561	Internet-draft       Media Server Markup Language        February 2008
5562	                                 (MSML)

5564	         media: as defined by <stream> element in MSML Conference Core
5565	         package. Mandatory.

5567	         dir: direction of stream, from audited target perspective,
5568	         "from" or "to". Mandatory.

5570	         compressed: as defined by <stream> element in MSML Conference
5571	         Core package.

5573	         display: as defined by <stream> element in MSML Conference Core
5574	         package.

5576	         override: as defined by <stream> element in MSML Conference
5577	         Core package.

5579	         preferred: as defined by <stream> element in MSML Conference
5580	         Core package.

5582	   This element MAY contain following child elements which optionally
5583	   return additional stream information, if the corresponding state
5584	   parameter is queried and the state value is available.

5586	11.5.2.1      <clamp>

5588	   The <clamp> element is included if stream clamping is active. The
5589	   currently active clamping state values are returned using the
5590	   attributes as defined by <clamp> element in the MSML Conference Core
5591	   package.

5593	11.5.2.2      <gain>

5595	   The <gain> element is included if stream gain is active. The current
5596	   gain control state values are returned using the attributes as
5597	   defined by <gain> element in the MSML Conference Core package.

5599	11.5.2.3      <visual>

5601	   The <visual> element is included if stream visual display is active.
5602	   The current visual display settings are returned using the attributes
5603	   as defined by <visual> element in the MSML Conference Core package.

5605	12.   Response Codes

5607	   Response codes are used to indicate reasons for failures as well as
5608	   completion status. The appropriate code and description must be
5609	   passed to the invoking environment on failure.

5611	Internet-draft       Media Server Markup Language        February 2008
5612	                                 (MSML)

5614	   The response codes defined in this section are returned as the value
5615	   of the response attribute to the <result> element. Some values may
5616	   also be returned as part of a namelist to an "msml.dialog.exit" event
5617	   generated when an executing MSML dialog fails.

5619	      Informational (1xx)

5621	         Reserved for future use

5623	      Success (200)

5625	         200 OK

5627	      Request Error (4xx)

5629	         400  Bad Request
5630	         401  Unknown Element
5631	         402  Unsupported Element
5632	         403  Missing mandatory element content
5633	         404  Forbidden element content
5634	         405  Invalid element content
5635	         406  Unknown attribute
5636	         407  Attribute not supported
5637	         408  Missing mandatory attribute
5638	         409             Forbidden attribute is present

5640	         410             Invalid attribute value

5642	         420 Unsupported media description language
5643	         421 Unknown media description language
5644	         422 Ambiguous request (both URI and inline description)
5645	         423 External document fetch error
5646	         424 Syntax error in foreign language
5647	         425 Semantic error in foreign language
5648	         426 Unknown error executing foreign language

5650	         430 Object does not exist

5652	Internet-draft       Media Server Markup Language        February 2008
5653	                                 (MSML)

5655	         431 Object instance name already used
5656	         432 Conference name already in use
5657	         433 reserved
5658	         434 External document fetch error

5660	         440 Cannot join objects of the specified class
5661	         441 Objects have incompatible media types
5662	         442 reserved
5663	         443 reserved
5664	         444 Number of media inputs exceeded

5666	         450 Objects have incompatible media formats
5667	         451 Incompatible media stream format

5669	      Server Error (5xx)

5671	         500             Internal media server error
5672	         503  Service Unavailable
5673	         510  Not in service
5674	         511  Service Unavailable
5675	         520  No resource to fulfill request
5676	         521             Internal limit exceeded

5678	13.   MSML Conference Examples

5680	   These examples focus on MSML Conference Core package used by an
5681	   Control Agent (CA) to control services on a Media Server (MS). They
5682	   show the relationship between SIP signaling to establish media
5683	   sessions and MSML service control commands. For brevity, only the
5684	   content of MSML messages is shown. The examples assumes that the CA
5685	   and MS use the IPv4 address and UDP port number of the audio stream
5686	   (on the MS) to identify the MSML connection.

5688	13.1    Establishing a Dial-in Conference
5689	Internet-draft       Media Server Markup Language        February 2008
5690	                                 (MSML)

5692	           UA                   Control Agent             Media Server
5693	           |                         |                           |
5694	           |                         |        INVITE F1          |
5695	           |                         |-------------------------->|
5696	           |                         |           200 F2          |
5697	           |                         |<--------------------------|
5698	           |                         |           ACK F3          |
5699	           |                         |-------------------------->|
5700	           |                         |                           |
5701	           |                         |     createconference> F4  |
5702	           |                         |-------------------------->|
5703	           |                         |           200 F5          |
5704	           |                         |<--------------------------|
5705	           |    INVITE (SDP UA) F6   |                           |
5706	           |------------------------>|                           |
5707	           |                         |      INVITE (SDP UA) F7   |
5708	           |                         |-------------------------->|
5709	           |                         |        200 (SDP MS) F8    |
5710	           |                         |<--------------------------|
5711	           |                         |           ACK F9          |
5712	           |                         |-------------------------->|
5713	           |     200 (SDP MS) F10    |                           |
5714	           |<------------------------|                           |
5715	           |        ACK F11          |                           |
5716	           |------------------------>|                           |
5717	           |                         |     <dialogstart> F12     |
5718	           |                         |-------------------------->|
5719	           |                         |           200 F13         |
5720	           |                         |<--------------------------|
5721	           |                         |    HTTP interactions F14  |
5722	           |                         |<------------------------->|
5723	           |                         |  <event>(dialog.exit) F15 |
5724	           |                         |<--------------------------|
5725	           |                         |         <join> F16        |
5726	           |                         |-------------------------->|
5727	           |                         |           200 F17         |
5728	           |                         |<--------------------------|
5729	           |         ...             |            ...            |
5730	           |                         |                           |
5731	           |                         |     <dialogstart> F18     |
5732	           |                         |-------------------------->|
5733	           |                         |           200 F19         |
5734	           |                         |-------------------------->|
5735	           |                         |    HTTP interactions F20  |
5736	           |                         |<--------------------------|
5737	           |                         |  <event>(dialog.exit) F21 |
5738	           |                         |-------------------------->|
5739	           |         ...             |            ...            |

5741	Internet-draft       Media Server Markup Language        February 2008
5742	                                 (MSML)

5744	           |                         |                           |

5746	   Steps 1-3: establish an MSML control channel for the conference.
5747	   Alternatively, a control channel could already have been established
5748	   which was used for all CA/MS interactions. A control channel per
5749	   conference is only one possible model. Currently MSML uses SIP INFO
5750	   requests and responses on this SIP dialog. There is a proposal to use
5751	   this message exchange to establish a TCP channel for MSML similar to
5752	   the approach used for MRCPv2. This approach would require that a
5753	   request identifier be added to the <msml> element to correlate
5754	   requests and responses. This currently relies on the SIP INFO request
5755	   and response for this property. MSML messages are shown without
5756	   specifying the transport in this example but it assumes a
5757	   request/response correlation based on transport messages.

5759	   Step 4: create a conference that will mix the loudest two speakers
5760	   and report those speakers to the Control Agent every ten seconds. The
5761	   media server will automatically terminate remaining media sessions
5762	   and delete the conference and associated resources and when the
5763	   control channel is terminated.

5765	      <msml version="1.1">
5766	         <createconference name="exampleConf" deletewhen="nocontrol">
5767	             <audiomix>
5768	                <n-loudest n="3"/>
5769	                <asn ri="10s"/>
5770	             </audiomix>
5771	         </createconference>
5772	      </msml>

5774	   Step 5: conference created successfully

5776	      <msml version="1.1">
5777	         <result response="200"/>
5778	      </msml>

5780	   Steps 6-11: standard 3PCC establishment of a user initiated media
5781	   session to a media server. This is the equivalent of a dial-in
5782	   conference participant. The "To:" header returned by the MS in the
5783	   200 response of Step F8 was:

5785	   To: <sip:msml@ms.example.com>;tag=jd87dfg4h

5787	   Step 12: request an initial dialog with the participant to prompt for
5788	   their name, desired conference, etc. The dialog completes by

5790	Internet-draft       Media Server Markup Language        February 2008
5791	                                 (MSML)

5793	   informing the participant they are joining the conference. If this
5794	   was not the first participant, the dialog could also announce the
5795	   other participants.

5797	      <msml version="1.1">
5798	         <dialogstart target="conn:jd87dfg4h" name="12345"
5799	             type="application/vxml+xml"
5800	             src="http://server.example.com/scripts/initial.vxml"/>
5801	      </msml>

5803	   Step 13: dialog started successfully. The dialog identifier is
5804	   returned.

5806	      <msml version="1.1">
5807	         <result response="200"/>
5808	         <dialogid>conn:jd87dfg4h/dialog:12345</dialogid>
5809	      </msml>

5811	   Step 14: sequence of HTTP VoiceXML dialog interactions.

5813	   Step 15: the VoiceXML browser exits (but does not disconnect). If a
5814	   namelist had been specified within the VoiceXML <exit> element, it
5815	   would have been included in the <event> sent to the CA.

5817	      <msml version="1.1">
5818	         <event name="msml.dialog.exit"
5819	                id="conn:jd87dfg4h/dialog:12345"/>
5820	      </msml>

5822	   Step 16: join the participant to the conference and have the volume
5823	   of their contributing audio automatically adjusted to a target level
5824	   of -20 dBm0.

5826	      <msml version="1.1">
5827	         <join id1="conn:jd87dfg4h" id2="conf:exampleConf">
5828	            <stream media="audio" dir="from-id1">
5829	                <gain agc="true" tgtlvl="-20"/>
5830	            </stream>
5831	            <stream media="audio" dir="to-id1"/>
5832	      </msml>

5834	   Step 17: successfully joined to conference

5836	      <msml version="1.1">
5837	         <result response="200"/>
5838	      </msml>

5840	   Steps 6 through 17 are repeated for the second participant.

5842	Internet-draft       Media Server Markup Language        February 2008
5843	                                 (MSML)

5845	   Step 18: play a join tone or message announcing the new participant
5846	   to the conference.

5848	      <msml version="1.1">
5849	         <dialogstart target="conf:exampleConf"
5850	             type="application/vxml+xml"
5851	             src="http://server.example.com/scripts/joinmsg.vxml"/>
5852	      </msml>

5854	   Step 19: dialog started successfully. The dialog identifier is
5855	   returned. Media Server assigned a unique identifier since name
5856	   attribute was not specified in <dialogstart>.

5858	      <msml version="1.1">
5859	         <result response="200"/>
5860	         <dialogid>conf:ExampleConf/dialog:j6fs8745</dialogid>
5861	      </msml>

5863	   Step 20: HTTP VoiceXML dialog interaction(s).

5865	   Step 21: the VoiceXML browser exits.

5867	      <msml version="1.1">
5868	         <event name="msml.dialog.exit"
5869	                id="conf:ExampleConf/dialog:j6fs8745"/>
5870	      </msml>

5872	   Steps 6 through 21 are repeated for the third and subsequent
5873	   participants.

5875	13.2    Example of a Sidebar Audio Conference

5877	   This example assumes that a conference has already been established
5878	   as in the previous example. It creates a sidebar conference that
5879	   hears the main conference as a whisper. Three participants are moved
5880	   to the sidebar. After some period of time, the sidebar participants
5881	   are returned to the main conference and the sidebar is deleted.

5883	   Step1: the sidebar conference is created. It is joined half-duplex to
5884	   the main conference and a manual gain object is inserted in the media
5885	   stream. Three participants are then moved from the main conference to
5886	   the sidebar. Although not shown, an CA could include the "mark"
5887	   attribute in each element to allow recovery in the event of a mid-
5888	   transaction error.

5890	      <msml version="1.1">
5891	         <createconference name="sidebarConf"
5892	                           deletewhen="nomedia">

5894	Internet-draft       Media Server Markup Language        February 2008
5895	                                 (MSML)

5897	             <audiomix/>
5898	         </createconference>
5899	         <join id1="conf:sidebarConf" id2="conf:exampleConf">
5900	             <stream media="audio" dir="to-id1">
5901	                 <gain amt="-20"/>
5902	             </stream>
5903	         </join>
5904	         <unjoin id1="conn:gs5s4-1" id2="conf:exampleConf"/>
5905	         <join id1="conn:gs5s4-1" id2="conf:sidebarConf"/>
5906	         <unjoin id1="conn:hd764gr9-2" id2="conf:exampleConf"/>
5907	         <join id1="conn:hd764gr9-2" id2="conf:sidebarConf"/>
5908	         <unjoin id1="conn:h37frdvgs65-3" id2="conf:exampleConf"/>
5909	         <join id1="conn:h37frdvgs65-3" id2="conf:sidebarConf"/>
5910	      </msml>

5912	   Step 2: sidebar conference created successfully and participants
5913	   joined.

5915	      <msml version="1.1">
5916	         <result response="200"/>
5917	      </msml>

5919	   Step 3: once the sidebar conference has completed, the participants
5920	   are rejoined to the main conference. The sidebar is destroyed
5921	   automatically by the MS when the last media stream is removed as
5922	   specified when the sidebar conference was created.

5924	      <msml version="1.1">
5925	         <unjoin id1="conn:gs5s4-1" id2="conf:sidebarConf"/>
5926	         <join id1="conn:gs5s4-1" id2="conf:exampleConf"/>
5927	         <unjoin id1="conn:hd764gr9-2" id2="conf:sidebarConf"/>
5928	         <join id1="conn:hd764gr9-2" id2="conf:exampleConf"/>
5929	         <unjoin id1="conn:h37frdvgs65-3" id2="conf:sidebarConf"/>
5930	         <join id1="conn:h37frdvgs65-3" id2="conf:exampleConf"/>
5931	      </msml>

5933	   Step 4: participants successfully moved to main conference and
5934	   sidebar destroyed.

5936	      <msml version="1.1">
5937	         <result response="200"/>
5938	      </msml>

5940	13.3    Example of Removing a Conference

5942	   This example assumes a conference created similar to the first
5943	   example where there is an MSML control channel specific to the

5945	Internet-draft       Media Server Markup Language        February 2008
5946	                                 (MSML)

5948	   conference and the conference has been configured to be deleted when
5949	   that channel is removed (using SIP).

5951	   Steps 1-2: the CA signals BYE for the SIP dialog used to establish
5952	   the conference control channel.

5954	   Steps 3-6: the MS initiates terminating the media sessions for each
5955	   participant remaining in the conference.

5957	   The MS deletes the conference and removes all resources when the last
5958	   participant has been removed.

5960	13.4    Example of Modifying Video Layout

5962	   Assume that a conference named "example" is created using the
5963	   following mixer descriptions.

5965	             +---+---+
5966	             | 1 | 2 |
5967	             +---+---+
5968	             | 3 | 4 |
5969	             +---+---+

5971	         <createconference name="quad-split">
5972	            <audiomix>
5973	               <n-loudest n="3"/>
5974	               <asn ri="10s"/>
5975	            </audiomix>
5976	            <videolayout>
5977	               <root size="CIF" background="white" />
5978	               <selector id="default" method="vas" si="500ms">
5979	                  <region id="1" left="0" top="0" relativesize="1/4"/>
5980	               </selector>
5981	               <region id="2" left="50%" top="0" relativesize="1/4"/>
5982	               <region id="3" left="0%" top="50%" relativesize="1/4">
5983	               <region id="4" left="50%" top="50%" relativesize="1/4"/>
5984	            </videolayout>
5985	         </createconference>

5987	   The following would change the size of the video window to QCIF and
5988	   the background color to the default "black".

5990	         <modifyconference id="conf:example">
5991	            <videolayout>
5992	               <root size="4CIF"/>
5993	            </videolayout>
5994	         </modifyconference>

5996	Internet-draft       Media Server Markup Language        February 2008
5997	                                 (MSML)

5999	   The relative location of the regions does not change. However the
6000	   sizes of the regions do change because they are relative to the size
6001	   of the root window. The result is a layout that looks identical but
6002	   half the size.

6004	   The following would freeze the video displayed in region "2" without
6005	   affecting any other attributes of that region.

6007	         <modifyconference id="conf:example">
6008	            <videolayout>
6009	               <region id="2" left="50%" top="0" relativesize="1/4"
6010	                              freeze="true"/>
6011	            </videolayout>
6012	         </modifyconference>

6014	14.   MSML Dialog Examples

6016	   These examples focus on the MSML Dialog Base package and the MSML
6017	   Dialog Group package.

6019	14.1    Announcement

6021	   The following is a simple announcement scenario. Two recorded audio
6022	   files are played in sequence followed by generated speech followed by
6023	   a variable. The results are reported once media generation completes.

6025	   <?xml version="1.0" encoding="UTF-8"?>
6026	   <msml version="1.1">
6027	      <dialogstart target="conn:12345" name="12345">
6028	         <play>
6029	            <audio uri="file://clip1.wav"/>
6030	            <audio uri="http://host1/clip2.wav"/>
6031	            <tts uri="http://host2/text.ssml"/>
6032	            <var type="date" subtype="mdy" value="20030601"/>
6033	         </play>
6034	         <send target="source" event="done" namelist="play.amt
6035	                                            play.end"/>
6036	      </dialogstart>
6037	   </msml>

6039	14.2    Voice Mail Retrieval

6041	   Below is an example which shows a simple voice mail retrieval
6042	   operation consisting of playing a message and allowing the user to
6043	   pause and resume play using '5' to toggle the state. The operation
6044	   would terminate when the play completed or the user entered '#'.

6046	Internet-draft       Media Server Markup Language        February 2008
6047	                                 (MSML)

6049	   During the play, the user can advance forward and backward through
6050	   the message as well as rewinding to the beginning.

6052	   <?xml version="1.0" encoding="UTF-8"?>
6053	   <msml version="1.1">
6054	     <dialogstart target="conn:12345" name="12345">
6055	      <group topology="parallel">
6056	         <play>
6057	            <audio uri="file://message.wav"/>
6058	            <playexit>
6059	               <send target="group" event="terminate"/>
6060	            </playexit>
6061	         </play>
6062	         <dtmf iterate="forever">
6063	            <pattern digits="5">
6064	               <send target="play" event="toggle-state"/>
6065	            </pattern>
6066	            <pattern digits="6">
6067	               <send target="play" event="forward"/>
6068	            </pattern>
6069	            <pattern digits="7">
6070	               <send target="play" event="backward"/>
6071	            </pattern>
6072	            <pattern digits="8">
6073	               <send target="play" event="restart"/>
6074	            </pattern>
6075	            <pattern digits="#">
6076	               <send target="play" event="terminate"/>
6077	            </pattern>
6078	         </dtmf>
6079	      </group>
6080	    </dialogsgtart>
6081	   </msml>

6083	14.3    Play and Record

6085	   A more complex example is a play and record operation. This sources
6086	   and sinks media and uses voice activity DTMF detection and
6087	   recognition to influence behavior. Any DTMF input or voice activity
6088	   will barge the play and cause the record to begin. However, if the
6089	   prompt was barged with a DTMF digit of '#', the record terminates
6090	   without starting. When the play terminates, it send a starttimer
6091	   event to the VAD to allow it to recognize an initial silence
6092	   condition. The recording will be terminated (without starting) when
6093	   the VAD detects an initial 3 seconds of silence.

6095	   Once resumed (based upon voice detection) the recording may be
6096	   terminated under several conditions. It will terminate after 5

6098	Internet-draft       Media Server Markup Language        February 2008
6099	                                 (MSML)

6101	   seconds of silence or after 60 seconds elapses. It will also
6102	   terminate if a '#' key is recognized. Every aspect of this behavior
6103	   can be modified by changing what is recognized and the events which
6104	   are sent. The following example uses the MSML Dialog Group package.

6106	   <?xml version="1.0" encoding="UTF-8"?>
6107	   <msml  version="1.1">
6108	    <dialogstart target="conn:12345" name="12345">
6109	      <group topology="parallel">
6110	         <play>
6111	            <audio uri="file://prompt.wav"/>
6112	            <playexit>
6113	               <send target="vad" event="starttimer"/>
6114	            </playexit>
6115	         </play>
6116	         <dtmf>
6117	            <pattern digits="#">
6118	               <send target="record" event="terminate.termkey"/>
6119	            </pattern>
6120	            <detect>
6121	               <send target="play" event="terminate"/>
6122	            </detect>
6123	         </dtmf>
6124	         <vad>
6125	            <voice len="10ms">
6126	               <send target="play" event="terminate"/>
6127	               <send target="record" event="resume"/>
6128	            </voice>
6129	            <silence len="3s">
6130	               <send target="record" event="nospeech"/>
6131	            </silence>
6132	            <tsilence len="5s">
6133	               <send target="record" event="terminate.finalsilence"/>
6134	            </tsilence>
6135	         </vad>
6136	         <record initial="suspend" maxtime="60s"
6137	                 dest="file://record.wav" format="g729">
6138	            <recordexit>
6139	               <send target="group" event="terminate"/>
6140	            </recordexit>
6141	         </record>
6142	         <groupexit>
6143	            <send target="source" event="done"
6144	                  namelist="record.len record.end"/>
6145	         </groupexit>
6146	      </group>
6147	    </dialogstart>
6148	   </msml>

6150	Internet-draft       Media Server Markup Language        February 2008
6151	                                 (MSML)

6153	   The following implements the same functionality, as described above,
6154	   in using the MSML Dialog Base package, using the <record> composite
6155	   mechanism for the play and record operation.

6157	   <?xml version="1.0" encoding="UTF-8"?>
6158	   <msml  version="1.1">
6159	    <dialogstart target="conn:12345" name="12345">
6160	      <record prespeech="3s" postspeech="5s" maxtime="60s" termkey="#"
6161	                 dest="file://record.wav" format="g729">
6162	         <play barge="true">
6163	            <audio uri="file://prompt.wav"/>
6164	         </play>
6165	         <recordexit>
6166	            <send target="source" event="done"
6167	                  namelist="record.len record.end"/>
6168	         </recordexit>
6169	      </record>
6170	    </dialogstart>
6171	   </msml>

6173	14.4    Speech Recognition

6175	   The following simple example requests that a user speak the name of a
6176	   city and returns the result.

6178	   <?xml version="1.0" encoding="UTF-8"?>
6179	   <msml version="1.1">
6180	    <dialogstart target="conn:12345" name="12345">
6181	      <group topology="parallel">
6182	         <play>
6183	            <audio uri="file://prompt.wav"/>
6184	         </play>
6185	         <speech>
6186	            <grammar version="1.0">
6187	               <rule id="city" scope="public">
6188	                  <item>
6189	                     <one-of>
6190	                        <item>vancouver</item>
6191	                        <item>new york</item>
6192	                        <item>london</item>
6193	                     </one-of>
6194	                  </item>
6195	               </rule>
6196	               <match>
6197	                  <send target="group" event="terminate"/>
6198	               </match>
6199	            </grammar>
6200	            <noinput>

6202	Internet-draft       Media Server Markup Language        February 2008
6203	                                 (MSML)

6205	               <send target="group" event="terminate"/>
6206	            </noinput>
6207	            <nomatch>
6208	               <send target="group" event="terminate"/>
6209	            </nomatch>
6210	         </speech>
6211	         <groupexit>
6212	            <send target="source" event="done"
6213	                          namelist="speech.end speech.results"/>
6214	         </groupexit>
6215	      </group>
6216	    </dialogstart>
6217	   </msml>

6219	14.5    Play and Collect

6221	   This example prompts a user to enter 4 DTMF digits terminated by the
6222	   '#' key. The prompt will be barged and the user has 10 seconds to
6223	   begin entering input or no input will be indicated.

6225	   <?xml version="1.0" encoding="UTF-8"?>
6226	   <msml version="1.1">
6227	    <dialogstart target="conn:12345" name="12345">
6228	      <group topology="parallel">
6229	         <play>
6230	            <audio uri="file://prompt.wav"/>
6231	            <playexit>
6232	               <send target="dtmf" event="starttimer"/>
6233	            </playexit>
6234	         </play>
6235	         <dtmf fdt="10s" idt="16s">
6236	            <pattern digits="xxxx#">
6237	               <send target="group" event="terminate"/>
6238	            </pattern>
6239	            <detect>
6240	               <send target="play" event="terminate"/>
6241	            </detect>
6242	            <noinput>
6243	               <send target="group" event="terminate"/>
6244	            </noinput>
6245	            <nomatch>
6246	               <send target="group" event="terminate"/>
6247	            </nomatch>
6248	         </dtmf>
6249	         <groupexit>
6250	            <send target="source" event="done"
6251	                  namelist="dtmf.digits dtmf.end"/>
6252	         </groupexit>

6254	Internet-draft       Media Server Markup Language        February 2008
6255	                                 (MSML)

6257	      </group>
6258	    </dialogstart>
6259	   </msml>

6261	   The following implements the same functionality, as described above,
6262	   using the MSML Dialog Base package, using the <collect> composite
6263	   mechanism for the play and collect operation.

6265	   <?xml version="1.0" encoding="UTF-8"?>
6266	   <msml version="1.1">
6267	    <dialogstart target="conn:12345" name="12345">

6269	      <collect fdt="10s" idt="16s">
6270	         <play barge="true">
6271	            <audio uri="file://prompt.wav"/>
6272	         </play>
6273	         <pattern digits="xxxx#">
6274	            <send target="source" event="done"
6275	                  namelist="dtmf.digits dtmf.end"/>
6276	         </pattern>
6277	         <noinput>
6278	            <send target="source" event="done"
6279	                  namelist="dtmf.end"/>
6280	         </noinput>
6281	         <nomatch>
6282	            <send target="source" event="done"
6283	                  namelist="dtmf.end"/>
6284	         </nomatch>
6285	      </collect>
6286	    </dialogstart>
6287	   </msml>

6289	14.6    User Controlled Gain

6291	   This shows an example of nesting groups to create an arbitrary full
6292	   duplex media control. DTMF is detected on media flowing in one
6293	   direction and used to adjust the gain applied to media flowing in the
6294	   opposite direction. Additionally, the stream which is used to detect
6295	   DTMF has DTMF removed and its gain automatically adjusted before
6296	   leaving the group. This widget could be used between a conference
6297	   participant and a conference mixer.

6299	   <?xml version="1.0" encoding="UTF-8"?>
6300	   <msml  version="1.0">
6301	    <dialogstart target="conn:12345" name="12345">
6302	      <group topology="fullduplex">
6303	         <group topology="parallel">
6304	            <dtmf>

6306	Internet-draft       Media Server Markup Language        February 2008
6307	                                 (MSML)

6309	               <pattern digits="1" iterate="forever">
6310	                  <send target="gain" event="louder"/>
6311	               </pattern>
6312	               <pattern digits="2" iterate="forever">
6313	                  <send target="gain" event="softer"/>
6314	               </pattern>
6315	            </dtmf>
6316	            <group topology="serial">
6317	               <clamp/>
6318	               <agc tgtlvl="0"/>
6319	            </group>
6320	         </group>
6321	         <gain amt="0" incr="5"/>
6322	      </group>
6323	    </dialogstart>
6324	   </msml>

6326	15.   MSML Audit Examples

6328	   The following examples describes the MSML Audit Conference package,
6329	   the MSML Audit Connection package, and their use together with the
6330	   MSML Audit Dialog package or/and the MSML Audit Stream package.

6332	15.1    Audit All Conferences

6334	   This example describes an audit of all active conferences on the
6335	   Media Server, querying the conference configurations.

6337	      <?xml version="1.0" encoding="UTF-8"?>
6338	      <msml version="1.1">
6339	         <audit queryid="conf:*" statelist="audit.conf.confconfig.*"/>
6340	      </msml>

6342	   The following result assumes two conferences currently allocated by
6343	   the Media Server. Conference "conf:1" contains both an audio mixer
6344	   (with ASN enabled) and a video layout (vas) created, while conference
6345	   "conf:2" contains only an audio mixer created with ASN disabled.

6347	      <?xml version="1.0" encoding="UTF-8"?>
6348	      <msml version="1.1">
6349	         <result response="200">
6350	            <auditresult targetid="conf:1">
6351	               <confconfig deletewhen="nocontrol" term="true">
6352	                  <audiomix id="audiomix1">
6353	                     <asn ri="5s"/>
6354	                     <n-loudest n="16"/>
6355	                  </audiomix>

6357	Internet-draft       Media Server Markup Language        February 2008
6358	                                 (MSML)

6360	                  <videolayout id="videolayout1">
6361	                     <root size="CIF"/>
6362	                     <selector method="vas" si="5s"
6363	                               speakersees="current"/>
6364	                  </videolayout>
6365	                  <controller>conn:1234<controller/>
6366	               </confconfig>
6367	            </auditresult>
6368	            <auditresult targetid="conf:2">
6369	               <confconfig deletewhen="nomedia" term="true">
6370	                  <audiomix id="audiomix2">
6371	                     <n-loudest n="1"/>
6372	                  </audiomix>
6373	                  <controller>conn:1234<controller/>
6374	               </confconfig>
6375	            </auditresult>
6376	         </result>
6377	      </msml>

6379	15.2    Audit Conference Dialogs

6381	   This example describes an audit of active dialogs on a specific
6382	   conference. The request queries all available dialog states.

6384	      <?xml version="1.0" encoding="UTF-8"?>
6385	      <msml version="1.1">
6386	         <audit queryid="conf:1" statelist="audit.conf.dialog.*"/>
6387	      </msml>

6389	   The example result assumes a single dialog running on conference
6390	   "conf:1", which has been running for 60 seconds, and the dialog is
6391	   currently executing a record operation.

6393	      <?xml version="1.0" encoding="UTF-8"?>
6394	      <msml version="1.1">
6395	         <result response="200">
6396	            <auditresult targetid="conf:1">
6397	               <dialog name="sample">
6398	                  <duration>60</duration>
6399	                  <primitive>record</primitive>
6400	                  <controller>conn:1234</controller>
6401	               </dialog>
6402	            </auditresult>
6403	         </result>
6404	      </msml>

6406	Internet-draft       Media Server Markup Language        February 2008
6407	                                 (MSML)

6409	15.3    Audit Conference Streams

6411	   This example request describes an audit of active streams on a
6412	   specific conference. The request queries all available stream states.

6414	      <?xml version="1.0" encoding="UTF-8"?>
6415	      <msml version="1.1">
6416	         <audit queryid="conf:1" statelist="audit.conf.stream.*"/>
6417	      </msml>

6419	   The example result assumes three audio participants in the
6420	   conference. Connection "conn:1234" is a talk-listen participant with
6421	   both clamp and gain control enabled. Connection "conn:1235" is talk-
6422	   only participant. Connection "conn:1236" is a listen-only participant
6423	   with automatic gain control enabled.

6425	      <?xml version="1.0" encoding="UTF-8"?>
6426	      <msml version="1.1">
6427	         <result response="200">
6428	            <auditresult targetid="conf:1">
6429	               <stream joinwith="conn:1234" media="audio" dir="to">
6430	                  <clamp dtmf="true" tone="false"/>
6431	                  <gain amt="-10"/>
6432	               </stream>
6433	               <stream joinwith="conn:1234" media="audio" dir="from">
6434	                  <gain amt="10"/>
6435	               </stream>
6436	               <stream joinwith="conn:1235" media="audio" dir="to">
6437	               </stream>
6438	               <stream joinwith="conn:1236" media="audio" dir="from">
6439	                  <gain agc="true" tgtlvl="0" maxgain="10"/>
6440	               </stream>
6441	            </auditresult>
6442	         </result>
6443	      </msml>

6445	15.4    Audit All Connections

6447	   This example request describes an audit of all active connections on
6448	   the Media Server. No additional state is queried.

6450	      <?xml version="1.0" encoding="UTF-8"?>
6451	      <msml version="1.1">
6452	         <audit queryid="conn:*"/>
6453	      </msml>

6455	Internet-draft       Media Server Markup Language        February 2008
6456	                                 (MSML)

6458	   The example result assumes five connections currently allocated by
6459	   the Media Server.

6461	      <?xml version="1.0" encoding="UTF-8"?>
6462	      <msml version="1.1">
6463	         <result response="200">
6464	            <auditresult targetid="conn:1230"/>
6465	            <auditresult targetid="conn:1231"/>
6466	            <auditresult targetid="conn:1232"/>
6467	            <auditresult targetid="conn:1233"/>
6468	            <auditresult targetid="conn:1234"/>
6469	         </result>
6470	      </msml>

6472	15.5    Audit Connection Dialogs

6474	   This example request describes an audit of active dialogs on a
6475	   specific connection. No additional dialog state is queried.

6477	      <?xml version="1.0" encoding="UTF-8"?>
6478	      <msml version="1.1">
6479	         <audit queryid="conn:1234" statelist="audit.conn.dialog"/>
6480	      </msml>

6482	   The example result assumes three dialogs running on the connection.

6484	      <?xml version="1.0" encoding="UTF-8"?>
6485	      <msml version="1.1">
6486	         <result response="200">
6487	            <auditresult targetid="conn:1234">
6488	               <dialog name="sample1"/>
6489	               <dialog name="sample2"/>
6490	               <dialog name="sample3"/>
6491	            </auditresult>
6492	         </result>
6493	      </msml>

6495	15.6    Audit Connection Streams

6497	   This example request describes an audit of active streams on a
6498	   specific connection. No additional stream state is queried.

6500	      <?xml version="1.0" encoding="UTF-8"?>
6501	      <msml version="1.1">
6502	         <audit queryid="conn:1234" statelist="audit.conn.stream"/>

6504	Internet-draft       Media Server Markup Language        February 2008
6505	                                 (MSML)

6507	      </msml>

6509	   The example result assumes three audio streams created between target
6510	   connection and other MSML objects, one of which is a bi-directional
6511	   stream between target connection and a conference, and two are uni-
6512	   directional streams between two other connections.

6514	      <?xml version="1.0" encoding="UTF-8"?>
6515	      <msml version="1.1">
6516	         <result response="200">
6517	            <auditresult targetid="conn:1234">
6518	               <stream joinwith="conf:1" media="audio" dir="to"/>
6519	               <stream joinwith="conf:1" media="audio" dir="from"/>
6520	               <stream joinwith="conn:1235" media="audio" dir="to"/>
6521	               <stream joinwith="conn:1236" media="audio" dir="from"/>
6522	            </auditresult>
6523	         </result>
6524	      </msml>

6526	15.7    Audit Connection With Selective States

6528	   This example describes an audit of a specific connection, querying
6529	   associated SIP dialog ID and SDP info.

6531	      <?xml version="1.0" encoding="UTF-8"?>
6532	      <msml version="1.1">
6533	         <audit queryid="conn:1234" statelist="audit.conn.sipdialog
6534	            audit.conn.localsdp audit.conn.remotesdp"/>
6535	      </msml>

6537	      <?xml version="1.0" encoding="UTF-8"?>
6538	      <msml version="1.1">
6539	         <result response="200">
6540	            <auditresult targetid="conn:1234">
6541	               <sipdialog called=ABCD@10.0.0.10:5060
6542	                          localtag="sdfjsiodf"
6543	                          remotetag="zvnmviuhd8"/>
6544	               <localsdp>
6545	                  v=0
6546	                  o=- 31691 31691 IN IP4 ms5mpc11.lab.radisys.com
6547	                  s=media server session
6548	                  t=0 0
6549	                  m=audio 33794 RTP/AVP 0
6550	                  c=IN IP4 10.3.5.111
6551	                  a=rtpmap:0 PCMU/8000

6553	Internet-draft       Media Server Markup Language        February 2008
6554	                                 (MSML)

6556	                  a=sendrecv
6557	                  m=video 32770 RTP/AVP 34
6558	                  c=IN IP4 10.3.5.11
6559	                  b=AS:48
6560	                  a=rtpmap:34 H263/90000
6561	                  a=fmtp:34 CIF=1
6562	                  a=sendrecv
6563	               </localsdp>
6564	               <remotesdp>
6565	                  v=0
6566	                  o=- 12345 12345 IN IP4 10.0.0.88
6567	                  s=Radisys SIP Media Server session
6568	                  t=0 0
6569	                  c=IN IP4 10.0.0.126
6570	                  b=AS:128
6571	                  m=audio 10000 RTP/AVP 0
6572	                  a=rtpmap:0 PCMU/8000
6573	                  a=ptime:20
6574	                  a=sendrecv
6575	                  m=video 10002 RTP/AVP 34
6576	                  a=rtpmap:34 H263/90000
6577	                  a=fmtp:34 CIF=1
6578	                  a=sendrecv
6579	               </remotesdp>
6580	            </auditresult>
6581	         </result>
6582	      </msml>

6584	16.   Change Summary

6586	   MSML-06 draft includes the following changes from the previous
6587	   version

6589	         Updated IANA registrations section, as per IANA review

6591	         Fixed errors found in some sample scripts

6593	         Minor clarifications in dialog-fax package

6595	         Updated authors contact information

6597	   MSML-05 draft includes the following changes from the previous
6598	   version

6600	         Separated all references into either Normative or Informative
6601	         references, as requested by RFC-Editor.

6603	         Added "record.recordid" shadow variable to <record> element.

6605	Internet-draft       Media Server Markup Language        February 2008
6606	                                 (MSML)

6608	         Added "terminate" event to <faxdetect> element.

6610	   MSML-04 draft includes

6612	         Updates based on expert review comments from Stephen Buko
6613	         (Dialogic).

6615	         Enhancement to fax tone detection (msml-dialog-fax-detect
6616	         package). Support added for detection of CED fax tones as well
6617	         as new <faxdetectexit> element to allow reporting of fax
6618	         detection events.

6620	   MSML-03 draft includes the following changes from the previous
6621	   version.

6623	         Several editorial updates as requested by the RFC Editor.

6625	         Addition of support for media sample rates for audio
6626	         conferences, floor control override source for video
6627	         conferences, and long DTMF digit detection.

6629	   MSML-02 draft includes the following changes from the previous
6630	   version.

6632	         MSML Audit Core package and additional audit packages are added
6633	         to allow MSML clients to perform state auditing on conferences,
6634	         connections, dialogs or stream resources currently allocated
6635	         and in use by the Media Server.

6637	         Support for MSML to be alternatively invoked using SIP Control
6638	         Framework [i13]. MSML Control Packages are defined and their
6639	         usage according to SIP Control Framework [i13].

6641	         MSML schema files have been re-arranged in support of a more
6642	         modular structure and direct correlation between MSML packages
6643	         and associated XML schemas.

6645	         Other minor textual and schema corrections.

6647	   MSML-01 draft includes the following changes from the previous
6648	   version. XML schema changes for compatibility with newer versions of
6649	   XML schema validation tools. Addition of <tonegen> and associated
6650	   child elements in support of tone generation capability added to MSML
6651	   Dialog Base package. Removal of certain invalid control characters
6652	   throughout the document. Addition of "id" attribute to <gain> and
6653	   <agc> elements. Corrections to some sample scripts and other textual
6654	   fixes.

6656	Internet-draft       Media Server Markup Language        February 2008
6657	                                 (MSML)

6659	   MSML-00 is an initial draft, however it is derived from draft-
6660	   melanchuk-sipping-msml-06 [i8] and draft-melanchuk-sipping-moml-06
6661	   [i9]. Earlier versions of these specifications were co-authored by
6662	   Tim Melanchuk (while he was an employee of Convedia) and Garland
6663	   Sharratt. All functionality supported in [i8] and [i9] is supported
6664	   within this MSML specification, no new functionality is introduced in
6665	   this initial version, and there are no XML or SIP interface changes
6666	   introduced, allowing MSML-00 client/server implementations to be
6667	   fully compatible with implementations based on [i8] and [i9]. This
6668	   specification completely replaces earlier internet drafts MSML [i8]
6669	   and MOML [i9].

6671	   Additional sample scripts added and includes minor wording
6672	   corrections.

6674	   Previous versions of MSML specification are defined in this internet
6675	   draft as MSML Core and MSML Conference Core packages.

6677	   Previous versions of MOML specification are defined in this internet
6678	   draft as MSML Dialog Core, MSML Dialog Base, and all other MSML
6679	   Dialog packages.

6681	17.   Future Work

6683	   The following capabilities may be added in future versions of this
6684	   draft:

6686	      o Ability for MSML clients to audit or query the Media Server for
6687	         supported set of MSML packages and profiles.

6689	      o Ability to version MSML packages and profiles and naming scheme
6690	         for MSML extension packages.

6692	18.   XML Schema

6694	   MSML specification consists of a set of XML schemas, all of which may
6695	   be used together or any sub-set of the schemas may be used for each
6696	   MSML package. The following sections define a complete set of schemas
6697	   covering all MSML packages.

6699	   Each package contains a single schema file, <package-name>-
6700	   datatypes.xsd. This schema file can be included by its extended
6701	   package(s). Every package optionally contains another schema file,
6702	   named "<package_name>.xsd", which can be used directly to build or
6703	   validate MSML scripts for a given package.

6705	   The complete MSML schema (msml.xsd) includes all the individual MSML
6706	   packages.

6708	Internet-draft       Media Server Markup Language        February 2008
6709	                                 (MSML)

6711	   <?xml version="1.0" encoding="UTF-8"?>
6712	   <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
6713	              elementFormDefault="qualified"
6714	              attributeFormDefault="unqualified">
6715	    <xs:include schemaLocation="msml-core-datatypes.xsd"/>
6716	    <xs:include schemaLocation="msml-conf-core-datatypes.xsd"/>
6717	    <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>
6718	    <xs:include schemaLocation="msml-dialog-base-datatypes.xsd"/>
6719	    <xs:include schemaLocation="msml-dialog-transform-datatypes.xsd"/>
6720	    <xs:include schemaLocation="msml-dialog-group-datatypes.xsd"/>
6721	    <xs:include schemaLocation="msml-dialog-speech-datatypes.xsd"/>
6722	    <xs:include schemaLocation="msml-dialog-fax-detect-datatypes.xsd"/>
6723	    <xs:include schemaLocation="msml-dialog-fax-sendrecv-
6724	                datatypes.xsd"/>
6725	    <xs:include schemaLocation="msml-audit-core-datatypes.xsd"/>
6726	    <xs:include schemaLocation="msml-audit-conf-datatypes.xsd"/>
6727	    <xs:include schemaLocation="msml-audit-conn-datatypes.xsd"/>
6728	    <xs:include schemaLocation="msml-audit-dialog-datatypes.xsd"/>
6729	    <xs:include schemaLocation="msml-audit-stream-datatypes.xsd"/>
6730	    <xs:element name="msml">
6731	     <xs:complexType>
6732	      <xs:choice>
6733	       <xs:group ref="msmlRequestType" maxOccurs="unbounded"/>
6734	       <xs:element name="event">
6735	        <xs:complexType>
6736	         <xs:choice maxOccurs="unbounded">
6737	          <xs:sequence>
6738	           <xs:element name="name" type="msmlEventNameValue.datatype"/>
6739	           <xs:element name="value">
6740	            <xs:simpleType>
6741	             <xs:restriction base="xs:string">
6742	              <xs:pattern value="[a-zA-Z0-9.]+"/>
6743	             </xs:restriction>
6744	            </xs:simpleType>
6745	           </xs:element>
6746	          </xs:sequence>
6747	         </xs:choice>
6748	         <xs:attribute name="name" type="msmlEventName.datatype"
6749	                       use="required"/>
6750	         <xs:attribute name="id" type="msmlEventSource.datatype"
6751	                       use="required"/>
6752	        </xs:complexType>
6753	       </xs:element>
6754	       <xs:element name="result">
6755	        <xs:complexType>
6756	         <xs:choice>
6757	          <xs:element ref="description" minOccurs="0"/>
6758	          <xs:sequence>

6760	Internet-draft       Media Server Markup Language        February 2008
6761	                                 (MSML)

6763	           <xs:element ref="msmlResultSimple" minOccurs="0"
6764	                       maxOccurs="unbounded"/>
6765	           <xs:element ref="msmlResultComplex" minOccurs="0"
6766	                       maxOccurs="unbounded"/>
6767	          </xs:sequence>
6768	         </xs:choice>
6769	         <xs:attribute name="response">
6770	          <xs:simpleType>
6771	           <xs:restriction base="xs:string">
6772	            <xs:pattern value="\d{3}"/>
6773	           </xs:restriction>
6774	          </xs:simpleType>
6775	         </xs:attribute>
6776	         <xs:attribute name="mark" type="mark.datatype"/>
6777	        </xs:complexType>
6778	       </xs:element>
6779	      </xs:choice>
6780	      <xs:attribute name="version" type="xs:string" use="required"
6781	                    fixed="1.1"/>
6782	     </xs:complexType>
6783	    </xs:element>
6784	   </xs:schema>

6786	18.1    MSML Core

6788	18.1.1     msml-core.xsd

6790	<?xml version="1.0" encoding="UTF-8"?>
6791	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
6792	elementFormDefault="qualified" attributeFormDefault="unqualified">
6793	 <xs:include schemaLocation="msml-core-datatypes.xsd"/>
6794	 <xs:element name="msml">
6795	  <xs:complexType>
6796	   <xs:choice>
6797	    <xs:group ref="msmlRequestType" maxOccurs="unbounded"/>
6798	    <xs:element name="event">
6799	     <xs:complexType>
6800	      <xs:choice maxOccurs="unbounded">
6801	       <xs:sequence>
6802	        <xs:element name="name" type="msmlEventNameValue.datatype"/>
6803	        <xs:element name="value">
6804	         <xs:simpleType>
6805	          <xs:restriction base="xs:string">
6806	           <xs:pattern value="[a-zA-Z0-9.]+"/>
6807	          </xs:restriction>
6808	         </xs:simpleType>
6809	        </xs:element>
6810	       </xs:sequence>

6812	Internet-draft       Media Server Markup Language        February 2008
6813	                                 (MSML)

6815	      </xs:choice>
6816	      <xs:attribute name="name" type="msmlEventName.datatype"
6817	                    use="required"/>
6818	      <xs:attribute name="id" type="msmlEventSource.datatype"
6819	                    use="required"/>
6820	     </xs:complexType>
6821	    </xs:element>
6822	    <xs:element name="result">
6823	     <xs:complexType>
6824	      <xs:choice>
6825	       <xs:element ref="description" minOccurs="0"/>
6826	       <xs:sequence>
6827	        <xs:element ref="msmlResultSimple" minOccurs="0"
6828	                    maxOccurs="unbounded"/>
6829	        <xs:element ref="msmlResultComplex" minOccurs="0"
6830	                    maxOccurs="unbounded"/>
6831	       </xs:sequence>
6832	      </xs:choice>
6833	      <xs:attribute name="response">
6834	       <xs:simpleType>
6835	        <xs:restriction base="xs:string">
6836	         <xs:pattern value="\d{3}"/>
6837	        </xs:restriction>
6838	       </xs:simpleType>
6839	      </xs:attribute>
6840	      <xs:attribute name="mark" type="mark.datatype"/>
6841	     </xs:complexType>
6842	    </xs:element>
6843	   </xs:choice>
6844	   <xs:attribute name="version" type="xs:string" use="required"
6845	                 fixed="1.1"/>
6846	  </xs:complexType>
6847	 </xs:element>
6848	</xs:schema>

6850	18.1.2     msml-core-datatypes.xsd

6852	<?xml version="1.0" encoding="UTF-8"?>
6853	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
6854	           elementFormDefault="qualified"
6855	           attributeFormDefault="unqualified">
6856	 <xs:group name="msmlRequestType">
6857	  <xs:choice>
6858	   <xs:element ref="msmlRequest"/>
6859	   <xs:element name="send">
6860	    <xs:complexType>
6861	     <xs:complexContent>
6862	      <xs:extension base="msmlRequestType">

6864	Internet-draft       Media Server Markup Language        February 2008
6865	                                 (MSML)

6867	       <xs:attribute name="event" type="msmlEvent.datatype"
6868	                     use="required"/>
6869	       <xs:attribute name="target" type="msmlTarget.datatype"
6870	                    use="required"/>
6871	       <xs:attribute name="valuelist" type="xs:string"/>
6872	      </xs:extension>
6873	     </xs:complexContent>
6874	    </xs:complexType>
6875	   </xs:element>
6876	  </xs:choice>
6877	 </xs:group>
6878	 <xs:element name="msmlRequest" type="msmlRequestType" abstract="true"/>
6879	 <xs:complexType name="msmlRequestType">
6880	  <xs:attribute ref="mark"/>
6881	 </xs:complexType>
6882	 <xs:element name="msmlResultSimple" type="msmlResultSimpleType"
6883	             abstract="true"/>
6884	 <xs:element name="msmlResultComplex" type="msmlResultComplexType"
6885	             abstract="true"/>
6886	 <xs:simpleType name="msmlResultSimpleType">
6887	  <xs:restriction base="xs:string"/>
6888	 </xs:simpleType>
6889	 <xs:complexType name="msmlResultComplexType"/>
6890	 <xs:element name="description" type="xs:string"/>
6891	 <xs:attribute name="mark" type="mark.datatype"/>
6892	 <xs:simpleType name="msmlInstanceID.datatype">
6893	  <xs:restriction base="xs:string">
6894	   <xs:pattern value="[a-zA-Z0-9.:\-_]+"/>
6895	  </xs:restriction>
6896	 </xs:simpleType>
6897	 <xs:simpleType name="connID.datatype">
6898	  <xs:restriction base="xs:string">
6899	   <xs:pattern value="conn:[a-zA-Z0-9.:\-_]+"/>
6900	  </xs:restriction>
6901	 </xs:simpleType>
6902	 <xs:simpleType name="confID.datatype">
6903	  <xs:restriction base="xs:string">
6904	   <xs:pattern value="conf:[a-zA-Z0-9.:\-_]+"/>
6905	  </xs:restriction>
6906	 </xs:simpleType>
6907	 <xs:simpleType name="dialogID.datatype">
6908	  <xs:restriction base="xs:string">
6909	   <xs:pattern value="conf:[a-zA-Z0-9.:\-_]+/dialog:[a-zA-Z0-9.:\-_]+"/>
6910	   <xs:pattern value="conn:[a-zA-Z0-9.:\-_]+/dialog:[a-zA-Z0-9.:\-_]+"/>
6911	  </xs:restriction>
6912	 </xs:simpleType>
6913	 <xs:simpleType name="independentID.datatype">
6914	  <xs:restriction base="xs:string">

6916	Internet-draft       Media Server Markup Language        February 2008
6917	                                 (MSML)

6919	   <xs:pattern value="conf:[a-zA-Z0-9.:\-_]+"/>
6920	   <xs:pattern value="conn:[a-zA-Z0-9.:\-_]+"/>
6921	  </xs:restriction>
6922	 </xs:simpleType>
6923	 <xs:simpleType name="dialogLanguage.datatype">
6924	  <xs:restriction base="xs:string">
6925	   <xs:enumeration value="application/moml+xml"/>
6926	   <xs:enumeration value="application/voicexml+xml"/>
6927	  </xs:restriction>
6928	 </xs:simpleType>
6929	 <xs:simpleType name="msmlEvent.datatype">
6930	  <xs:restriction base="xs:string"/>
6931	 </xs:simpleType>
6932	 <xs:simpleType name="msmlSend.datatype">
6933	  <xs:restriction base="xs:string"/>
6934	 </xs:simpleType>
6935	 <xs:simpleType name="msmlEventName.datatype">
6936	  <xs:restriction base="xs:string">
6937	   <xs:pattern value="msml.dialog.exit"/>
6938	   <xs:pattern value="msml.conf.asn"/>
6939	   <xs:pattern value="msml.conf.nomedia"/>
6940	   <xs:pattern value="msml.dialog.exit"/>
6941	   <xs:pattern value="[a-zA-Z0-9.:_\-]+"/>
6942	  </xs:restriction>
6943	 </xs:simpleType>
6944	 <xs:simpleType name="msmlTarget.datatype">
6945	  <xs:restriction base="xs:string">
6946	   <xs:pattern
6947	value="conf:[a-zA-Z0-9.:_\-]+(/oper:[a-zA-Z0-9.:_\-]+|\*)*"/>
6948	   <xs:pattern
6949	value="conn:[a-zA-Z0-9.:_\-]+(/oper:[a-zA-Z0-9.:_\-]+|\*)+"/>
6950	  </xs:restriction>
6951	 </xs:simpleType>
6952	 <xs:simpleType name="msmlEventSource.datatype">
6953	  <xs:restriction base="xs:string">
6954	   <xs:pattern value="conf:[a-zA-Z0-9.:_\-]+"/>
6955	   <xs:pattern value="(conf:[a-zA-Z0-9.:_\-]+|conn:[a-zA-Z0-9.:_\-
6956	   ]+)/dialog:[a-zA-Z0-9.:_\-]+"/>
6957	  </xs:restriction>
6958	 </xs:simpleType>
6959	 <xs:simpleType name="msmlEventNameValue.datatype">
6960	  <xs:restriction base="xs:string"/>
6961	 </xs:simpleType>
6962	 <xs:simpleType name="mark.datatype">
6963	  <xs:restriction base="xs:string">
6964	   <xs:pattern value="[a-zA-Z0-9.:\-_]+"/>
6965	  </xs:restriction>
6966	 </xs:simpleType>

6968	Internet-draft       Media Server Markup Language        February 2008
6969	                                 (MSML)

6971	 <xs:simpleType name="boolean.datatype">
6972	  <xs:restriction base="xs:string">
6973	   <xs:enumeration value="true"/>
6974	   <xs:enumeration value="false"/>
6975	  </xs:restriction>
6976	 </xs:simpleType>
6977	 <xs:simpleType name="posDuration.datatype">
6978	  <xs:restriction base="xs:string">
6979	   <xs:pattern value="(\+)?([0-9]*\.)?[0-9]+(ms|s)"/>
6980	  </xs:restriction>
6981	 </xs:simpleType>
6982	</xs:schema>

6984	18.2    MSML Conference Core Package

6986	18.2.1     msml-conf-core.xsd

6988	<?xml version="1.0" encoding="UTF-8"?>
6989	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
6990	           elementFormDefault="qualified"
6991	           attributeFormDefault="unqualified">
6992	   <xs:include schemaLocation="msml-core.xsd"/>
6993	   <xs:include schemaLocation="msml-conf-core-datatypes.xsd"/>
6994	</xs:schema>

6996	18.2.2     msml-conf-core-datatypes.xsd

6998	<?xml version="1.0" encoding="UTF-8"?>
6999	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
7000	           elementFormDefault="qualified"
7001	           attributeFormDefault="unqualified">
7002	 <xs:include schemaLocation="msml-core-datatypes.xsd"/>
7003	 <xs:element name="createconference" substitutionGroup="msmlRequest">
7004	  <xs:complexType>
7005	   <xs:complexContent>
7006	    <xs:extension base="msmlRequestType">
7007	     <xs:all>
7008	      <xs:element name="audiomix" type="audioMixType" minOccurs="0"/>
7009	      <xs:element name="videolayout" type="videoLayoutType"
7010	                  minOccurs="0"/>
7011	      <xs:element name="reserve" minOccurs="0">
7012	       <xs:complexType>
7013	        <xs:sequence>
7014	         <xs:element name="resource" maxOccurs="unbounded">
7015	          <xs:complexType>
7016	           <xs:sequence>
7017	            <xs:any namespace="##other" processContents="lax"
7018	                    minOccurs="0" maxOccurs="unbounded"/>

7020	Internet-draft       Media Server Markup Language        February 2008
7021	                                 (MSML)

7023	           </xs:sequence>
7024	           <xs:attribute name="n" type="xs:positiveInteger"
7025	                        default="1"/>
7026	           <xs:anyAttribute namespace="##any"/>
7027	          </xs:complexType>
7028	         </xs:element>
7029	        </xs:sequence>
7030	        <xs:attribute name="required" type="boolean.datatype"
7031	                      default="true"/>
7032	       </xs:complexType>
7033	      </xs:element>
7034	     </xs:all>
7035	     <xs:attribute name="name" type="msmlInstanceID.datatype"/>
7036	     <xs:attribute name="deletewhen" default="never">
7037	      <xs:simpleType>
7038	       <xs:restriction base="xs:string">
7039	        <xs:enumeration value="nomedia"/>
7040	        <xs:enumeration value="nocontrol"/>
7041	        <xs:enumeration value="never"/>
7042	       </xs:restriction>
7043	      </xs:simpleType>
7044	     </xs:attribute>
7045	     <xs:attribute name="term" type="boolean.datatype" default="true"/>
7046	    </xs:extension>
7047	   </xs:complexContent>
7048	  </xs:complexType>
7049	 </xs:element>
7050	 <xs:element name="modifyconference" substitutionGroup="msmlRequest">
7051	  <xs:complexType>
7052	   <xs:complexContent>
7053	    <xs:extension base="msmlRequestType">
7054	     <xs:all>
7055	      <xs:element name="audiomix" type="audioMixType" minOccurs="0"/>
7056	      <xs:element name="videolayout" type="videoLayoutType"
7057	                  minOccurs="0"/>
7058	     </xs:all>
7059	     <xs:attribute name="id" type="confID.datatype" use="required"/>
7060	    </xs:extension>
7061	   </xs:complexContent>
7062	  </xs:complexType>
7063	 </xs:element>
7064	 <xs:element name="destroyconference" substitutionGroup="msmlRequest">
7065	  <xs:complexType>
7066	   <xs:complexContent>
7067	    <xs:extension base="msmlRequestType">
7068	     <xs:all>
7069	      <xs:element name="audiomix" type="basicAudioMixType"
7070	                  minOccurs="0"/>

7072	Internet-draft       Media Server Markup Language        February 2008
7073	                                 (MSML)

7075	      <xs:element name="videolayout" type="basicVideoLayoutType"
7076	                  minOccurs="0"/>
7077	     </xs:all>
7078	     <xs:attribute name="id" type="confID.datatype" use="required"/>
7079	    </xs:extension>
7080	   </xs:complexContent>
7081	  </xs:complexType>
7082	 </xs:element>
7083	 <xs:element name="join" substitutionGroup="msmlRequest">
7084	  <xs:complexType>
7085	   <xs:complexContent>
7086	    <xs:extension base="msmlRequestType">
7087	     <xs:sequence>
7088	      <xs:element name="stream" type="streamType" minOccurs="0"
7089	                  maxOccurs="4"/>
7090	     </xs:sequence>
7091	     <xs:attribute name="id1" type="independentID.datatype"
7092	                   use="required"/>
7093	     <xs:attribute name="id2" type="independentID.datatype"
7094	                   use="required"/>
7095	    </xs:extension>
7096	   </xs:complexContent>
7097	  </xs:complexType>
7098	 </xs:element>
7099	 <xs:element name="modifystream" substitutionGroup="msmlRequest">
7100	  <xs:complexType>
7101	   <xs:complexContent>
7102	    <xs:extension base="msmlRequestType">
7103	     <xs:sequence>
7104	      <xs:element name="stream" type="streamType" maxOccurs="4"/>
7105	     </xs:sequence>
7106	     <xs:attribute name="id1" type="independentID.datatype"
7107	                   use="required"/>
7108	     <xs:attribute name="id2" type="independentID.datatype"
7109	                   use="required"/>
7110	    </xs:extension>
7111	   </xs:complexContent>
7112	  </xs:complexType>
7113	 </xs:element>
7114	 <xs:element name="unjoin" substitutionGroup="msmlRequest">
7115	  <xs:complexType>
7116	   <xs:complexContent>
7117	    <xs:extension base="msmlRequestType">
7118	     <xs:sequence>
7119	      <xs:element name="stream" type="basicStreamType" minOccurs="0"
7120	                  maxOccurs="4"/>
7121	     </xs:sequence>
7122	     <xs:attribute name="id1" type="independentID.datatype"

7124	Internet-draft       Media Server Markup Language        February 2008
7125	                                 (MSML)

7127	                   use="required"/>
7128	     <xs:attribute name="id2" type="independentID.datatype"
7129	                   use="required"/>
7130	    </xs:extension>
7131	   </xs:complexContent>
7132	  </xs:complexType>
7133	 </xs:element>
7134	 <xs:element name="monitor" substitutionGroup="msmlRequest">
7135	  <xs:complexType>
7136	   <xs:complexContent>
7137	    <xs:extension base="msmlRequestType">
7138	     <xs:attribute name="id1" type="connID.datatype" use="required"/>
7139	     <xs:attribute name="id2" type="independentID.datatype"
7140	                   use="required"/>
7141	     <xs:attribute name="compressed" type="boolean.datatype"
7142	                   default="false"/>
7143	    </xs:extension>
7144	   </xs:complexContent>
7145	  </xs:complexType>
7146	 </xs:element>
7147	 <xs:element name="confid" type="msmlResultSimpleType"
7148	             substitutionGroup="msmlResultSimple"/>
7149	 <xs:complexType name="basicStreamType">
7150	  <xs:attribute name="dir">
7151	   <xs:simpleType>
7152	    <xs:restriction base="xs:string">
7153	     <xs:enumeration value="to-id1"/>
7154	     <xs:enumeration value="from-id1"/>
7155	    </xs:restriction>
7156	   </xs:simpleType>
7157	  </xs:attribute>
7158	  <xs:attribute name="media">
7159	   <xs:simpleType>
7160	    <xs:restriction base="xs:string">
7161	     <xs:enumeration value="audio"/>
7162	     <xs:enumeration value="video"/>
7163	    </xs:restriction>
7164	   </xs:simpleType>
7165	  </xs:attribute>
7166	  <xs:attribute name="compressed" type="boolean.datatype"/>
7167	 </xs:complexType>
7168	 <xs:complexType name="streamType">
7169	  <xs:complexContent>
7170	   <xs:extension base="basicStreamType">
7171	    <xs:choice minOccurs="0" maxOccurs="unbounded">
7172	     <xs:element name="gain">
7173	      <xs:complexType>
7174	       <xs:attribute name="amt" use="optional">

7176	Internet-draft       Media Server Markup Language        February 2008
7177	                                 (MSML)

7179	        <xs:simpleType>
7180	         <xs:restriction base="xs:integer">
7181	          <xs:minInclusive value="-96"/>
7182	          <xs:maxInclusive value="96"/>
7183	         </xs:restriction>
7184	        </xs:simpleType>
7185	       </xs:attribute>
7186	       <xs:attribute name="agc" type="boolean.datatype"/>
7187	       <xs:attribute name="tgtlvl" use="optional">
7188	        <xs:simpleType>
7189	         <xs:restriction base="xs:nonPositiveInteger">
7190	          <xs:minInclusive value="-40"/>
7191	          <xs:maxInclusive value="0"/>
7192	         </xs:restriction>
7193	        </xs:simpleType>
7194	       </xs:attribute>
7195	       <xs:attribute name="maxgain" default="10">
7196	        <xs:simpleType>
7197	         <xs:restriction base="xs:nonNegativeInteger">
7198	          <xs:minInclusive value="0"/>
7199	          <xs:maxInclusive value="40"/>
7200	         </xs:restriction>
7201	        </xs:simpleType>
7202	       </xs:attribute>
7203	      </xs:complexType>
7204	     </xs:element>
7205	     <xs:element name="clamp">
7206	      <xs:complexType>
7207	       <xs:attribute name="dtmf" type="boolean.datatype"/>
7208	       <xs:attribute name="tones" type="boolean.datatype"/>
7209	      </xs:complexType>
7210	     </xs:element>
7211	     <xs:element name="visual"/>
7212	    </xs:choice>
7213	    <xs:attribute name="preferred" type="boolean.datatype"
7214	                  default="false"/>
7215	    <xs:attribute name="display" type="xs:string"/>
7216	    <xs:attribute name="override" type="boolean.datatype"
7217	                  default="false"/>
7218	   </xs:extension>
7219	  </xs:complexContent>
7220	 </xs:complexType>
7221	 <xs:complexType name="basicAudioMixType">
7222	  <xs:attribute name="id" type="xs:string" use="optional"/>
7223	  <xs:attribute name="samplerate" type="xs:positiveInteger"
7224	                use="optional" default="8000"/>
7225	 </xs:complexType>
7226	 <xs:complexType name="audioMixType">

7228	Internet-draft       Media Server Markup Language        February 2008
7229	                                 (MSML)

7231	  <xs:complexContent>
7232	   <xs:extension base="basicAudioMixType">
7233	    <xs:all>
7234	     <xs:element name="asn" minOccurs="0">
7235	      <xs:complexType>
7236	       <xs:attribute name="ri" type="posDuration.datatype"/>
7237	       <xs:attribute name="asth" default="-96">
7238	        <xs:simpleType>
7239	         <xs:restriction base="xs:nonPositiveInteger">
7240	          <xs:minInclusive value="-96"/>
7241	          <xs:maxInclusive value="0"/>
7242	         </xs:restriction>
7243	        </xs:simpleType>
7244	       </xs:attribute>
7245	      </xs:complexType>
7246	     </xs:element>
7247	     <xs:element name="n-loudest" minOccurs="0">
7248	      <xs:complexType>
7249	       <xs:attribute name="n" type="xs:positiveInteger" use="required"/>
7250	      </xs:complexType>
7251	     </xs:element>
7252	    </xs:all>
7253	   </xs:extension>
7254	  </xs:complexContent>
7255	 </xs:complexType>
7256	 <xs:complexType name="basicVideoLayoutType">
7257	  <xs:attribute name="id" type="xs:string" use="required"/>
7258	  <xs:attribute name="type" type="xs:string" use="required"
7259	                fixed="text/msml-basic-layout"/>
7260	 </xs:complexType>
7261	 <xs:complexType name="videoLayoutType">
7262	  <xs:complexContent>
7263	   <xs:extension base="basicVideoLayoutType">
7264	    <xs:choice>
7265	     <xs:element name="selector">
7266	      <xs:complexType>
7267	       <xs:complexContent>
7268	        <xs:extension base="selectorType">
7269	         <xs:choice>
7270	          <xs:element name="root" type="rootType" minOccurs="0"/>
7271	          <xs:element name="region" minOccurs="0">
7272	           <xs:complexType>
7273	            <xs:attribute name="id" type="xs:string" use="required"/>
7274	            <xs:attribute name="left" type="xs:positiveInteger"/>
7275	            <xs:attribute name="top" type="xs:positiveInteger"/>
7276	            <xs:attribute name="relativeSize">
7277	             <xs:simpleType>
7278	              <xs:restriction base="xs:string">

7280	Internet-draft       Media Server Markup Language        February 2008
7281	                                 (MSML)

7283	               <xs:enumeration value="1/4"/>
7284	               <xs:enumeration value="1/3"/>
7285	               <xs:enumeration value="2/3"/>
7286	               <xs:enumeration value="3/4"/>
7287	               <xs:enumeration value="1"/>
7288	              </xs:restriction>
7289	             </xs:simpleType>
7290	            </xs:attribute>
7291	            <xs:attribute name="priority">
7292	             <xs:simpleType>
7293	              <xs:restriction base="xs:float">
7294	               <xs:minInclusive value="0"/>
7295	               <xs:maxExclusive value="1"/>
7296	              </xs:restriction>
7297	             </xs:simpleType>
7298	            </xs:attribute>
7299	            <xs:attribute name="title" type="xs:string"/>
7300	            <xs:attribute name="titleTextColor" type="xs:string"/>
7301	            <xs:attribute name="titleBackgroundColor" type="xs:string"/>
7302	            <xs:attribute name="borderColor" type="xs:string"/>
7303	            <xs:attribute name="borderWidth" type="xs:positiveInteger"/>
7304	            <xs:attribute name="logo" type="xs:anyURI"/>
7305	           </xs:complexType>
7306	          </xs:element>
7307	         </xs:choice>
7308	        </xs:extension>
7309	       </xs:complexContent>
7310	      </xs:complexType>
7311	     </xs:element>
7312	     <xs:element name="root" type="rootType"/>
7313	     <xs:element name="region" minOccurs="0" maxOccurs="unbounded">
7314	      <xs:complexType>
7315	       <xs:complexContent>
7316	        <xs:extension base="regionType"/>
7317	       </xs:complexContent>
7318	      </xs:complexType>
7319	     </xs:element>
7320	    </xs:choice>
7321	   </xs:extension>
7322	  </xs:complexContent>
7323	 </xs:complexType>
7324	 <xs:complexType name="regionType">
7325	  <xs:attribute name="id" type="xs:string" use="required"/>
7326	  <xs:attribute name="left" type="xs:positiveInteger"/>
7327	  <xs:attribute name="top" type="xs:positiveInteger"/>
7328	  <xs:attribute name="relativeSize">
7329	   <xs:simpleType>
7330	    <xs:restriction base="xs:string">

7332	Internet-draft       Media Server Markup Language        February 2008
7333	                                 (MSML)

7335	     <xs:enumeration value="1/4"/>
7336	     <xs:enumeration value="1/3"/>
7337	     <xs:enumeration value="2/3"/>
7338	     <xs:enumeration value="3/4"/>
7339	     <xs:enumeration value="1"/>
7340	    </xs:restriction>
7341	   </xs:simpleType>
7342	  </xs:attribute>
7343	  <xs:attribute name="priority">
7344	   <xs:simpleType>
7345	    <xs:restriction base="xs:float">
7346	     <xs:minInclusive value="0"/>
7347	     <xs:maxExclusive value="1"/>
7348	    </xs:restriction>
7349	   </xs:simpleType>
7350	  </xs:attribute>
7351	  <xs:attribute name="title" type="xs:string"/>
7352	  <xs:attribute name="titleTextColor" type="xs:string"/>
7353	  <xs:attribute name="titleBackgroundColor" type="xs:string"/>
7354	  <xs:attribute name="borderColor" type="xs:string"/>
7355	  <xs:attribute name="borderWidth" type="xs:positiveInteger"/>
7356	  <xs:attribute name="logo" type="xs:anyURI"/>
7357	 </xs:complexType>
7358	 <xs:complexType name="selectorType">
7359	  <xs:attribute name="id" type="xs:string" use="required"/>
7360	  <xs:attribute name="method" use="required">
7361	   <xs:simpleType>
7362	    <xs:restriction base="xs:string">
7363	     <xs:enumeration value="vas"/>
7364	     <xs:enumeration value="sequence"/>
7365	    </xs:restriction>
7366	   </xs:simpleType>
7367	  </xs:attribute>
7368	  <xs:attribute name="status" default="active">
7369	   <xs:simpleType>
7370	    <xs:restriction base="xs:string">
7371	     <xs:enumeration value="active"/>
7372	     <xs:enumeration value="disabled"/>
7373	    </xs:restriction>
7374	   </xs:simpleType>
7375	  </xs:attribute>
7376	  <xs:attribute name="si" type="posDuration.datatype" default="1s"/>
7377	  <xs:attribute name="blankothers" type="xs:boolean" default="false"/>
7378	  <xs:attribute name="speakersees" default="current">
7379	   <xs:simpleType>
7380	    <xs:restriction base="xs:string">
7381	     <xs:enumeration value="current"/>
7382	     <xs:enumeration value="previous"/>

7384	Internet-draft       Media Server Markup Language        February 2008
7385	                                 (MSML)

7387	    </xs:restriction>
7388	   </xs:simpleType>
7389	  </xs:attribute>
7390	 </xs:complexType>
7391	 <xs:complexType name="rootType">
7392	  <xs:attribute name="size" default="CIF">
7393	   <xs:simpleType>
7394	    <xs:restriction base="xs:string">
7395	     <xs:enumeration value="16CIF"/>
7396	     <xs:enumeration value="4CIF"/>
7397	     <xs:enumeration value="CIF"/>
7398	     <xs:enumeration value="QCIF"/>
7399	    </xs:restriction>
7400	   </xs:simpleType>
7401	  </xs:attribute>
7402	  <xs:attribute name="backgroundcolor" type="xs:string"
7403	                default="black"/>
7404	  <xs:attribute name="backgroundimage" type="xs:anyURI"/>
7405	 </xs:complexType>
7406	 <xs:simpleType name="confclass.datatype">
7407	  <xs:restriction base="xs:string">
7408	   <xs:enumeration value="standard"/>
7409	   <xs:enumeration value="preferred"/>
7410	  </xs:restriction>
7411	 </xs:simpleType>
7412	 <xs:simpleType name="conferenceType.datatype">
7413	  <xs:restriction base="xs:string">
7414	   <xs:enumeration value="audio.basic"/>
7415	   <xs:enumeration value="audio.advanced"/>
7416	  </xs:restriction>
7417	 </xs:simpleType>
7418	 <xs:simpleType name="duplex.datatype">
7419	  <xs:restriction base="xs:string">
7420	   <xs:enumeration value="half"/>
7421	   <xs:enumeration value="full"/>
7422	  </xs:restriction>
7423	 </xs:simpleType>
7424	</xs:schema>

7426	18.3    MSML Dialog Packages

7428	18.3.1     msml-dialog-core.xsd

7430	<?xml version="1.0" encoding="UTF-8"?>
7431	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
7432	           elementFormDefault="qualified"
7433	           attributeFormDefault="unqualified">

7435	Internet-draft       Media Server Markup Language        February 2008
7436	                                 (MSML)

7438	 <xs:include schemaLocation="msml-core.xsd"/>
7439	 <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>
7440	</xs:schema>

7442	18.3.2     msml-dialog-core-datatypes.xsd

7444	<?xml version="1.0" encoding="UTF-8"?>
7445	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
7446	           elementFormDefault="qualified"
7447	           attributeFormDefault="unqualified">
7448	 <xs:include schemaLocation="msml-core-datatypes.xsd"/>
7449	 <xs:group name="momlRequest">
7450	  <xs:choice>
7451	   <xs:group ref="executeType"/>
7452	   <xs:group ref="sendType"/>
7453	  </xs:choice>
7454	 </xs:group>
7455	 <xs:element name="dialogstart" substitutionGroup="msmlRequest">
7456	  <xs:complexType>
7457	   <xs:complexContent>
7458	    <xs:extension base="msmlRequestType">
7459	     <xs:choice>
7460	      <xs:group ref="momlRequest" minOccurs="0"/>
7461	     </xs:choice>
7462	     <xs:attribute name="target" type="independentID.datatype"
7463	                   use="required"/>
7464	     <xs:attribute name="type" type="dialogLanguage.datatype"
7465	                   use="required"/>
7466	     <xs:attribute name="name" type="msmlInstanceID.datatype"/>
7467	     <xs:attribute name="src" type="xs:anyURI" use="optional"/>
7468	    </xs:extension>
7469	   </xs:complexContent>
7470	  </xs:complexType>
7471	 </xs:element>
7472	 <xs:element name="dialogend" substitutionGroup="msmlRequest">
7473	  <xs:complexType>
7474	   <xs:complexContent>
7475	    <xs:extension base="msmlRequestType">
7476	     <xs:attribute name="id" type="dialogID.datatype" use="required"/>
7477	    </xs:extension>
7478	   </xs:complexContent>
7479	  </xs:complexType>
7480	 </xs:element>
7481	 <xs:element name="dialogid" type="msmlResultSimpleType"
7482	             substitutionGroup="msmlResultSimple"/>
7483	 <xs:group name="executeType">
7484	  <xs:choice>
7485	   <xs:element ref="primitive" maxOccurs="unbounded"/>

7487	Internet-draft       Media Server Markup Language        February 2008
7488	                                 (MSML)

7490	   <xs:element ref="control" maxOccurs="unbounded"/>
7491	  </xs:choice>
7492	 </xs:group>
7493	 <xs:element name="primitive" type="primitiveType" abstract="true"/>
7494	 <xs:complexType name="primitiveType">
7495	  <xs:attribute name="id" type="momlID.datatype"/>
7496	 </xs:complexType>
7497	 <xs:element name="control" abstract="true"/>
7498	 <xs:group name="sendType">
7499	  <xs:choice>
7500	   <xs:choice>
7501	    <xs:element name="exit" type="exitType"/>
7502	    <xs:element name="disconnect" type="exitType"/>
7503	   </xs:choice>
7504	   <xs:sequence>
7505	    <xs:element ref="send" maxOccurs="unbounded"/>
7506	    <xs:choice minOccurs="0">
7507	     <xs:element name="exit" type="exitType"/>
7508	     <xs:element name="disconnect" type="exitType"/>
7509	    </xs:choice>
7510	   </xs:sequence>
7511	  </xs:choice>
7512	 </xs:group>
7513	 <xs:element name="send">
7514	  <xs:complexType>
7515	   <xs:attribute name="event" type="momlEvent.datatype" use="required"/>
7516	   <xs:attribute name="target" type="momlTarget.datatype"
7517	                 use="required"/>
7518	   <xs:attribute name="namelist" type="momlNamelist.datatype"/>
7519	  </xs:complexType>
7520	 </xs:element>
7521	 <xs:complexType name="exitType">
7522	  <xs:attribute name="namelist" type="momlNamelist.datatype"/>
7523	 </xs:complexType>
7524	 <xs:simpleType name="momlID.datatype">
7525	  <xs:restriction base="xs:string">
7526	   <xs:pattern value="[a-zA-Z0-9][a-zA-Z0-9._\-]*"/>
7527	  </xs:restriction>
7528	 </xs:simpleType>
7529	 <xs:simpleType name="momlEvent.datatype">
7530	  <xs:restriction base="xs:string">
7531	   <xs:pattern value="[a-zA-Z0-9][a-zA-Z0-9._\-]*"/>
7532	  </xs:restriction>
7533	 </xs:simpleType>
7534	 <xs:simpleType name="momlNamelist.datatype">
7535	  <xs:restriction base="xs:string"/>
7536	 </xs:simpleType>
7537	 <xs:simpleType name="dtmfDigits.datatype">

7539	Internet-draft       Media Server Markup Language        February 2008
7540	                                 (MSML)

7542	  <xs:restriction base="xs:string">
7543	   <xs:pattern value="[0-9#*]+"/>
7544	  </xs:restriction>
7545	 </xs:simpleType>
7546	 <xs:simpleType name="iterate.datatype">
7547	  <xs:union memberTypes="xs:positiveInteger">
7548	   <xs:simpleType>
7549	    <xs:restriction base="xs:negativeInteger">
7550	     <xs:minInclusive value="-1"/>
7551	    </xs:restriction>
7552	   </xs:simpleType>
7553	   <xs:simpleType>
7554	    <xs:restriction base="xs:string">
7555	     <xs:enumeration value="forever"/>
7556	    </xs:restriction>
7557	   </xs:simpleType>
7558	  </xs:union>
7559	 </xs:simpleType>
7560	 <xs:simpleType name="momlTarget.datatype">
7561	  <xs:restriction base="xs:string">
7562	   <xs:pattern value="[a-zA-Z0-9][a-zA-Z0-9._\-]*"/>
7563	  </xs:restriction>
7564	 </xs:simpleType>
7565	 <xs:simpleType name="duration.datatype">
7566	  <xs:restriction base="xs:string">
7567	   <xs:pattern value="(\+|\-)?([0-9]*\.)?[0-9]+(ms|s)"/>
7568	  </xs:restriction>
7569	 </xs:simpleType>
7570	</xs:schema>

7572	18.3.3     msml-dialog-base.xsd

7574	<?xml version="1.0" encoding="UTF-8"?>
7575	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
7576	           elementFormDefault="unqualified"
7577	           attributeFormDefault="unqualified">
7578	 <xs:include schemaLocation="msml-core.xsd"/>
7579	 <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>
7580	 <xs:include schemaLocation="msml-dialog-base-datatypes.xsd"/>
7581	</xs:schema>

7583	18.3.4     msml-dialog-base-datatypes.xsd

7585	<?xml version="1.0" encoding="UTF-8"?>
7586	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
7587	           elementFormDefault="unqualified"
7588	           attributeFormDefault="unqualified">
7589	 <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>

7591	Internet-draft       Media Server Markup Language        February 2008
7592	                                 (MSML)

7594	 <xs:import namespace="http://www.w3.org/XML/1998/namespace"
7595	            schemaLocation="http://www.w3.org/2001/xml.xsd"/>
7596	 <xs:element name="play" substitutionGroup="primitive">
7597	  <xs:complexType>
7598	   <xs:complexContent>
7599	    <xs:extension base="primitiveType">
7600	     <xs:sequence>
7601	      <xs:choice maxOccurs="unbounded">
7602	       <xs:element name="audio" minOccurs="0" maxOccurs="unbounded">
7603	        <xs:complexType>
7604	         <xs:attribute name="uri" type="xs:anyURI" use="required"/>
7605	         <xs:attribute name="iterate" type="iterate.datatype"
7606	                       default="1"/>
7607	         <xs:attribute name="format" type="xs:string" use="optional"/>
7608	         <xs:attribute name="audiosamplerate" type="xs:positiveInteger"
7609	                       use="optional"/>
7610	         <xs:attribute name="audiosamplesize" type="xs:positiveInteger"
7611	                       use="optional"/>
7612	         <xs:attribute ref="xml:lang"/>
7613	        </xs:complexType>
7614	       </xs:element>
7615	       <xs:element name="video" minOccurs="0" maxOccurs="unbounded">
7616	        <xs:complexType>
7617	         <xs:attribute name="uri" type="xs:anyURI" use="required"/>
7618	         <xs:attribute name="iterate" type="iterate.datatype"
7619	                       use="optional" default="1"/>
7620	         <xs:attribute name="format" type="xs:string" use="optional"/>
7621	         <xs:attribute name="audiosamplerate" type="xs:positiveInteger"
7622	                       use="optional"/>
7623	         <xs:attribute name="audiosamplesize" type="xs:positiveInteger"
7624	                       use="optional"/>
7625	         <xs:attribute name="codecconfig" type="xs:string"
7626	                       use="optional"/>
7627	         <xs:attribute name="profile" type="xs:string" use="optional"/>
7628	         <xs:attribute name="level" type="xs:string" use="optional"/>
7629	         <xs:attribute name="imagewidth" type="xs:positiveInteger"
7630	                       use="optional"/>
7631	         <xs:attribute name="imageheight" type="xs:positiveInteger"
7632	                       use="optional"/>
7633	         <xs:attribute name="maxbitrate" type="xs:positiveInteger"
7634	                       use="optional"/>
7635	         <xs:attribute name="framerate" type="xs:positiveInteger"
7636	                       use="optional"/>
7637	        </xs:complexType>
7638	       </xs:element>
7639	       <xs:element name="media" minOccurs="0" maxOccurs="unbounded">
7640	        <xs:complexType>
7641	         <xs:choice minOccurs="0" maxOccurs="unbounded">

7643	Internet-draft       Media Server Markup Language        February 2008
7644	                                 (MSML)

7646	          <xs:element name="audio" minOccurs="0">
7647	           <xs:complexType>
7648	            <xs:attribute name="uri" type="xs:anyURI" use="required"/>
7649	            <xs:attribute name="iterate" type="iterate.datatype"
7650	                          default="1"/>
7651	            <xs:attribute name="format" type="xs:string"
7652	                          use="optional"/>
7653	            <xs:attribute name="audiosamplerate"
7654	                          type="xs:positiveInteger" use="optional"/>
7655	            <xs:attribute name="audiosamplesize"
7656	                          type="xs:positiveInteger" use="optional"/>
7657	            <xs:attribute ref="xml:lang"/>
7658	           </xs:complexType>
7659	          </xs:element>
7660	          <xs:element name="video" minOccurs="0">
7661	           <xs:complexType>
7662	            <xs:attribute name="uri" type="xs:anyURI" use="required"/>
7663	            <xs:attribute name="iterate" type="iterate.datatype"
7664	                          use="optional" default="1"/>
7665	            <xs:attribute name="format" type="xs:string"
7666	                          use="optional"/>
7667	            <xs:attribute name="audiosamplerate"
7668	                          type="xs:positiveInteger" use="optional"/>
7669	            <xs:attribute name="audiosamplesize"
7670	                          type="xs:positiveInteger" use="optional"/>
7671	            <xs:attribute name="codecconfig" type="xs:string"
7672	                          use="optional"/>
7673	            <xs:attribute name="profile" type="xs:string"
7674	                          use="optional"/>
7675	            <xs:attribute name="level" type="xs:string" use="optional"/>
7676	            <xs:attribute name="imagewidth" type="xs:positiveInteger"
7677	                          use="optional"/>
7678	            <xs:attribute name="imageheight" type="xs:positiveInteger"
7679	                          use="optional"/>
7680	            <xs:attribute name="maxbitrate" type="xs:positiveInteger"
7681	                          use="optional"/>
7682	            <xs:attribute name="framerate" type="xs:positiveInteger"
7683	                          use="optional"/>
7684	           </xs:complexType>
7685	          </xs:element>
7686	         </xs:choice>
7687	        </xs:complexType>
7688	       </xs:element>
7689	       <xs:element ref="smedia" minOccurs="0" maxOccurs="unbounded"/>
7690	      </xs:choice>
7691	      <xs:choice minOccurs="0">
7692	       <xs:element name="playexit">
7693	        <xs:complexType>

7695	Internet-draft       Media Server Markup Language        February 2008
7696	                                 (MSML)

7698	         <xs:group ref="sendType"/>
7699	        </xs:complexType>
7700	       </xs:element>
7701	      </xs:choice>
7702	     </xs:sequence>
7703	     <xs:attribute name="interval" type="posDuration.datatype"
7704	                   use="optional"/>
7705	     <xs:attribute name="iterate" type="iterate.datatype" use="optional"
7706	                   default="1"/>
7707	     <xs:attribute name="offset" type="duration.datatype"
7708	                   use="optional"/>
7709	     <xs:attribute name="initial" use="optional" default="generate">
7710	      <xs:simpleType>
7711	       <xs:restriction base="xs:string">
7712	        <xs:enumeration value="generate"/>
7713	        <xs:enumeration value="suspend"/>
7714	       </xs:restriction>
7715	      </xs:simpleType>
7716	     </xs:attribute>
7717	     <xs:attribute name="maxtime" type="posDuration.datatype"
7718	                   use="optional"/>
7719	     <xs:attribute name="skip" type="duration.datatype" use="optional"
7720	                   default="3s"/>
7721	     <xs:attribute name="barge" type="boolean.datatype" use="optional"
7722	                   default="false"/>
7723	     <xs:attribute name="cleardb" type="boolean.datatype" use="optional"
7724	                   default="false"/>
7725	     <xs:attribute ref="xml:lang"/>
7726	    </xs:extension>
7727	   </xs:complexContent>
7728	  </xs:complexType>
7729	 </xs:element>
7730	 <xs:element name="record" substitutionGroup="primitive">
7731	  <xs:complexType>
7732	   <xs:complexContent>
7733	    <xs:extension base="primitiveType">
7734	     <xs:choice minOccurs="0">
7735	      <xs:element ref="play" minOccurs="0" maxOccurs="unbounded"/>
7736	      <xs:element ref="tonegen" minOccurs="0" maxOccurs="unbounded"/>
7737	      <xs:element name="recordexit">
7738	       <xs:complexType>
7739	        <xs:group ref="sendType"/>
7740	       </xs:complexType>
7741	      </xs:element>
7742	     </xs:choice>
7743	     <xs:attribute name="append" type="boolean.datatype" use="optional"
7744	                   default="false"/>
7745	     <xs:attribute name="dest" type="xs:anyURI" use="optional"/>

7747	Internet-draft       Media Server Markup Language        February 2008
7748	                                 (MSML)

7750	     <xs:attribute name="audiodest" type="xs:anyURI" use="optional"/>
7751	     <xs:attribute name="videodest" type="xs:anyURI" use="optional"/>
7752	     <xs:attribute name="format" use="required">
7753	      <xs:simpleType>
7754	       <xs:restriction base="xs:string"/>
7755	      </xs:simpleType>
7756	     </xs:attribute>
7757	     <xs:attribute name="codecconfig" use="optional">
7758	      <xs:simpleType>
7759	       <xs:restriction base="xs:string"/>
7760	      </xs:simpleType>
7761	     </xs:attribute>
7762	     <xs:attribute name="audiosamplerate" type="xs:positiveInteger"
7763	                   use="optional"/>
7764	     <xs:attribute name="audiosamplesize" type="xs:positiveInteger"
7765	                   use="optional"/>
7766	     <xs:attribute name="profile" use="optional">
7767	      <xs:simpleType>
7768	       <xs:restriction base="xs:string"/>
7769	      </xs:simpleType>
7770	     </xs:attribute>
7771	     <xs:attribute name="level" use="optional">
7772	      <xs:simpleType>
7773	       <xs:restriction base="xs:string"/>
7774	      </xs:simpleType>
7775	     </xs:attribute>
7776	     <xs:attribute name="imagewidth" type="xs:positiveInteger"
7777	                   use="optional"/>
7778	     <xs:attribute name="imageheight" type="xs:positiveInteger"
7779	                   use="optional"/>
7780	     <xs:attribute name="maxbitrate" type="xs:positiveInteger"
7781	                   use="optional"/>
7782	     <xs:attribute name="framerate" type="xs:positiveInteger"
7783	                   use="optional"/>
7784	     <xs:attribute name="maxtime" type="posDuration.datatype"
7785	                   use="required"/>
7786	     <xs:attribute name="initial" use="optional" default="create">
7787	      <xs:simpleType>
7788	       <xs:restriction base="xs:string">
7789	        <xs:enumeration value="create"/>
7790	        <xs:enumeration value="suspend"/>
7791	       </xs:restriction>
7792	      </xs:simpleType>
7793	     </xs:attribute>
7794	     <xs:attribute name="prespeech" type="posDuration.datatype"
7795	                   use="optional" default="0s"/>
7796	     <xs:attribute name="postspeech" type="posDuration.datatype"
7797	                   use="optional" default="0s"/>

7799	Internet-draft       Media Server Markup Language        February 2008
7800	                                 (MSML)

7802	     <xs:attribute name="termkey" use="optional">
7803	      <xs:simpleType>
7804	       <xs:restriction base="xs:string">
7805	        <xs:pattern value="[0-9#*ABCD]"/>
7806	       </xs:restriction>
7807	      </xs:simpleType>
7808	     </xs:attribute>
7809	    </xs:extension>
7810	   </xs:complexContent>
7811	  </xs:complexType>
7812	 </xs:element>
7813	 <xs:element name="dtmf" substitutionGroup="primitive">
7814	  <xs:complexType>
7815	   <xs:complexContent>
7816	    <xs:extension base="primitiveType">
7817	     <xs:sequence>
7818	      <xs:element name="pattern" maxOccurs="unbounded">
7819	       <xs:complexType>
7820	        <xs:group ref="sendType"/>
7821	        <xs:attribute name="digits" type="xs:string" use="required"/>
7822	        <xs:attribute name="format">
7823	         <xs:simpleType>
7824	          <xs:restriction base="xs:string">
7825	           <xs:enumeration value="mgcp"/>
7826	           <xs:enumeration value="megaco"/>
7827	           <xs:enumeration value="moml+digits"/>
7828	          </xs:restriction>
7829	         </xs:simpleType>
7830	        </xs:attribute>
7831	        <xs:attribute name="iterate" type="iterate.datatype"
7832	                      default="1"/>
7833	       </xs:complexType>
7834	      </xs:element>
7835	      <xs:element name="detect" minOccurs="0">
7836	       <xs:complexType>
7837	        <xs:group ref="sendType"/>
7838	       </xs:complexType>
7839	      </xs:element>
7840	      <xs:element name="noinput" type="iterateSendType" minOccurs="0"/>
7841	      <xs:element name="nomatch" type="iterateSendType" minOccurs="0"/>
7842	      <xs:element name="dtmfexit" minOccurs="0">
7843	       <xs:complexType>
7844	        <xs:group ref="sendType"/>
7845	       </xs:complexType>
7846	      </xs:element>
7847	      <xs:element ref="play" minOccurs="0"/>
7848	     </xs:sequence>
7849	     <xs:attribute name="cleardb" type="boolean.datatype"

7851	Internet-draft       Media Server Markup Language        February 2008
7852	                                 (MSML)

7854	                   default="true"/>
7855	     <xs:attribute name="fdt" type="posDuration.datatype" default="0s"/>
7856	     <xs:attribute name="idt" type="posDuration.datatype" default="4s"/>
7857	     <xs:attribute name="edt" type="posDuration.datatype" default="4s"/>
7858	     <xs:attribute name="starttimer" type="boolean.datatype"
7859	                   default="false"/>
7860	     <xs:attribute name="iterate" type="iterate.datatype" default="1"/>
7861	     <xs:attribute name="ldd" type="posDuration.datatype" default="0s"/>
7862	    </xs:extension>
7863	   </xs:complexContent>
7864	  </xs:complexType>
7865	 </xs:element>
7866	 <xs:element name="collect" substitutionGroup="primitive">
7867	  <xs:complexType>
7868	   <xs:complexContent>
7869	    <xs:extension base="primitiveType">
7870	     <xs:sequence>
7871	      <xs:element name="pattern" maxOccurs="unbounded">
7872	       <xs:complexType>
7873	        <xs:group ref="sendType"/>
7874	        <xs:attribute name="digits" type="xs:string" use="required"/>
7875	        <xs:attribute name="format">
7876	         <xs:simpleType>
7877	          <xs:restriction base="xs:string">
7878	           <xs:enumeration value="mgcp"/>
7879	           <xs:enumeration value="megaco"/>
7880	           <xs:enumeration value="moml+digits"/>
7881	          </xs:restriction>
7882	         </xs:simpleType>
7883	        </xs:attribute>
7884	        <xs:attribute name="iterate" type="iterate.datatype"
7885	                      default="1"/>
7886	       </xs:complexType>
7887	      </xs:element>
7888	      <xs:element name="detect" minOccurs="0">
7889	       <xs:complexType>
7890	        <xs:group ref="sendType"/>
7891	       </xs:complexType>
7892	      </xs:element>
7893	      <xs:element name="noinput" type="iterateSendType" minOccurs="0"/>
7894	      <xs:element name="nomatch" type="iterateSendType" minOccurs="0"/>
7895	      <xs:element name="dtmfexit" minOccurs="0">
7896	       <xs:complexType>
7897	        <xs:group ref="sendType"/>
7898	       </xs:complexType>
7899	      </xs:element>
7900	      <xs:element ref="play" minOccurs="0"/>
7901	     </xs:sequence>

7903	Internet-draft       Media Server Markup Language        February 2008
7904	                                 (MSML)

7906	     <xs:attribute name="cleardb" type="boolean.datatype"
7907	                   default="true"/>
7908	     <xs:attribute name="fdt" type="posDuration.datatype" default="0s"/>
7909	     <xs:attribute name="idt" type="posDuration.datatype" default="4s"/>
7910	     <xs:attribute name="edt" type="posDuration.datatype" default="4s"/>
7911	     <xs:attribute name="starttimer" type="boolean.datatype"
7912	                   default="false"/>
7913	     <xs:attribute name="iterate" type="iterate.datatype" default="1"/>
7914	     <xs:attribute name="ldd" type="posDuration.datatype"/>
7915	    </xs:extension>
7916	   </xs:complexContent>
7917	  </xs:complexType>
7918	 </xs:element>
7919	 <xs:element name="dtmfgen" substitutionGroup="primitive">
7920	  <xs:complexType>
7921	   <xs:complexContent>
7922	    <xs:extension base="primitiveType">
7923	     <xs:choice minOccurs="0">
7924	      <xs:element name="dtmfgenexit">
7925	       <xs:complexType>
7926	        <xs:group ref="sendType"/>
7927	       </xs:complexType>
7928	      </xs:element>
7929	     </xs:choice>
7930	     <xs:attribute name="level" use="optional" default="-6">
7931	      <xs:simpleType>
7932	       <xs:restriction base="xs:nonPositiveInteger">
7933	        <xs:maxInclusive value="0"/>
7934	        <xs:minInclusive value="-96"/>
7935	       </xs:restriction>
7936	      </xs:simpleType>
7937	     </xs:attribute>
7938	     <xs:attribute name="digits" type="dtmfDigits.datatype"
7939	                   use="required"/>
7940	     <xs:attribute name="dur" type="posDuration.datatype" use="optional"
7941	                   default="100ms"/>
7942	     <xs:attribute name="interval" type="posDuration.datatype"
7943	                   use="optional" default="100ms"/>
7944	    </xs:extension>
7945	   </xs:complexContent>
7946	  </xs:complexType>
7947	 </xs:element>
7948	 <xs:element name="tonegen" substitutionGroup="primitive">
7949	  <xs:complexType>
7950	   <xs:complexContent>
7951	    <xs:extension base="primitiveType">
7952	     <xs:choice minOccurs="0">
7953	      <xs:element name="tonegenexit" minOccurs="0">

7955	Internet-draft       Media Server Markup Language        February 2008
7956	                                 (MSML)

7958	       <xs:complexType>
7959	        <xs:group ref="sendType"/>
7960	       </xs:complexType>
7961	      </xs:element>
7962	      <xs:element name="tone" maxOccurs="unbounded">
7963	       <xs:complexType>
7964	        <xs:sequence>
7965	         <xs:element name="tone1">
7966	          <xs:complexType>
7967	           <xs:attribute name="freq" use="required">
7968	            <xs:simpleType>
7969	             <xs:restriction base="xs:unsignedInt">
7970	              <xs:minInclusive value="0"/>
7971	              <xs:maxInclusive value="3999"/>
7972	             </xs:restriction>
7973	            </xs:simpleType>
7974	           </xs:attribute>
7975	           <xs:attribute name="atten" use="required">
7976	            <xs:simpleType>
7977	             <xs:restriction base="xs:nonPositiveInteger">
7978	              <xs:minInclusive value="-96"/>
7979	              <xs:maxInclusive value="0"/>
7980	             </xs:restriction>
7981	            </xs:simpleType>
7982	           </xs:attribute>
7983	          </xs:complexType>
7984	         </xs:element>
7985	         <xs:element name="tone2">
7986	          <xs:complexType>
7987	           <xs:attribute name="freq" use="required">
7988	            <xs:simpleType>
7989	             <xs:restriction base="xs:unsignedInt">
7990	              <xs:minInclusive value="0"/>
7991	              <xs:maxInclusive value="3999"/>
7992	             </xs:restriction>
7993	            </xs:simpleType>
7994	           </xs:attribute>
7995	           <xs:attribute name="atten" use="required">
7996	            <xs:simpleType>
7997	             <xs:restriction base="xs:nonPositiveInteger">
7998	              <xs:minInclusive value="-96"/>
7999	              <xs:maxInclusive value="0"/>
8000	             </xs:restriction>
8001	            </xs:simpleType>
8002	           </xs:attribute>
8003	          </xs:complexType>
8004	         </xs:element>
8005	         <xs:element name="silence" minOccurs="0" maxOccurs="unbounded">

8007	Internet-draft       Media Server Markup Language        February 2008
8008	                                 (MSML)

8010	          <xs:complexType>
8011	           <xs:attribute name="duration" type="duration.datatype"
8012	                         use="required"/>
8013	          </xs:complexType>
8014	         </xs:element>
8015	        </xs:sequence>
8016	        <xs:attribute name="duration" use="required">
8017	         <xs:simpleType>
8018	          <xs:restriction base="duration.datatype"/>
8019	         </xs:simpleType>
8020	        </xs:attribute>
8021	        <xs:attribute name="iterate" type="iterate.datatype"
8022	                      use="optional" default="1"/>
8023	       </xs:complexType>
8024	      </xs:element>
8025	      <xs:element name="silence" minOccurs="0" maxOccurs="unbounded">
8026	       <xs:complexType>
8027	        <xs:attribute name="duration" type="duration.datatype"
8028	                      use="required"/>
8029	       </xs:complexType>
8030	      </xs:element>
8031	     </xs:choice>
8032	     <xs:attribute name="iterate" type="iterate.datatype" use="optional"
8033	                   default="1"/>
8034	    </xs:extension>
8035	   </xs:complexContent>
8036	  </xs:complexType>
8037	 </xs:element>
8038	 <xs:complexType name="iterateSendType">
8039	  <xs:group ref="sendType"/>
8040	  <xs:attribute name="iterate" type="iterate.datatype" default="1"/>
8041	 </xs:complexType>
8042	 <xs:element name="smedia" type="smediaType" abstract="true"/>
8043	 <xs:complexType name="smediaType">
8044	  <xs:attribute ref="xml:lang"/>
8045	  <xs:attribute name="iterate" type="iterate.datatype"/>
8046	 </xs:complexType>
8047	 <xs:element name="var" substitutionGroup="smedia">
8048	  <xs:complexType>
8049	   <xs:complexContent>
8050	    <xs:extension base="smediaType">
8051	     <xs:attribute name="type" use="required">
8052	      <xs:simpleType>
8053	       <xs:restriction base="xs:string">
8054	        <xs:enumeration value="date"/>
8055	        <xs:enumeration value="digits"/>
8056	        <xs:enumeration value="duration"/>
8057	        <xs:enumeration value="month"/>

8059	Internet-draft       Media Server Markup Language        February 2008
8060	                                 (MSML)

8062	        <xs:enumeration value="money"/>
8063	        <xs:enumeration value="number"/>
8064	        <xs:enumeration value="silence"/>
8065	        <xs:enumeration value="time"/>
8066	        <xs:enumeration value="weekday"/>
8067	       </xs:restriction>
8068	      </xs:simpleType>
8069	     </xs:attribute>
8070	     <xs:attribute name="subtype" type="xs:string" use="optional"/>
8071	     <xs:attribute name="value" type="xs:string" use="required"/>
8072	    </xs:extension>
8073	   </xs:complexContent>
8074	  </xs:complexType>
8075	 </xs:element>
8076	</xs:schema>

8078	18.3.5     msml-dialog-transform.xsd

8080	<?xml version="1.0" encoding="UTF-8"?>
8081	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8082	           elementFormDefault="unqualified"
8083	           attributeFormDefault="unqualified">
8084	 <xs:include schemaLocation="msml-core.xsd"/>
8085	 <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>
8086	 <xs:include schemaLocation="msml-dialog-transform-datatypes.xsd"/>
8087	</xs:schema>

8089	18.3.6     msml-dialog-transform-datatypes.xsd

8091	<?xml version="1.0" encoding="UTF-8"?>
8092	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8093	           elementFormDefault="unqualified"
8094	           attributeFormDefault="unqualified">
8095	 <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>
8096	 <xs:import namespace="http://www.w3.org/XML/1998/namespace"
8097	            schemaLocation="http://www.w3.org/2001/xml.xsd"/>
8098	 <xs:element name="vad" substitutionGroup="primitive">
8099	  <xs:complexType>
8100	   <xs:complexContent>
8101	    <xs:extension base="primitiveType">
8102	     <xs:all>
8103	      <xs:element name="voice" type="vadPatternType" minOccurs="0"/>
8104	      <xs:element name="silence" type="vadPatternType" minOccurs="0"/>
8105	      <xs:element name="tvoice" type="vadPatternType" minOccurs="0"/>
8106	      <xs:element name="tsilence" type="vadPatternType" minOccurs="0"/>
8107	     </xs:all>
8108	     <xs:attribute name="starttimer" type="boolean.datatype"
8109	                   default="false"/>

8111	Internet-draft       Media Server Markup Language        February 2008
8112	                                 (MSML)

8114	    </xs:extension>
8115	   </xs:complexContent>
8116	  </xs:complexType>
8117	 </xs:element>
8118	 <xs:element name="gain" substitutionGroup="primitive">
8119	  <xs:complexType>
8120	   <xs:complexContent>
8121	    <xs:extension base="primitiveType">
8122	     <xs:attribute name="incr" default="3">
8123	      <xs:simpleType>
8124	       <xs:restriction base="xs:positiveInteger">
8125	        <xs:maxInclusive value="96"/>
8126	       </xs:restriction>
8127	      </xs:simpleType>
8128	     </xs:attribute>
8129	     <xs:attribute name="amt" use="required">
8130	      <xs:simpleType>
8131	       <xs:restriction base="xs:integer">
8132	        <xs:minInclusive value="-96"/>
8133	        <xs:maxInclusive value="96"/>
8134	       </xs:restriction>
8135	      </xs:simpleType>
8136	     </xs:attribute>
8137	    </xs:extension>
8138	   </xs:complexContent>
8139	  </xs:complexType>
8140	 </xs:element>
8141	 <xs:element name="agc" substitutionGroup="primitive">
8142	  <xs:complexType>
8143	   <xs:complexContent>
8144	    <xs:extension base="primitiveType">
8145	     <xs:attribute name="tgtlvl" use="required">
8146	      <xs:simpleType>
8147	       <xs:restriction base="xs:nonPositiveInteger">
8148	        <xs:minInclusive value="-40"/>
8149	        <xs:maxInclusive value="0"/>
8150	       </xs:restriction>
8151	      </xs:simpleType>
8152	     </xs:attribute>
8153	     <xs:attribute name="maxgain" default="10">
8154	      <xs:simpleType>
8155	       <xs:restriction base="xs:nonNegativeInteger">
8156	        <xs:minInclusive value="0"/>
8157	        <xs:maxInclusive value="40"/>
8158	       </xs:restriction>
8159	      </xs:simpleType>
8160	     </xs:attribute>
8161	    </xs:extension>

8163	Internet-draft       Media Server Markup Language        February 2008
8164	                                 (MSML)

8166	   </xs:complexContent>
8167	  </xs:complexType>
8168	 </xs:element>
8169	 <xs:element name="gate" substitutionGroup="primitive">
8170	  <xs:complexType>
8171	   <xs:complexContent>
8172	    <xs:extension base="primitiveType">
8173	     <xs:attribute name="initial" default="pass">
8174	      <xs:simpleType>
8175	       <xs:restriction base="xs:string">
8176	        <xs:enumeration value="pass"/>
8177	        <xs:enumeration value="halt"/>
8178	       </xs:restriction>
8179	      </xs:simpleType>
8180	     </xs:attribute>
8181	    </xs:extension>
8182	   </xs:complexContent>
8183	  </xs:complexType>
8184	 </xs:element>
8185	 <xs:element name="clamp" substitutionGroup="primitive">
8186	  <xs:complexType>
8187	   <xs:complexContent>
8188	    <xs:extension base="primitiveType"/>
8189	   </xs:complexContent>
8190	  </xs:complexType>
8191	 </xs:element>
8192	 <xs:element name="relay" substitutionGroup="primitive">
8193	  <xs:complexType>
8194	   <xs:complexContent>
8195	    <xs:extension base="primitiveType"/>
8196	   </xs:complexContent>
8197	  </xs:complexType>
8198	 </xs:element>
8199	 <xs:complexType name="vadPatternType">
8200	  <xs:group ref="sendType"/>
8201	  <xs:attribute name="iterate" type="iterate.datatype" default="1"/>
8202	  <xs:attribute name="len" type="posDuration.datatype" use="required"/>
8203	  <xs:attribute name="sen" type="posDuration.datatype" use="optional"/>
8204	 </xs:complexType>
8205	</xs:schema>

8207	18.3.7     msml-dialog-group.xsd

8209	<?xml version="1.0" encoding="UTF-8"?>
8210	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8211	           elementFormDefault="unqualified"
8212	           attributeFormDefault="unqualified">
8213	 <xs:include schemaLocation="msml-core.xsd"/>

8215	Internet-draft       Media Server Markup Language        February 2008
8216	                                 (MSML)

8218	 <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>
8219	 <xs:include schemaLocation="msml-dialog-base-datatypes.xsd"/>
8220	 <xs:include schemaLocation="msml-dialog-group-datatypes.xsd"/>
8221	</xs:schema>

8223	18.3.8     msml-dialog-group-datatypes.xsd

8225	<?xml version="1.0" encoding="UTF-8"?>
8226	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8227	           elementFormDefault="unqualified"
8228	           attributeFormDefault="unqualified">
8229	 <xs:include schemaLocation="msml-core-datatypes.xsd"/>
8230	 <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>
8231	 <xs:include schemaLocation="msml-dialog-base-datatypes.xsd"/>
8232	 <xs:include schemaLocation="msml-dialog-transform-datatypes.xsd"/>
8233	 <xs:element name="group" substitutionGroup="control">
8234	  <xs:complexType>
8235	   <xs:sequence>
8236	    <xs:group ref="executeType"/>
8237	    <xs:element name="groupexit" minOccurs="0">
8238	     <xs:complexType>
8239	      <xs:group ref="sendType"/>
8240	     </xs:complexType>
8241	    </xs:element>
8242	   </xs:sequence>
8243	   <xs:attribute name="id" type="momlID.datatype"/>
8244	   <xs:attribute name="topology" use="required">
8245	    <xs:simpleType>
8246	     <xs:restriction base="xs:string">
8247	      <xs:enumeration value="serial"/>
8248	      <xs:enumeration value="parallel"/>
8249	      <xs:enumeration value="fullduplex"/>
8250	     </xs:restriction>
8251	    </xs:simpleType>
8252	   </xs:attribute>
8253	  </xs:complexType>
8254	 </xs:element>
8255	</xs:schema>

8257	18.3.9     msml-dialog-speech.xsd

8259	<?xml version="1.0" encoding="UTF-8"?>
8260	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8261	           elementFormDefault="qualified"
8262	           attributeFormDefault="unqualified">
8263	 <xs:include schemaLocation="msml-core.xsd"/>
8264	 <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>
8265	 <xs:include schemaLocation="msml-dialog-base-datatypes.xsd"/>

8267	Internet-draft       Media Server Markup Language        February 2008
8268	                                 (MSML)

8270	 <xs:include schemaLocation="msml-dialog-speech-datatypes.xsd"/>
8271	</xs:schema>

8273	18.3.10      msml-dialog-speech-datatypes.xsd

8275	<?xml version="1.0" encoding="UTF-8"?>
8276	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8277	           elementFormDefault="qualified"
8278	           attributeFormDefault="unqualified">
8279	 <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>
8280	 <xs:include schemaLocation="msml-dialog-base-datatypes.xsd"/>
8281	 <xs:include schemaLocation="http://www.w3.org/TR/2002/WD-speech-
8282	             synthesis-20020405/synthesis-core.xsd"/>
8283	 <xs:include schemaLocation="http://www.w3.org/TR/speech-
8284	             grammar/grammar-core.xsd"/>
8285	 <xs:element name="speech" substitutionGroup="primitive">
8286	  <xs:complexType>
8287	   <xs:complexContent>
8288	    <xs:extension base="primitiveType">
8289	     <xs:sequence>
8290	      <xs:element name="grammar" maxOccurs="unbounded">
8291	       <xs:complexType>
8292	        <xs:complexContent>
8293	         <xs:extension base="grammar">
8294	          <xs:choice>
8295	           <xs:element name="match" type="iterateSendType"
8296	                       minOccurs="0"/>
8297	          </xs:choice>
8298	          <xs:attribute name="uri" type="xs:anyURI"/>
8299	          <xs:attribute name="iterate" type="iterate.datatype"
8300	                        default="1"/>
8301	         </xs:extension>
8302	        </xs:complexContent>
8303	       </xs:complexType>
8304	      </xs:element>
8305	      <xs:element name="noinput" type="iterateSendType" minOccurs="0"/>
8306	      <xs:element name="nomatch" type="iterateSendType" minOccurs="0"/>
8307	      <xs:element name="speechexit" minOccurs="0">
8308	       <xs:complexType>
8309	        <xs:group ref="sendType"/>
8310	       </xs:complexType>
8311	      </xs:element>
8312	     </xs:sequence>
8313	     <xs:attribute name="noint" type="posDuration.datatype"/>
8314	     <xs:attribute name="norect" type="posDuration.datatype"/>
8315	     <xs:attribute name="spcmplt" type="posDuration.datatype"/>
8316	     <xs:attribute name="confidence">
8317	      <xs:simpleType>

8319	Internet-draft       Media Server Markup Language        February 2008
8320	                                 (MSML)

8322	       <xs:restriction base="xs:positiveInteger">
8323	        <xs:maxInclusive value="100"/>
8324	       </xs:restriction>
8325	      </xs:simpleType>
8326	     </xs:attribute>
8327	     <xs:attribute name="sens" type="xs:positiveInteger"/>
8328	     <xs:attribute name="starttimer" type="boolean.datatype"
8329	                   default="false"/>
8330	     <xs:attribute name="iterate" type="iterate.datatype" default="1"/>
8331	    </xs:extension>
8332	   </xs:complexContent>
8333	  </xs:complexType>
8334	 </xs:element>
8335	 <xs:element name="tts" type="smediaType" substitutionGroup="smedia"/>
8336	</xs:schema>

8338	18.3.11      msml-dialog-fax-detect.xsd

8340	<?xml version="1.0" encoding="UTF-8"?>
8341	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8342	           elementFormDefault="qualified"
8343	           attributeFormDefault="unqualified">
8344	 <xs:include schemaLocation="msml-core.xsd"/>
8345	 <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>
8346	 <xs:include schemaLocation="msml-dialog-fax-detect-datatypes.xsd"/>
8347	</xs:schema>

8349	18.3.12      msml-dialog-fax-detect-datatypes.xsd

8351	<?xml version="1.0" encoding="UTF-8"?>
8352	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8353	           elementFormDefault="qualified"
8354	           attributeFormDefault="unqualified">
8355	 <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>
8356	 <xs:element name="faxdetect" substitutionGroup="primitive">
8357	  <xs:complexType>
8358	   <xs:complexContent>
8359	    <xs:extension base="primitiveType">
8360	     <xs:choice minOccurs="0">
8361	      <xs:element name="faxdetectexit">
8362	       <xs:complexType>
8363	        <xs:group ref="sendType"/>
8364	       </xs:complexType>
8365	      </xs:element>
8366	     </xs:choice>
8367	    </xs:extension>
8368	   </xs:complexContent>
8369	  </xs:complexType>

8371	Internet-draft       Media Server Markup Language        February 2008
8372	                                 (MSML)

8374	 </xs:element>
8375	</xs:schema>

8377	18.3.13      msml-dialog-fax-sendrecv.xsd

8379	<?xml version="1.0" encoding="UTF-8"?>
8380	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8381	           elementFormDefault="qualified"
8382	           attributeFormDefault="unqualified">
8383	 <xs:include schemaLocation="msml-core.xsd"/>
8384	 <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>
8385	 <xs:include schemaLocation="msml-dialog-fax-sendrecv-datatypes.xsd"/>
8386	</xs:schema>

8388	18.3.14      msml-dialog-fax-sendrecv-datatypes.xsd

8390	<?xml version="1.0" encoding="UTF-8"?>
8391	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8392	           elementFormDefault="qualified"
8393	           attributeFormDefault="unqualified">
8394	 <xs:include schemaLocation="msml-dialog-core-datatypes.xsd"/>
8395	 <xs:element name="faxsend" substitutionGroup="primitive">
8396	  <xs:complexType>
8397	   <xs:complexContent>
8398	    <xs:extension base="primitiveType">
8399	     <xs:sequence>
8400	      <xs:element name="sendobj" type="sendobjType" minOccurs="0"
8401	          maxOccurs="unbounded"/>
8402	      <xs:element name="hdrfooter" type="hdrfooterType" minOccurs="0"/>
8403	      <xs:element name="rxpoll" minOccurs="0">
8404	       <xs:complexType>
8405	        <xs:sequence>
8406	         <xs:element name="rcvobj" type="rcvobjType"
8407	                     maxOccurs="unbounded"/>
8408	         <xs:element name="hdrfooter" type="hdrfooterType"
8409	                     minOccurs="0"/>
8410	        </xs:sequence>
8411	        <xs:attribute name="rmtid" type="faxid.datatype"
8412	                      use="required"/>
8413	       </xs:complexType>
8414	      </xs:element>
8415	      <xs:group ref="faxstatusrequest"/>
8416	     </xs:sequence>
8417	     <xs:attribute name="lclid" type="faxid.datatype" use="optional"/>
8418	     <xs:attribute name="minspeed" type="faxspeed.datatype"
8419	                   use="optional"/>
8420	     <xs:attribute name="maxspeed" type="faxspeed.datatype"
8421	                   use="optional"/>

8423	Internet-draft       Media Server Markup Language        February 2008
8424	                                 (MSML)

8426	     <xs:attribute name="ecm" type="boolean.datatype" use="optional"/>
8427	    </xs:extension>
8428	   </xs:complexContent>
8429	  </xs:complexType>
8430	 </xs:element>
8431	 <xs:element name="faxrecv" substitutionGroup="primitive">
8432	  <xs:complexType>
8433	   <xs:complexContent>
8434	    <xs:extension base="primitiveType">
8435	     <xs:sequence>
8436	      <xs:element name="rcvobj" type="rcvobjType" minOccurs="0"
8437	                  maxOccurs="unbounded"/>
8438	      <xs:element name="hdrfooter" type="hdrfooterType" minOccurs="0"/>
8439	      <xs:element name="txpoll" minOccurs="0">
8440	       <xs:complexType>
8441	        <xs:sequence>
8442	         <xs:element name="sendobj" type="sendobjType"
8443	                     maxOccurs="unbounded"/>
8444	         <xs:element name="hdrfooter" type="hdrfooterType"
8445	                     minOccurs="0"/>
8446	        </xs:sequence>
8447	        <xs:attribute name="rmtid" type="faxid.datatype"/>
8448	       </xs:complexType>
8449	      </xs:element>
8450	      <xs:group ref="faxstatusrequest"/>
8451	     </xs:sequence>
8452	     <xs:attribute name="lclid" type="faxid.datatype" use="optional"/>
8453	     <xs:attribute name="ecm" type="boolean.datatype" default="true"/>
8454	    </xs:extension>
8455	   </xs:complexContent>
8456	  </xs:complexType>
8457	 </xs:element>
8458	 <xs:group name="faxstatusrequest">
8459	  <xs:sequence>
8460	   <xs:element name="faxstart" minOccurs="0"/>
8461	   <xs:element name="faxnegotiate" minOccurs="0"/>
8462	   <xs:element name="faxpagedone" minOccurs="0"/>
8463	   <xs:element name="faxobjectdone" minOccurs="0"/>
8464	   <xs:element name="faxopcomplete" minOccurs="0"/>
8465	   <xs:element name="faxpollstart" minOccurs="0"/>
8466	  </xs:sequence>
8467	 </xs:group>
8468	 <xs:complexType name="hdrfooterType">
8469	  <xs:choice>
8470	   <xs:element name="format" type="xs:string" minOccurs="0"
8471	               maxOccurs="unbounded"/>
8472	  </xs:choice>
8473	  <xs:attribute name="type" type="hdrfooter.datatype"/>

8475	Internet-draft       Media Server Markup Language        February 2008
8476	                                 (MSML)

8478	  <xs:attribute name="style" type="hdrfooterstyle.datatype"/>
8479	 </xs:complexType>
8480	 <xs:complexType name="formatType">
8481	  <xs:simpleContent>
8482	   <xs:extension base="xs:string">
8483	    <xs:attribute name="style">
8484	     <xs:simpleType>
8485	      <xs:restriction base="xs:string">
8486	       <xs:enumeration value="append"/>
8487	       <xs:enumeration value="overlay"/>
8488	       <xs:enumeration value="replace"/>
8489	      </xs:restriction>
8490	     </xs:simpleType>
8491	    </xs:attribute>
8492	   </xs:extension>
8493	  </xs:simpleContent>
8494	 </xs:complexType>
8495	 <xs:complexType name="rcvobjType">
8496	  <xs:attribute name="objuri" type="xs:anyURI" use="required"/>
8497	  <xs:attribute name="maxpages" type="xs:positiveInteger"/>
8498	 </xs:complexType>
8499	 <xs:complexType name="sendobjType">
8500	  <xs:attribute name="objuri" type="xs:anyURI" use="required"/>
8501	  <xs:attribute name="startpage" type="xs:positiveInteger"/>
8502	  <xs:attribute name="pagecount" type="xs:positiveInteger"/>
8503	 </xs:complexType>
8504	 <xs:simpleType name="faxid.datatype">
8505	  <xs:restriction base="xs:string">
8506	   <xs:pattern value="[0-9+*- ]{20}"/>
8507	  </xs:restriction>
8508	 </xs:simpleType>
8509	 <xs:simpleType name="faxspeed.datatype">
8510	  <xs:restriction base="xs:string">
8511	   <xs:enumeration value="2400"/>
8512	   <xs:enumeration value="4800"/>
8513	   <xs:enumeration value="7200"/>
8514	   <xs:enumeration value="9600"/>
8515	   <xs:enumeration value="12000"/>
8516	   <xs:enumeration value="14400"/>
8517	  </xs:restriction>
8518	 </xs:simpleType>
8519	 <xs:simpleType name="hdrfooter.datatype">
8520	  <xs:restriction base="xs:string">
8521	   <xs:enumeration value="header"/>
8522	   <xs:enumeration value="footer"/>
8523	   <xs:enumeration value="autohdr"/>
8524	   <xs:enumeration value="nohdr"/>
8525	  </xs:restriction>

8527	Internet-draft       Media Server Markup Language        February 2008
8528	                                 (MSML)

8530	 </xs:simpleType>
8531	 <xs:simpleType name="hdrfooterstyle.datatype">
8532	  <xs:restriction base="xs:string">
8533	   <xs:enumeration value="append"/>
8534	   <xs:enumeration value="overlay"/>
8535	   <xs:enumeration value="replace"/>
8536	  </xs:restriction>
8537	 </xs:simpleType>
8538	</xs:schema>

8540	18.4    MSML Audit Packages

8542	18.4.1     msml-audit-core.xsd

8544	<?xml version="1.0" encoding="UTF-8"?>
8545	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8546	           elementFormDefault="qualified"
8547	           attributeFormDefault="unqualified">
8548	 <xs:include schemaLocation="msml-core.xsd"/>
8549	 <xs:include schemaLocation="msml-core-datatypes.xsd"/>
8550	 <xs:include schemaLocation="msml-audit-core-datatypes.xsd"/>
8551	</xs:schema>

8553	18.4.2     msml-audit-core-datatypes.xsd

8555	<?xml version="1.0" encoding="UTF-8"?>
8556	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8557	           elementFormDefault="qualified"
8558	           attributeFormDefault="unqualified">
8559	 <xs:include schemaLocation="msml-core-datatypes.xsd"/>
8560	 <xs:element name="audit" substitutionGroup="msmlRequest">
8561	  <xs:complexType>
8562	   <xs:complexContent>
8563	    <xs:extension base="msmlRequestType">
8564	     <xs:attribute name="queryid" type="auditQueryId.datatype"
8565	                   use="required"/>
8566	     <xs:attribute name="statelist" type="auditStateList.datatype"
8567	                   use="optional"/>
8568	    </xs:extension>
8569	   </xs:complexContent>
8570	  </xs:complexType>
8571	 </xs:element>
8572	 <xs:element name="auditresult" substitutionGroup="msmlResultComplex">
8573	  <xs:complexType>
8574	   <xs:complexContent>
8575	    <xs:extension base="msmlResultComplexType">
8576	     <xs:choice>
8577	      <xs:element ref="stateParameter" maxOccurs="unbounded"/>

8579	Internet-draft       Media Server Markup Language        February 2008
8580	                                 (MSML)

8582	      <xs:element ref="stateParameterSimple" maxOccurs="unbounded"/>
8583	     </xs:choice>
8584	     <xs:attribute name="targetid" type="independentID.datatype"
8585	                   use="required"/>
8586	    </xs:extension>
8587	   </xs:complexContent>
8588	  </xs:complexType>
8589	 </xs:element>
8590	 <xs:element name="stateParameter" type="stateParameterType"
8591	             abstract="true"/>
8592	 <xs:element name="stateParameterSimple" type="stateParameterSimpleType"
8593	             abstract="true"/>
8594	 <xs:complexType name="stateParameterType"/>
8595	 <xs:simpleType name="stateParameterSimpleType">
8596	  <xs:restriction base="xs:string"/>
8597	 </xs:simpleType>
8598	 <xs:simpleType name="auditQueryId.datatype">
8599	  <xs:restriction base="xs:string">
8600	   <xs:pattern value="conf:[a-zA-Z0-9.:\-_]+"/>
8601	   <xs:pattern value="conn:[a-zA-Z0-9.:\-_]+"/>
8602	   <xs:pattern value="conf:\*"/>
8603	   <xs:pattern value="conn:\*"/>
8604	  </xs:restriction>
8605	 </xs:simpleType>
8606	 <xs:simpleType name="auditStateList.datatype">
8607	  <xs:restriction base="xs:string"/>
8608	 </xs:simpleType>
8609	</xs:schema>

8611	18.4.3     msml-audit-conf.xsd

8613	<?xml version="1.0" encoding="UTF-8"?>
8614	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8615	           elementFormDefault="qualified"
8616	           attributeFormDefault="unqualified">
8617	 <xs:include schemaLocation="msml-core.xsd"/>
8618	 <xs:include schemaLocation="msml-core-datatypes.xsd"/>
8619	 <xs:include schemaLocation="msml-audit-core-datatypes.xsd"/>
8620	 <xs:include schemaLocation="msml-audit-dialog-datatypes.xsd"/>
8621	 <xs:include schemaLocation="msml-audit-stream-datatypes.xsd"/>
8622	 <xs:include schemaLocation="msml-audit-conf-datatypes.xsd"/>
8623	</xs:schema>

8625	18.4.4     msml-audit-conf-datatypes.xsd

8627	<?xml version="1.0" encoding="UTF-8"?>
8628	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8629	           elementFormDefault="qualified"

8631	Internet-draft       Media Server Markup Language        February 2008
8632	                                 (MSML)

8634	           attributeFormDefault="unqualified">
8635	 <xs:include schemaLocation="msml-conf-core-datatypes.xsd"/>
8636	 <xs:include schemaLocation="msml-audit-core-datatypes.xsd"/>
8637	 <xs:element name="confconfig" substitutionGroup="stateParameter">
8638	  <xs:complexType>
8639	   <xs:complexContent>
8640	    <xs:extension base="stateParameterType">
8641	     <xs:sequence>
8642	      <xs:element name="audiomix" type="audioMixType" minOccurs="0"
8643	                  maxOccurs="unbounded"/>
8644	      <xs:element name="videolayout" type="videoLayoutType"
8645	                  minOccurs="0" maxOccurs="unbounded"/>
8646	      <xs:element name="controller" type="connID.datatype"
8647	                  minOccurs="0"/>
8648	     </xs:sequence>
8649	     <xs:attribute name="deletewhen" use="optional" default="never">
8650	      <xs:simpleType>
8651	       <xs:restriction base="xs:string">
8652	        <xs:enumeration value="nomedia"/>
8653	        <xs:enumeration value="nocontrol"/>
8654	        <xs:enumeration value="never"/>
8655	       </xs:restriction>
8656	      </xs:simpleType>
8657	     </xs:attribute>
8658	     <xs:attribute name="term" type="boolean.datatype" use="optional"
8659	                   default="true"/>
8660	    </xs:extension>
8661	   </xs:complexContent>
8662	  </xs:complexType>
8663	 </xs:element>
8664	</xs:schema>

8666	18.4.5     msml-audit-conn.xsd

8668	<?xml version="1.0" encoding="UTF-8"?>
8669	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8670	           elementFormDefault="qualified"
8671	           attributeFormDefault="unqualified">
8672	 <xs:include schemaLocation="msml-core.xsd"/>
8673	 <xs:include schemaLocation="msml-audit-core-datatypes.xsd"/>
8674	 <xs:include schemaLocation="msml-audit-dialog-datatypes.xsd"/>
8675	 <xs:include schemaLocation="msml-audit-stream-datatypes.xsd"/>
8676	 <xs:include schemaLocation="msml-audit-conn-datatypes.xsd"/>
8677	</xs:schema>

8679	18.4.6     msml-audit-conn-datatypes.xsd

8681	<?xml version="1.0" encoding="UTF-8"?>
8682	Internet-draft       Media Server Markup Language        February 2008
8683	                                 (MSML)

8685	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8686	           elementFormDefault="qualified"
8687	           attributeFormDefault="unqualified">
8688	 <xs:include schemaLocation="msml-audit-core-datatypes.xsd"/>
8689	 <xs:element name="sipdialog" substitutionGroup="stateParameter">
8690	  <xs:complexType>
8691	   <xs:complexContent>
8692	    <xs:extension base="stateParameterType">
8693	     <xs:sequence>
8694	      <xs:element name="localseq" type="xs:integer" minOccurs="0"/>
8695	      <xs:element name="remoteseq" type="xs:int" minOccurs="0"/>
8696	      <xs:element name="localuri" type="xs:string" minOccurs="0"/>
8697	      <xs:element name="remoteuri" type="xs:string" minOccurs="0"/>
8698	      <xs:element name="remotetaget" type="xs:string" minOccurs="0"/>
8699	      <xs:element name="routeset" type="xs:string" minOccurs="0"/>
8700	     </xs:sequence>
8701	     <xs:attribute name="callid" type="xs:string" use="required"/>
8702	     <xs:attribute name="localtag" type="xs:string" use="required"/>
8703	     <xs:attribute name="remotetag" type="xs:string" use="required"/>
8704	    </xs:extension>
8705	   </xs:complexContent>
8706	  </xs:complexType>
8707	 </xs:element>
8708	 <xs:element name="localsdp" type="stateParameterSimpleType"
8709	             substitutionGroup="stateParameterSimple"/>
8710	 <xs:element name="remotesdp" type="stateParameterSimpleType"
8711	             substitutionGroup="stateParameterSimple"/>
8712	</xs:schema>

8714	18.4.7     msml-audit-dialog-datatypes.xsd

8716	   Audit Dialog functionality requires use of either Audit Conf package
8717	   or the Audit Conn package.

8719	<?xml version="1.0" encoding="UTF-8"?>
8720	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8721	           elementFormDefault="qualified"
8722	           attributeFormDefault="unqualified">
8723	 <xs:include schemaLocation="msml-audit-core-datatypes.xsd"/>
8724	 <xs:element name="dialog" substitutionGroup="stateParameter">
8725	  <xs:complexType>
8726	   <xs:complexContent>
8727	    <xs:extension base="stateParameterType">
8728	     <xs:sequence>
8729	      <xs:element name="duration" type="xs:positiveInteger"
8730	                  minOccurs="0"/>
8731	      <xs:element name="primitive" minOccurs="0">
8732	       <xs:simpleType>

8734	Internet-draft       Media Server Markup Language        February 2008
8735	                                 (MSML)

8737	        <xs:restriction base="xs:string">
8738	         <xs:pattern value="play"/>
8739	         <xs:pattern value="dtmf"/>
8740	         <xs:pattern value="collect"/>
8741	         <xs:pattern value="dtmfgen"/>
8742	         <xs:pattern value="tonegen"/>
8743	         <xs:pattern value="record"/>
8744	         <xs:pattern value="none"/>
8745	        </xs:restriction>
8746	       </xs:simpleType>
8747	      </xs:element>
8748	      <xs:element name="controller" type="connID.datatype"
8749	                  minOccurs="0"/>
8750	     </xs:sequence>
8751	     <xs:attribute name="name" type="msmlInstanceID.datatype"
8752	                   use="required"/>
8753	     <xs:attribute name="src" type="xs:anyURI" use="optional"/>
8754	     <xs:attribute name="type" type="dialogLanguage.datatype"
8755	                   use="required"/>
8756	    </xs:extension>
8757	   </xs:complexContent>
8758	  </xs:complexType>
8759	 </xs:element>
8760	</xs:schema>

8762	18.4.8     msml-audit-stream-datatypes.xsd

8764	   Audit Stream functionality requires use of either Audit Conf package
8765	   or the Audit Conn package.

8767	<?xml version="1.0" encoding="UTF-8"?>
8768	<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
8769	           elementFormDefault="qualified"
8770	           attributeFormDefault="unqualified">
8771	 <xs:include schemaLocation="msml-audit-core-datatypes.xsd"/>
8772	 <xs:element name="stream" substitutionGroup="stateParameter">
8773	  <xs:complexType>
8774	   <xs:complexContent>
8775	    <xs:extension base="stateParameterType">
8776	     <xs:all>
8777	      <xs:element name="clamp" minOccurs="0">
8778	       <xs:complexType>
8779	        <xs:attribute name="dtmf" type="boolean.datatype"/>
8780	        <xs:attribute name="tones" type="boolean.datatype"/>
8781	       </xs:complexType>
8782	      </xs:element>
8783	      <xs:element name="gain" minOccurs="0">
8784	       <xs:complexType>

8786	Internet-draft       Media Server Markup Language        February 2008
8787	                                 (MSML)

8789	        <xs:attribute name="amt" use="optional">
8790	         <xs:simpleType>
8791	          <xs:restriction base="xs:integer">
8792	           <xs:minInclusive value="-96"/>
8793	           <xs:maxInclusive value="96"/>
8794	          </xs:restriction>
8795	         </xs:simpleType>
8796	        </xs:attribute>
8797	        <xs:attribute name="agc" type="boolean.datatype"/>
8798	        <xs:attribute name="tgtlvl" use="optional">
8799	         <xs:simpleType>
8800	          <xs:restriction base="xs:nonPositiveInteger">
8801	           <xs:minInclusive value="-40"/>
8802	           <xs:maxInclusive value="0"/>
8803	          </xs:restriction>
8804	         </xs:simpleType>
8805	        </xs:attribute>
8806	        <xs:attribute name="maxgain" default="10">
8807	         <xs:simpleType>
8808	          <xs:restriction base="xs:nonNegativeInteger">
8809	           <xs:minInclusive value="0"/>
8810	           <xs:maxInclusive value="40"/>
8811	          </xs:restriction>
8812	         </xs:simpleType>
8813	        </xs:attribute>
8814	       </xs:complexType>
8815	      </xs:element>
8816	      <xs:element name="visual" minOccurs="0"/>
8817	     </xs:all>
8818	     <xs:attribute name="joinwith" type="independentID.datatype"
8819	                   use="required"/>
8820	     <xs:attribute name="media" use="required">
8821	      <xs:simpleType>
8822	       <xs:restriction base="xs:string">
8823	        <xs:pattern value="audio"/>
8824	        <xs:pattern value="video"/>
8825	       </xs:restriction>
8826	      </xs:simpleType>
8827	     </xs:attribute>
8828	     <xs:attribute name="dir" use="required">
8829	      <xs:simpleType>
8830	       <xs:restriction base="xs:string">
8831	        <xs:pattern value="from"/>
8832	        <xs:pattern value="to"/>
8833	       </xs:restriction>
8834	      </xs:simpleType>
8835	     </xs:attribute>
8836	     <xs:attribute name="compressed" type="boolean.datatype"/>

8838	Internet-draft       Media Server Markup Language        February 2008
8839	                                 (MSML)

8841	     <xs:attribute name="preferred" type="boolean.datatype"
8842	                   default="false"/>
8843	     <xs:attribute name="display" type="xs:string"/>
8844	     <xs:attribute name="override" type="boolean.datatype"
8845	                   default="false"/>
8846	    </xs:extension>
8847	   </xs:complexContent>
8848	  </xs:complexType>
8849	 </xs:element>
8850	</xs:schema>

8852	19.   Security Considerations

8854	   MSML is invoked through other languages and protocols and as such
8855	   security considerations depend on those environments.

8857	   MSML being an XML based language, security considerations as defined
8858	   by RFC 3023 [i2] are applicable.

8860	20.   IANA Considerations

8862	20.1    IANA registrations for 'application' MIME Media Type

8864	   The following registrations are planned:

8866	      'application/msml+xml',

8868	      'application/moml+xml'

8870	      'application/msml-conf+xml',

8872	      'application/msml-dialog+xml',

8874	      'application/msml-dialog-base+xml',

8876	      'application/msml-dialog-group+xml',

8878	      'application/msml-dialog-speech+xml',

8880	      'application/msml-dialog-transform+xml',

8882	      'application/msml-dialog-fax-detect+xml',

8884	      'application/msml-dialog-fax-sendrecv+xml',

8886	      'application/msml-audit+xml',

8888	      'application/msml-audit-conf+xml',

8890	Internet-draft       Media Server Markup Language        February 2008
8891	                                 (MSML)

8893	      'application/msml-audit-conn+xml',

8895	      'application/msml-audit-dialog+xml',

8897	      'application/msml-audit-stream+xml'

8899	      Required parameters: none

8901	      Optional parameters: charset

8903	               charset semantics as specified in RFC 3023 [i2] for
8904	               "application/xml" media type.

8906	      Encoding considerations: As specified in RFC 3023 [i2].

8908	      Interoperability considerations: As specified in RFC 3023 [i2] and
8909	      as specified within this document.

8911	      Intended applications for these media types: Multimedia
8912	      Conferencing, Interactive Voice Response systems

8914	      Intended usage: COMMON

8916	20.2    IANA registrations for 'text' MIME Media Type

8918	   The following registrations are planned:

8920	      'text/msml-basic-layout'

8922	      Required parameters: none

8924	      Optional parameters: charset

8926	          charset semantics as specified in RFC 3023 [i2] for "text/xml"
8927	          media type.

8929	      Encoding considerations: As specified in RFC 3023 [i2].

8931	      Interoperability considerations: As specified in RFC 3023 [i2] and
8932	      as specified within this document.

8934	      Intended applications for these media types: Multimedia
8935	      Conferencing, Interactive Voice Response systems

8937	Internet-draft       Media Server Markup Language        February 2008
8938	                                 (MSML)

8940	      Intended usage: COMMON

8942	20.3    URN Sub-Namespace Registration

8944	   The namespace URI for elements defined within this specification is a
8945	   URN [i10]. It uses the namespace identifier 'ietf' defined by [i11]
8946	   and extended by RFC 3688 [i12].

8948	   The following registrations of URN Sub-Namespaces are planned:

8950	     XML namespace: urn:ietf:params:xml:ns:msml

8952	     XML namespace: urn:ietf:params:xml:ns:moml

8954	20.4    XML Schema Registration

8956	   The XML schema associated with the MSML specification, is planned for
8957	   registration as per the guidelines in RFC 3688 [i12].

8959	21.   Normative References

8961	   [n1] J. Rosenberg, H. Schulzrinne, G. Camarillo, A. Johnston, J.
8962	   Peterson, R. Sparks, M. Handley, and E. Schooler, "SIP: Session
8963	   Initiation Protocol", RFC3261, Internet Engineering Task Force, June
8964	   2002.

8966	   [n2] Bray, T., Paoli, J., Sperberg-McQueen, C., and E. Maler,
8967	   "Extensible Markup Language (XML) 1.0 (Second Edition)," W3C
8968	   FirstEdition REC-xml-20001006, October 2000.

8970	   [n3] World Wide Web Consortium, "Speech Recognition Grammar
8971	   Specification Version 1.0" (SRGS), W3C Candidate Recommendation,
8972	   March 16, 2004

8974	   [n4] World Wide Web Consortium, "Natural Language Semantics Markup
8975	   Language (NLSML) for the Speech Interface Framework", W3C Working
8976	   Draft 20, November 2000.

8978	   [n5] World Wide Web Consortium, "Voice Extensible Markup Language
8979	   (VoiceXML) Version 2.0, W3C Candidate Recommendation, March 16, 2004

8981	   [n6] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
8982	   Resource Identifiers (URI): Generic Syntax," RFC 2396, Internet
8983	   Engineering Task Force, August 1998.

8985	   [n7] E. Burger, J. Van Dyke, A. Spitzer, "Basic Network Media
8986	   Services with SIP", RFC 4240, Internet Engineering Task Force,
8987	   December 2005

8989	Internet-draft       Media Server Markup Language        February 2008
8990	                                 (MSML)

8992	   [n8] E. Levinson, "Content-ID and Message-ID Uniform Resource
8993	   Locators", RFC 2392, Internet Engineering Task Force, August 1998.

8995	   [n9] Handley, M. and V. Jacobson, "SDP: Session Description
8996	   Protocol," RFC 2327, Internet Engineering Task Force, April 1998.

8998	   [n10] Bos, B., Lie, H., Tantek, C., and Hickson, I., "Cascading Style
8999	   Sheets, level 2 (CSS2) Specification," W3C REC CR-CSS21-, July 2007.

9001	   [n11] Burnett, D., Walker, M., and Hunt, A., "Speech Synthesis Markup
9002	   Language (SSML) Version 1.0", W3C Recommendation, 7 September 2004.

9004	22.   Informative References

9006	   [i1] J. Rosenberg, H. Schulzrinne, and P. Kyzivat, "Indicating User
9007	   Agent Capabilities in the Session Initiation Protocol (SIP)", RFC
9008	   3840, Internet Engineering Task Force, August 2004

9010	   [i2] M. Murata, S. St.Laurent, and D. Kohn, "XML Media Types," RFC
9011	   3023, Internet Engineering Task Force, January 2001.

9013	   [i3] Schulzrinne, H., Casner, S., Frederick, R., and V. Jacobson,
9014	   "RTP Profile for Audio and Video Conferences with Minimal Control,"
9015	   RFC 3550, Internet Engineering Task Force, July 2003.

9017	   [i4] Rosenberg, J., Peterson, J., Schulzrinne, H., and G. Camarillo,
9018	   "Best Current Practices for Third Party Call Control (3pcc) in the
9019	   Session Initiation Protocol (SIP)," RFC 3725, April 2004.

9021	   [i5] Donovan, S., "The SIP INFO Method," RFC 2976, Internet
9022	   Engineering Task Force, October 2000.

9024	   [i6] Ossenbruggen, J., Rutledge, L., Saccocio, B., Schmitz, P., Kate,
9025	   W., Ayars, J., Bulterman, D., Cohen, A., Day, K., Hodge, E., Hoschka,
9026	   P., Hyche, E., Jourdan, M., Kubota, K., Lanphier, R., Laya'da, N.,
9027	   Michel, T., and D. Newman, "Synchronized Multimedia Integration
9028	   Language (SMIL 2.0) Specification," W3C REC REC-smil2-20050107,
9029	   January 2005.

9031	   [i7] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
9032	   Extensions (MIME) Part Two: Media Types," RFC 2046, November 1996.

9034	   [i8] Saleem, A. and Sharratt, G., "Media Sessions Markup Language"
9035	   Internet Draft (draft-melanchuk-sipping-msml-06), October 21, 2005.

9037	   [i9] Saleem, A. and Sharratt, G., "Media Objects Markup Language"
9038	   Internet Draft (draft-melanchuk-sipping-moml-06), October 21, 2005.

9040	Internet-draft       Media Server Markup Language        February 2008
9041	                                 (MSML)

9043	   [i10] Moats, R., "URN Syntax", RFC 2141, Internet Engineering Task
9044	   Force, May 1997.

9046	   [i11] Moats, R., "A URN Namespace for IETF Documents", RFC 2648,
9047	   Internet Engineering Task Force, August 1999.

9049	   [i12] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
9050	   Internet Engineering Task Force, January 2004.

9052	   [i13] Boulton, C., "A Control Framework for the Session Initiation
9053	   Protocol (SIP)", Internet Engineering Task Force, draft-boulton-sip-
9054	   control-framework-05 (work in Progress, February 2007.

9056	   [i14] S. Bradner, "Key words for use in RFCs to Indicate Requirement
9057	   Levels," RFC 2119, Internet Engineering Taskforce, March 1997.

9059	Acknowledgments

9061	   Sergiu Stambolian of Radisys provided key insights, both theoretic
9062	   and through development experience, on several versions of the
9063	   drafts.

9065	   Stephen Buko and George Raskulinec of Intel made numerous valuable
9066	   contributions towards enhancements of multimedia playback and record
9067	   operations. Gene Shtirmer of Intel provided review feedback on
9068	   several revisions and feature enhancement suggestions.

9070	   David Asher of NMS Communications provided valuable insights towards
9071	   creation of standard profiles and a modularization scheme based on
9072	   packages for better interoperability.

9074	   Gilles Compienne of Ubiquity Software has provided feedback on
9075	   several earlier versions of this draft.

9077	   Chris Boulton and Ben Smith, both of Ubiquity, and Michael Rice of
9078	   VocalData helped clarify several issues, while Bruce Walsh and Kevin
9079	   Fitzgerald, both of Spectel/Avaya, provided important feedback. Cliff
9080	   Schornak of Commetrex significantly contributed to the facsimile
9081	   work. Peter Danielsen of Lucent has contributed thoughtful and
9082	   detailed reviews for several earlier versions of the draft.

9084	Authors' Addresses

9086	   Adnan Saleem
9087	     Radisys
9088	     4190 Still Creek Drive, Suite 300
9089	     Vancouver, BC, V5C 6C6
9090	     Canada

9092	Internet-draft       Media Server Markup Language        February 2008
9093	                                 (MSML)

9095	     Phone: +1 604 918 6376
9096	     Email: adnan.saleem@RadiSys.com

9098	   Yong Xin
9099	     Radisys
9100	     4190 Still Creek Drive, Suite 300
9101	     Vancouver, BC, V5C 6C6
9102	     Canada

9104	     Phone: +1 604 918 6383
9105	     Email: yong.xin@RadiSys.com

9107	   Garland Sharratt

9109	     Email: gsharratt@myprivacy.ca

9111	Intellectual Property Statement

9113	   The IETF takes no position regarding the validity or scope of any
9114	   Intellectual Property Rights or other rights that might be claimed to
9115	   pertain to the implementation or use of the technology described in
9116	   this document or the extent to which any license under such rights
9117	   might or might not be available; nor does it represent that it has
9118	   made any independent effort to identify any such rights. Information
9119	   on the procedures with respect to rights in RFC documents can be
9120	   found in BCP 78 and BCP 79.

9122	   Copies of IPR disclosures made to the IETF Secretariat and any
9123	   assurances of licenses to be made available, or the result of an
9124	   attempt made to obtain a general license or permission for the use of
9125	   such proprietary rights by implementers or users of this
9126	   specification can be obtained from the IETF on-line IPR repository at
9127	   http://www.ietf.org/ipr.

9129	   The IETF invites any interested party to bring to its attention any
9130	   copyrights, patents or patent applications, or other proprietary
9131	   rights that may cover technology that may be required to implement
9132	   this standard. Please address the information to the IETF at ietf-
9133	   ipr@ietf.org

9135	Full Copyright Statement

9137	   Copyright (C) The IETF Trust(2008).

9139	Internet-draft       Media Server Markup Language        February 2008
9140	                                 (MSML)

9142	   This document is subject to the rights, licenses and restrictions
9143	   contained in BCP 78, and except as set forth therein, the authors
9144	   retain all their rights

9146	Disclaimer of Validity

9148	   This document and the information contained herein are provided on an
9149	   "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
9150	   OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
9151	   THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
9152	   OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
9153	   THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
9154	   WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

9156	Acknowledgement

9158	   Funding for the RFC Editor function is provided by the IETF Internet
9159	   Administrative Support Activity (IASA).