draft-ietf-mediactrl-mixer-control-package-02.txt   draft-ietf-mediactrl-mixer-control-package-03.txt 
Network Working Group T. Melanchuk Network Working Group S. McGlashan
Internet-Draft Rain Willow Communications Internet-Draft Hewlett-Packard
Intended status: Standards Track S. McGlashan Intended status: Standards Track T. Melanchuk
Expires: May 7, 2009 Hewlett-Packard Expires: June 1, 2009 Rain Willow Communications
C. Boulton C. Boulton
Avaya Avaya
November 3, 2008 November 28, 2008
A Mixer Control Package for the Media Control Channel Framework A Mixer Control Package for the Media Control Channel Framework
draft-ietf-mediactrl-mixer-control-package-02 draft-ietf-mediactrl-mixer-control-package-03
Status of this Memo Status of this Memo
By submitting this Internet-Draft, each author represents that any By submitting this Internet-Draft, each author represents that any
applicable patent or other IPR claims of which he or she is aware applicable patent or other IPR claims of which he or she is aware
have been or will be disclosed, and any of which he or she becomes have been or will be disclosed, and any of which he or she becomes
aware will be disclosed, in accordance with Section 6 of BCP 79. aware will be disclosed, in accordance with Section 6 of BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that Task Force (IETF), its areas, and its working groups. Note that
skipping to change at page 1, line 37 skipping to change at page 1, line 37
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt. http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html. http://www.ietf.org/shadow.html.
This Internet-Draft will expire on May 7, 2009. This Internet-Draft will expire on June 1, 2009.
Abstract Abstract
This document defines a Mixer Control Package for the Media Control This document defines a Media Control Channel Framework Package for
Channel Framework. This Control Package aims to fulfill Conferencing managing mixers for media conferences and connections. The package
requirements using the SIP Control Framework. defines request elements for managing conference mixers, managing
mixers between conferences and/or connections, as well as associated
responses and notifications. The package also defines elements for
auditing package capabilities and mixers.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Conventions and Terminology . . . . . . . . . . . . . . . . . 5 2. Conventions and Terminology . . . . . . . . . . . . . . . . . 6
3. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 3. Control Package Definition . . . . . . . . . . . . . . . . . . 7
4. Control Package Definition . . . . . . . . . . . . . . . . . . 8 3.1. Control Package Name . . . . . . . . . . . . . . . . . . . 7
4.1. Control Package Name . . . . . . . . . . . . . . . . . . . 8 3.2. Framework Message Usage . . . . . . . . . . . . . . . . . 7
4.2. Framework Message Usage . . . . . . . . . . . . . . . . . 8 3.3. Common XML Support . . . . . . . . . . . . . . . . . . . . 8
4.3. Common XML Support . . . . . . . . . . . . . . . . . . . . 9 3.4. CONTROL Message Body . . . . . . . . . . . . . . . . . . . 8
4.4. CONTROL Message Body . . . . . . . . . . . . . . . . . . . 9 3.5. REPORT Message Body . . . . . . . . . . . . . . . . . . . 8
4.5. REPORT Message Body . . . . . . . . . . . . . . . . . . . 9 3.6. Audit . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.6. Audit . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.7. Examples . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.7. Examples . . . . . . . . . . . . . . . . . . . . . . . . . 10 4. Element Definitions . . . . . . . . . . . . . . . . . . . . . 10
5. Element Definitions . . . . . . . . . . . . . . . . . . . . . 11 4.1. <mscmixer> . . . . . . . . . . . . . . . . . . . . . . . . 10
5.1. <mscmixer> . . . . . . . . . . . . . . . . . . . . . . . . 11 4.2. Mixer Elements . . . . . . . . . . . . . . . . . . . . . . 11
5.2. Mixer Elements . . . . . . . . . . . . . . . . . . . . . . 12 4.2.1. Conference Elements . . . . . . . . . . . . . . . . . 12
5.2.1. Conference Elements . . . . . . . . . . . . . . . . . 13 4.2.1.1. <createconference> . . . . . . . . . . . . . . . . 12
5.2.1.1. <createconference> . . . . . . . . . . . . . . . . 13 4.2.1.2. <modifyconference> . . . . . . . . . . . . . . . . 15
5.2.1.2. <modifyconference> . . . . . . . . . . . . . . . . 16 4.2.1.3. <destroyconference> . . . . . . . . . . . . . . . 16
5.2.1.3. <destroyconference> . . . . . . . . . . . . . . . 17 4.2.1.4. Conference Configuration . . . . . . . . . . . . . 16
5.2.1.4. Conference Configuration . . . . . . . . . . . . . 17 4.2.1.4.1. <audio-mixing> . . . . . . . . . . . . . . . . 17
5.2.1.4.1. <audio-mixing> . . . . . . . . . . . . . . . . 18 4.2.1.4.2. <video-layouts> . . . . . . . . . . . . . . . 17
5.2.1.4.2. <video-layouts> . . . . . . . . . . . . . . . 18 4.2.1.4.2.1. <video-layout> . . . . . . . . . . . . . . 19
5.2.1.4.2.1. <video-layout> . . . . . . . . . . . . . . 19 4.2.1.4.3. <video-switch> . . . . . . . . . . . . . . . . 24
5.2.1.4.3. <video-switch> . . . . . . . . . . . . . . . . 24 4.2.1.4.3.1. Priority assignment . . . . . . . . . . . 26
5.2.1.4.3.1. Priority assignment . . . . . . . . . . . 26 4.2.1.4.4. <subscribe> . . . . . . . . . . . . . . . . . 27
5.2.1.4.4. <subscribe> . . . . . . . . . . . . . . . . . 27 4.2.1.4.4.1. <active-talkers-sub> . . . . . . . . . . . 27
5.2.1.4.4.1. <active-talkers-sub> . . . . . . . . . . . 27 4.2.2. Joining Elements . . . . . . . . . . . . . . . . . . . 27
5.2.2. Joining Elements . . . . . . . . . . . . . . . . . . . 27 4.2.2.1. Joining Model . . . . . . . . . . . . . . . . . . 27
5.2.2.1. Joining Model . . . . . . . . . . . . . . . . . . 27 4.2.2.2. <join> . . . . . . . . . . . . . . . . . . . . . . 29
5.2.2.2. <join> . . . . . . . . . . . . . . . . . . . . . . 29 4.2.2.3. <modifyjoin> . . . . . . . . . . . . . . . . . . . 31
5.2.2.3. <modifyjoin> . . . . . . . . . . . . . . . . . . . 31 4.2.2.4. <unjoin> . . . . . . . . . . . . . . . . . . . . . 33
5.2.2.4. <unjoin> . . . . . . . . . . . . . . . . . . . . . 32 4.2.2.5. <stream> . . . . . . . . . . . . . . . . . . . . . 34
5.2.2.5. <stream> . . . . . . . . . . . . . . . . . . . . . 33 4.2.2.5.1. <volume> . . . . . . . . . . . . . . . . . . . 36
5.2.2.5.1. <volume> . . . . . . . . . . . . . . . . . . . 34 4.2.2.5.2. <clamp> . . . . . . . . . . . . . . . . . . . 36
5.2.2.5.2. <clamp> . . . . . . . . . . . . . . . . . . . 34 4.2.2.5.3. <region> . . . . . . . . . . . . . . . . . . . 36
5.2.2.5.3. <region> . . . . . . . . . . . . . . . . . . . 35 4.2.2.5.4. <priority> . . . . . . . . . . . . . . . . . . 36
5.2.2.5.4. <priority> . . . . . . . . . . . . . . . . . . 35 4.2.3. <response> . . . . . . . . . . . . . . . . . . . . . . 37
5.2.3. <response> . . . . . . . . . . . . . . . . . . . . . . 35 4.2.4. <event> . . . . . . . . . . . . . . . . . . . . . . . 37
5.2.4. <event> . . . . . . . . . . . . . . . . . . . . . . . 36 4.2.4.1. <active-talkers-notify> . . . . . . . . . . . . . 38
5.2.4.1. <active-talkers-notify> . . . . . . . . . . . . . 36 4.2.4.1.1. <active-talker> . . . . . . . . . . . . . . . 38
5.2.4.1.1. <active-talker> . . . . . . . . . . . . . . . 36 4.2.4.2. <unjoin-notify> . . . . . . . . . . . . . . . . . 38
5.2.4.2. <unjoin-notify> . . . . . . . . . . . . . . . . . 37 4.2.4.3. <conferenceexit> . . . . . . . . . . . . . . . . . 40
5.2.4.3. <conferenceexit> . . . . . . . . . . . . . . . . . 37 4.3. Audit Elements . . . . . . . . . . . . . . . . . . . . . . 41
5.3. Audit Elements . . . . . . . . . . . . . . . . . . . . . . 38 4.3.1. <audit> . . . . . . . . . . . . . . . . . . . . . . . 41
5.3.1. <audit> . . . . . . . . . . . . . . . . . . . . . . . 39 4.3.2. <auditresponse> . . . . . . . . . . . . . . . . . . . 43
5.3.2. <auditresponse> . . . . . . . . . . . . . . . . . . . 40 4.3.2.1. <capabilities> . . . . . . . . . . . . . . . . . . 44
5.3.2.1. <capabilities> . . . . . . . . . . . . . . . . . . 41 4.3.2.2. <mixers> . . . . . . . . . . . . . . . . . . . . . 45
5.3.2.2. <mixers> . . . . . . . . . . . . . . . . . . . . . 42 4.3.2.2.1. <conferenceaudit> . . . . . . . . . . . . . . 45
5.3.2.2.1. <conferenceaudit> . . . . . . . . . . . . . . 42 4.3.2.2.1.1. <participants> . . . . . . . . . . . . . . 46
5.3.2.2.1.1. <participants> . . . . . . . . . . . . . . 43 4.3.2.2.1.1.1. <participant> . . . . . . . . . . . . 46
5.3.2.2.1.1.1. <participant> . . . . . . . . . . . . 44 4.3.2.2.2. <joinaudit> . . . . . . . . . . . . . . . . . 47
5.3.2.2.2. <joinaudit> . . . . . . . . . . . . . . . . . 44 4.4. <codecs> . . . . . . . . . . . . . . . . . . . . . . . . . 47
5.4. <codecs> . . . . . . . . . . . . . . . . . . . . . . . . . 44 4.4.1. <codec> . . . . . . . . . . . . . . . . . . . . . . . 48
5.4.1. <codec> . . . . . . . . . . . . . . . . . . . . . . . 45 4.5. <params> . . . . . . . . . . . . . . . . . . . . . . . . . 48
5.5. <params> . . . . . . . . . . . . . . . . . . . . . . . . . 46 4.5.1. <param> . . . . . . . . . . . . . . . . . . . . . . . 49
5.5.1. <param> . . . . . . . . . . . . . . . . . . . . . . . 46 4.6. Response Status Codes . . . . . . . . . . . . . . . . . . 49
5.6. Response Status Codes . . . . . . . . . . . . . . . . . . 46 4.7. Type Definitions . . . . . . . . . . . . . . . . . . . . . 55
5.7. Type Definitions . . . . . . . . . . . . . . . . . . . . . 51 5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 56
6. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 53 6. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
7. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 6.1. AS-MS Framework Interaction Examples . . . . . . . . . . . 75
7.1. AS-MS Framework Interaction Examples . . . . . . . . . . . 71 6.1.1. Creating a conference mixer and joining a
7.1.1. Creating a conference mixer and joining a participant . . . . . . . . . . . . . . . . . . . . . 75
participant . . . . . . . . . . . . . . . . . . . . . 71 6.1.2. Receiving active talker notifications . . . . . . . . 76
7.1.2. Receiving active talker notifications . . . . . . . . 72 6.1.3. Conference termination . . . . . . . . . . . . . . . . 76
7.1.3. Conference termination . . . . . . . . . . . . . . . . 72 6.2. Mixing Examples . . . . . . . . . . . . . . . . . . . . . 76
7.2. Mixing Examples . . . . . . . . . . . . . . . . . . . . . 72 6.2.1. Audio conferencing . . . . . . . . . . . . . . . . . . 77
7.2.1. Audio conferencing . . . . . . . . . . . . . . . . . . 73 6.2.2. Bridging connections . . . . . . . . . . . . . . . . . 79
7.2.2. Bridging connections . . . . . . . . . . . . . . . . . 75 6.2.3. Video conferencing . . . . . . . . . . . . . . . . . . 80
7.2.3. Video conferencing . . . . . . . . . . . . . . . . . . 76 7. Security Considerations . . . . . . . . . . . . . . . . . . . 82
8. Security Considerations . . . . . . . . . . . . . . . . . . . 78 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 85
9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 79 8.1. Control Package Registration . . . . . . . . . . . . . . . 85
9.1. Control Package Registration . . . . . . . . . . . . . . . 79 8.2. URN Sub-Namespace Registration . . . . . . . . . . . . . . 85
9.2. URN Sub-Namespace Registration . . . . . . . . . . . . . . 79 8.3. MIME Registration . . . . . . . . . . . . . . . . . . . . 85
9.3. MIME Registration . . . . . . . . . . . . . . . . . . . . 79 9. Change Summary . . . . . . . . . . . . . . . . . . . . . . . . 86
10. Change Summary . . . . . . . . . . . . . . . . . . . . . . . . 80 10. Contributors . . . . . . . . . . . . . . . . . . . . . . . . . 91
11. Contributors . . . . . . . . . . . . . . . . . . . . . . . . . 84 11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 92
12. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 85 12. References . . . . . . . . . . . . . . . . . . . . . . . . . . 93
13. References . . . . . . . . . . . . . . . . . . . . . . . . . . 86 12.1. Normative References . . . . . . . . . . . . . . . . . . . 93
13.1. Normative References . . . . . . . . . . . . . . . . . . . 86 12.2. Informative References . . . . . . . . . . . . . . . . . . 93
13.2. Informative References . . . . . . . . . . . . . . . . . . 86 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 95
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 88 Intellectual Property and Copyright Statements . . . . . . . . . . 96
Intellectual Property and Copyright Statements . . . . . . . . . . 89
1. Introduction 1. Introduction
This document defines a Media Control Channel Framework Package for The Media Control Channel Framework
conference mixers and connection mixers. The package defines mixer [I-D.ietf-mediactrl-sip-control-framework] provides a generic
management elements for creating, modifying and deleting conference approach for establishment and reporting capabilities of remotely
mixers, elements for joining, modifying and unjoining media streams initiated commands. The Framework utilizes many functions provided
between connections and conferences (including mixers between by the Session Initiation Protocol [RFC3261] (SIP) for the rendezvous
connections), as well as associated responses and notifications. The and establishment of a reliable channel for control interactions.
package also defines elements for auditing package capabilities and The Control Framework also introduces the concept of a Control
Package. A Control Package is an explicit usage of the Control
Framework for a particular interaction set. This specification
defines a package for media conference mixers and media connection
mixers. mixers.
This package defines mixer management elements for creating,
modifying and deleting conference mixers, elements for joining,
modifying and unjoining media streams between connections and
conferences (including mixers between connections), as well as
associated responses and notifications. The package also defines
elements for auditing package capabilities and mixers.
This package has been designed to satisfy media mixing requirements
documented in the Media Server Control Protocol Requirements document
([RFC5167]); more specifically REQ-MCP-22, REQ-MCP-23, REQ-MCP-24,
REQ-MCP-25, REQ-MCP-26 and REQ-MCP-27.
The package provides the major conferencing functionality of SIP
Media Server languages such as MSCML ([RFC5022]) and MSML ([MSML]).
A key differentiator is that this package provides such functionality
using the Media Control Channel Framework.
Out of scope for this mixer package are more advanced functions
including personalized video mixes for conference participants,
support for floor control protocols, as well as support for video
overlays and text insertion. Such functionality can be addressed by
extensions to this package (through addition of foreign elements or
attributes from another namespace) or use of other control packages
which could build upon this package.
The functionality of this package is defined by messages, containing
XML [XML] elements, transported using the Media Control Channel
Framework. The XML elements can be divided into two types: mixer
management elements; and elements for auditing package capabilities
as well as mixers managed by the package.
The document is organized as follows. Section 3 describes how this
control package fulfills the requirements for a Media Control Channel
Framework control package. Section 4 describes the syntax and
semantics of defined elements, including mixer management
(Section 4.2) and audit elements (Section 4.3). Section 5 describes
an XML schema for these elements and provides extensibility by
allowing attributes and elements from other namespaces. Section 6
provides examples of package usage. Section 7 describes important
security considerations for use of this control package. Section 8
provides information on IANA registration of this control package,
including its name, XML namespace and MIME media type.
2. Conventions and Terminology 2. Conventions and Terminology
In this document, BCP 14/RFC 2119 [RFC2119] defines the key words In this document, BCP 14/RFC 2119 [RFC2119] defines the key words
"MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
"SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL". In addition, BCP 15 indicates requirement levels for "OPTIONAL". In addition, BCP 15 indicates requirement levels for
compliant implementations. compliant implementations.
The following additional terms are defined for use in this document: The following additional terms are defined for use in this document:
Application server: A SIP [RFC3261] application server (AS) is a Application server: A SIP [RFC3261] application server (AS) is a
control client that hosts and executes services such as control client that hosts and executes services such as
interactive media and conferencing in an operator's network. An interactive media and conferencing in an operator's network. An
AS controls the media server (MS), influencing and impacting the AS controls the media server (MS), influencing and impacting the
SIP sessions terminating on a media server, which the AS may have SIP sessions terminating on a media server, which the AS can have
established for example using SIP third party call control. established for example using SIP third party call control.
Media Server: A media server (MS) processes media streams on behalf Media Server: A media server (MS) processes media streams on behalf
of an AS by offering functionality such as interactive media, of an AS by offering functionality such as interactive media,
conferencing, and transcoding to the end user. Interactive media conferencing, and transcoding to the end user. Interactive media
functionality is realized by way of dialogs, which are identified functionality is realized by way of dialogs, which are identified
by a URI and initiated by the application server. by a URI and initiated by the application server.
MS Conference: A MS Conference provides the media related mixing MS Conference: A MS Conference provides the media related mixing
resources and services for conferences. In this document, A MS resources and services for conferences. In this document, A MS
Conference is often referred to simply as a conference. Conference is often referred to simply as a conference.
MS Connection: A Media Server connection represents the termination MS Connection: A Media Server connection represents the termination
on a media server of one or more RTP [RFC3550] sessions that are on a media server of one or more RTP [RFC3550] sessions that are
associated to a single SIP dialog. A media server receives media associated to a single SIP dialog. A media server receives media
from the output(s) of a connection and it transmits media on the from the output(s) of a connection and it transmits media on the
input(s) of a connection. input(s) of a connection.
Media Stream: A media stream on a media server represents a media Media Stream: A media stream on a media server represents a media
flow between either a connection and a conference, between two flow between either a connection and a conference, between two
connections, or between two conferences. Streams may be audio or connections, or between two conferences. Streams can be audio or
video and may be bi-directional or uni-directional. video and can be bi-directional or uni-directional.
3. Overview
The SIP Control Framework [I-D.ietf-mediactrl-sip-control-framework]
provides a generic approach for establishment and reporting
capabilities of remotely initiated commands. The Framework utilizes
many functions provided by the Session Initiation Protocol [RFC3261]
(SIP) for the rendezvous and establishment of a reliable channel for
control interactions. The Control Framework also introduces the
concept of a Control Package. A Control Package is an explicit usage
of the Control Framework for a particular interaction set. This
specification defines a package for media conference mixers and media
connection mixers.
This package defines mixer management elements for creating,
modifying and deleting conference mixers, elements for joining,
modifying and unjoining media streams between connections and
conferences (including mixers between connections), as well as
associated responses and notifications. The package also defines
elements for auditing package capabilities and mixers.
This package has been designed to satisfy the IETF MediaCtrl
requirements ([RFC5167]). The package provides the major
conferencing functionality of SIP Media Server languages such as
MSCML ([RFC5022]) and MSML ([MSML]). A key differentiator is that
this package provides such functionality using the Media Control
Channel Framework.
Out of scope for this mixer package are more advanced functions
including personalized video mixes for conference participants,
support for floor control protocols, as well as support for video
overlays and text insertion. Such functionality may be addressed by
extensions to this package (through addition of foreign elements or
attributes from another namespace) or use of other control packages
which could build upon this package.
The functionality of this package is defined by messages, containing
XML [XML] elements, transported using the Media Control Channel
Framework. The XML elements can be divided into two types: mixer
management elements; and elements for auditing package capabilities
as well as mixers managed by the package.
The document is organized as follows. Section 4 describes how this
control package fulfills the requirements for a Media Control Channel
Framework control package. Section 5 describes the syntax and
semantics of defined elements, including mixer management
(Section 5.2) and audit elements (Section 5.3). Section 6 describes
an XML schema for these elements and provides extensibility by
allowing attributes and elements from other namespaces. Section 7
provides examples of package usage.
4. Control Package Definition 3. Control Package Definition
This section fulfills the mandatory requirement for information that This section fulfills the mandatory requirement for information that
MUST be specified during the definition of a Control Framework MUST be specified during the definition of a Control Framework
Package, as detailed in Section 8 of Package, as detailed in Section 8 of
[I-D.ietf-mediactrl-sip-control-framework]. [I-D.ietf-mediactrl-sip-control-framework].
4.1. Control Package Name 3.1. Control Package Name
The Control Framework requires a Control Package definition to The Control Framework requires a Control Package definition to
specify and register a unique name. The name and version of this specify and register a unique name. The name and version of this
Control Package is "msc-mixer/1.0" (Media Server Control - Mixer - Control Package is "msc-mixer/1.0" (Media Server Control - Mixer -
version 1.0). Its IANA registration is specified in Section 9.1. version 1.0). Its IANA registration is specified in Section 8.1.
Since this is the initial ("1.0") version of the control package, Since this is the initial ("1.0") version of the control package,
there are no backwards compatibility issues to address. there are no backwards compatibility issues to address.
4.2. Framework Message Usage 3.2. Framework Message Usage
The Control Framework requires a Control Package to explicitly detail The Control Framework requires a Control Package to explicitly detail
the control messages that can be used as well as provide an the control messages that can be used as well as provide an
indication of directionality between entities. This will include indication of directionality between entities. This will include
which role type is allowed to initiate a request type. which role type is allowed to initiate a request type.
This package specifies CONTROL and response messages in terms of XML This package specifies CONTROL and response messages in terms of XML
elements defined in Section 5, where the message bodies have the MIME elements defined in Section 4, where the message bodies have the MIME
media type defined in Section 9.3. These elements describe requests, media type defined in Section 8.3. These elements describe requests,
response and notifications and all are contained within a root response and notifications and all are contained within a root
<mscmixer> element (Section 5.1). <mscmixer> element (Section 4.1).
In this package, the MS operates as a Control Server in receiving In this package, the MS operates as a Control Server in receiving
requests from, and sending responses to, the AS (operating as Control requests from, and sending responses to, the AS (operating as Control
Client). Mixer management requests and responses are defined in Client). Mixer management requests and responses are defined in
Section 5.2. Audit requests and responses are defined in Section 4.2. Audit requests and responses are defined in
Section 5.3. Mixer management and audit responses are carried in a Section 4.3. Mixer management and audit responses are carried in a
framework 200 response or REPORT message bodies. This package's framework 200 response or REPORT message bodies. This package's
response codes are defined in Section 5.6. response codes are defined in Section 4.6.
Note that package responses are different from framework response Note that package responses are different from framework response
codes. Framework error response codes (see Section 8 of codes. Framework error response codes (see Section 8 of
[I-D.ietf-mediactrl-sip-control-framework]) are used when the request [I-D.ietf-mediactrl-sip-control-framework]) are used when the request
or event notification is invalid; for example, a request is invalid or event notification is invalid; for example, a request is invalid
XML (400), or not understood (500). XML (400), or not understood (500).
The MS also operates as a Control Client in sending event The MS also operates as a Control Client in sending event
notification to the AS (Control Server). Event notifications notification to the AS (Control Server). Event notifications
(Section 5.2.4) are carried in CONTROL message bodies. The AS MUST (Section 4.2.4) are carried in CONTROL message bodies. The AS MUST
respond with a Control Framework 200 response. respond with a Control Framework 200 response.
4.3. Common XML Support 3.3. Common XML Support
The Control Framework requires a Control Package definition to The Control Framework requires a Control Package definition to
specify if the attributes for media dialog or conference references specify if the attributes for media dialog or conference references
are required. are required.
This package requires that the XML Schema in Section 17.1 of This package requires that the XML Schema in Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework] MUST be supported for [I-D.ietf-mediactrl-sip-control-framework] MUST be supported for
media dialogs and conferences. media dialogs and conferences.
The package uses "connectionid" and "conferenceid" attributes for The package uses "connectionid" and "conferenceid" attributes for
various element definitions (Section 5). The XML schema (Section 6) various element definitions (Section 4). The XML schema (Section 5)
imports the definitions of these attributes from the framework imports the definitions of these attributes from the framework
schema. schema.
4.4. CONTROL Message Body 3.4. CONTROL Message Body
The Control Framework requires a Control Package to define the The Control Framework requires a Control Package to define the
control body that can be contained within a CONTROL command request control body that can be contained within a CONTROL command request
and to indicate the location of detailed syntax definitions and and to indicate the location of detailed syntax definitions and
semantics for the appropriate body types. semantics for the appropriate body types.
When operating as Control Server, the MS receives CONTROL messages When operating as Control Server, the MS receives CONTROL messages
with the MIME media type defined in Section 9.3 and a body containing with the MIME media type defined in Section 8.3 and a body containing
a <mscmixer> element (Section 5.1) with either a mixer management or a <mscmixer> element (Section 4.1) with either a mixer management or
audit request child element. audit request child element.
The following mixer management request elements are carried in The following mixer management request elements are carried in
CONTROL message bodies to MS: <createconference> (Section 5.2.1.1), CONTROL message bodies to MS: <createconference> (Section 4.2.1.1),
<modifyconference> (Section 5.2.1.2), <destroyconference> <modifyconference> (Section 4.2.1.2), <destroyconference>
(Section 5.2.1.3), <join> (Section 5.2.2.2), <modifyjoin> (Section 4.2.1.3), <join> (Section 4.2.2.2), <modifyjoin>
(Section 5.2.2.3) and <unjoin> (Section 5.2.2.4) elements. (Section 4.2.2.3) and <unjoin> (Section 4.2.2.4) elements.
The <audit> request element (Section 5.3.1) is also carried in The <audit> request element (Section 4.3.1) is also carried in
CONTROL message bodies. CONTROL message bodies.
When operating as Control Client, the MS sends CONTROL messages with When operating as Control Client, the MS sends CONTROL messages with
the MIME media type defined in Section 9.3 and a body containing a the MIME media type defined in Section 8.3 and a body containing a
<mscmixer> element (Section 5.1) with a notification <event> child <mscmixer> element (Section 4.1) with a notification <event> child
element (Section 5.2.4). element (Section 4.2.4).
4.5. REPORT Message Body 3.5. REPORT Message Body
The Control Framework requires a control package definition to define The Control Framework requires a control package definition to define
the REPORT body that can be contained within a REPORT command the REPORT body that can be contained within a REPORT command
request, or that no report package body is required. This section request, or that no report package body is required. This section
should indicate the location of detailed syntax definitions and indicates the location of detailed syntax definitions and semantics
semantics for the appropriate body types. for the appropriate body types.
When operating as Control Server, the MS sends REPORT bodies with the When operating as Control Server, the MS sends REPORT bodies with the
MIME media type defined in Section 9.3 and a <mscmixer> element with MIME media type defined in Section 8.3 and a <mscmixer> element with
a response child element. The response element for mixer management a response child element. The response element for mixer management
requests is a <response> element (Section 5.2.3). The response requests is a <response> element (Section 4.2.3). The response
element for an audit request is a <auditresponse> element element for an audit request is a <auditresponse> element
(Section 5.3.2). (Section 4.3.2).
4.6. Audit 3.6. Audit
The Control Framework encourages Control Packages to specify whether The Control Framework encourages Control Packages to specify whether
auditing is available, how it is triggered as well as the query/ auditing is available, how it is triggered as well as the query/
response formats. response formats.
This Control Packages supports auditing of package capabilities and This Control Packages supports auditing of package capabilities and
mixers on the MS. An audit request is carried in a CONTROL message mixers on the MS. An audit request is carried in a CONTROL message
and an audit response in a REPORT message (or a 200 response to the and an audit response in a REPORT message (or a 200 response to the
CONTROL if it can execute the audit in time). CONTROL if it can execute the audit in time).
The syntax and semantics of audit request and response elements is The syntax and semantics of audit request and response elements is
defined in Section 5.3. defined in Section 4.3.
4.7. Examples 3.7. Examples
The Control Framework recommends Control Packages to provide a range The Control Framework recommends Control Packages to provide a range
of message flows that represent common flows using the package and of message flows that represent common flows using the package and
this framework document. this framework document.
This Control Package provides examples of such message flows in This Control Package provides examples of such message flows in
Section 7. Section 6.
5. Element Definitions 4. Element Definitions
This section defines the XML elements for this package. The elements This section defines the XML elements for this package. The elements
are defined in the XML namespace specified in Section 9.2. are defined in the XML namespace specified in Section 8.2.
The root element is <mscmixer> (Section 5.1). All other XML elements The root element is <mscmixer> (Section 4.1). All other XML elements
(requests, responses and notification elements) are contained within (requests, responses and notification elements) are contained within
it. Child elements describe mixer management (Section 5.2) and audit it. Child elements describe mixer management (Section 4.2) and audit
(Section 5.3) functionality. Response status codes are defined in (Section 4.3) functionality. Response status codes are defined in
Section 5.6 and type definitions in Section 5.7. Section 4.6 and type definitions in Section 4.7.
Implementation of this control package MUST address the Security
Considerations described in Section 7 ).
Implementation of this control package MUST adhere to the syntax and Implementation of this control package MUST adhere to the syntax and
semantics of XML elements defined in this section and the schema semantics of XML elements defined in this section and the schema
(Section 6). The XML schema supports extensibility by allowing (Section 5). The XML schema supports extensibility by allowing
attributes and elements from other namespaces. Implementations MAY attributes and elements from other namespaces. Implementations MAY
support attributes and elements from other (foreign) namespaces. If support attributes and elements from other (foreign) namespaces. If
an MS implementation receives a <mscmixer> element containing an MS implementation receives a <mscmixer> element containing
attributes or elements from another namespace which it does not attributes or elements from another namespace which it does not
support, the MS MUST send a 428 response (Section 5.6). support, the MS sends a 428 response (Section 4.6).
Extensible attributes and elements are not described in this section. Extensible attributes and elements are not described in this section.
In all other cases where there is a difference in constraints between In all other cases where there is a difference in constraints between
the XML schema and the textual description of elements in this the XML schema and the textual description of elements in this
section, the textual definition takes priority. section, the textual definition takes priority.
Usage examples are provided in Section 7. Usage examples are provided in Section 6.
5.1. <mscmixer> 4.1. <mscmixer>
The <mscmixer> element has the following attributes (in addition to The <mscmixer> element has the following attributes (in addition to
standard XML namespace attributes such as xmlns): standard XML namespace attributes such as xmlns):
version: a string specifying the mscmixer package version. The version: a string specifying the mscmixer package version. The
value is fixed as '1.0' for this version of the package. The value is fixed as '1.0' for this version of the package. The
attribute is mandatory. attribute is mandatory.
The <mscmixer> element has the following defined child elements, only The <mscmixer> element has the following defined child elements, only
one of which can occur: one of which can occur:
1. mixer management elements defined in Section 5.2: 1. mixer management elements defined in Section 4.2:
<createconference> create and configure a new conference mixer. <createconference> create and configure a new conference mixer.
See Section 5.2.1.1 See Section 4.2.1.1
<modifyconference> modify the configuration of an existing <modifyconference> modify the configuration of an existing
conference mixer. See Section 5.2.1.2 conference mixer. See Section 4.2.1.2
<destroyconference> destroy an existing conference mixer. See <destroyconference> destroy an existing conference mixer. See
Section 5.2.1.3 Section 4.2.1.3
<join> create and configure media streams between connections <join> create and configure media streams between connections
and/or conferences (for example, add a participant to a and/or conferences (for example, add a participant to a
conference). See Section 5.2.2.2 conference). See Section 4.2.2.2
<modifyjoin> modify the configuration of joined media streams. <modifyjoin> modify the configuration of joined media streams.
See Section 5.2.2.3 See Section 4.2.2.3
<unjoin> delete a media stream (for example, remove a <unjoin> delete a media stream (for example, remove a
participant from a conference). See Section 5.2.2.4 participant from a conference). See Section 4.2.2.4
<response> response to a mixer request. See Section 5.2.3 <response> response to a mixer request. See Section 4.2.3
<event> mixer or subscription notification. See Section 5.2.4 <event> mixer or subscription notification. See Section 4.2.4
2. audit elements defined in Section 5.3: 2. audit elements defined in Section 4.3:
<audit> audit package capabilities and managed mixers. See <audit> audit package capabilities and managed mixers. See
Section 5.3.1 Section 4.3.1
<auditresponse> response to an audit request. See Section 5.3.2 <auditresponse> response to an audit request. See Section 4.3.2
For example, a request to the MS to create a conference mixer: For example, a request to the MS to create a conference mixer:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<createconference/> <createconference/>
</mscmixer> </mscmixer>
and a response from the MS that the conference was successfully and a response from the MS that the conference was successfully
created: created:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<response status="200" conferenceid="conference1"/> <response status="200" conferenceid="conference1"/>
</mscmixer> </mscmixer>
5.2. Mixer Elements 4.2. Mixer Elements
This section defines the mixer management XML elements for this This section defines the mixer management XML elements for this
control package. These elements are divided into requests, responses control package. These elements are divided into requests, responses
and notifications. and notifications.
Request elements are sent to the MS to request a specific mixer Request elements are sent to the MS to request a specific mixer
operation to be executed. The following request elements are operation to be executed. The following request elements are
defined: defined:
<createconference> create and configure a new a conference mixer. <createconference> create and configure a new a conference mixer.
See Section 5.2.1.1 See Section 4.2.1.1
<modifyconference> modify the configuration of an existing <modifyconference> modify the configuration of an existing
conference mixer. See Section 5.2.1.2 conference mixer. See Section 4.2.1.2
<destroyconference> destroy an existing conference mixer. See <destroyconference> destroy an existing conference mixer. See
Section 5.2.1.3 Section 4.2.1.3
<join> create and configure media streams between connections and/or <join> create and configure media streams between connections and/or
conferences (for example, add a participant to a conference). See conferences (for example, add a participant to a conference). See
Section 5.2.2.2 Section 4.2.2.2
<modifyjoin> modify the configuration of joined media streams. See <modifyjoin> modify the configuration of joined media streams. See
Section 5.2.2.3 Section 4.2.2.3
<unjoin> delete a media stream (for example, remove a participant <unjoin> delete a media stream (for example, remove a participant
from a conference). See Section 5.2.2.4 from a conference). See Section 4.2.2.4
Responses from the MS describe the status of the requested operation. Responses from the MS describe the status of the requested operation.
Responses are specified in a <response> element (Section 5.2.3) which Responses are specified in a <response> element (Section 4.2.3) which
includes a mandatory attribute describing the status in terms of a includes a mandatory attribute describing the status in terms of a
numeric code. Response status codes are defined in Section 5.6. The numeric code. Response status codes are defined in Section 4.6. The
MS MUST respond to a request message with a response message. If the MS MUST respond to a request message with a response message. If the
MS is not able to process the request and carry out the mixer MS is not able to process the request and carry out the mixer
operation, the request has failed and the MS MUST indicate the class operation, the request has failed and the MS MUST indicate the class
of failure using an appropriate 4xx response code. Unless an error of failure using an appropriate 4xx response code. Unless an error
response code is mandated for a specific class of error within this response code is specified for a class of error within this section,
section, implementations follow Section 5.6 in determining the implementations follow Section 4.6 in determining the appropriate
appropriate status code for the response. status code for the response.
Notifications are sent from the MS to provide updates on the status Notifications are sent from the MS to provide updates on the status
of a mixer operation or subscription. Notifications are specified in of a mixer operation or subscription. Notifications are specified in
an <event> element (Section 5.2.4). an <event> element (Section 4.2.4).
5.2.1. Conference Elements 4.2.1. Conference Elements
5.2.1.1. <createconference> 4.2.1.1. <createconference>
The <createconference> element is sent to the MS to request creation The <createconference> element is sent to the MS to request creation
of a new conference (multiparty) mixer. of a new conference (multiparty) mixer.
The <createconference> element has the following attributes: The <createconference> element has the following attributes:
conferenceid: string indicating a unique name for the new conferenceid: string indicating a unique name for the new
conference. If this attribute is not specified, the MS MUST conference. If this attribute is not specified, the MS MUST
create a unique name for the conference. The value is used in create a unique name for the conference. The value is used in
subsequent references to the conference (e.g. as conferenceid in a subsequent references to the conference (e.g. as conferenceid in a
<response>). The attribute is optional. There is no default <response>). The attribute is optional. There is no default
value. value.
reserved-talkers: indicates the requested number of guaranteed reserved-talkers: indicates the requested number of guaranteed
speaker slots to be reserved for the conference. A valid value is speaker slots to be reserved for the conference. A valid value is
a non-negative integer (see Section 5.7.2). The attribute is a non-negative integer (see Section 4.7.2). The attribute is
optional. The default value is 0. optional. The default value is 0.
reserved-listeners: indicates the requested number of guaranteed reserved-listeners: indicates the requested number of guaranteed
listener slots to be reserved for the conference. A valid value listener slots to be reserved for the conference. A valid value
is a non-negative integer (see Section 5.7.2). The attribute is is a non-negative integer (see Section 4.7.2). The attribute is
optional. The default value is 0. optional. The default value is 0.
The <createconference> element has the following sequence of child The <createconference> element has the following sequence of child
elements: elements:
<codecs>: an element to configure the codecs supported by the <codecs>: an element to configure the codecs supported by the
conference (see Section 5.4). The element is optional. conference (see Section 4.4). The element is optional.
<audio-mixing>: an element to configure the audio mixing <audio-mixing>: an element to configure the audio mixing
characteristics of a conference (see Section 5.2.1.4.1). The characteristics of a conference (see Section 4.2.1.4.1). The
element is optional. element is optional.
<video-layouts>: an element to configure the video layouts of a <video-layouts>: an element to configure the video layouts of a
conference (see Section 5.2.1.4.2). The element is optional. conference (see Section 4.2.1.4.2). The element is optional.
<video-switch>: an element to configure the video switch policy for <video-switch>: an element to configure the video switch policy for
the layout of a conference (see Section 5.2.1.4.3). The element the layout of a conference (see Section 4.2.1.4.3). The element
is optional. is optional.
<subscribe>: an element to request subscription to conference <subscribe>: an element to request subscription to conference
events. (see Section 5.2.1.4.4). The element is optional. events. (see Section 4.2.1.4.4). The element is optional.
If the conferenceid attribute specifies the name of a conference If the conferenceid attribute specifies a value which is already used
which already exists, the MS MUST report an error (405) and MUST NOT by an existing conference, the MS reports an error (405) and MUST NOT
create the conference. create a new conference and MUST NOT affect the existing conference.
If the MS is unable to configure the conference according to If the MS is unable to configure the conference according to
specified reserved-talkers or reserved-listeners attributes, the MS specified reserved-talkers or reserved-listeners attributes, the MS
MUST report an error (420) and MUST NOT create the conference. reports an error (420) and MUST NOT create the conference.
If the MS is unable to configure the conference according to a If the MS is unable to configure the conference according to a
specified <audio-mixing> element, the MS MUST report an error (421) specified <audio-mixing> element, the MS reports an error (421) and
and MUST NOT create the conference. MUST NOT create the conference.
If the MS is unable to configure the conference for any specified
conference event specified in the <subscribe> element, the MS MUST
report an error (422) and MUST NOT create the conference.
If the MS is unable to configure the conference according to a If the MS is unable to configure the conference according to a
specified <video-layouts> element, the MS MUST report an error (423) specified <video-layouts> element, the MS reports an error (423) and
and MUST NOT create the conference. MUST NOT create the conference.
If the MS is unable to configure the conference according to a If the MS is unable to configure the conference according to a
specified <video-switch> element, the MS MUST report an error (424) specified <video-switch> element, the MS reports an error (424) and
and MUST NOT create the conference. MUST NOT create the conference.
If the MS is unable to configure the conference according to a If the MS is unable to configure the conference according to a
specified <codecs> element, the MS MUST report an error (425) and specified <codecs> element, the MS reports an error (425) and MUST
MUST NOT create the conference. NOT create the conference.
When a MS has finished processing a <createconference> request, it When a MS has finished processing a <createconference> request, it
MUST reply with an appropriate <response> element (Section 5.2.3). MUST reply with an appropriate <response> element (Section 4.2.3).
For example, a request to create an audio video conference mixer with For example, a request to create an audio video conference mixer with
specified codecs, video layout, video switch and subscription: specified codecs, video layout, video switch and subscription:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<createconference conferenceid="conference1" <createconference conferenceid="conference1"
reserved-talkers="1" reserved-listeners="10"> reserved-talkers="1" reserved-listeners="10">
<codecs> <codecs>
<codec> <codec>
<subtype>H264</subtype> <subtype>H264</subtype>
skipping to change at page 16, line 12 skipping to change at page 15, line 12
<response status="200" conferenceid="conference1"/> <response status="200" conferenceid="conference1"/>
</mscmixer> </mscmixer>
alternatively, a response if MS could not create the conference due alternatively, a response if MS could not create the conference due
to a lack of support for the H264 codec: to a lack of support for the H264 codec:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<response status="425" conferenceid="conference1" <response status="425" conferenceid="conference1"
reason="H264 codec not supported"/> reason="H264 codec not supported"/>
</mscmixer> </mscmixer>
5.2.1.2. <modifyconference> 4.2.1.2. <modifyconference>
The <modifyconference> element is sent to the MS to request The <modifyconference> element is sent to the MS to request
modification of an existing conference. modification of an existing conference.
The <modifyconference> element has the following attributes: The <modifyconference> element has the following attributes:
conferenceid: string indicating the name of the conference to conferenceid: string indicating the name of the conference to
modify. This attribute is mandatory. modify. This attribute is mandatory.
The <modifyconference> element has the following sequence of child The <modifyconference> element has the following sequence of child
elements (1 or more): elements (1 or more):
<codecs>: an element to configure the codecs supported by the <codecs>: an element to configure the codecs supported by the
conference (see Section 5.4). Existing participants are conference (see Section 4.4). Existing participants are
unaffected by any policy change. The element is optional. unaffected by any policy change. The element is optional.
<audio-mixing>: an element to configure the audio mixing <audio-mixing>: an element to configure the audio mixing
characteristics of a conference (see Section 5.2.1.4.1). The characteristics of a conference (see Section 4.2.1.4.1). The
element is optional. element is optional.
<video-layouts>: an element to configure the video layouts of a <video-layouts>: an element to configure the video layouts of a
conference (see Section 5.2.1.4.2). The element is optional. conference (see Section 4.2.1.4.2). The element is optional.
<video-switch>: an element to configure the video switch policy for <video-switch>: an element to configure the video switch policy for
the layout of a conference (see Section 5.2.1.4.3). The element the layout of a conference (see Section 4.2.1.4.3). The element
is optional. is optional.
<subscribe>: an element to request subscription to conference <subscribe>: an element to request subscription to conference
events. (see Section 5.2.1.4.4). The element is optional. events. (see Section 4.2.1.4.4). The element is optional.
If the conferenceid attribute specifies the name of a conference If the conferenceid attribute specifies the name of a conference
which does not exist, the MS MUST report an error (406). which does not exist, the MS reports an error (406).
If the MS is unable to configure the conference according to a If the MS is unable to configure the conference according to a
specified <audio-mixing> element, the MS MUST report an error (421) specified <audio-mixing> element, the MS reports an error (421) and
and MUST NOT modify the conference in any way. MUST NOT modify the conference in any way.
If the MS is unable to configure the conference for any specified
conference event specified in the <subscribe> element, the MS MUST
report an error (422) and MUST NOT modify the conference in anyway.
If the MS is unable to configure the conference according to a If the MS is unable to configure the conference according to a
specified <video-layouts> element, the MS MUST report an error (423) specified <video-layouts> element, the MS reports an error (423) and
and MUST NOT modify the conference in any way. MUST NOT modify the conference in any way.
If the MS is unable to configure the conference according to a If the MS is unable to configure the conference according to a
specified <video-switch> element, the MS MUST report an error (424) specified <video-switch> element, the MS reports an error (424) and
and MUST NOT modify the conference in any way. MUST NOT modify the conference in any way.
If the MS is unable to configure the conference according to a If the MS is unable to configure the conference according to a
specified <codecs> element, the MS MUST report an error (425) and specified <codecs> element, the MS reports an error (425) and MUST
MUST NOT modify the conference. NOT modify the conference.
When a MS has finished processing a <modifyconference> request, it When a MS has finished processing a <modifyconference> request, it
MUST reply with an appropriate <response> element (Section 5.2.3). MUST reply with an appropriate <response> element (Section 4.2.3).
5.2.1.3. <destroyconference> 4.2.1.3. <destroyconference>
The <destroyconference> element is sent to the MS to request The <destroyconference> element is sent to the MS to request
destruction of an existing conference. destruction of an existing conference.
The <destroyconference> element has the following attributes: The <destroyconference> element has the following attributes:
conferenceid: string indicating the name of the conference to conferenceid: string indicating the name of the conference to
destroy. This attribute is mandatory. destroy. This attribute is mandatory.
The <destroyconference> element does not specify any child elements. The <destroyconference> element does not specify any child elements.
If the conferenceid attribute specifies the name of a conference If the conferenceid attribute specifies the name of a conference
which does not exist, the MS MUST report an error (406). which does not exist, the MS reports an error (406).
When a MS has finished processing a <destroyconference> request, it When a MS has finished processing a <destroyconference> request, it
MUST reply with an appropriate <response> element (Section 5.2.3). MUST reply with an appropriate <response> element (Section 4.2.3).
Successfully destroying the conference (status code 200) will result Successfully destroying the conference (status code 200) will result
in all connection or conference participants being removed from the in all connection or conference participants being removed from the
conference mixer, <unjoin-notify> notification events conference mixer, <unjoin-notify> notification events
(Section 5.2.4.2) being sent for each conference participant and a (Section 4.2.4.2) being sent for each conference participant and a
<conferenceexit> notification event (Section 5.2.4.3) indicating that <conferenceexit> notification event (Section 4.2.4.3) indicating that
conference has exited. A <response> with any other status code conference has exited. A <response> with any other status code
indicates that the conference mixer still exists and participants are indicates that the conference mixer still exists and participants are
still joined to the mixer. still joined to the mixer.
5.2.1.4. Conference Configuration 4.2.1.4. Conference Configuration
The elements in this section are used to establish and modify the The elements in this section are used to establish and modify the
configuration of conferences. configuration of conferences.
5.2.1.4.1. <audio-mixing> 4.2.1.4.1. <audio-mixing>
The <audio-mixing> element defines the configuration of the The <audio-mixing> element defines the configuration of the
conference audio mix. It has no child elements and has the following conference audio mix.
attributes:
The <audio-mixing> element has the following attributes:
type: is a string indicating the audio stream mixing policy. type: is a string indicating the audio stream mixing policy.
Defined values are: "nbest" (where the N best participant signals Defined values are: "nbest" (where the N best (loudest)
are mixed) and "controller" (where the contributing participant(s) participant signals are mixed) and "controller" (where the
is/are selected by the controlling AS via an external floor contributing participant(s) is/are selected by the controlling AS
control protocol). The default value is "nbest". The attribute via an external floor control protocol). The attribute is
is optional. optional. The default value is "nbest".
5.2.1.4.2. <video-layouts> n: indicates the number of eligible participants included in the
conference audio mix. An eligible participant is a partipicant
who contributes audio to the conference. Inclusion is based on
having the greatest audio energy. A valid value is a non-negative
integer (see Section 4.7.2). A value of 0 indicates that all
participants contributing audio to the conference are included in
the audio mix. The default value is 0. The element is optional.
If the type attribute does not have the value "nbest", the MS ignores
the "n" attribute.
The <audio-mixing> element has no child elements.
For example, a fragment where the audio mixing policy is set to
"nbest" with 3 participants to be included:
<audio-mixing type="nbest" n="3"/>
If the conference had 200 participants of whom 30 contributed audio,
then there would be 30 eligible participants for the audio mix. Of
these, the 3 loudest partipicants would have their audio included in
the conference.
4.2.1.4.2. <video-layouts>
The <video-layouts> element describe the video presentation layout The <video-layouts> element describe the video presentation layout
configuration for participants providing a video input stream to the configuration for participants providing a video input stream to the
conference. This element allows multiple video layouts to be conference. This element allows multiple video layouts to be
specified so that the MS automatically changes layout depending on specified so that the MS automatically changes layout depending on
the number of video-enabled participants. the number of video-enabled participants.
The <video-layouts> element has no attributes. The <video-layouts> element has no attributes.
The <video-layouts> element has the following sequence of child The <video-layouts> element has the following sequence of child
elements (1 or more): elements (1 or more):
<video-layout>: element describing a video layout <video-layout>: element describing a video layout
(Section 5.2.1.4.2.1). (Section 4.2.1.4.2.1).
If the MS does not support video conferencing at all, or does not If the MS does not support video conferencing at all, or does not
support multiple video layouts, or does not support a specific video support multiple video layouts, or does not support a specific video
layout, the MS MUST report an 408 error in the response to the layout, the MS reports an 408 error in the response to the request
request element containing the <video-layouts> element. element containing the <video-layouts> element.
An MS MAY support more than one <video-layout> element, although only An MS MAY support more than one <video-layout> element, although only
one layout can be active at a time. A <video-layout> is active if one layout can be active at a time. A <video-layout> is active if
the number of participants in the conference is equal to or greater the number of participants in the conference is equal to or greater
than the value of its "min-participants" attribute, but less than the than the value of its "min-participants" attribute, but less than the
value of the "min-participants" attribute for any other <video- value of the "min-participants" attribute for any other <video-
layout> element. An MS MUST report an error if more than one <video- layout> element. An MS reports an error (400) if more than one
layout> has the same value for the "min-participants" attribute. <video-layout> has the same value for the "min-participants"
When the number of regions within the active layout is greater than attribute. When the number of regions within the active layout is
the number of participants in the conference, the display of greater than the number of participants in the conference, the
unassigned regions is implementation-specific. display of unassigned regions is implementation-specific.
The assignment of participant video streams to regions within the The assignment of participant video streams to regions within the
layout is according to the video switch policy specified by the layout is according to the video switch policy specified by the
<video-switch> element (Section 5.2.1.4.3). <video-switch> element (Section 4.2.1.4.3).
For example, a fragment describing a single layout: For example, a fragment describing a single layout:
<video-layouts> <video-layouts>
<video-layout>single-view</video-layout> <video-layout>single-view</video-layout>
</video-layouts> </video-layouts>
And a fragment describing a sequence of layouts: And a fragment describing a sequence of layouts:
<video-layouts> <video-layouts>
skipping to change at page 19, line 27 skipping to change at page 19, line 5
<video-layout min-participants="5">multiple-3x3</video-layout> <video-layout min-participants="5">multiple-3x3</video-layout>
</video-layouts> </video-layouts>
When the conference has one participant providing a video input When the conference has one participant providing a video input
stream to the conference, then the single-view format is used. When stream to the conference, then the single-view format is used. When
the conference has two such participants, the dual-view layout is the conference has two such participants, the dual-view layout is
used. When the conference has three or four participants, the quad- used. When the conference has three or four participants, the quad-
view layout is used. When the conference has five or more view layout is used. When the conference has five or more
participants, the multiple-3x3 layout is used. participants, the multiple-3x3 layout is used.
5.2.1.4.2.1. <video-layout> 4.2.1.4.2.1. <video-layout>
The <video-layout> element describes a video layout containing one or The <video-layout> element describes a video layout containing one or
more regions in which participant video input streams are displayed. more regions in which participant video input streams are displayed.
The <video-layout> element has the following attributes: The <video-layout> element has the following attributes:
min-participants: the minimum number of conference participants min-participants: the minimum number of conference participants
needed to allow this layout to be active. A valid value is a needed to allow this layout to be active. A valid value is a
positive integer (see Section 5.7.3). The attribute is optional. positive integer (see Section 4.7.3). The attribute is optional.
The default value is 1. The default value is 1.
The <video-layout> element has a content model specifying the name of The <video-layout> element has a content model specifying the name of
the video layout. the video layout.
It is RECOMMENDED that an MS support the predefined video layouts An MS MAY support the predefined video layouts defined in the XCON
defined in the XCON conference information data model conference information data model
([I-D.ietf-xcon-common-data-model]). The MS MAY support other video ([I-D.ietf-xcon-common-data-model]). The MS MAY support other video
layouts. It is RECOMMENDED that non-XCON layouts are prefixed with a layouts. Non-XCON layouts MUST be prefixed with a label; for
label; for example, <video-layout>mylayout:single-view<video-layout>. example, <video-layout>mylayout:single-view<video-layout>.
Each video layout has associated with it one or more regions. The Each video layout has associated with it one or more regions. The
XCON layouts have associated the following named regions: XCON layouts have associated the following named regions:
single-view layout with one stream in a single region as shown in single-view layout with one stream in a single region as shown in
Figure 1. Figure 1.
+-----------+ +-----------+
| | | |
| | | |
| 1 | | 1 |
| | | |
| | | |
+-----------+ +-----------+
Figure 1: single-view video layout Figure 1: single-view video layout
dual-view layout presenting two streams side-by-side in two regions dual-view layout presenting two streams side-by-side in two regions
as shown in Figure 2. The MS MUST NOT alter the aspect ratio of as shown in Figure 2. The MS MUST NOT alter the aspect ratio of
each stream to fit the region and hence the MS MAY have to blank each stream to fit the region and hence the MS could have to blank
part of each region. part of each region.
+-----------+-----------+ +-----------+-----------+
| | | | | |
| | | | | |
| 1 | 2 | | 1 | 2 |
| | | | | |
| | | | | |
+-----------+-----------+ +-----------+-----------+
skipping to change at page 21, line 4 skipping to change at page 20, line 28
+-----------+-----------+ +-----------+-----------+
| | | | | |
| | | | | |
| 1 | 2 | | 1 | 2 |
| | | | | |
| | | | | |
+-----------+-----------+ +-----------+-----------+
Figure 3: dual-view-crop video layout Figure 3: dual-view-crop video layout
dual-view-2x1 layout presenting two streams one above the other in dual-view-2x1 layout presenting two streams one above the other in
two regions as shown in Figure 4. The MS MUST NOT alter the two regions as shown in Figure 4. The MS MUST NOT alter the
aspect ratio of each stream to fit its region and hence the MS MAY aspect ratio of each stream to fit its region and hence the MS
have to blank part of each region. could have to blank part of each region.
+-----------+ +-----------+
| | | |
| | | |
| 1 | | 1 |
| | | |
| | | |
+-----------+ +-----------+
| | | |
| | | |
skipping to change at page 24, line 27 skipping to change at page 24, line 27
+-----------+-----------+-----------+ +-----------+-----------+-----------+
| | | | | | | |
| | | | | | | |
| 4 | 5 | 6 | | 4 | 5 | 6 |
| | | | | | | |
| | | | | | | |
+-----------+-----------+-----------+ +-----------+-----------+-----------+
Figure 9: multiple-5x1 video layout Figure 9: multiple-5x1 video layout
5.2.1.4.3. <video-switch> 4.2.1.4.3. <video-switch>
The <video-switch> element describe the configuration of the The <video-switch> element describe the configuration of the
conference policy for how participant's input video streams are conference policy for how participant's input video streams are
assigned to regions within the active video layout. assigned to regions within the active video layout.
The <video-switch> element has the following attributes: The <video-switch> element has the following attributes:
type: a string indicating the video switching policy of the type: a string indicating the video switching policy of the
conference. Defined values are: conference. Defined values are:
vas (Voice Activated Switching) enables automatic display of the vas (Voice Activated Switching) enables automatic display of the
most active speaker participant also providing a video input loudest speaker participant also providing a video input stream
stream to the conference. Participants who do not provide an to the conference. Participants who do not provide an audio
audio stream are not considered for automatic display. If a stream are not considered for automatic display. If a
participant provides more than one audio stream, then the participant provides more than one audio stream, then the
policy for inclusion of such a participant in the VAS is policy for inclusion of such a participant in the VAS is
implementation-specific; an MS could select one stream, sum implementation-specific; an MS could select one stream, sum
audio streams or ignore the participant for VAS consideration. audio streams or ignore the participant for VAS consideration.
If there is only one region in the layout, then the most active If there is only one region in the layout, then the loudest
speaker is displayed there. If more than one region is speaker is displayed there. If more than one region is
available, then the most active speaker is displayed in the available, then the loudest speaker is displayed in the largest
largest region, if any, and then in the first region from the region, if any, and then in the first region from the top-left
top-left corner of the layout. The MS assigns the remaining corner of the layout. The MS assigns the remaining regions
regions based on the priority mechanism described in based on the priority mechanism described in
Section 5.2.1.4.3.1. Section 4.2.1.4.3.1.
controller enables manual control over video switching. The controller enables manual control over video switching. The
controller AS determines how the regions are assigned based on controller AS determines how the regions are assigned based on
an external floor control policy. The MS receives <join>, an external floor control policy. The MS receives <join>,
<modifyjoin> and <join> commands with a <stream> element <modifyjoin> and <join> commands with a <stream> element
(Section 5.2.2.5) indicating the region where the stream is (Section 4.2.2.5) indicating the region where the stream is
displayed. If no explicit region is specified, the MS assigns displayed. If no explicit region is specified, the MS assigns
the region based on the priority mechanism described in the region based on the priority mechanism described in
Section 5.2.1.4.3.1. Section 4.2.1.4.3.1.
An MS MAY support other video switching policies. It is An MS MAY support other video switching policies. Other policy
RECOMMENDED that other policy names are prefixed with a label; names MUST be prefixed with a label; e.g. "mypolicies:policy1".
e.g. "mypolicies:policy1". The attribute is optional. The The attribute is optional. The default value is 'vas'.
default value is 'vas'.
interval: specifies the period between video switches as a number of interval: specifies the period between video switches as a number of
seconds. In the case of 'vas' policy, a speaker needs to be the seconds. In the case of 'vas' policy, a speaker needs to be the
most active speaker for the interval before the switch takes loudest speaker for the interval before the switch takes place. A
place. A valid value is a non-negative integer (see valid value is a non-negative integer (see Section 4.7.2). A
Section 5.7.2). A value of 0 indicates that switching is applied value of 0 indicates that switching is applied immediately. The
immediately. The attribute is optional. The default value is 3 attribute is optional. The default value is 3 (seconds).
(seconds).
activespeakermix: indicates whether or not the active speaker activespeakermix: indicates whether or not the active (loudest)
participant receives a video stream without themselves displayed speaker participant receives a video stream without themselves
in the case of the 'vas' switching policy. If enabled, the MS displayed in the case of the 'vas' switching policy. If enabled,
needs to generate two video streams for each conference mix: one the MS needs to generate two video streams for each conference
for the active speaker participant without themselves displayed - mix: one for the active speaker participant without themselves
details of this video layout are implementation-specific; and one displayed - details of this video layout are implementation-
for other participants as described in the 'vas' switch policy specific; and one for other participants as described in the 'vas'
above. A valid value is a boolean (see Section 5.7.1). A value switch policy above. A valid value is a boolean (see
of true indicates that a separate video mix is generated for the Section 4.7.1). A value of true indicates that a separate video
active speaker without themselves being displayed. A value of mix is generated for the active speaker without themselves being
false indicates that all participants receive the same video mix. displayed. A value of false indicates that all participants
The attribute is optional. The default value is false. If the receive the same video mix. The attribute is optional. The
type attribute is not set to 'vas', the MS MUST ignore this default value is false. If the type attribute is not set to
attribute. 'vas', the MS ignores this attribute.
If the MS does not support the specified video switching policy or If the MS does not support the specified video switching policy or
other configuration parameters (including separate active speaker other configuration parameters (including separate active speaker
video mixes), then MS MUST report a 409 error (Section 5.6) in the video mixes), then MS reports a 409 error (Section 4.6) in the
response to the request element containing the <video-switch> response to the request element containing the <video-switch>
element. element.
If the MS receives a <join> or <modifyjoin> request containing a a If the MS receives a <join> or <modifyjoin> request containing a a
<stream> element (Section 5.2.2.5) specifying a region and the <stream> element (Section 4.2.2.5) specifying a region and the
conference video switching policy is set to 'vas', then the MS MUST conference video switching policy is set to 'vas', then the MS
ignore the region (i.e. conference switching policy takes ignores the region (i.e. conference switching policy takes
precedence). precedence).
If the MS receives a <join> or <modifyjoin> request containing a If the MS receives a <join> or <modifyjoin> request containing a
<stream> element (Section 5.2.2.5) specifying a region which is not <stream> element (Section 4.2.2.5) specifying a region which is not
defined for the currently active video layout, the MS MUST NOT report defined for the currently active video layout, the MS MUST NOT report
an error. Even though the participant is not currently visible, the an error. Even though the participant is not currently visible, the
MS MUST display the participant if the layout changes to one which MS displays the participant if the layout changes to one which
defines the specified region. defines the specified region.
The <video-switch> element has no child elements. The <video-switch> element has no child elements.
For example, a fragment specifying a 'vas' video switching policy For example, a fragment specifying a 'vas' video switching policy
with an interval of 2s with an interval of 2s
<video-switch type="vas" interval="2"/> <video-switch type="vas" interval="2"/>
For example, a fragment specifying a 'controller' video switching For example, a fragment specifying a 'controller' video switching
policy where video switching takes place immediately: policy where video switching takes place immediately:
<video-switch type="controller" interval="0"/> <video-switch type="controller" interval="0"/>
5.2.1.4.3.1. Priority assignment 4.2.1.4.3.1. Priority assignment
In cases where the video switching policy does not explicitly In cases where the video switching policy does not explicitly
determine the region to which a participant is assigned, the determine the region to which a participant is assigned, the
following priority assignment mechanism applies: following priority assignment mechanism applies:
1. Each participant has an (positive integer) priority value: the 1. Each participant has an (positive integer) priority value: the
lower the value, the higher the priority. The priority value is lower the value, the higher the priority. The priority value is
determined by the <priority> child element (Section 5.2.2.5.4) of determined by the <priority> child element (Section 4.2.2.5.4) of
<stream>. If not explicitly specified, the default priority <stream>. If not explicitly specified, the default priority
value is 100. value is 100.
2. The MS uses priority values to assign participants to regions in 2. The MS uses priority values to assign participants to regions in
the video layout which remain unfilled after application of the the video layout which remain unfilled after application of the
video switching policy. The MS MUST dedicate larger and/or more video switching policy. The MS MUST dedicate larger and/or more
prominent portions of the layout to participants with higher prominent portions of the layout to participants with higher
priority values first (e.g. first all participants with priority priority values first (e.g. first all participants with priority
1, then those with 2, 3, etc). 1, then those with 2, 3, etc).
skipping to change at page 27, line 10 skipping to change at page 27, line 7
The MS applies this priority policy each time the video layout is The MS applies this priority policy each time the video layout is
changed or updated. It is RECOMMENDED that the MS does not move a changed or updated. It is RECOMMENDED that the MS does not move a
participant from one region to another unless required by the video participant from one region to another unless required by the video
switching policy when an active video layout is updated. switching policy when an active video layout is updated.
This model allows the MS to apply default video layouts after This model allows the MS to apply default video layouts after
applying the video switch policy. For example, region 2 is applying the video switch policy. For example, region 2 is
statically assigned to Bob, so the priority mechanism only applies to statically assigned to Bob, so the priority mechanism only applies to
regions 1, 3, 4, etc. regions 1, 3, 4, etc.
5.2.1.4.4. <subscribe> 4.2.1.4.4. <subscribe>
The <subscribe> element is a container for specifying conference The <subscribe> element is a container for specifying conference
notification events to which a controlling entity subscribes. notification events to which a controlling entity subscribes.
Notifications of conference events are delivered using the <event> Notifications of conference events are delivered using the <event>
element (see Section 5.2.4). element (see Section 4.2.4).
The <subscribe> element has no attributes, but has the following The <subscribe> element has no attributes, but has the following
child element: child element:
<active-talkers-sub>: subscription to active talker events <active-talkers-sub>: subscription to active talker events
(Section 5.2.1.4.4.1). The element is optional. (Section 4.2.1.4.4.1). The element is optional.
The MS SHOULD support a <active-talkers-sub> subscription. It MAY The MS MUST support a <active-talkers-sub> subscription. It MAY
support other event subscriptions. If the MS does not support a support other event subscriptions (specified using attributes and
requested subscription, it MUST send a <response> with a 422 status child elements from a foreign namespace). If the MS does not support
code. a subscription specified in a foreign namespace, it sends a
<response> with a 428 status code (see Section 4.6).
5.2.1.4.4.1. <active-talkers-sub> 4.2.1.4.4.1. <active-talkers-sub>
The <active-talkers-sub> element has the following attributes: The <active-talkers-sub> element has the following attributes:
interval: the minimum amount of time (in seconds) that must elapse interval: the minimum amount of time (in seconds) that elapses
before further active talker events can be generated. A valid before further active talker events can be generated. A valid
value is a non-negative integer (see Section 5.7.2). A value of 0 value is a non-negative integer (see Section 4.7.2). A value of 0
suppresses further notifications. The attribute is optional. The suppresses further notifications. The attribute is optional. The
default value is 3 (seconds). default value is 3 (seconds).
The <active-talker-sub> element has no child elements. The <active-talker-sub> element has no child elements.
Active talker notifications are delivered in the <active-talker- Active talker notifications are delivered in the <active-talker-
notify> element (Section 5.2.4.1). notify> element (Section 4.2.4.1).
5.2.2. Joining Elements 4.2.2. Joining Elements
5.2.2.1. Joining Model In this section, the joining model is defined (Section 4.2.2.1) as
well as definitions of the <join> (Section 4.2.2.2), <modifyjoin>
(Section 4.2.2.3), <unjoin> (Section 4.2.2.4) and <stream>
(Section 4.2.2.5) elements.
4.2.2.1. Joining Model
The <join> operation creates a media stream between a connection and The <join> operation creates a media stream between a connection and
a conference, between connections, or between conferences. This sub- a conference, between connections, or between conferences. This
section describes the model of conferences and connections and section describes the model of conferences and connections and
specifies the behavior for join requests to targets that already have specifies the behavior for join requests to targets that already have
an associated media stream. an associated media stream.
Conferences support multiple inputs and have resources to mix them Conferences support multiple inputs and have resources to mix them
together. A media server conference in essence is a mixer that together. A media server conference in essence is a mixer that
combines media streams. A simple audio mix simply sums its input combines media streams. A simple audio mixer simply sums its input
audio signals to create a single common output. Conferences however audio signals to create a single common output. Conferences however
use a more complex algorithm so that participants do not hear use a more complex algorithm so that participants do not hear
themselves as part of the mix. That algorithm, sometimes called an themselves as part of the mix. That algorithm, sometimes called an
n-minus mix, subtracts each participants input signal from the summed n-minus mix, subtracts each participants input signal from the summed
input signals, creating a unique output for each contributing input signals, creating a unique output for each contributing
participant. Each <join> operation to a conference uses one of the participant. Each <join> operation to a conference uses one of the
conferences available inputs and/or outputs, to the maximum number of conference's available inputs and/or outputs, to the maximum number
supported participants. of supported participants.
A connection is the termination of a RTP session(s) on a media A connection is the termination of a RTP session(s) on a media
server. It has a single input and output for each media session server. It has a single input and output for each media session
established by its SIP dialog. The output of a connection may feed established by its SIP dialog. The output of a connection can feed
several different inputs such as both a conference mix and a several different inputs such as both a conference mixer and a
recording of that participants audio. recording of that participant's audio.
Joining two connections which are are not joined to anything else Joining two connections which are are not joined to anything else
simply creates a media stream from the outputs(s) of one connection simply creates a media stream from the outputs(s) of one connection
to the corresponding inputs(s) of the other connection. It is not to the corresponding inputs(s) of the other connection. It is not
necessary to combine media from multiple sources in this case. There necessary to combine media from multiple sources in this case. There
are however several common scenarios where combining media from are however several common scenarios where combining media from
several sources to create a single input to a connection is needed. several sources to create a single input to a connection is needed.
In the first case, a connection may be receiving media from one In the first case, a connection can be receiving media from one
source, for example a conference, and it is necessary to play an source, for example a conference, and it is necessary to play an
announcement to the connection so that both the conference audio and announcement to the connection so that both the conference audio and
announcement can be heard by the conference participant. This is announcement can be heard by the conference participant. This is
sometimes referred to as a whisper announcement. An alternative to a sometimes referred to as a whisper announcement. An alternative to a
whisper announcement is to have the announcement pre-empt the whisper announcement is to have the announcement pre-empt the
conference media. conference media.
Another common case is the call center coaching scenario where a Another common case is the call center coaching scenario where a
supervisor can listen to the conversation between an agent and a supervisor can listen to the conversation between an agent and a
customer, and provide hints to the agent, which are not heard by the customer, and provide hints to the agent, which are not heard by the
skipping to change at page 29, line 13 skipping to change at page 29, line 17
is straight forward and simple, requiring no indirect requests on the is straight forward and simple, requiring no indirect requests on the
part of the controlling AS. This increases transport efficiency and part of the controlling AS. This increases transport efficiency and
reduces the coordination complexity and the latency of the overall reduces the coordination complexity and the latency of the overall
operation. Therefore, it is RECOMMENDED that a media server be able operation. Therefore, it is RECOMMENDED that a media server be able
to automatically mix at least two audio streams where only the simple to automatically mix at least two audio streams where only the simple
summing of signals is required. summing of signals is required.
When a media server receives a <join> request, it MUST automatically When a media server receives a <join> request, it MUST automatically
mix all of the media streams included in the request with any streams mix all of the media streams included in the request with any streams
already joined to one of the entities identified in the request, or already joined to one of the entities identified in the request, or
it MUST fail the request and MUST NOT join any of the streams. A it MUST fail the request and MUST NOT join any of the streams (and
controlling AS MUST use the <createconference> request for generic MUST NOT change existing streams of the entities). A controlling AS
conferences where the complex mixing algorithm is required. uses the <createconference> request for generic conferences where the
complex mixing algorithm is required.
Specifications which extend this package to handle additional media Specifications which extend this package to handle additional media
types such as text or video, MUST define the semantics of the join types such as text, MUST define the semantics of the join operation
operation when multiple streams are requested to be joined to a when multiple streams are requested to be joined to a single input,
single input, such as that for a connection with a single RTP session such as that for a connection with a single RTP session per media
per media type. type.
5.2.2.2. <join> 4.2.2.2. <join>
The <join> element is sent to the MS to request creation one or more The <join> element is sent to the MS to request creation one or more
media streams either between a connection and a conference, between media streams either between a connection and a conference, between
connections, or between conferences. The two entities to join are connections, or between conferences. The two entities to join are
specified by the attributes of <join>. specified by the attributes of <join>.
Streams may be of any media type, and may be bi-directional or uni- Streams can be of any media type, and can be bi-directional or uni-
directional. A bi-directional stream is implicitly composed of two directional. A bi-directional stream is implicitly composed of two
uni-directional streams that can be manipulated independently. The uni-directional streams that can be manipulated independently. The
streams to be established are specified by child <stream> elements streams to be established are specified by child <stream> elements
(see Section 5.2.2.5). (see Section 4.2.2.5).
The <join> element has the following attributes: The <join> element has the following attributes:
id1: an identifier for either a connection or a conference. The id1: an identifier for either a connection or a conference. The
identifier MUST conform to the syntax defined in Section 17.1 of identifier MUST conform to the syntax defined in Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [I-D.ietf-mediactrl-sip-control-framework] The attribute is
mandatory. mandatory.
id2: an identifier for either a connection or a conference. The id2: an identifier for either a connection or a conference. The
identifier MUST conform to the syntax defined in Section 17.1 of identifier MUST conform to the syntax defined in Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [I-D.ietf-mediactrl-sip-control-framework] The attribute is
mandatory. mandatory.
Note: Section 17.1 of [I-D.ietf-mediactrl-sip-control-framework] Note: Section 17.1 of [I-D.ietf-mediactrl-sip-control-framework]
defines the semantics for a conference identifier but not its syntax. defines the semantics for a conference identifier but not its syntax.
Media server implementations need to distinguish between conferences Media server implementations need to distinguish between conferences
and connections based upon the values of the "id1" and "id2" and connections based upon the values of the "id1" and "id2"
attributes. attributes.
If id1 or id2 specify a conference identifier and the conference does
not exist on the MS, the MS reports an error (406). If id1 or id2
specify a connection identifier and the connection does not exist on
the MS, the MS reports an error (412).
The <join> element has the following child element (0 or more): The <join> element has the following child element (0 or more):
<stream>: an element that both identifies the media streams to join <stream>: an element that both identifies the media streams to join
and defines the way that they are to be joined (see and defines the way that they are to be joined (see
Section 5.2.2.5). The element is optional. Section 4.2.2.5). The element is optional.
If no <stream> elements are specified, then the default is to join If no <stream> elements are specified, then the default is to join
all streams between the entities according to the media configuration all streams between the entities according to the media configuration
of the connection or conference. of the connection or conference.
One or more <stream> elements may be specified so that individual One or more <stream> elements can be specified so that individual
media streams can be controlled independently. For example, if a media streams can be controlled independently. For example, if a
connection supports both audio and video streams, a <stream> element connection supports both audio and video streams, a <stream> element
could be used to indicate that only the audio stream is used in could be used to indicate that only the audio stream is used in
receive mode. In cases where there are multiple media streams of the receive mode. In cases where there are multiple media streams of the
same type for a connection or conference, it is RECOMMENDED that the same type for a connection or conference, the configuration MUST be
configuration is explicitly specified using <stream> elements. explicitly specified using <stream> elements.
It is an error if a <stream> element is in conflict with (a) another Multiple <stream> elements can be specified for precise control over
<stream> element, (b) with specified connection or conference media the media flow in different directions within the same media stream.
capabilities, (c) with a SDP label value as part of the connection-id One <stream> element can be specified for the receiving media flow
(see Section 17.1 of [I-D.ietf-mediactrl-sip-control-framework]) or and another element for the sending media flow, where each
(d) if the media stream configuration is not supported by the MS. independently controls features such as volume (see child element of
<stream> in Section 4.2.2.5). If there is only one <stream> element
for a given media specifying a 'sendonly' or 'recvonly' direction,
then the media flow in the opposite direction is inactive
(established but no actual flow of media) unless this is leads to a
stream conflict.
If the MS is unable to execute the join as specified in <stream> If the MS is unable to execute the join as specified in <stream>
elements, the MS MUST report an error (407) and MUST NOT join the because a <stream> element is in conflict with (a) another <stream>
entities. element, (b) with specified connection or conference media
capabilities or (c) with a SDP label value as part of the
connection-id (see Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework]), then the MS reports an
error (407) and MUST NOT join the entities and MUST NOT change
existing streams of the entities.
If the MS is unable to execute the join as specified in <stream>
elements because the MS does not support the media stream
configuration, the MS reports an error (422) and MUST NOT join the
entities and MUST NOT change existing streams of the entities.
If the MS is unable to join an entity to a conference because it is If the MS is unable to join an entity to a conference because it is
full, then the MS MUST report an error (410). full, then the MS reports an error (410).
If the specified entities are already joined, then the MS MUST report If the specified entities are already joined, then the MS reports an
an error (408). error (408).
If the MS does not support joining two specified connections If the MS does not support joining two specified connections
together, the MS MUST report an error (426). together, the MS reports an error (426).
If the MS does not support joining two specified conferences If the MS does not support joining two specified conferences
together, the MS MUST report an error (427). together, the MS reports an error (427).
If the MS is unable to join the specified entities for any other If the MS is unable to join the specified entities for any other
reason, the MS MUST report an error (411). reason, the MS reports an error (411).
When the MS has finished processing a <join> request, it MUST reply When the MS has finished processing a <join> request, it MUST reply
with an <response> element (Section 5.2.3). with an <response> element (Section 4.2.3).
For example, a request to join two connection together: For example, a request to join two connection together:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<join id1="connnection1" id2="connection2"/> <join id1="1536067209~913cd14c" id2="1536067209~913cd14c"/>
</mscmixer> </mscmixer>
and the response if the MS doesn't support joining media streams and the response if the MS doesn't support joining media streams
between connections: between connections:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<response status="426" reason="mixing connections not supported"/> <response status="426" reason="mixing connections not supported"/>
</mscmixer> </mscmixer>
5.2.2.3. <modifyjoin> 4.2.2.3. <modifyjoin>
The <modifyjoin> element is sent to the MS to request changes in the The <modifyjoin> element is sent to the MS to request changes in the
configuration of media stream(s) that were previously established configuration of media stream(s) that were previously established
between a connection and a conference, between two connections, or between a connection and a conference, between two connections, or
between two conferences. between two conferences.
The <modifyjoin> element has the following attributes: The <modifyjoin> element has the following attributes:
id1: an identifier for either a connection or a conference. The id1: an identifier for either a connection or a conference. The
identifier MUST conform to the syntax defined in Section 17.1 of identifier MUST conform to the syntax defined in Section 17.1 of
skipping to change at page 31, line 41 skipping to change at page 32, line 19
id2: an identifier for either a connection or a conference. The id2: an identifier for either a connection or a conference. The
identifier MUST conform to the syntax defined in Section 17.1 of identifier MUST conform to the syntax defined in Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [I-D.ietf-mediactrl-sip-control-framework] The attribute is
mandatory. mandatory.
The <modifyjoin> element has the following child elements (1 or The <modifyjoin> element has the following child elements (1 or
more): more):
<stream>: an element that both identifies the media streams to <stream>: an element that both identifies the media streams to
modify and defines the way that each stream should now be modify and defines the way that each stream is now to be
configured (see Section 5.2.2.5). configured (see Section 4.2.2.5).
The MS MUST support <modifyjoin> for any stream that was established The MS MUST support <modifyjoin> for any stream that was established
using <join>. using <join>.
The media server MUST configure the streams that are included within The media server MUST configure the streams that are included within
<modifyjoin> to that stated by the child elements. It MUST NOT <modifyjoin> to that stated by the child elements. It MUST NOT
change the configuration of any streams not included as child change the configuration of any streams not included as child
elements. elements.
If the MS is unable to modify the join as specified in <stream> If the MS is unable to modify the join as specified in <stream>
elements, the MS MUST report an error (407) and MUST NOT modify the elements because a <stream> element is in conflict with (a) another
join between the entities. <stream> element, (b) with specified connection or conference media
capabilities or (c) with a SDP label value as part of the
connection-id (see Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework]), then the MS reports an
error (407) and MUST NOT modify the join between the entities and
MUST NOT change existing streams of the entities.
If the specified entities are not already joined, then the MS MUST If the MS is unable to modify the join as specified in <stream>
report an error (408). elements because the MS does not support the media stream
configuration, the MS reports an error (422) and MUST NOT modify the
join between the entities and MUST NOT change existing streams of the
entities.
If the specified entities are not already joined, then the MS reports
an error (408).
If the MS is unable to modify the join between the specified entities If the MS is unable to modify the join between the specified entities
for any other reason, the MS MUST report an error (411). for any other reason, the MS reports an error (411).
When an MS has finished processing a <modifyjoin> request, it MUST When an MS has finished processing a <modifyjoin> request, it MUST
reply with an appropriate <response> element (Section 5.2.3). reply with an appropriate <response> element (Section 4.2.3).
5.2.2.4. <unjoin> 4.2.2.4. <unjoin>
The <unjoin> element is sent to the MS to request removal of The <unjoin> element is sent to the MS to request removal of
previously established media stream(s) from between a connection and previously established media stream(s) from between a connection and
a conference, between two connections, or between two conferences. a conference, between two connections, or between two conferences.
The <unjoin> element has the following attributes: The <unjoin> element has the following attributes:
id1: an identifier for either a connection or a conference. The id1: an identifier for either a connection or a conference. The
identifier MUST conform to the syntax defined in Section 17.1 of identifier MUST conform to the syntax defined in Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [I-D.ietf-mediactrl-sip-control-framework] The attribute is
skipping to change at page 32, line 38 skipping to change at page 33, line 27
id2: an identifier for either a connection or a conference. The id2: an identifier for either a connection or a conference. The
identifier MUST conform to the syntax defined in Section 17.1 of identifier MUST conform to the syntax defined in Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [I-D.ietf-mediactrl-sip-control-framework] The attribute is
mandatory. mandatory.
The <unjoin> element has the following child element (0 or more The <unjoin> element has the following child element (0 or more
occurrences): occurrences):
<stream>: an element that identifies the media stream(s) to remove <stream>: an element that identifies the media stream(s) to remove
(see Section 5.2.2.5). The element is optional. When not (see Section 4.2.2.5). The element is optional. When not
present, all currently established streams between "id1" and "id2" present, all currently established streams between "id1" and "id2"
are removed. are removed.
The MS MUST support <unjoin> for any stream that was established The MS MUST support <unjoin> for any stream that was established
using <join> and has not already been removed by a previous <unjoin> using <join> and has not already been removed by a previous <unjoin>
on the same stream. on the same stream.
If the MS is unable to terminate any join as specified in <stream> If the MS is unable to terminate the join as specified in <stream>
elements, the MS MUST report an error (407) and MUST NOT terminate elements because a <stream> element is in conflict with (a) another
the join between the entities. <stream> element, (b) with specified connection or conference media
capabilities or (c) with a SDP label value as part of the
connection-id (see Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework]), then the MS reports an
error (407) and MUST NOT terminate the join between the entities and
MUST NOT change existing streams of the entities.
If the specified entities are not already joined, then the MS MUST If the MS is unable to terminate the join as specified in <stream>
report an error (409). elements because the MS does not support the media stream
configuration, the MS reports an error (422) and MUST NOT terminate
the join between the entities and MUST NOT change existing streams of
the entities.
If the specified entities are not already joined, then the MS reports
an error (409).
If the MS is unable to terminate the join between the specified If the MS is unable to terminate the join between the specified
entities for any other reason, the MS MUST report an error (411). entities for any other reason, the MS reports an error (411).
When an MS has successfully processed a <unjoin> request, it MUST When an MS has successfully processed a <unjoin> request, it MUST
reply with a successful <response> element (Section 5.2.3). reply with a successful <response> element (Section 4.2.3).
5.2.2.5. <stream> 4.2.2.5. <stream>
<join>, <modifyjoin> and <unjoin> require the identification and <join>, <modifyjoin> and <unjoin> require the identification and
manipulations of media streams. Media streams represent the flow of manipulations of media streams. Media streams represent the flow of
media between a participant connection and a conference, between two media between a participant connection and a conference, between two
connections, or between two conferences. The <stream> element is connections, or between two conferences. The <stream> element is
used (as a child to <join>, <modifyjoin> and <unjoin) to identify the used (as a child to <join>, <modifyjoin> and <unjoin) to identify the
media stream(s) for the request and to specify the configuration of media stream(s) for the request and to specify the configuration of
the media stream. the media stream.
The <stream> element has the following attributes: The <stream> element has the following attributes:
media: a string indicating the type of media associated with the media: a string indicating the type of media associated with the
stream. It is strongly recommended that the following values are stream. The following values MUST be used for common types of
used for common types of media: "audio" for audio media, and media: "audio" for audio media, and "video" for video media. The
"video" for video media. The attribute is mandatory. attribute is mandatory.
label: a string indicating the SDP label associated with a media label: a string indicating the SDP label associated with a media
stream ([RFC4574]). The attribute is optional. stream ([RFC4574]). The attribute is optional.
direction: a string indicating the allowed media flow of the stream direction: a string indicating the allowed media flow of the stream
relative to the value of the "id1" attribute of the parent relative to the value of the "id1" attribute of the parent
element. Defined values are: "sendrecv" (media can be sent and element. Defined values are: "sendrecv" (media can be sent and
received), "sendonly" (media can only be sent), "recvonly" (media received), "sendonly" (media can only be sent), "recvonly" (media
can only be received) and "inactive" (stream established but no can only be received) and "inactive" (stream established but no
media flow). The default value is "sendrecv". The attribute is media flow). The default value is "sendrecv". The attribute is
optional. optional.
The <stream> element has the following sequence of child elements: The <stream> element has the following sequence of child elements:
<volume>: an element (Section 5.2.2.5.1) to configure the volume or <volume>: an element (Section 4.2.2.5.1) to configure the volume or
gain of the media stream. The element is optional. gain of the media stream. The element is optional.
<clamp>: an element (Section 5.2.2.5.2) to configure filtering and <clamp>: an element (Section 4.2.2.5.2) to configure filtering and
removal of tones from the media stream. The element is optional. removal of tones from the media stream. The element is optional.
<region>: an element (Section 5.2.2.5.3) to configure a region <region>: an element (Section 4.2.2.5.3) to configure a region
within a video layout where the media stream is displayed. The within a video layout where the media stream is displayed. The
element is optional. element is optional.
<priority>: an element (Section 5.2.2.5.4) to configure priority <priority>: an element (Section 4.2.2.5.4) to configure priority
associated with the stream in the media mix. The element is associated with the stream in the media mix. The element is
optional. optional.
In each child element, the media stream affected is from the value of In each child element, the media stream affected is indicated by the
the "id1" attribute of the parent element. value of the direction attribute of the parent element.
If the "media" attribute does not have the value of "audio", then the If the "media" attribute does not have the value of "audio", then the
MS MUST ignored <volume> and <clamp> elements. MS ignores <volume> and <clamp> elements.
If the "media" attribute does not have the value of "video", then the If the "media" attribute does not have the value of "video", then the
MS MUST ignored <region> element. MS ignores a <region> element.
5.2.2.5.1. <volume> For example, a request to join a connection to conference in both
directions with volume control:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<join id1="1536067209~913cd14c" id2="conference1">
<stream type="audio" direction="sendrecv">
<volume controltype="setgain" value="-3"/>
</stream>
</join>
</mscmixer>
where audio flow from the connection (id1) to the conference (id2)
has the volume lowered by 3dB, and likewise the volume of the audio
flow from the conference to the connection is lowered by 3 dB.
In this example, the volume is independently controlled for each
direction.
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<join id1="1536067209~913cd14c" id2="conference1">
<stream type="audio" direction="sendonly">
<volume controltype="setgain" value="-3"/>
</stream>
<stream type="audio" direction="recvonly">
<volume controltype="setgain" value="+3"/>
</stream>
</join>
</mscmixer>
where audio flow from the connection (id1) to the conference (id2)
has the volume lowered by 3dB, but the volume of the audio flow from
the conference to the connection is raised by 3 dB.
4.2.2.5.1. <volume>
The <volume> element is used to configure the volume of an audio The <volume> element is used to configure the volume of an audio
media stream. It may be set to a specific gain amount, to media stream. It can be set to a specific gain amount, to
automatically adjust the gain to a desired target level, or to mute automatically adjust the gain to a desired target level, or to mute
the volume. the volume.
The <volume> element has no child elements but has the following The <volume> element has no child elements but has the following
attributes: attributes:
controltype: a string indicating the type of volume control to use controltype: a string indicating the type of volume control to use
for the stream. Defined values are: "automatic" (the volume will for the stream. Defined values are: "automatic" (the volume will
be adjusted automatically to the level specified by the "value" be adjusted automatically to the level specified by the "value"
attribute), "setgain" (use the value of the "value" attribute as a attribute), "setgain" (use the value of the "value" attribute as a
specific gain measured in dB to apply), "setstate" (set the state specific gain measured in dB to apply), "setstate" (set the state
of the stream to "mute" or "unmute" as specified by the value of of the stream to "mute" or "unmute" as specified by the value of
the "value" attribute). The attribute is mandatory. the "value" attribute). The attribute is mandatory.
value: a string specifying the amount or state for the volume value: a string specifying the amount or state for the volume
control defined by the value of the "controltype" attribute. The control defined by the value of the "controltype" attribute. The
attribute is optional. There is no default value. attribute is optional. There is no default value.
5.2.2.5.2. <clamp> 4.2.2.5.2. <clamp>
The <clamp> element is used to configure whether tones should be The <clamp> element is used to configure whether tones are filtered
filtered and removed from a media stream. and removed from a media stream.
The <clamp> element has no child elements but has the following The <clamp> element has no child elements but has the following
attributes: attributes:
tones: A space-separated list of the tones to remove. The attribute tones: A space-separated list of the tones to remove. The attribute
is mandatory. is mandatory.
5.2.2.5.3. <region> 4.2.2.5.3. <region>
The <region> element is used to explicitly specify the region within The <region> element is used to explicitly specify the region within
a video layout where the media stream is displayed. a video layout where the media stream is displayed.
The <region> element has no attributes and its content model The <region> element has no attributes and its content model
specifies the name of the region layout. specifies the name of the region layout.
5.2.2.5.4. <priority> 4.2.2.5.4. <priority>
The <priority> element is used to explicitly specify the priority of The <priority> element is used to explicitly specify the priority of
a participant. The MS uses this priority to determine where the a participant. The MS uses this priority to determine where the
media stream is displayed within a video layout media stream is displayed within a video layout
(Section 5.2.1.4.3.1). (Section 4.2.1.4.3.1).
The <priority> element has no attributes and its content model The <priority> element has no attributes and its content model
specifies a positive integer (see Section 5.7.3). The lower the specifies a positive integer (see Section 4.7.3). The lower the
value, the higher the priority. value, the higher the priority.
5.2.3. <response> 4.2.3. <response>
Responses to requests are indicated by a <response> element. Responses to requests are indicated by a <response> element.
The <response> element has following attributes: The <response> element has following attributes:
status: numeric code indicating the response status. Valid values status: numeric code indicating the response status. Valid values
are defined in Section 5.6. The attribute is mandatory. are defined in Section 4.6. The attribute is mandatory.
reason: string specifying a reason for the response status. The reason: string specifying a reason for the response status. The
attribute is optional. attribute is optional.
conferenceid: string identifying the conference (see Section 17.1 of conferenceid: string identifying the conference (see Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework]). The attribute is [I-D.ietf-mediactrl-sip-control-framework]). The attribute is
optional. optional.
connectionid: string identifying the SIP dialog connection (see connectionid: string identifying the SIP dialog connection (see
Section 17.1 of [I-D.ietf-mediactrl-sip-control-framework]). The Section 17.1 of [I-D.ietf-mediactrl-sip-control-framework]). The
skipping to change at page 36, line 9 skipping to change at page 37, line 42
<reason>Success</reason> <reason>Success</reason>
</response> </response>
The response if conference creation failed due to the requested The response if conference creation failed due to the requested
conference id already existing: conference id already existing:
<response code="403"> <response code="403">
<reason>Conf already exists</reason> <reason>Conf already exists</reason>
</response> </response>
5.2.4. <event> 4.2.4. <event>
When a mixer generates a notification event, the MS sends the event When a mixer generates a notification event, the MS sends the event
using an <event> element. using an <event> element.
The <event> element has no attributes, but has the following sequence The <event> element has no attributes, but has the following sequence
of child elements (0 or more instances of each child): of child elements (0 or more instances of each child):
<active-talkers-notify> specifies an active talkers notification <active-talkers-notify> specifies an active talkers notification
(Section 5.2.4.1). (Section 4.2.4.1).
<unjoin-notify> notifies that a connection or conference has been <unjoin-notify> notifies that a connection or conference has been
completely unjoined (Section 5.2.4.2). completely unjoined (Section 4.2.4.2).
<conferenceexit> notifies that a conference has exited <conferenceexit> notifies that a conference has exited
(Section 5.2.4.3). (Section 4.2.4.3).
5.2.4.1. <active-talkers-notify> 4.2.4.1. <active-talkers-notify>
The <active-talkers-notify> element describes zero or more speakers The <active-talkers-notify> element describes zero or more speakers
that have been active in a conference during the specified interval that have been active in a conference during the specified interval
(see Section 5.2.1.4.4.1). (see Section 4.2.1.4.4.1).
The <active-talkers-notify> element has the following attributes: The <active-talkers-notify> element has the following attributes:
conferenceid: string indicating the name of the conference from conferenceid: string indicating the name of the conference from
which the event originated. This attribute is mandatory. which the event originated. This attribute is mandatory.
The <active-talkers-notify> element has the following sequence of The <active-talkers-notify> element has the following sequence of
child elements (0 or more occurrence's): child elements (0 or more occurrence's):
<active-talker> element describing an active talker <active-talker> element describing an active talker
(Section 5.2.4.1.1). (Section 4.2.4.1.1).
5.2.4.1.1. <active-talker> 4.2.4.1.1. <active-talker>
The <active-talker> element describes an active talker, associated The <active-talker> element describes an active talker, associated
with either a connection or conference participant in a conference. with either a connection or conference participant in a conference.
The <active-talker> element has the following attributes: The <active-talker> element has the following attributes:
connectionid: string indicating the connectionid of the active connectionid: string indicating the connectionid of the active
talker. This attribute is optional. There is no default value. talker. This attribute is optional. There is no default value.
conferenceid: string indicating the conferenceid of the active conferenceid: string indicating the conferenceid of the active
talker. This attribute is optional. There is no default value. talker. This attribute is optional. There is no default value.
It is an error (400) if both the connectionid and conferenceid It is an error (400) if both the connectionid and conferenceid
attributes are specified. attributes are specified.
The <active-talker> element has no child elements. The <active-talker> element has no child elements.
5.2.4.2. <unjoin-notify> 4.2.4.2. <unjoin-notify>
The <unjoin-notify> element describes a notification event where a The <unjoin-notify> element describes a notification event where a
connection and/or conference have been completely unjoined. connection and/or conference have been completely unjoined.
The <unjoin-notify> element has the following attributes: The <unjoin-notify> element has the following attributes:
status: a status code indicating why the unjoin occurred. A valid status: a status code indicating why the unjoin occurred. A valid
value is a non-negative integer (see Section 5.7.2). A value of 1 value is a non-negative integer (see Section 4.7.2). The MS MUST
indicates that the join has been terminated by a <unjoin> request. support the following values:
A value of 2 indicates that the unjoin occurred because the a
connection or conference has terminated. A value of 3 indicates 0 indicates the join has been terminated by a <unjoin> request.
the join terminated due to an internal error. Any other value
indicates an error defined by the MS. The attribute is mandatory. 1 indicates the join terminated due to an execution error.
2 indicates that the join terminated because a connection or
conference has terminated.
3 Reserved for future use.
4 Reserved for future use.
5 Reserved for future use.
6 Reserved for future use.
7 Reserved for future use.
8 Reserved for future use.
9 Reserved for future use.
The MS MAY define other values. The AS MUST treat any status code
it does not recognize as being equivalent to 1 (join execution
error). The attribute is mandatory.
reason: a textual description providing a reason for the status reason: a textual description providing a reason for the status
code; e.g. details about an error. A valid value is a string (see code; e.g. details about an error. A valid value is a string (see
Section 5.7.4). The attribute is optional. There is no default Section 4.7.4). The attribute is optional. There is no default
value. value.
id1: an identifier for either a connection or a conference. The id1: an identifier for either a connection or a conference. The
identifier MUST conform to the syntax defined in Section 17.1 of identifier MUST conform to the syntax defined in Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [I-D.ietf-mediactrl-sip-control-framework] The attribute is
mandatory. mandatory.
id2: an identifier for either a connection or a conference. The id2: an identifier for either a connection or a conference. The
identifier MUST conform to the syntax defined in Section 17.1 of identifier MUST conform to the syntax defined in Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [I-D.ietf-mediactrl-sip-control-framework] The attribute is
mandatory. mandatory.
The <unjoin-notify> element has no child elements. The <unjoin-notify> element has no child elements.
5.2.4.3. <conferenceexit> 4.2.4.3. <conferenceexit>
The <conferenceexit> element indicates that a conference has exited The <conferenceexit> element indicates that a conference has exited
because it has been terminated or because a error occurred (for because it has been terminated or because a error occurred (for
example, a hardware error in the conference mixing unit). This event example, a hardware error in the conference mixing unit). This event
MUST be sent by the MS whenever a successfully created conference MUST be sent by the MS whenever a successfully created conference
exits. exits.
The <conferenceexit> element has the following attributes: The <conferenceexit> element has the following attributes:
conferenceid: string indicating the name of the conference. This conferenceid: string indicating the name of the conference. This
attribute is mandatory. attribute is mandatory.
status: a status code indicating why the conference exited. A valid status: a status code indicating why the conference exited. A valid
value is a non-negative integer (see Section 5.7.2). A value of 1 value is a non-negative integer (see Section 4.7.2). The MS MUST
indicates that the conference has been terminated by a support the following values:
<destroyconference> request. Any other value indicates an error
defined by the MS. The attribute is mandatory. 0 indicates the conference has been terminated by a
<destroyconference> request.
1 indicates the conference terminated due to an execution error.
2 indicates the conference terminated due to exceeding the
maximum duration for a conference.
3 Reserved for future use.
4 Reserved for future use.
5 Reserved for future use.
6 Reserved for future use.
7 Reserved for future use.
8 Reserved for future use.
9 Reserved for future use.
The MS MAY define other values. The AS MUST treat any status code
it does not recognize as being equivalent to 1 (conference
execution error). The attribute is mandatory.
reason: a textual description providing a reason for the status reason: a textual description providing a reason for the status
code; e.g. details about an error. A valid value is a string (see code; e.g. details about an error. A valid value is a string (see
Section 5.7.4). The attribute is optional. There is no default Section 4.7.4). The attribute is optional. There is no default
value. value.
The <conferenceexit> element has no child elements. The <conferenceexit> element has no child elements.
When a MS sends a <conferenceexit> event, the identifier for the When a MS sends a <conferenceexit> event, the identifier for the
conference (conferenceid attribute) is no longer valid on the MS and conference (conferenceid attribute) is no longer valid on the MS and
can be reused for another conference. can be reused for another conference.
For example, the following notification event would be sent from the For example, the following notification event would be sent from the
MS when the conference with identifier "conference99" exits due to a MS when the conference with identifier "conference99" exits due to a
successful <destroyconference/>: successful <destroyconference/>:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<event> <event>
<conferenceexit conferenceid="conference99" <conferenceexit conferenceid="conference99"
status="1"/> status="0"/>
</event> </event>
</mscmixer> </mscmixer>
5.3. Audit Elements 4.3. Audit Elements
The audit elements defined in this section allow the MS to be audited The audit elements defined in this section allow the MS to be audited
for package capabilities as well as mixers managed by the package. for package capabilities as well as mixers managed by the package.
Auditing is particularly important for two use cases. First, it Auditing is particularly important for two use cases. First, it
enables discovery of package capabilities supported on an MS before enables discovery of package capabilities supported on an MS before
an AS creates a conference mixer or joins connections and an AS creates a conference mixer or joins connections and
conferences. The AS may then use this information to create request conferences. The AS can then use this information to create request
elements using supported capabilities and, in the case of codecs, to elements using supported capabilities and, in the case of codecs, to
negotiate an appropriate SDP for a user agent's connection. Second, negotiate an appropriate SDP for a user agent's connection. Second,
auditing enables discovery of the existence and status of mixers auditing enables discovery of the existence and status of mixers
currently managed by the package on the MS. This allows one AS to currently managed by the package on the MS. This could be used when
take over management of mixers when the AS which initiated the mixers one AS takes over management of mixers if the AS which created the
fails or is no longer available. mixers fails or is no longer available (see Security Considerations
described in Section 7).
5.3.1. <audit> 4.3.1. <audit>
The <audit> request element is sent to the MS to request information The <audit> request element is sent to the MS to request information
about the capabilities of, and mixers currently managed with, this about the capabilities of, and mixers currently managed with, this
control package. Capabilities include supported conference codecs control package. Capabilities include supported conference codecs
and video layouts. Mixer information includes the status of managed and video layouts. Mixer information includes the status of managed
mixers as well as codecs. mixers as well as codecs.
The <audit> element has the following attributes: The <audit> element has the following attributes:
capabilities: indicates whether package capabilities are to be capabilities: indicates whether package capabilities are to be
audited. A valid value is a boolean (see Section 5.7.1). A value audited. A valid value is a boolean (see Section 4.7.1). A value
of true indicates that capability information is to be reported. of true indicates that capability information is to be reported.
A value of false indicates that capability information is not to A value of false indicates that capability information is not to
be reported. The attribute is optional. The default value is be reported. The attribute is optional. The default value is
true. true.
mixers: indicates whether mixers currently managed by the package mixers: indicates whether mixers currently managed by the package
are to be audited. A valid value is a boolean (see are to be audited. A valid value is a boolean (see
Section 5.7.1). A value of true indicates that mixer information Section 4.7.1). A value of true indicates that mixer information
is to be reported. A value of false indicates that mixer is to be reported. A value of false indicates that mixer
information is not to be reported. The attribute is optional. information is not to be reported. The attribute is optional.
The default value is true. The default value is true.
conferenceid: string identifying a specific conference mixer to conferenceid: string identifying a specific conference mixer to
audit. It is an error (406) if the conferenceid attribute is audit. It is an error (406) if the conferenceid attribute is
specified and the conference identifier is not valid. The specified and the conference identifier is not valid. The
attribute is optional. There is no default value. attribute is optional. There is no default value.
If the mixers attribute has the value true and conferenceid attribute If the mixers attribute has the value true and conferenceid attribute
is specified, then only audit information about the specified is specified, then only audit information about the specified
conference mixer is reported. If the mixers attribute has the value conference mixer is reported. If the mixers attribute has the value
false, then no mixer audit information is reported even if a false, then no mixer audit information is reported even if a
conferenceid attribute is specified. conferenceid attribute is specified.
The <audit> element has no child elements. The <audit> element has no child elements.
When the MS receives an <audit> request, it MUST reply with a When the MS receives an <audit> request, it MUST reply with a
<auditresponse> element (Section 5.3.2) which includes a mandatory <auditresponse> element (Section 4.3.2) which includes a mandatory
attribute describing the status in terms of a numeric code. Response attribute describing the status in terms of a numeric code. Response
status codes are defined in Section 5.6. If the request is status codes are defined in Section 4.6. If the request is
successful, the <auditresponse> contains (depending on attribute successful, the <auditresponse> contains (depending on attribute
values) a <capabilities> element (Section 5.3.2.1) reporting package values) a <capabilities> element (Section 4.3.2.1) reporting package
capabilities and a <mixers> element (Section 5.3.2.2) reporting capabilities and a <mixers> element (Section 4.3.2.2) reporting
managed mixer information. If the MS is not able to process the managed mixer information. If the MS is not able to process the
request and carry out the audit operation, the audit request has request and carry out the audit operation, the audit request has
failed and the MS MUST indicate the class of failure using an failed and the MS MUST indicate the class of failure using an
appropriate 4xx response code. Unless an error response code is appropriate 4xx response code. Unless an error response code is
mandated for a specific class of error within this section, specified for a class of error within this section, implementations
implementations follow Section 5.6 in determining the appropriate follow Section 4.6 in determining the appropriate status code for the
status code for the response. response.
For example, a request to audit capabilities and mixers managed by For example, a request to audit capabilities and mixers managed by
the package: the package:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<audit/> <audit/>
</mscmixer> </mscmixer>
In this example, only capabilities are to be audited: In this example, only capabilities are to be audited:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<audit mixers="false"/> <audit mixers="false"/>
</mscmixer> </mscmixer>
With this example, only a specific conference mixer is to be audited: With this example, only a specific conference mixer is to be audited:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<audit capabilities="false" conferenceid="conf4"/> <audit capabilities="false" conferenceid="conf4"/>
</mscmixer> </mscmixer>
5.3.2. <auditresponse> 4.3.2. <auditresponse>
The <auditresponse> element describes a response to a <audit> The <auditresponse> element describes a response to a <audit>
request. request.
The <auditresponse> element has the following attributes: The <auditresponse> element has the following attributes:
status: numeric code indicating the audit response status. The status: numeric code indicating the audit response status. The
attribute is mandatory. Valid values are defined in Section 5.6. attribute is mandatory. Valid values are defined in Section 4.6.
reason: string specifying a reason for the status. The attribute is reason: string specifying a reason for the status. The attribute is
optional. optional.
The <auditresponse> element has the following sequence of child The <auditresponse> element has the following sequence of child
elements: elements:
<capabilities> element (Section 5.3.2.1) describing capabilities of <capabilities> element (Section 4.3.2.1) describing capabilities of
the package. The element is optional. the package. The element is optional.
<mixers> element (Section 5.3.2.2) describing information about <mixers> element (Section 4.3.2.2) describing information about
managed mixers. The element is optional. managed mixers. The element is optional.
For example, a successful response to a <audit> request requesting For example, a successful response to a <audit> request requesting
capabilities and mixer information: capabilities and mixer information:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<auditresponse status="200"> <auditresponse status="200">
<capabilities> <capabilities>
<codecs> <codecs>
<codec> <codec>
skipping to change at page 41, line 37 skipping to change at page 44, line 31
</codecs> </codecs>
</capabilities> </capabilities>
<mixers> <mixers>
<conferenceaudit conferenceid="conf1"> <conferenceaudit conferenceid="conf1">
<codecs> <codecs>
<codec> <codec>
<subtype>PCMA</subtype> <subtype>PCMA</subtype>
</codec> </codec>
</codecs> </codecs>
<participants> <participants>
<participant id="connection1"/> <participant id="1536067209~913cd14c"/>
</participants> </participants>
</conferenceaudit> </conferenceaudit>
<joinaudit id1="connection1" id2="conf1"/> <joinaudit id1="1536067209~913cd14c" id2="conf1"/>
<joinaudit id1="connection2" id2="connection3"/> <joinaudit id1="1636067209~113cd14c" id2="1836067209~313cd14c"/>
<joinaudit id1="connection4" id2="connection5"/> <joinaudit id1="1736067209~213cd14c" id2="1936067209~413cd14c"/>
</mixers> </mixers>
</auditresponse> </auditresponse>
</mscmixer> </mscmixer>
5.3.2.1. <capabilities> 4.3.2.1. <capabilities>
The <capabilities> element provides audit information about package The <capabilities> element provides audit information about package
capabilities. capabilities.
The <capabilities> element has no attributes. The <capabilities> element has no attributes.
The <capabilities> element has the following sequence of child The <capabilities> element has the following sequence of child
elements: elements:
<codecs>: element (Section 5.4) describing codecs available to the <codecs>: element (Section 4.4) describing codecs available to the
package. The element is mandatory. package. The element is mandatory.
For example, a fragment describing capabilities: For example, a fragment describing capabilities:
<capabilities> <capabilities>
<codecs> <codecs>
<codec> <codec>
<subtype>H263</subtype> <subtype>H263</subtype>
</codec> </codec>
<codec> <codec>
skipping to change at page 42, line 30 skipping to change at page 45, line 27
</codec> </codec>
<codec> <codec>
<subtype>PCMU</subtype> <subtype>PCMU</subtype>
</codec> </codec>
<codec> <codec>
<subtype>PCMA</subtype> <subtype>PCMA</subtype>
</codec> </codec>
</codecs> </codecs>
</capabilities> </capabilities>
5.3.2.2. <mixers> 4.3.2.2. <mixers>
The <mixers> element provides audit information about mixers. The <mixers> element provides audit information about mixers.
The <mixers> element has no attributes. The <mixers> element has no attributes.
The <mixers> element has the following sequence of child elements (0 The <mixers> element has the following sequence of child elements (0
or more occurrences, any order): or more occurrences, any order):
<conferenceaudit>: audit information for a conference mixer <conferenceaudit>: audit information for a conference mixer
(Section 5.3.2.2.1). The element is optional. (Section 4.3.2.2.1). The element is optional.
<joinaudit>: audit information for a join mixer (Section 5.3.2.2.2). <joinaudit>: audit information for a join mixer (Section 4.3.2.2.2).
The element is optional. The element is optional.
5.3.2.2.1. <conferenceaudit> 4.3.2.2.1. <conferenceaudit>
The <conferenceaudit> element has the following attributes: The <conferenceaudit> element has the following attributes:
conferenceid: string identifying the conference (see Section 17.1 of conferenceid: string identifying the conference (see Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework]). The attribute is [I-D.ietf-mediactrl-sip-control-framework]). The attribute is
mandatory. mandatory.
The <conferenceaudit> element has the following sequence of child The <conferenceaudit> element has the following sequence of child
elements: elements:
<codecs> element describing codecs used in the conference. See <codecs> element describing codecs used in the conference. See
Section 5.4. The element is optional. Section 4.4. The element is optional.
<participants> element listing connections or conferences joined to <participants> element listing connections or conferences joined to
the conference. See Section 5.3.2.2.1.1. The element is the conference. See Section 4.3.2.2.1.1. The element is
optional. optional.
<video-layout> element describing the active video layout for the <video-layout> element describing the active video layout for the
conference. See Section 5.2.1.4.2.1. The element is optional. conference. See Section 4.2.1.4.2.1. The element is optional.
For example, a fragment describing a conference which has been For example, a fragment describing a conference which has been
created but has no participants: created but has no participants:
<conferenceaudit conferenceid="conference1"/> <conferenceaudit conferenceid="conference1"/>
And a fragment when the same conference has three participants (two And a fragment when the same conference has three participants (two
connections and another conference) joined to it: connections and another conference) joined to it:
<conferenceaudit conferenceid="conference1"> <conferenceaudit conferenceid="conference1">
skipping to change at page 43, line 39 skipping to change at page 46, line 36
<subtype>PCMU</subtype> <subtype>PCMU</subtype>
</codec> </codec>
</codecs> </codecs>
<participants> <participants>
<participant id="connection1"/> <participant id="connection1"/>
<participant id="connection2"/> <participant id="connection2"/>
<participant id="conference2"/> <participant id="conference2"/>
</participants> </participants>
</conferenceaudit> </conferenceaudit>
5.3.2.2.1.1. <participants> 4.3.2.2.1.1. <participants>
The <participants> element is a container for <participant> elements The <participants> element is a container for <participant> elements
(Section 5.3.2.2.1.1.1). (Section 4.3.2.2.1.1.1).
The <participants> element has no attributes, but the following child The <participants> element has no attributes, but the following child
elements are defined (0 or more): elements are defined (0 or more):
<participant>: specifies a participant (Section 5.3.2.2.1.1.1). <participant>: specifies a participant (Section 4.3.2.2.1.1.1).
5.3.2.2.1.1.1. <participant> 4.3.2.2.1.1.1. <participant>
The <participant> element describes a participant. The <participant> element describes a participant.
The <participant> element has the following attributes: The <participant> element has the following attributes:
id: an identifier for either a connection or a conference. The id: an identifier for either a connection or a conference. The
identifier MUST conform to the syntax defined in Section 17.1 of identifier MUST conform to the syntax defined in Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework]. The attribute is [I-D.ietf-mediactrl-sip-control-framework]. The attribute is
mandatory. mandatory.
The <participant> element has no children. The <participant> element has no children.
5.3.2.2.2. <joinaudit> 4.3.2.2.2. <joinaudit>
The <joinaudit> element has the following attributes: The <joinaudit> element has the following attributes:
id1: an identifier for either a connection or a conference. The id1: an identifier for either a connection or a conference. The
identifier MUST conform to the syntax defined in Section 17.1 of identifier MUST conform to the syntax defined in Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [I-D.ietf-mediactrl-sip-control-framework] The attribute is
mandatory. mandatory.
id2: an identifier for either a connection or a conference. The id2: an identifier for either a connection or a conference. The
identifier MUST conform to the syntax defined in Section 17.1 of identifier MUST conform to the syntax defined in Section 17.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [I-D.ietf-mediactrl-sip-control-framework] The attribute is
mandatory. mandatory.
The <joinaudit> element has no children. The <joinaudit> element has no children.
For example, a fragment describing an audit of two join mixers, one For example, a fragment describing an audit of two join mixers, one
between connections and the second between conferences: between connections and the second between conferences:
<mixers> <mixers>
<joinaudit id1="connection1" id2="connection2"/> <joinaudit id1="1536067209~913cd14" id2="1636067209~413cd14"/>
<joinaudit id1="conference1" id2="conference2"/> <joinaudit id1="conference1" id2="conference2"/>
</mixers> </mixers>
5.4. <codecs> 4.4. <codecs>
The <codecs> element is a container for one or more codec The <codecs> element is a container for one or more codec
definitions. Codec definitions are used by an AS to specify the definitions. Codec definitions are used by an AS to specify the
codecs allowed for a conference (e.g. when used as a child of codecs allowed for a conference (e.g. when used as a child of
<createconference> or <modifyconference). Codec definitions are used <createconference> or <modifyconference). Codec definitions are used
by an MS to provide audit information about the codecs supported by by an MS to provide audit information about the codecs supported by
an MS and used in specific conferences. an MS and used in specific conferences.
The <codecs> element has no attributes. The <codecs> element has no attributes.
The <codecs> element has the following sequence of child elements (0 The <codecs> element has the following sequence of child elements (0
or more occurrences): or more occurrences):
<codec>: defines a codec and optionally its policy(Section 5.4.1). <codec>: defines a codec and optionally its policy(Section 4.4.1).
The element is optional. The element is optional.
For example, a fragment describing two codecs: For example, a fragment describing two codecs:
<codecs> <codecs>
<codec> <codec>
<subtype>PCMA</subtype> <subtype>PCMA</subtype>
</codec> </codec>
<codec> <codec>
<subtype>H263</subtype> <subtype>H263</subtype>
</codec> </codec>
</codecs> </codecs>
5.4.1. <codec> 4.4.1. <codec>
The <codec> element describes a codec. The element is modeled on the The <codec> element describes a codec. The element is modeled on the
<codec> element in the XCON conference information data model <codec> element in the XCON conference information data model
([I-D.ietf-xcon-common-data-model]) and allows addition information ([I-D.ietf-xcon-common-data-model]) and allows addition information
(e.g. rate, speed, etc) to be specified. (e.g. rate, speed, etc) to be specified.
The <codecs> element has no attributes. The <codecs> element has no attributes.
The <codecs> element has the following sequence of child elements: The <codecs> element has the following sequence of child elements:
<subtype>: element describing the codec's name. The possible values <subtype>: element describing the codec's name. The possible values
of this element are the values of the 'subtype' column of the RTP of this element are the values of the 'subtype' column of the RTP
Payload Format media types per [RFC4855] defined in IANA ([IANA]). Payload Format media types per [RFC4855] defined in IANA ([IANA]).
The element is mandatory. The element is mandatory.
<params>: element (Section 5.5) describing additional information <params>: element (Section 4.5) describing additional information
about the codec. This package is agnostic to the names and values about the codec. This package is agnostic to the names and values
of the codec parameters supported by an implementation. The of the codec parameters supported by an implementation. The
element is optional. element is optional.
For example, a fragment with a <codec> element describing the H263 For example, a fragment with a <codec> element describing the H263
codec: codec:
<codec> <codec>
<subtype>H263</subtype> <subtype>H263</subtype>
</codec> </codec>
5.5. <params> 4.5. <params>
The <params> element is a container for <param> elements The <params> element is a container for <param> elements
(Section 5.5.1). (Section 4.5.1).
The <params> element has no attributes, but the following child The <params> element has no attributes, but the following child
elements are defined (0 or more): elements are defined (0 or more):
<param>: specifies a parameter name and value (Section 5.5.1). <param>: specifies a parameter name and value (Section 4.5.1).
5.5.1. <param> 4.5.1. <param>
The <param> element describes a parameter name and value. The <param> element describes a parameter name and value.
The <param> element has the following attributes: The <param> element has the following attributes:
name: a string indicating the name of the parameter. The attribute name: a string indicating the name of the parameter. The attribute
is mandatory. is mandatory.
type: specifies a type indicating how the inline value of the type: specifies a type indicating how the inline value of the
parameter is to be interpreted. A valid value is a MIME media parameter is to be interpreted. A valid value is a MIME media
type (see Section 5.7.6). The attribute is optional. The default type (see Section 4.7.6). The attribute is optional. The default
value is "text/plain". value is "text/plain".
The <param> element content model is the value of the parameter. The <param> element content model is the value of the parameter.
Note that a value which contains XML characters (e.g. "<") needs to Note that a value which contains XML characters (e.g. "<") needs to
be escaped following standard XML conventions. be escaped following standard XML conventions.
5.6. Response Status Codes 4.6. Response Status Codes
This section describes the response codes in Table 1 for the status This section describes the response codes in Table 1 for the status
attribute of mixer management <response> (Section 5.2.3) and audit attribute of mixer management <response> (Section 4.2.3) and audit
<auditresponse> (Section 5.3.2) responses. The MS MUST support these <auditresponse> (Section 4.3.2) responses. The MS MUST support these
status response codes. The MS MAY support other response codes. The status response codes. The MS MAY support other response codes. The
AS MUST treat any responses it does not recognize as being equivalent AS MUST treat any responses it does not recognize as being equivalent
to the x00 response code for all classes. For example, if an AS to the x00 response code for all classes. For example, if an AS
receives an unrecognized response code of 499, it can safely assume receives an unrecognized response code of 499, it can safely assume
that there was something wrong with its request and treat the that there was something wrong with its request and treat the
response as if it had received a 400 (Syntax error) response code. response as if it had received a 400 (Syntax error) response code.
4xx responses are definite failure responses from a particular MS. 4xx responses are definite failure responses from a particular MS.
The reason attribute in the response SHOULD identify the failure in The reason attribute in the response SHOULD identify the failure in
more detail, for example, "Mandatory attribute missing: id2 join more detail, for example, "Mandatory attribute missing: id2 join
skipping to change at page 47, line 33 skipping to change at page 50, line 27
+-------+---------------+----------------------+--------------------+ +-------+---------------+----------------------+--------------------+
| 200 | OK | request has | | | 200 | OK | request has | |
| | | succeeded | | | | | succeeded | |
| | | | | | | | | |
| 400 | Syntax error | request is | Change the request | | 400 | Syntax error | request is | Change the request |
| | | syntactically | so that it is | | | | syntactically | so that it is |
| | | invalid: it is not | syntactically | | | | invalid: it is not | syntactically |
| | | valid with respect | valid. | | | | valid with respect | valid. |
| | | to the XML schema | | | | | to the XML schema | |
| | | specified in | | | | | specified in | |
| | | Section 6 or it | | | | | Section 5 or it | |
| | | violates a | | | | | violates a | |
| | | co-occurrence | | | | | co-occurrence | |
| | | constraint for a | | | | | constraint for a | |
| | | request element | | | | | request element | |
| | | defined in | | | | | defined in | |
| | | Section 5. | | | | | Section 4. | |
| | | | | | | | | |
| 401 | Reserved for | | | | 401 | Reserved for | | |
| | future use | | | | | future use | | |
| | | | | | | | | |
| 402 | Reserved for | | | | 402 | Reserved for | | |
| | future use | | | | | future use | | |
| | | | | | | | | |
| 403 | Reserved for | | | | 403 | Reserved for | | |
| | future use | | | | | future use | | |
| | | | | | | | | |
| 404 | Reserved for | | | | 404 | Reserved for | | |
| | future use | | | | | future use | | |
| | | | |
| 405 | Conference | request uses an | Send an <audit> | | 405 | Conference | request uses an | Send an <audit> |
| | already | identifier to create | request | | | already | identifier to create | request |
| | exists | a new conference | (Section 5.3.1) | | | exists | a new conference | (Section 4.3.1) |
| | | (Section 5.2.1.1) | requesting the | | | | (Section 4.2.1.1) | requesting the |
| | | which is already | list of conference | | | | which is already | list of conference |
| | | used by another | mixer identifiers | | | | used by another | mixer identifiers |
| | | conference on the | already used by | | | | conference on the | already used by |
| | | MS. | the MS and then | | | | MS. | the MS and then |
| | | | use a conference | | | | | use a conference |
| | | | identifier which | | | | | identifier which |
| | | | is not listed. | | | | | is not listed. |
| | | | | | | | | |
| 406 | Conference | request uses an | Send an <audit> | | 406 | Conference | request uses an | Send an <audit> |
| | does not | identifier for a | request | | | does not | identifier for a | request |
| | exist | conference which | (Section 5.3.1) | | | exist | conference which | (Section 4.3.1) |
| | | does not exist on | requesting the | | | | does not exist on | requesting the |
| | | the MS. | list of conference | | | | the MS. | list of conference |
| | | | mixer identifiers | | | | | mixer identifiers |
| | | | used by the MS and | | | | | used by the MS and |
| | | | then use a | | | | | then use a |
| | | | conference | | | | | conference |
| | | | identifier which | | | | | identifier which |
| | | | is listed. | | | | | is listed. |
| | | | | | | | | |
| 407 | Incompatible | request specifies a | Change the media | | 407 | Incompatible | request specifies a | Change the media |
| | stream | media stream | stream | | | stream | media stream | stream |
| | configuration | configuration which | configuration to | | | configuration | configuration which | configuration to |
| | | is in conflict with | match the | | | | is in conflict with | match the |
| | | itself, or the | capabilities of | | | | itself, or the | capabilities of |
| | | connection or | the connection or | | | | connection or | the connection or |
| | | conference | conference | | | | conference | conference |
| | | capabilities (see | | | | | capabilities (see | |
| | | Section 5.2.2.2) | | | | | Section 4.2.2.2) | |
| | | | | | | | | |
| 408 | joining | request attempts to | Send an <audit> | | 408 | joining | request attempts to | Send an <audit> |
| | entities | create a join mixer | request | | | entities | create a join mixer | request |
| | already | (Section 5.2.2.2) | (Section 5.3.1) | | | already | (Section 4.2.2.2) | (Section 4.3.1) |
| | joined | where the entities | requesting the | | | joined | where the entities | requesting the |
| | | are already joined | list of join | | | | are already joined | list of join |
| | | | mixers on the MS | | | | | mixers on the MS |
| | | | and then use | | | | | and then use |
| | | | entities which are | | | | | entities which are |
| | | | not listed. | | | | | not listed. |
| | | | | | | | | |
| 409 | joining | request attempts to | Send an <audit> | | 409 | joining | request attempts to | Send an <audit> |
| | entities not | manipulate a join | request | | | entities not | manipulate a join | request |
| | joined | mixer where entities | (Section 5.3.1) | | | joined | mixer where entities | (Section 4.3.1) |
| | | which are not joined | requesting the | | | | which are not joined | requesting the |
| | | | list of join | | | | | list of join |
| | | | mixers on the MS | | | | | mixers on the MS |
| | | | and then use | | | | | and then use |
| | | | entities which are | | | | | entities which are |
| | | | listed. | | | | | listed. |
| | | | | | | | | |
| 410 | Unable to | request attempts to | | | 410 | Unable to | request attempts to | |
| | join - | join a participant | | | | join - | join a participant | |
| | conference | to a conference | | | | conference | to a conference | |
| | full | (Section 5.2.2.2) | | | | full | (Section 4.2.2.2) | |
| | | but the conference | | | | | but the conference | |
| | | is already full | | | | | is already full | |
| | | | | | | | | |
| 411 | Unable to | request attempts to | | | 411 | Unable to | request attempts to | |
| | perform join | create, modify or | | | | perform join | create, modify or | |
| | mixer | delete a join | | | | mixer | delete a join | |
| | operation | between entities but | | | | operation | between entities but | |
| | | fails | | | | | fails | |
| | | | | | | | | |
| 412 | Reserved for | | | | 412 | Connection | request uses an | |
| | future use | | | | | does not | identifier for a | |
| | exist | connection which | |
| | | does not exist on | |
| | | the MS. | |
| | | | | | | | | |
| 413 | Reserved for | | | | 413 | Reserved for | | |
| | future use | | | | | future use | | |
| | | | | | | | | |
| 414 | Reserved for | | | | 414 | Reserved for | | |
| | future use | | | | | future use | | |
| | | | | | | | | |
| 415 | Reserved for | | | | 415 | Reserved for | | |
| | future use | | | | | future use | | |
| | | | | | | | | |
skipping to change at page 50, line 6 skipping to change at page 53, line 10
| | | | | | | | | |
| 418 | Reserved for | | | | 418 | Reserved for | | |
| | future use | | | | | future use | | |
| | | | | | | | | |
| 419 | Other | requested operation | | | 419 | Other | requested operation | |
| | execution | cannot be executed | | | | execution | cannot be executed | |
| | error | by the MS. | | | | error | by the MS. | |
| | | | | | | | | |
| 420 | Conference | request to create a | | | 420 | Conference | request to create a | |
| | reservation | new conference | | | | reservation | new conference | |
| | failed | (Section 5.2.1.1) | | | | failed | (Section 4.2.1.1) | |
| | | failed due to | | | | | failed due to | |
| | | unsupported | | | | | unsupported | |
| | | reservation of | | | | | reservation of | |
| | | talkers or | | | | | talkers or | |
| | | listeners. | | | | | listeners. | |
| | | | | | | | | |
| 421 | Unable to | request to create or | | | 421 | Unable to | request to create or | |
| | configure | modify a conference | | | | configure | modify a conference | |
| | audio mix | failed due to | | | | audio mix | failed due to | |
| | | unsupported audio | | | | | unsupported audio | |
| | | mix. | | | | | mix. | |
| | | | | | | | | |
| 422 | Unable to | request to create or | | | 422 | Unsupported | request contains one | |
| | create | modify a conference | | | | media stream | or more <stream> | |
| | subscription | failed due to | | | | configuration | elements | |
| | | unsupported | | | | | (Section 4.2.2.5) | |
| | | subscription. | | | | | whose configuration | |
| | | is not supported by | |
| | | the MS. | |
| | | | | | | | | |
| 423 | Unable to | request to create or | | | 423 | Unable to | request to create or | |
| | configure | modify a conference | | | | configure | modify a conference | |
| | video layouts | failed due to | | | | video layouts | failed due to | |
| | | unsupported video | | | | | unsupported video | |
| | | layout | | | | | layout | |
| | | configuration. | | | | | configuration. | |
| | | | | | | | | |
| 424 | Unable to | request to create or | | | 424 | Unable to | request to create or | |
| | configure | modify a conference | | | | configure | modify a conference | |
skipping to change at page 50, line 46 skipping to change at page 54, line 6
| | | switch | | | | | switch | |
| | | configuration. | | | | | configuration. | |
| | | | | | | | | |
| 425 | Unable to | request to create or | | | 425 | Unable to | request to create or | |
| | configure | modify a conference | | | | configure | modify a conference | |
| | codecs | failed due to | | | | codecs | failed due to | |
| | | unsupported codec. | | | | | unsupported codec. | |
| | | | | | | | | |
| 426 | Unable to | request to join | | | 426 | Unable to | request to join | |
| | join - mixing | connection entities | | | | join - mixing | connection entities | |
| | connections | (Section 5.2.2.2) | | | | connections | (Section 4.2.2.2) | |
| | not supported | failed due lack of | | | | not supported | failed due lack of | |
| | | support for mixing | | | | | support for mixing | |
| | | connections. | | | | | connections. | |
| | | | | | | | | |
| 427 | Unable to | request to join | | | 427 | Unable to | request to join | |
| | join - mixing | conference entities | | | | join - mixing | conference entities | |
| | conferences | (Section 5.2.2.2) | | | | conferences | (Section 4.2.2.2) | |
| | not supported | failed due lack of | | | | not supported | failed due lack of | |
| | | support for mixing | | | | | support for mixing | |
| | | conferences. | | | | | conferences. | |
| | | | | | | | | |
| 428 | Unsupported | the request contains | | | 428 | Unsupported | the request contains | |
| | foreign | attributes or | | | | foreign | attributes or | |
| | namespace | elements from | | | | namespace | elements from | |
| | attribute or | another namespace | | | | attribute or | another namespace | |
| | element | which the MS does | | | | element | which the MS does | |
| | | not support | | | | | not support | |
skipping to change at page 51, line 44 skipping to change at page 55, line 5
| | future use | | | | | future use | | |
| | | | | | | | | |
| 435 | Other | request requires | | | 435 | Other | request requires | |
| | unsupported | another capability | | | | unsupported | another capability | |
| | capability | not supported by the | | | | capability | not supported by the | |
| | | MS | | | | | MS | |
+-------+---------------+----------------------+--------------------+ +-------+---------------+----------------------+--------------------+
Table 1: status codes Table 1: status codes
5.7. Type Definitions 4.7. Type Definitions
This section defines types referenced in attribute definitions. This section defines types referenced in attribute definitions.
5.7.1. Boolean 4.7.1. Boolean
The value space of boolean is the set {true, false}. The value space of boolean is the set {true, false}.
5.7.2. Non-Negative Integer 4.7.2. Non-Negative Integer
The value space of non-negative integer is the infinite set The value space of non-negative integer is the infinite set
{0,1,2,...}. {0,1,2,...}.
5.7.3. Positive Integer 4.7.3. Positive Integer
The value space of positive integer is the infinite set {1,2,...}. The value space of positive integer is the infinite set {1,2,...}.
5.7.4. String 4.7.4. String
A string in the character encoding associated with the XML element. A string in the character encoding associated with the XML element.
5.7.5. Time Designation 4.7.5. Time Designation
A time designation consists of a non-negative real number followed by A time designation consists of a non-negative real number followed by
a time unit identifier. a time unit identifier.
The time unit identifiers are: "ms" (milliseconds) and "s" (seconds). The time unit identifiers are: "ms" (milliseconds) and "s" (seconds).
Examples include: "3s", "850ms", "0.7s", ".5s" and "+1.5s". Examples include: "3s", "850ms", "0.7s", ".5s" and "+1.5s".
5.7.6. MIME Media Type 4.7.6. MIME Media Type
A string formated as a IANA MIME media type ([MIME.mediatypes]). A string formated as a IANA MIME media type ([MIME.mediatypes]).
6. Formal Syntax 5. Formal Syntax
This section defines the XML schema for the Mixer Control Package. This section defines the XML schema for the Mixer Control Package.
The schema defines datatypes, attributes, and mixer elements in the The schema defines datatypes, attributes, and mixer elements in the
urn:ietf:params:xml:ns:msc-mixer namespace. In most elements the urn:ietf:params:xml:ns:msc-mixer namespace. In most elements the
order of child elements is significant. The schema is extensible: order of child elements is significant. The schema is extensible:
elements allow attributes and child elements from other namespaces. elements allow attributes and child elements from other namespaces.
Elements from outside this package's namespace can occur after Elements from outside this package's namespace can occur after
elements defined in this package. elements defined in this package.
skipping to change at page 53, line 30 skipping to change at page 56, line 30
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<xsd:schema targetNamespace="urn:ietf:params:xml:ns:msc-mixer" <xsd:schema targetNamespace="urn:ietf:params:xml:ns:msc-mixer"
xmlns:fw="urn:ietf:params:xml:ns:control:framework-attributes" xmlns:fw="urn:ietf:params:xml:ns:control:framework-attributes"
elementFormDefault="qualified" elementFormDefault="qualified"
xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns="urn:ietf:params:xml:ns:msc-mixer" xmlns="urn:ietf:params:xml:ns:msc-mixer"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"> xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:annotation> <xsd:annotation>
<xsd:documentation> <xsd:documentation>
IETF MediaCtrl Mixer 1.0 (20081010) IETF MediaCtrl Mixer 1.0 (20081103)
This is the schema of the Mixer control package. It This is the schema of the Mixer control package. It
defines request, response and notification elements for defines request, response and notification elements for
mixing. mixing.
The schema namespace is urn:ietf:params:xml:ns:msc-mixer The schema namespace is urn:ietf:params:xml:ns:msc-mixer
</xsd:documentation> </xsd:documentation>
</xsd:annotation> </xsd:annotation>
skipping to change at page 55, line 18 skipping to change at page 58, line 18
<xsd:element ref="unjoin" /> <xsd:element ref="unjoin" />
<xsd:element ref="modifyjoin" /> <xsd:element ref="modifyjoin" />
<xsd:element ref="response" /> <xsd:element ref="response" />
<xsd:element ref="event" /> <xsd:element ref="event" />
<xsd:element ref="audit" /> <xsd:element ref="audit" />
<xsd:element ref="auditresponse" /> <xsd:element ref="auditresponse" />
<xsd:any namespace="##other" minOccurs="0" <xsd:any namespace="##other" minOccurs="0"
maxOccurs="unbounded" processContents="lax" /> maxOccurs="unbounded" processContents="lax" />
</xsd:choice> </xsd:choice>
</xsd:sequence> </xsd:sequence>
<xsd:attribute name="version" type="version.datatype"
use="required" />
</xsd:extension> </xsd:extension>
</xsd:complexContent> </xsd:complexContent>
</xsd:complexType> </xsd:complexType>
<xsd:element name="mscmixer" type="mscmixerType" /> <xsd:element name="mscmixer" type="mscmixerType" />
<!-- <!--
##################################################### #####################################################
CONFERENCE MANAGEMENT TYPES CONFERENCE MANAGEMENT TYPES
skipping to change at page 59, line 42 skipping to change at page 62, line 45
<xsd:element name="active-talker" type="activetalkerType" /> <xsd:element name="active-talker" type="activetalkerType" />
<xsd:complexType name="unjoinnotifyType"> <xsd:complexType name="unjoinnotifyType">
<xsd:complexContent> <xsd:complexContent>
<xsd:extension base="Tcore"> <xsd:extension base="Tcore">
<xsd:sequence> <xsd:sequence>
<xsd:any namespace="##other" minOccurs="0" <xsd:any namespace="##other" minOccurs="0"
maxOccurs="unbounded" processContents="lax" /> maxOccurs="unbounded" processContents="lax" />
</xsd:sequence> </xsd:sequence>
<xsd:attribute name="status" type="status.datatype" <xsd:attribute name="status" type="xsd:nonNegativeInteger"
use="required" /> use="required" />
<xsd:attribute name="reason" type="xsd:string" /> <xsd:attribute name="reason" type="xsd:string" />
<xsd:attribute name="id1" type="xsd:string" <xsd:attribute name="id1" type="xsd:string"
use="required" /> use="required" />
<xsd:attribute name="id2" type="xsd:string" <xsd:attribute name="id2" type="xsd:string"
use="required" /> use="required" />
</xsd:extension> </xsd:extension>
</xsd:complexContent> </xsd:complexContent>
</xsd:complexType> </xsd:complexType>
skipping to change at page 63, line 16 skipping to change at page 66, line 18
<xsd:restriction base="xsd:positiveInteger" /> <xsd:restriction base="xsd:positiveInteger" />
</xsd:simpleType> </xsd:simpleType>
<xsd:element name="priority" type="priorityType" /> <xsd:element name="priority" type="priorityType" />
<xsd:complexType name="audiomixingType"> <xsd:complexType name="audiomixingType">
<xsd:complexContent> <xsd:complexContent>
<xsd:extension base="Tcore"> <xsd:extension base="Tcore">
<xsd:attribute name="type" type="audiomix.datatype" <xsd:attribute name="type" type="audiomix.datatype"
default="nbest" /> default="nbest" />
<xsd:attribute name="n" type="xsd:nonNegativeInteger"
default="0" />
</xsd:extension> </xsd:extension>
</xsd:complexContent> </xsd:complexContent>
</xsd:complexType> </xsd:complexType>
<xsd:element name="audio-mixing" type="audiomixingType" /> <xsd:element name="audio-mixing" type="audiomixingType" />
<!-- video-switch --> <!-- video-switch -->
<xsd:complexType name="videoswitchType"> <xsd:complexType name="videoswitchType">
<xsd:complexContent> <xsd:complexContent>
skipping to change at page 69, line 21 skipping to change at page 72, line 26
<xsd:element name="param" type="paramType" /> <xsd:element name="param" type="paramType" />
<!-- <!--
#################################################### ####################################################
DATATYPES DATATYPES
#################################################### ####################################################
--> -->
<xsd:simpleType name="version.datatype">
<xsd:restriction base="xsd:NMTOKEN">
<xsd:enumeration value="1.0" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="eventname.datatype"> <xsd:simpleType name="eventname.datatype">
<xsd:restriction base="xsd:NMTOKEN"> <xsd:restriction base="xsd:NMTOKEN">
<xsd:pattern value="[a-zA-Z0-9\.]+" /> <xsd:pattern value="[a-zA-Z0-9\.]+" />
</xsd:restriction> </xsd:restriction>
</xsd:simpleType> </xsd:simpleType>
<xsd:simpleType name="audiomix.datatype"> <xsd:simpleType name="audiomix.datatype">
<xsd:restriction base="xsd:NMTOKEN"> <xsd:restriction base="xsd:NMTOKEN">
<xsd:enumeration value="nbest" /> <xsd:enumeration value="nbest" />
<xsd:enumeration value="controller" /> <xsd:enumeration value="controller" />
skipping to change at page 70, line 38 skipping to change at page 74, line 4
<xsd:simpleType name="volumecontroltype.datatype"> <xsd:simpleType name="volumecontroltype.datatype">
<xsd:restriction base="xsd:NMTOKEN"> <xsd:restriction base="xsd:NMTOKEN">
<xsd:enumeration value="automatic" /> <xsd:enumeration value="automatic" />
<xsd:enumeration value="setgain" /> <xsd:enumeration value="setgain" />
<xsd:enumeration value="setstate" /> <xsd:enumeration value="setstate" />
</xsd:restriction> </xsd:restriction>
</xsd:simpleType> </xsd:simpleType>
</xsd:schema> </xsd:schema>
Figure 10: Mixer Package XML Schema Figure 10: Mixer Package XML Schema
7. Examples 6. Examples
This section provides examples of the Mixer Control package. This section provides examples of the Mixer Control package.
7.1. AS-MS Framework Interaction Examples 6.1. AS-MS Framework Interaction Examples
The following example assume a control channel has been established The following example assume a control channel has been established
and synced as described in the Media Control Channel Framework and synced as described in the Media Control Channel Framework
([I-D.ietf-mediactrl-sip-control-framework]). ([I-D.ietf-mediactrl-sip-control-framework]).
The XML messages are in angled brackets (with the root <mscmixer> and The XML messages are in angled brackets (with the root <mscmixer> and
other details omitted for clarity); the REPORT status is in round other details omitted for clarity); the REPORT status is in round
brackets. Other aspects of the protocol are omitted for readability. brackets. Other aspects of the protocol are omitted for readability.
7.1.1. Creating a conference mixer and joining a participant 6.1.1. Creating a conference mixer and joining a participant
A conference mixer is created successfully and a participant is A conference mixer is created successfully and a participant is
joined. joined.
Application Server (AS) Media Server (MS) Application Server (AS) Media Server (MS)
| | | |
| (1) CONTROL: <createconference> | | (1) CONTROL: <createconference> |
| ----------------------------------------> | | ----------------------------------------> |
| | | |
| (2) 202 | | (2) 202 |
skipping to change at page 72, line 5 skipping to change at page 76, line 5
| (6) 202 | | (6) 202 |
| <--------------------------------------- | | <--------------------------------------- |
| | | |
| (7) REPORT: <response status="200"/> | | (7) REPORT: <response status="200"/> |
| (terminate) | | (terminate) |
| <---------------------------------------- | | <---------------------------------------- |
| | | |
| (8) 200 | | (8) 200 |
| ----------------------------------------> | | ----------------------------------------> |
7.1.2. Receiving active talker notifications 6.1.2. Receiving active talker notifications
An active talker notification event is sent by the MS. An active talker notification event is sent by the MS.
Application Server (AS) Media Server (MS) Application Server (AS) Media Server (MS)
| | | |
| (1) CONTROL: <event ...> | | (1) CONTROL: <event ...> |
| <--------------------------------------- | | <--------------------------------------- |
| | | |
| (4) 200 | | (4) 200 |
| ----------------------------------------> | | ----------------------------------------> |
| | | |
7.1.3. Conference termination 6.1.3. Conference termination
The MS receives a request to terminate the conference, resulting in The MS receives a request to terminate the conference, resulting in
conferenceexit and participant unjoined notifications. conferenceexit and participant unjoined notifications.
Application Server (AS) Media Server (MS) Application Server (AS) Media Server (MS)
| | | |
| (1) CONTROL: <destroyconference> | | (1) CONTROL: <destroyconference> |
| ----------------------------------------> | | ----------------------------------------> |
| | | |
| (2) 200: <response status="200"/> | | (2) 200: <response status="200"/> |
skipping to change at page 72, line 45 skipping to change at page 76, line 45
| (4) 200 | | (4) 200 |
| ----------------------------------------> | | ----------------------------------------> |
| | | |
| (5) CONTROL: <event ..> | | (5) CONTROL: <event ..> |
| (conferenceexit) | | (conferenceexit) |
| <---------------------------------------- | | <---------------------------------------- |
| | | |
| (6) 200 | | (6) 200 |
| ----------------------------------------> | | ----------------------------------------> |
7.2. Mixing Examples 6.2. Mixing Examples
The following examples show how the mixing package can be used to The following examples show how the mixing package can be used to
create audio conferences, bridge connections and video conferences. create audio conferences, bridge connections and video conferences.
The examples do not specify all messages between the AS and MS. The examples do not specify all messages between the AS and MS.
7.2.1. Audio conferencing 6.2.1. Audio conferencing
The AS sends a request to create a conference mixer: The AS sends a request to create a conference mixer:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<createconference conferenceid="conf1" <createconference conferenceid="conf1"
reserved-talkers="2" reserved-listeners="3"> reserved-talkers="2" reserved-listeners="3">
<audio-mixing type="nbest"/> <audio-mixing type="nbest"/>
<subscribe> <subscribe>
<active-talkers-sub interval="5"/> <active-talkers-sub interval="5"/>
</subscribe> </subscribe>
skipping to change at page 75, line 16 skipping to change at page 79, line 16
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<response status="200" conferenceid="conf1"/> <response status="200" conferenceid="conf1"/>
</mscmixer> </mscmixer>
For each participant attached to the conference when it is destroyed, For each participant attached to the conference when it is destroyed,
the MS sends an unjoin notification event: the MS sends an unjoin notification event:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<event> <event>
<unjoin-notify status="1" id1="9936067209~914cd14c" <unjoin-notify status="2" id1="9936067209~914cd14c"
id2="conf1"/> id2="conf1"/>
</event> </event>
</mscmixer> </mscmixer>
And the MS sends a conferenceexit notification event when the And the MS sends a conferenceexit notification event when the
conference finally exits: conference finally exits:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<event> <event>
<conferenceexit status="1" conferenceid="conf1"/> <conferenceexit status="0" conferenceid="conf1"/>
</event> </event>
</mscmixer> </mscmixer>
7.2.2. Bridging connections 6.2.2. Bridging connections
The mixer package may be used to join connections to one another. In The mixer package can be used to join connections to one another. In
a call center scenario, for example, this package can be used to set a call center scenario, for example, this package can be used to set
up and modify connections between a caller, agent and supervisor. up and modify connections between a caller, agent and supervisor.
A caller is joined to an agent with bi-directional audio: A caller is joined to an agent with bi-directional audio:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<join id1="caller~001" id2="agent~002"> <join id1="caller~001" id2="agent~002">
<stream media="audio" direction="sendrecv"/> <stream media="audio" direction="sendrecv"/>
</join> </join>
</mscmixer> </mscmixer>
If the MS is able to establish this connection, then it would send a If the MS is able to establish this connection, then it would send a
200 response: 200 response:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<response status="200"/> <response status="200"/>
</mscmixer> </mscmixer>
Now assume that the AS wants a supervisor to listen into the agent Now assume that the AS wants a supervisor to listen into the agent
conversation with the caller and provide whsipered guidance to the conversation with the caller and provide whispered guidance to the
agent. First the AS would send a request to join the supervisor and agent. First the AS would send a request to join the supervisor and
the caller connections: the caller connections:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<join id1="supervisor~003" id2="caller~001"> <join id1="supervisor~003" id2="caller~001">
<stream media="audio" direction="recvonly"/> <stream media="audio" direction="recvonly"/>
</join> </join>
</mscmixer> </mscmixer>
If this request was successful, audio output from the caller If this request was successful, audio output from the caller
skipping to change at page 76, line 32 skipping to change at page 80, line 32
<stream media="audio" direction="sendrecv"/> <stream media="audio" direction="sendrecv"/>
</join> </join>
</mscmixer> </mscmixer>
If this request was successful, the audio mixing would occur on both If this request was successful, the audio mixing would occur on both
the agent and supervisor connections: the agent would hear the caller the agent and supervisor connections: the agent would hear the caller
and supervisor, and the supervisor would hear the agent and caller. and supervisor, and the supervisor would hear the agent and caller.
The caller would only hear the agent. If the MS is unable to join The caller would only hear the agent. If the MS is unable to join
and mix connections in this way, it would send a 426 response. and mix connections in this way, it would send a 426 response.
7.2.3. Video conferencing 6.2.3. Video conferencing
In this example, an audio video-conference is created with the In this example, an audio video-conference is created with the
loudest participant has the most prominent region in the video loudest participant has the most prominent region in the video
layout. layout.
The AS sends a request to create an audio-video conference: The AS sends a request to create an audio-video conference:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<createconference conferenceid="conf2"> <createconference conferenceid="conf2">
<audio-mixing type="nbest"/> <audio-mixing type="nbest"/>
skipping to change at page 78, line 5 skipping to change at page 82, line 5
conference participant to be displayed in region 2: conference participant to be displayed in region 2:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"> <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer">
<modifyjoin id1="1536067209~913cd14c" id2="conf2"> <modifyjoin id1="1536067209~913cd14c" id2="conf2">
<stream media="video"> <stream media="video">
<region>2</region> <region>2</region>
</stream> </stream>
</modifyjoin> </modifyjoin>
</mscmixer> </mscmixer>
8. Security Considerations 7. Security Considerations
As this control package processes XML markup, implementations MUST As this control package processes XML markup, implementations MUST
address the security considerations of [RFC3023]. address the security considerations of [RFC3023].
As a Control Package of the Media Control Channel Framework, As a Control Package of the Media Control Channel Framework,
security, confidentiality and integrity of messages transported over security, confidentiality and integrity of messages transported over
the control channel MUST be addressed as described in Section 11 of the control channel MUST be addressed as described in Section 11 of
the Media Control channel Framework the Media Control channel Framework
([I-D.ietf-mediactrl-sip-control-framework]), including Session ([I-D.ietf-mediactrl-sip-control-framework]), including Transport
Establishment, Transport Level Protection and Control Channel Policy Level Protection, Control Channel Policy Management and Session
Management. Establishment.
Adequate transport protection and authentication are critical,
especially when the implementation is deployed in open networks. If
the implementation fails to correctly address these issues, it risks
exposure to malicious attacks, including (but not limited to):
Denial of Service: An attacker could insert a request message into
the transport stream causing specific conferences or join mixers
on the MS to be destroyed. For example, <destroyconference
conferenceid="XXXX">, where the value of "XXXX" could be guessed
or discovered by auditing active mixers on the MS using an <audit>
request.
Resource Exhaustion: An attacker could insert into the control
channel new request messages (or modify existing ones) with, for
instance, <createconference> elements causing large numbers of
conference mixer resources to be allocated. At some point this
will exhaust the number of conference mixers that the MS is able
to allocate.
The Media Control Channel Framework permits additional policy The Media Control Channel Framework permits additional policy
management, including resource access and control channel usage, to management, including resource access and control channel usage, to
be specified at the control package level beyond that specified for be specified at the control package level beyond that specified for
the Media Control Channel Framework (see Section 11.3 of the Media Control Channel Framework (see Section 11.3 of
[I-D.ietf-mediactrl-sip-control-framework]). [I-D.ietf-mediactrl-sip-control-framework]).
Since creation of conferences and other mixers is associated with Since creation of conferences and other mixers is associated with
media mixing resources on the MS, policy management for this control media mixing resources on the MS, the security policy for this
package MUST address how such mixers are managed across multiple control package needs to address how such mixers are securely managed
control channels. This includes which channels are used to deliver across more than one control channels. The identity of control
mixer event notifications, and whether channels are permitted to channels is determined by the channel identifier: i.e. the value of
originate requests managing a mixer which was not created through the cfw-id attribute in the SDP and Dialog-ID header in the channel
that channel (e.g. a conference mixer has been created via channel X protocol (see [I-D.ietf-mediactrl-sip-control-framework]). Channels
and a request to terminate the conference, or join a participant, are the same if they have the same identifier; otherwise, they are
originates from channel Y). different. This control package imposes the following additional
security policies:
9. IANA Considerations Responses: The MS MUST only send a response to a mixer management or
audit request using the same control channel as the one used to
send the request.
Notifications: The MS MUST only send notification events for a
conference mixer using the same control channel as it received the
request creating the conference mixer.
Auditing: The MS MUST only provide audit information about mixers
which have been created on the same control channel as the one
upon the <audit> request is sent.
Rejection: The MS SHOULD reject requests to audit or manipulate an
existing mixer on the MS if the channel is not the same as the one
used when the mixer was created. The MS rejects a request by
sending a Control Framework 403 response (see Section 7.4 and
Section 11.3 of [I-D.ietf-mediactrl-sip-control-framework]). For
example, if a channel with identifier 'cfw1234' has been used to
send a request to create a particular conference and the MS
receives on channel 'cfw98969' a request to audit or destroy that
conference, then the MS sends a 403 framework response.
There can be valid reasons why an implementation does not reject an
audit or mixer manipulation request on a different channel from the
one which created the mixer. For example, a system administrator
might require a separate channel to audit mixer resources created by
system users and to terminate mixers consuming excessive system
resources. Alternatively, a system monitor or resource broker might
require a separate channel to audit mixers managed by this package on
a MS. However, the full implications need to be understood by the
implementation and carefully weighted before accepting these reasons
as valid. If the reasons are not valid in their particular
circumstances, the MS rejects such requests.
There can also be valid reasons for 'channel handover' including high
availability support or where one AS needs to take over management of
mixers after the AS which created them has failed. This could be
achieved by the control channels using the same channel identifier,
one after another. For example, assume a channel is created with the
identifier 'cfw1234' and the channel is used to create mixers on the
MS. This channel (and associated SIP dialog) then terminates due to
a failure on the AS. As permitted by the Control Framework, the
channel identifier 'cfw1234' could then be reused so that another
channel is created with the same identifier 'cfw1234', allowing it to
'take over' management of the mixers on the MS. Again, the
implementation needs to understand the full implications and
carefully weight them before accepting these reasons as valid. If
the reasons are not valid for their particular circumstances, the MS
uses the appropriate SIP mechanisms to prevent session establishment
when the same channel identifier is used in setting up another
control channel (see Section 4 of
[I-D.ietf-mediactrl-sip-control-framework]).
8. IANA Considerations
This specification instructs IANA to register a new Media Control This specification instructs IANA to register a new Media Control
Channel Framework Package, a new XML namespace and a new MIME type. Channel Framework Package, a new XML namespace and a new MIME type.
9.1. Control Package Registration 8.1. Control Package Registration
Control Package name: msc-mixer/1.0 Control Package name: msc-mixer/1.0
9.2. URN Sub-Namespace Registration 8.2. URN Sub-Namespace Registration
XML namspace: urn:ietf:params:xml:ns:msc-mixer XML namspace: urn:ietf:params:xml:ns:msc-mixer
9.3. MIME Registration 8.3. MIME Registration
Mime type: application/msc-mixer+xml Mime type: application/msc-mixer+xml
10. Change Summary 9. Change Summary
Note to RFC Editor: Please remove this whole section. Note to RFC Editor: Please remove this whole section.
The following are the major changes between the -03 and -02 versions.
o Corrected various typos and nits.
o Conformance language: Removed unnecessary MUSTs, especially for
error codes. Changed most RECOMMENDEDs to MUST or MAY. Removed
lowercase 'should', 'must' and 'may'.
o Tidied up Abstract
o Removed old Introduction section (it just duplicated the
abstract). Replaced it with the old Overview Section. Section
numbering changed!
o Introduction: Clarified which MediaCtrl Requirements are satisfied
by this package.
o 4.2.1.1: <createconference>: Clarified that an attempt to create a
conference with an identifier already used by an existing
conference does not affect the existing conference (405 error
response).
o 4.2.1.4.1: <audio-mixing>: Added a 'n' attribute for the number of
participants to be included in nbest audio mixing.
o 4.2.1.4.3: <video-switch>: Clarified that the active speaker in
video switching is the loudest speaker.
o 4.2.1.4.4: <subscribe>: Clarified that if a subscription specified
in a foreign namespace element or attribute is not supported by
the MS, then the MS generates a 428 error response. Changed
conformance support for <active-talkers-sub> from SHOULD to MUST.
Removed 422 error response.
o 4.2.2: Joining Elements: Added text to the empty section.
o 4.2.2.2, 4.2.2.3, 4.2.2.4: <join>, <modifyjoin> and <unjoin>:
Clarified that join operation failures do not affect existing
stream properties of the entities (407 and new 422 error
response). Clarified stream failure errors in <modifyjoin> and
<unjoin>.
o 4.2.2.2: <join>. Clarified that <stream> elements can be used to
independently control properties of the media flow in different
directions. Added a response code (422) for when the MS does not
support a media stream configuation.
o 4.2.2.2: <join>. Clarified that error responses are generated if
id1 or id2 reference a conference or connection which does not
exist. Added an error status code (412) for non-existant
connections.
o 4.2.2.5: <stream>: Changed the definition so that in each child
element, the media stream affected is indicated by the value of
the direction attribute of the parent element. Added examples of
controlling the media flow properties.
o 4.2.4.2: <unjoin-notify>. Added reserved range of status codes.
Changed code from 1 to 0 for the unjoin case. Changed code from 3
to 1 for execution error.
o 4.2.4.3: <conferenceexit>. Added reserved range of status codes.
Changed code from 1 to 0 for the destroyconference case (align
with IVR). Added a code for conference exiting due to exceeding
its maximum duration.
o Schema: Adding missing version attribute on <mscmixer>.
o Security Considerations: Major update. Added examples showing
malicious attacks when channel security is not correctly
addressed. Added more details on multiple channel cases including
administrator and monitor channels as well as channel handover.
o Removed affliations in Contributors section.
The following are the major changes between the -02 and -01 versions. The following are the major changes between the -02 and -01 versions.
o Section 4: Aligned Control Package definitions with requirements o Section 4: Aligned Control Package definitions with requirements
in Section 8 of the Control Framework. in Section 8 of the Control Framework.
o Following October Interim meeting discussion on response codes, o Following October Interim meeting discussion on response codes,
generally clarified usage of error status codes, modified some generally clarified usage of error status codes, modified some
codes and re-organized the response codes section (Section 5.6) codes and re-organized the response codes section (Section 4.6)
with more guidance and details. with more guidance and details.
o MIXER-006. No action required following October 2008 interim o MIXER-006. No action required following October 2008 interim
discussion. discussion.
o MIXER-008. No action required following October 2008 interim o MIXER-008. No action required following October 2008 interim
discussion. discussion.
o MIXER-009. No action required for control package - addressed in o MIXER-009. No action required for control package - addressed in
-05 framework draft following interim October 2008 discussion. -05 framework draft following interim October 2008 discussion.
skipping to change at page 84, line 5 skipping to change at page 91, line 5
o added definition for MS connection o added definition for MS connection
The following are the major changes between the -01 of the draft and The following are the major changes between the -01 of the draft and
the -00 version. the -00 version.
o restructured into single request response model for non-trivial o restructured into single request response model for non-trivial
operations operations
o aligned with XML structure of other control framework packages o aligned with XML structure of other control framework packages
11. Contributors 10. Contributors
Asher Shiratzky from Radvision provided valuable support and Asher Shiratzky provided valuable support and contributions to early
contributions to early versions of this document. versions of this document.
The authors would like to thank the Mixer design team consisting of The authors would like to thank the Mixer design team consisting of
Roni Even, Lorenzo Miniero, Adnan Saleem, Diego Besprosvan and Mary Roni Even, Lorenzo Miniero, Adnan Saleem, Diego Besprosvan and Mary
Barnes who provided valuable feedback, input, diagrams and text to Barnes who provided valuable feedback, input, diagrams and text to
this document. this document.
12. Acknowledgments 11. Acknowledgments
The authors would like to thank Roni Even, Lorenzo Miniero and Steve The authors would like to thank Roni Even, Lorenzo Miniero and Steve
Buko for expert reviews of this work. Buko for expert reviews of this work.
13. References 12. References
13.1. Normative References 12.1. Normative References
[I-D.ietf-mediactrl-sip-control-framework] [I-D.ietf-mediactrl-sip-control-framework]
Boulton, C., Melanchuk, T., and S. McGlashan, "Media Boulton, C., Melanchuk, T., and S. McGlashan, "Media
Control Channel Framework", Control Channel Framework",
draft-ietf-mediactrl-sip-control-framework-06 (work in draft-ietf-mediactrl-sip-control-framework-07 (work in
progress), October 2008. progress), November 2008.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997. Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC3023] Murata, M., St. Laurent, S., and D. Kohn, "XML Media [RFC3023] Murata, M., St. Laurent, S., and D. Kohn, "XML Media
Types", RFC 3023, January 2001. Types", RFC 3023, January 2001.
[RFC4574] Levin, O. and G. Camarillo, "The Session Description [RFC4574] Levin, O. and G. Camarillo, "The Session Description
Protocol (SDP) Label Attribute", RFC 4574, August 2006. Protocol (SDP) Label Attribute", RFC 4574, August 2006.
[XML] Bray, T., Paoli, J., Sperberg-McQueen, C M., Maler, E., [XML] Bray, T., Paoli, J., Sperberg-McQueen, C M., Maler, E.,
and F. Yergeau, "Extensible Markup Language (XML) 1.0 and F. Yergeau, "Extensible Markup Language (XML) 1.0
(Third Edition)", W3C Recommendation, February 2004. (Third Edition)", W3C Recommendation, February 2004.
13.2. Informative References 12.2. Informative References
[I-D.ietf-xcon-common-data-model] [I-D.ietf-xcon-common-data-model]
Novo, O., Camarillo, G., Morgan, D., Even, R., and J. Novo, O., Camarillo, G., Morgan, D., Even, R., and J.
Urpalainen, "Conference Information Data Model for Urpalainen, "Conference Information Data Model for
Centralized Conferencing (XCON)", Centralized Conferencing (XCON)",
draft-ietf-xcon-common-data-model-12 (work in progress), draft-ietf-xcon-common-data-model-12 (work in progress),
October 2008. October 2008.
[IANA] "IANA registry for RTP Payload Types", [IANA] "IANA registry for RTP Payload Types",
<http://www.iana.org/assignments/rtp-parameters>. <http://www.iana.org/assignments/rtp-parameters>.
skipping to change at page 88, line 7 skipping to change at page 95, line 7
[RFC5022] Van Dyke, J., Burger, E., and A. Spitzer, "Media Server [RFC5022] Van Dyke, J., Burger, E., and A. Spitzer, "Media Server
Control Markup Language (MSCML) and Protocol", RFC 5022, Control Markup Language (MSCML) and Protocol", RFC 5022,
September 2007. September 2007.
[RFC5167] Dolly, M. and R. Even, "Media Server Control Protocol [RFC5167] Dolly, M. and R. Even, "Media Server Control Protocol
Requirements", RFC 5167, March 2008. Requirements", RFC 5167, March 2008.
Authors' Addresses Authors' Addresses
Tim Melanchuk
Rain Willow Communications
Email: tim.melanchuk@gmail.com
Scott McGlashan Scott McGlashan
Hewlett-Packard Hewlett-Packard
Gustav III:s boulevard 36 Gustav III:s boulevard 36
SE-16985 Stockholm, Sweden SE-16985 Stockholm, Sweden
Email: scott.mcglashan@hp.com Email: scott.mcglashan@hp.com
Tim Melanchuk
Rain Willow Communications
Email: tim.melanchuk@gmail.com
Chris Boulton Chris Boulton
Avaya Avaya
Building 3 Building 3
Wern Fawr Lane Wern Fawr Lane
St Mellons St Mellons
Cardiff, South Wales CF3 5EA Cardiff, South Wales CF3 5EA
Email: cboulton@avaya.com Email: cboulton@avaya.com
Full Copyright Statement Full Copyright Statement
 End of changes. 310 change blocks. 
581 lines changed or deleted 888 lines changed or added

This html diff was produced by rfcdiff 1.35. The latest version is available from http://tools.ietf.org/tools/rfcdiff/