draft-ietf-mediactrl-mixer-control-package-14.txt   rfc6505.txt 
Network Working Group S. McGlashan Internet Engineering Task Force (IETF) S. McGlashan
Internet-Draft Hewlett-Packard Request for Comments: 6505 Hewlett-Packard
Intended status: Standards Track T. Melanchuk Category: Standards Track T. Melanchuk
Expires: July 10, 2011 Rain Willow Communications ISSN: 2070-1721 Rainwillow
C. Boulton C. Boulton
NS-Technologies NS-Technologies
January 6, 2011 March 2012
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-14
Abstract Abstract
This document defines a Media Control Channel Framework Package for This document defines a Media Control Channel Framework Package for
managing mixers for media conferences and connections. The package managing mixers for media conferences and connections. The package
defines request elements for managing conference mixers, managing defines request elements for managing conference mixers, managing
mixers between conferences and/or connections, as well as associated mixers between conferences and/or connections, as well as associated
responses and notifications. The package also defines elements for responses and notifications. The package also defines elements for
auditing package capabilities and mixers. auditing package capabilities and mixers.
Status of this Memo Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering This is an Internet Standards Track document.
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months This document is a product of the Internet Engineering Task Force
and may be updated, replaced, or obsoleted by other documents at any (IETF). It represents the consensus of the IETF community. It has
time. It is inappropriate to use Internet-Drafts as reference received public review and has been approved for publication by the
material or to cite them other than as "work in progress." Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in Section 2 of RFC 5741.
This Internet-Draft will expire on July 10, 2011. Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
http://www.rfc-editor.org/info/rfc6505.
Copyright Notice Copyright Notice
Copyright (c) 2011 IETF Trust and the persons identified as the Copyright (c) 2012 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
skipping to change at page 3, line 7 skipping to change at page 2, line 19
modifications of such material outside the IETF Standards Process. modifications of such material outside the IETF Standards Process.
Without obtaining an adequate license from the person(s) controlling Without obtaining an adequate license from the person(s) controlling
the copyright in such materials, this document may not be modified the copyright in such materials, this document may not be modified
outside the IETF Standards Process, and derivative works of it may outside the IETF Standards Process, and derivative works of it may
not be created outside the IETF Standards Process, except to format not be created outside the IETF Standards Process, except to format
it for publication as an RFC or to translate it into languages other it for publication as an RFC or to translate it into languages other
than English. than English.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 5 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Conventions and Terminology . . . . . . . . . . . . . . . . . 7 2. Conventions and Terminology . . . . . . . . . . . . . . . . . 5
3. Control Package Definition . . . . . . . . . . . . . . . . . 8 3. Control Package Definition . . . . . . . . . . . . . . . . . . 6
3.1. Control Package Name . . . . . . . . . . . . . . . . . . 8 3.1. Control Package Name . . . . . . . . . . . . . . . . . . . 6
3.2. Framework Message Usage . . . . . . . . . . . . . . . . . 8 3.2. Framework Message Usage . . . . . . . . . . . . . . . . . 6
3.3. Common XML Support . . . . . . . . . . . . . . . . . . . 9 3.3. Common XML Support . . . . . . . . . . . . . . . . . . . . 7
3.4. CONTROL Message Body . . . . . . . . . . . . . . . . . . 9 3.4. CONTROL Message Body . . . . . . . . . . . . . . . . . . . 7
3.5. REPORT Message Body . . . . . . . . . . . . . . . . . . . 9 3.5. REPORT Message Body . . . . . . . . . . . . . . . . . . . 7
3.6. Audit . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3.6. Audit . . . . . . . . . . . . . . . . . . . . . . . . . . 8
3.7. Examples . . . . . . . . . . . . . . . . . . . . . . . . 10 3.7. Examples . . . . . . . . . . . . . . . . . . . . . . . . . 8
4. Element Definitions . . . . . . . . . . . . . . . . . . . . . 11 4. Element Definitions . . . . . . . . . . . . . . . . . . . . . 8
4.1. <mscmixer> . . . . . . . . . . . . . . . . . . . . . . . 11 4.1. <mscmixer> . . . . . . . . . . . . . . . . . . . . . . . . 9
4.2. Mixer Elements . . . . . . . . . . . . . . . . . . . . . 13 4.2. Mixer Elements . . . . . . . . . . . . . . . . . . . . . . 11
4.2.1. Conference Elements . . . . . . . . . . . . . . . . . 14 4.2.1. Conference Elements . . . . . . . . . . . . . . . . . 12
4.2.1.1. <createconference> . . . . . . . . . . . . . . . 14 4.2.1.1. <createconference> . . . . . . . . . . . . . . . . 12
4.2.1.2. <modifyconference> . . . . . . . . . . . . . . . 16 4.2.1.2. <modifyconference> . . . . . . . . . . . . . . . . 14
4.2.1.3. <destroyconference> . . . . . . . . . . . . . . . 18 4.2.1.3. <destroyconference> . . . . . . . . . . . . . . . 16
4.2.1.4. Conference Configuration . . . . . . . . . . . . 18 4.2.1.4. Conference Configuration . . . . . . . . . . . . . 16
4.2.1.4.1. <audio-mixing> . . . . . . . . . . . . . . . 18 4.2.1.4.1. <audio-mixing> . . . . . . . . . . . . . . . . 16
4.2.1.4.2. <video-layouts> . . . . . . . . . . . . . . . 19 4.2.1.4.2. <video-layouts> . . . . . . . . . . . . . . . 17
4.2.1.4.2.1. <video-layout> . . . . . . . . . . . . . 20 4.2.1.4.2.1. <video-layout> . . . . . . . . . . . . . . 18
4.2.1.4.3. <video-switch> . . . . . . . . . . . . . . . 26 4.2.1.4.3. <video-switch> . . . . . . . . . . . . . . . . 24
4.2.1.4.3.1. Priority assignment . . . . . . . . . . . 28 4.2.1.4.3.1. Priority Assignment . . . . . . . . . . . 26
4.2.1.4.4. <subscribe> . . . . . . . . . . . . . . . . . 29 4.2.1.4.4. <subscribe> . . . . . . . . . . . . . . . . . 27
4.2.1.4.4.1. <active-talkers-sub> . . . . . . . . . . 29 4.2.1.4.4.1. <active-talkers-sub> . . . . . . . . . . . 27
4.2.2. Joining Elements . . . . . . . . . . . . . . . . . . 29 4.2.2. Joining Elements . . . . . . . . . . . . . . . . . . . 28
4.2.2.1. Joining Model . . . . . . . . . . . . . . . . . . 30 4.2.2.1. Joining Model . . . . . . . . . . . . . . . . . . 28
4.2.2.2. <join> . . . . . . . . . . . . . . . . . . . . . 31 4.2.2.2. <join> . . . . . . . . . . . . . . . . . . . . . . 29
4.2.2.3. <modifyjoin> . . . . . . . . . . . . . . . . . . 33 4.2.2.3. <modifyjoin> . . . . . . . . . . . . . . . . . . . 32
4.2.2.4. <unjoin> . . . . . . . . . . . . . . . . . . . . 36 4.2.2.4. <unjoin> . . . . . . . . . . . . . . . . . . . . . 34
4.2.2.5. <stream> . . . . . . . . . . . . . . . . . . . . 37 4.2.2.5. <stream> . . . . . . . . . . . . . . . . . . . . . 35
4.2.2.5.1. <volume> . . . . . . . . . . . . . . . . . . 39 4.2.2.5.1. <volume> . . . . . . . . . . . . . . . . . . . 37
4.2.2.5.2. <clamp> . . . . . . . . . . . . . . . . . . . 39 4.2.2.5.2. <clamp> . . . . . . . . . . . . . . . . . . . 38
4.2.2.5.3. <region> . . . . . . . . . . . . . . . . . . 39 4.2.2.5.3. <region> . . . . . . . . . . . . . . . . . . . 38
4.2.2.5.4. <priority> . . . . . . . . . . . . . . . . . 40 4.2.2.5.4. <priority> . . . . . . . . . . . . . . . . . . 38
4.2.3. <response> . . . . . . . . . . . . . . . . . . . . . 40 4.2.3. <response> . . . . . . . . . . . . . . . . . . . . . . 38
4.2.4. <event> . . . . . . . . . . . . . . . . . . . . . . . 41 4.2.4. <event> . . . . . . . . . . . . . . . . . . . . . . . 39
4.2.4.1. <active-talkers-notify> . . . . . . . . . . . . . 41 4.2.4.1. <active-talkers-notify> . . . . . . . . . . . . . 39
4.2.4.1.1. <active-talker> . . . . . . . . . . . . . . . 41 4.2.4.1.1. <active-talker> . . . . . . . . . . . . . . . 40
4.2.4.2. <unjoin-notify> . . . . . . . . . . . . . . . . . 42 4.2.4.2. <unjoin-notify> . . . . . . . . . . . . . . . . . 40
4.2.4.3. <conferenceexit> . . . . . . . . . . . . . . . . 43 4.2.4.3. <conferenceexit> . . . . . . . . . . . . . . . . . 41
4.3. Audit Elements . . . . . . . . . . . . . . . . . . . . . 44 4.3. Audit Elements . . . . . . . . . . . . . . . . . . . . . . 42
4.3.1. <audit> . . . . . . . . . . . . . . . . . . . . . . . 44 4.3.1. <audit> . . . . . . . . . . . . . . . . . . . . . . . 43
4.3.2. <auditresponse> . . . . . . . . . . . . . . . . . . . 46 4.3.2. <auditresponse> . . . . . . . . . . . . . . . . . . . 44
4.3.2.1. <capabilities> . . . . . . . . . . . . . . . . . 47 4.3.2.1. <capabilities> . . . . . . . . . . . . . . . . . . 46
4.3.2.2. <mixers> . . . . . . . . . . . . . . . . . . . . 48 4.3.2.2. <mixers> . . . . . . . . . . . . . . . . . . . . . 46
4.3.2.2.1. <conferenceaudit> . . . . . . . . . . . . . . 48 4.3.2.2.1. <conferenceaudit> . . . . . . . . . . . . . . 47
4.3.2.2.1.1. <participants> . . . . . . . . . . . . . 49 4.3.2.2.1.1. <participants> . . . . . . . . . . . . . . 47
4.3.2.2.1.1.1. <participant> . . . . . . . . . . . . 49 4.3.2.2.1.1.1. <participant> . . . . . . . . . . . . 48
4.3.2.2.2. <joinaudit> . . . . . . . . . . . . . . . . . 50 4.3.2.2.2. <joinaudit> . . . . . . . . . . . . . . . . . 48
4.4. <codecs> . . . . . . . . . . . . . . . . . . . . . . . . 50 4.4. <codecs> . . . . . . . . . . . . . . . . . . . . . . . . . 48
4.4.1. <codec> . . . . . . . . . . . . . . . . . . . . . . . 51 4.4.1. <codec> . . . . . . . . . . . . . . . . . . . . . . . 49
4.5. <params> . . . . . . . . . . . . . . . . . . . . . . . . 52 4.5. <params> . . . . . . . . . . . . . . . . . . . . . . . . . 50
4.5.1. <param> . . . . . . . . . . . . . . . . . . . . . . . 52 4.5.1. <param> . . . . . . . . . . . . . . . . . . . . . . . 50
4.6. Response Status Codes . . . . . . . . . . . . . . . . . . 53 4.6. Response Status Codes . . . . . . . . . . . . . . . . . . 51
4.7. Type Definitions . . . . . . . . . . . . . . . . . . . . 57 4.7. Type Definitions . . . . . . . . . . . . . . . . . . . . . 55
5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 59 5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 56
6. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . 78 6. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
6.1. AS-MS Framework Interaction Examples . . . . . . . . . . 78 6.1. AS-MS Framework Interaction Examples . . . . . . . . . . . 75
6.1.1. Creating a conference mixer and joining a 6.1.1. Creating a Conference Mixer and Joining a
participant . . . . . . . . . . . . . . . . . . . . . 78 Participant . . . . . . . . . . . . . . . . . . . . . 75
6.1.2. Receiving active talker notifications . . . . . . . . 79 6.1.2. Receiving Active Talker Notifications . . . . . . . . 76
6.1.3. Conference termination . . . . . . . . . . . . . . . 79 6.1.3. Conference Termination . . . . . . . . . . . . . . . . 76
6.2. Mixing Examples . . . . . . . . . . . . . . . . . . . . . 79 6.2. Mixing Examples . . . . . . . . . . . . . . . . . . . . . 76
6.2.1. Audio conferencing . . . . . . . . . . . . . . . . . 80 6.2.1. Audio Conferencing . . . . . . . . . . . . . . . . . . 77
6.2.2. Bridging connections . . . . . . . . . . . . . . . . 82 6.2.2. Bridging Connections . . . . . . . . . . . . . . . . . 79
6.2.3. Video conferencing . . . . . . . . . . . . . . . . . 83 6.2.3. Video Conferencing . . . . . . . . . . . . . . . . . . 80
7. Security Considerations . . . . . . . . . . . . . . . . . . . 85 7. Security Considerations . . . . . . . . . . . . . . . . . . . 81
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 88 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 84
8.1. Control Package Registration . . . . . . . . . . . . . . 88 8.1. Control Package Registration . . . . . . . . . . . . . . . 84
8.2. URN Sub-Namespace Registration . . . . . . . . . . . . . 88 8.2. URN Sub-Namespace Registration . . . . . . . . . . . . . . 84
8.3. XML Schema Registration . . . . . . . . . . . . . . . . . 89 8.3. XML Schema Registration . . . . . . . . . . . . . . . . . 85
8.4. MIME Media Type Registration for 8.4. MIME Media Type Registration for
'application/msc-mixer+xml' . . . . . . . . . . . . . . . 89 'application/msc-mixer+xml' . . . . . . . . . . . . . . . 85
9. Change Summary . . . . . . . . . . . . . . . . . . . . . . . 91 8.5. Mixer Control Package Status Code Registration . . . . . . 86
10. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 101 9. Contributors . . . . . . . . . . . . . . . . . . . . . . . . . 86
11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 102 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 87
12. References . . . . . . . . . . . . . . . . . . . . . . . . . 103 11. References . . . . . . . . . . . . . . . . . . . . . . . . . . 87
12.1. Normative References . . . . . . . . . . . . . . . . . . 103 11.1. Normative References . . . . . . . . . . . . . . . . . . . 87
12.2. Informative References . . . . . . . . . . . . . . . . . 104 11.2. Informative References . . . . . . . . . . . . . . . . . . 88
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 105
1. Introduction 1. Introduction
The Media Control Channel Framework The Media Control Channel Framework [RFC6230] provides a generic
[I-D.ietf-mediactrl-sip-control-framework] provides a generic
approach for establishment and reporting capabilities of remotely approach for establishment and reporting capabilities of remotely
initiated commands. The Control Framework - an equivalent term for initiated commands. The Control Framework -- an equivalent term for
the Media Control Channel Framework - utilizes many functions the Media Control Channel Framework -- utilizes many functions
provided by the Session Initiation Protocol [RFC3261] (SIP) for the provided by the Session Initiation Protocol (SIP) [RFC3261] for the
rendezvous and establishment of a reliable channel for control rendezvous and establishment of a reliable channel for control
interactions. The Control Framework also introduces the concept of a interactions. The Control Framework also introduces the concept of a
Control Package. A Control Package is an explicit usage of the Control Package. A Control Package is an explicit usage of the
Control Framework for a particular interaction set. This Control Framework for a particular interaction set. This
specification defines a package for media conference mixers and media specification defines a package for media conference mixers and media
connection mixers. connection mixers.
This package defines mixer management elements for creating, This package defines mixer management elements for creating,
modifying and deleting conference mixers, elements for joining, modifying, and deleting conference mixers, elements for joining,
modifying and unjoining media streams between connections and modifying, and unjoining media streams between connections and
conferences (including mixers between connections), as well as conferences (including mixers between connections), as well as
associated responses and notifications. The package also defines associated responses and notifications. The package also defines
elements for auditing package capabilities and mixers. elements for auditing package capabilities and mixers.
This package has been designed to satisfy media mixing requirements This package has been designed to satisfy media-mixing requirements
documented in the Media Server Control Protocol Requirements document documented in the Media Server Control Protocol Requirements document
([RFC5167]); more specifically REQ-MCP-22, REQ-MCP-23, REQ-MCP-24, [RFC5167]; more specifically REQ-MCP-22, REQ-MCP-23, REQ-MCP-24,
REQ-MCP-25, REQ-MCP-26 and REQ-MCP-27. REQ-MCP-25, REQ-MCP-26, and REQ-MCP-27.
The package provides the major conferencing functionality of SIP The package provides the major conferencing functionality of SIP
Media Server languages such as MSCML ([RFC5022]) and MSML media server languages such as MSCML [RFC5022] and MSML [RFC5707]. A
([RFC5707]). A key differentiator is that this package provides such key differentiator is that this package provides such functionality
functionality using the Media Control Channel Framework. using the Media Control Channel Framework.
Out of scope for this mixer package are more advanced functions Out of scope for this mixer package are more advanced functions
including personalized video mixes for conference participants, including personalized video mixes for conference participants,
support for floor control protocols, as well as support for video support for floor control protocols, as well as support for video
overlays and text insertion. Such functionality can be addressed by overlays and text insertion. Such functionality can be addressed by
extensions to this package (through addition of foreign elements or extensions to this package (through addition of foreign elements or
attributes from another namespace) or use of other control packages attributes from another namespace) or use of other Control Packages
which could build upon this package. that could build upon this package.
The functionality of this package is defined by messages, containing The functionality of this package is defined by messages, containing
XML [XML] elements, transported using the Media Control Channel XML [XML] elements and transported using the Media Control Channel
Framework. The XML elements can be divided into two types: mixer Framework. The XML elements can be divided into two types: mixer
management elements; and elements for auditing package capabilities management elements and audit elements (for auditing package
as well as mixers managed by the package. capabilities and mixers managed by the package).
The document is organized as follows. Section 3 describes how this The document is organized as follows. Section 3 describes how this
control package fulfills the requirements for a Media Control Channel Control Package fulfills the requirements for a Media Control Channel
Framework control package. Section 4 describes the syntax and Framework Control Package. Section 4 describes the syntax and
semantics of defined elements, including mixer management semantics of defined elements, including mixer management
(Section 4.2) and audit elements (Section 4.3). Section 5 describes (Section 4.2) and audit elements (Section 4.3). Section 5 describes
an XML schema for these elements and provides extensibility by an XML schema for these elements and provides extensibility by
allowing attributes and elements from other namespaces. Section 6 allowing attributes and elements from other namespaces. Section 6
provides examples of package usage. Section 7 describes important provides examples of package usage. Section 7 describes important
security considerations for use of this control package. Section 8 security considerations for use of this Control Package. Section 8
provides information on IANA registration of this control package, provides information on IANA registration of this Control Package,
including its name, XML namespace and MIME media type. 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 [RFC2119] defines the key words "MUST",
"MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT",
"SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL". In
"OPTIONAL". In addition, BCP 15 indicates requirement levels for addition, BCP 15 indicates requirement levels for compliant
compliant implementations. 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 can have SIP sessions terminating on an MS, 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: An 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, an 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: An MS connection represents the termination on a
on a media server of one or more RTP [RFC3550] sessions that are 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 can be audio or connections, or between two conferences. Streams can be audio or
video and can be bi-directional or uni-directional. video and can be bidirectional or unidirectional.
3. 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 [RFC6230].
[I-D.ietf-mediactrl-sip-control-framework].
3.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 8.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.
3.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 4, where the message bodies have the MIME elements defined in Section 4, where the message bodies have the MIME
media type defined in Section 8.4. These elements describe requests, media type defined in Section 8.4. These elements describe requests,
response and notifications and all are contained within a root responses, and notifications, and all are contained within a root
<mscmixer> element (Section 4.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 a
Client). Mixer management requests and responses are defined in Control Client). Mixer management requests and responses are defined
Section 4.2. Audit requests and responses are defined in in Section 4.2. Audit requests and responses are defined in
Section 4.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 4.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 7 of [RFC6230])
[I-D.ietf-mediactrl-sip-control-framework]) are used when the request are used when the request or event notification is invalid, for
or event notification is invalid; for example, a request is invalid 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 4.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.
3.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 16.1 of This package requires that the XML schema in Appendix A.1 of
[I-D.ietf-mediactrl-sip-control-framework] MUST be supported for [RFC6230] 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 4). The XML schema (Section 5) 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.
3.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 a Control Server, the MS receives CONTROL messages
with the MIME media type defined in Section 8.4 and a body containing with the MIME media type defined in Section 8.4 and a body containing
a <mscmixer> element (Section 4.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 4.2.1.1), CONTROL message bodies to MS: <createconference> (Section 4.2.1.1),
<modifyconference> (Section 4.2.1.2), <destroyconference> <modifyconference> (Section 4.2.1.2), <destroyconference>
(Section 4.2.1.3), <join> (Section 4.2.2.2), <modifyjoin> (Section 4.2.1.3), <join> (Section 4.2.2.2), <modifyjoin>
(Section 4.2.2.3) and <unjoin> (Section 4.2.2.4) elements. (Section 4.2.2.3), and <unjoin> (Section 4.2.2.4) elements.
The <audit> request element (Section 4.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 a Control Client, the MS sends CONTROL messages
the MIME media type defined in Section 8.4 and a body containing a with the MIME media type defined in Section 8.4 and a body containing
<mscmixer> element (Section 4.1) with a notification <event> child a <mscmixer> element (Section 4.1) with a notification <event> child
element (Section 4.2.4). element (Section 4.2.4).
3.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 to indicate that no report package body is required.
indicates the location of detailed syntax definitions and semantics This section indicates the location of detailed syntax definitions
for the appropriate body types. and semantics for the appropriate body types.
When operating as Control Server, the MS sends REPORT bodies with the When operating as a Control Server, the MS sends REPORT bodies with
MIME media type defined in Section 8.4 and a <mscmixer> element with the MIME media type defined in Section 8.4 and a <mscmixer> element
a response child element. The response element for mixer management with a response child element. The response element for mixer
requests is a <response> element (Section 4.2.3). The response management requests is a <response> element (Section 4.2.3). The
element for an audit request is a <auditresponse> element response element for an audit request is a <auditresponse> element
(Section 4.3.2). (Section 4.3.2).
3.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 Package 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 are
defined in Section 4.3. defined in Section 4.3.
3.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 6. Section 6.
4. 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 8.2. are defined in the XML namespace specified in Section 8.2.
The root element is <mscmixer> (Section 4.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 4.2) and audit it. Child elements describe mixer management (Section 4.2) and audit
(Section 4.3) functionality. Response status codes are defined in (Section 4.3) functionality. Response status codes are defined in
Section 4.6 and type definitions in Section 4.7. Section 4.6 and type definitions in Section 4.7.
Implementation of this control package MUST address the Security Implementation of this Control Package MUST address the security
Considerations described in Section 7. 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 5). 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 sends a 428 response (Section 4.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.
Some elements in this control package contain attributes whose value Some elements in this Control Package contain attributes whose value
is descriptive text primarily for diagnostic use. The implementation is descriptive text primarily for diagnostic use. The implementation
can indicated the language used in the descriptive text by means of a can indicated the language used in the descriptive text by means of a
'desclang' attribute ([RFC2277]). The desclang attribute can appear 'desclang' attribute [RFC2277]. The 'desclang' attribute can appear
on the root element as well as selected subordinate elements (see on the root element as well as selected subordinate elements (see
Section 4.1). The desclang attribute value on the root element Section 4.1). The 'desclang' attribute value on the root element
applies to all desclang attributes in subordinate elements unless the applies to all 'desclang' attributes in subordinate elements unless
subordinate element has an explicit desclang attribute which the subordinate element has an explicit 'desclang' attribute that
overrides it. overrides it.
Usage examples are provided in Section 6. Usage examples are provided in Section 6.
4.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.
desclang: specifies the language used in descriptive text attributes desclang: specifies the language used in descriptive text attributes
of subordinate elements (unless the subordinate element provides a of subordinate elements (unless the subordinate element provides a
desclang attribute which overrides the value for its descriptive 'desclang' attribute that overrides the value for its descriptive
text attributes). The descriptive text attributes on subordinate text attributes). The descriptive text attributes on subordinate
elements include: the reason attribute on <response> elements include: the 'reason' attribute on <response>
(Section 4.2.3), <unjoin-notify> (Section 4.2.4.2), (Section 4.2.3), <unjoin-notify> (Section 4.2.4.2),
<conferenceexit> (Section 4.2.4.3) and <auditresponse> <conferenceexit> (Section 4.2.4.3), and <auditresponse>
(Section 4.3.2). A valid value is a language identifier (Section 4.3.2). A valid value is a language identifier
(Section 4.7.7). The attribute is optional. The default value is (Section 4.7.7). The attribute is optional. The default value is
i-default (BCP47 [RFC5646]). "i-default" (BCP 47 [RFC5646]).
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 4.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 4.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 4.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 4.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 4.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 4.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 4.2.2.4 participant from a conference). See Section 4.2.2.4
<response> response to a mixer request. See Section 4.2.3 <response>: response to a mixer request. See Section 4.2.3
<event> mixer or subscription notification. See Section 4.2.4 <event>: mixer or subscription notification. See Section 4.2.4
2. audit elements defined in Section 4.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 4.3.1 Section 4.3.1
<auditresponse> response to an audit request. See Section 4.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 is as
follows:
<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 is as follows:
<mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer" <mscmixer version="1.0" xmlns="urn:ietf:params:xml:ns:msc-mixer"
desclang="en"> desclang="en">
<response status="200" conferenceid="conference1" <response status="200" conferenceid="conference1"
reason="conference created"/> reason="conference created"/>
</mscmixer> </mscmixer>
4.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,
and notifications. responses, 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 4.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 4.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 4.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
conferences (for example, add a participant to a conference). See and/or conferences (for example, add a participant to a
Section 4.2.2.2 conference). See Section 4.2.2.2
<modifyjoin> modify the configuration of joined media streams. See <modifyjoin>: modify the configuration of joined media streams. See
Section 4.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 4.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 4.2.3) which Responses are specified in a <response> element (Section 4.2.3) that
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 4.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 (in whole or in part), then the request has failed: the MS operation (in whole or in part), then the request has failed: the MS
MUST ensure that no part of the requested mixer operation is carried MUST ensure that no part of the requested mixer operation is carried
out, and the MS MUST indicate the class of failure using an out, 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
specified for a class of error within this section, implementations specified for a class of error within this section, implementations
follow Section 4.6 in determining the appropriate status code for the follow Section 4.6 in determining the appropriate status code for the
skipping to change at page 14, line 38 skipping to change at page 12, line 21
4.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
<response>). The attribute is optional. There is no default a <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 4.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 4.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 4.4). If codecs are specified, then they conference (see Section 4.4). If codecs are specified, then they
impose limitations in media capability when the MS attempts to impose limitations on media capability when the MS attempts to
join the conference to other entities (see Section 4.2.2.2 and join the conference to other entities (see Sections 4.2.2.2 and
Section 4.2.2.3). The element is optional. 4.2.2.3). 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 4.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 4.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 4.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 4.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 a value which is already used If the 'conferenceid' attribute specifies a value that is already
by an existing conference, the MS reports an error (405) and MUST NOT used by an existing conference, the MS reports an error (405) and
create a new conference and MUST NOT affect the existing conference. MUST NOT 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
reports an error (420) and MUST NOT create the conference. MS 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 reports an error (421) and specified <audio-mixing> element, the MS reports an error (421) 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-layouts> element, the MS reports an error (423) and specified <video-layouts> element, the MS reports an error (423) 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
skipping to change at page 16, line 6 skipping to change at page 13, line 41
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 reports an error (425) and MUST specified <codecs> element, the MS reports an error (425) and 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 4.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 is as
follows:
<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 name="video"> <codec name="video">
<subtype>H264</subtype> <subtype>H264</subtype>
</codec> </codec>
<codec name="audio"> <codec name="audio">
<subtype>PCMA</subtype> <subtype>PCMA</subtype>
skipping to change at page 16, line 32 skipping to change at page 14, line 29
<video-layout min-participants="2"><dual-view/></video-layout> <video-layout min-participants="2"><dual-view/></video-layout>
<video-layout min-participants="3"><quad-view/></video-layout> <video-layout min-participants="3"><quad-view/></video-layout>
</video-layouts> </video-layouts>
<video-switch interval="5"><vas/></video-switch> <video-switch interval="5"><vas/></video-switch>
<subscribe> <subscribe>
<active-talkers-sub interval="4"/> <active-talkers-sub interval="4"/>
</subscribe> </subscribe>
</createconference> </createconference>
</mscmixer> </mscmixer>
and a response from the MS if the conference was successfully A response from the MS if the conference was successfully created is
created: as follows:
<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>
alternatively, a response if MS could not create the conference due Alternatively, a response if the MS could not create the conference
to a lack of support for the H264 codec: due to a lack of support for the H264 codec is as follows:
<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>
4.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 attribute:
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 (one 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 4.4). If codecs are specified, then they conference (see Section 4.4). If codecs are specified, then they
impose limitations in media capability when the MS attempts to impose limitations in media capability when the MS attempts to
join the conference to other entities (see Section 4.2.2.2 and join the conference to other entities (see Sections 4.2.2.2 and
Section 4.2.2.3). Existing conference participants are unaffected 4.2.2.3). Existing conference participants are unaffected by any
by any policy change. The element is optional. 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 4.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 4.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 4.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 4.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 reports an error (406). that 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 reports an error (421) and specified <audio-mixing> element, the MS reports an error (421) 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-layouts> element, the MS reports an error (423) and specified <video-layouts> element, the MS reports an error (423) 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
skipping to change at page 18, line 10 skipping to change at page 16, line 10
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 4.2.3). MUST reply with an appropriate <response> element (Section 4.2.3).
4.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 attribute:
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 reports an error (406). that 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 4.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 4.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 4.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.
4.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.
skipping to change at page 19, line 13 skipping to change at page 17, line 13
optional. The default value is "nbest". optional. The default value is "nbest".
n: indicates the number of eligible participants included in the n: indicates the number of eligible participants included in the
conference audio mix. An eligible participant is a participant conference audio mix. An eligible participant is a participant
who contributes audio to the conference. Inclusion is based on who contributes audio to the conference. Inclusion is based on
having the greatest audio energy. A valid value is a non-negative 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 integer (see Section 4.7.2). A value of 0 indicates that all
participants contributing audio to the conference are included in participants contributing audio to the conference are included in
the audio mix. The default value is 0. The element is optional. 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 If the 'type' attribute does not have the value "nbest", the MS
the "n" attribute. ignores the 'n' attribute.
The <audio-mixing> element has no child elements. The <audio-mixing> element has no child elements.
For example, a fragment where the audio mixing policy is set to For example, a fragment where the audio-mixing policy is set to
"nbest" with 3 participants to be included: "nbest" with 3 participants to be included is as follows:
<audio-mixing type="nbest" n="3"/> <audio-mixing type="nbest" n="3"/>
If the conference had 200 participants of whom 30 contributed audio, If the conference had 200 participants of whom 30 contributed audio,
then there would be 30 eligible participants for the audio mix. Of then there would be 30 eligible participants for the audio mix. Of
these, the 3 loudest participants would have their audio included in these, the 3 loudest participants would have their audio included in
the conference. the conference.
4.2.1.4.2. <video-layouts> 4.2.1.4.2. <video-layouts>
The <video-layouts> element describe the video presentation layout The <video-layouts> element describes 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 (one or more):
<video-layout>: element describing a video layout <video-layout>: element describing a video layout
(Section 4.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 reports an 423 error in the response to the request layout, the MS reports an 423 error in the response to the 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 reports an error (400) if more than one layout> element. An MS reports an error (400) if more than one
<video-layout> has the same value for the "min-participants" <video-layout> has the same value for the 'min-participants'
attribute. When the number of regions within the active layout is attribute. When the number of regions within the active layout is
greater than the number of participants in the conference, the greater than the number of participants in the conference, the
display of 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 4.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 is as follows:
<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: A fragment describing a sequence of layouts is as follows:
<video-layouts> <video-layouts>
<video-layout min-participants="1"><single-view/></video-layout> <video-layout min-participants="1"><single-view/></video-layout>
<video-layout min-participants="2"><dual-view/></video-layout> <video-layout min-participants="2"><dual-view/></video-layout>
<video-layout min-participants="3"><quad-view/></video-layout> <video-layout min-participants="3"><quad-view/></video-layout>
<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.
4.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 attribute:
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 4.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 one child element specifying the video The <video-layout> element has one child element specifying the video
layout. An MS MAY support the predefined video layouts defined in layout. An MS MAY support the predefined video layouts defined in
the XCON conference information data model the conference information data model for centralized conferencing
([I-D.ietf-xcon-common-data-model]): <single-view>, <dual-view>, (XCON) [RFC6501]: <single-view>, <dual-view>, <dual-view-crop>,
<dual-view-crop>, <dual-view-2x1>, <dual-view-2x1-crop>, <quad-view>, <dual-view-2x1>, <dual-view-2x1-crop>, <quad-view>, <multiple-3x3>,
<multiple-3x3>, <multiple-4x4> and <multiple-5x1>. <multiple-4x4>, and <multiple-5x1>.
The MS MAY support other video layouts. Non-XCON layouts MUST be The MS MAY support other video layouts. Non-XCON layouts MUST be
specified using an element from a namespace other than the one used specified using an element from a namespace other than the one used
in this specification. For example, in this specification, for example:
<video-layout> <video-layout>
<mylayout xmlns='http://example.com/foo'>my-single-view</mylayout> <mylayout xmlns='http://example.com/foo'>my-single-view</mylayout>
</video-layout> </video-layout>
If the MS does not support the specified video layout configuration, If the MS does not support the specified video layout configuration,
then the MS reports a 423 error (Section 4.6) in the response to the then the MS reports a 423 error (Section 4.6) in the response to the
request element containing the <video-layout> element. request element containing the <video-layout> element.
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 are associated with the following named regions: XCON layouts are associated with 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
Figure 1. in 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 <dual-view/>: layout presenting two streams side-by-side in two
regions as shown in Figure 2. The MS MUST NOT alter the aspect regions as shown in Figure 2. The MS MUST NOT alter the aspect
ratio of each stream to fit the region and hence the MS might need ratio of each stream to fit the region, and hence the MS might
to blank out part of each region. need to blank out part of each region.
+-----------+-----------+ +-----------+-----------+
| | | | | |
| | | | | |
| 1 | 2 | | 1 | 2 |
| | | | | |
| | | | | |
+-----------+-----------+ +-----------+-----------+
Figure 2: dual-view video layout Figure 2: dual-view video layout
<dual-view-crop/> layout presenting two streams side-by-side in two <dual-view-crop/>: layout presenting two streams side-by-side in two
regions as shown in Figure 3. The MS MUST alter the aspect ratio regions as shown in Figure 3. The MS MUST alter the aspect ratio
of each stream to fit its region so that no blanking is required. of each stream to fit its region so that no blanking is required.
+-----------+-----------+ +-----------+-----------+
| | | | | |
| | | | | |
| 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 <dual-view-2x1/>: layout presenting two streams, one above the
in two regions as shown in Figure 4. The MS MUST NOT alter the other, in two regions as shown in Figure 4. The MS MUST NOT alter
aspect ratio of each stream to fit its region and hence the MS the aspect ratio of each stream to fit its region, and hence the
might need to blank out part of each region. MS might need to blank out part of each region.
+-----------+ +-----------+
| | | |
| | | |
| 1 | | 1 |
| | | |
| | | |
+-----------+ +-----------+
| | | |
| | | |
| 2 | | 2 |
| | | |
| | | |
+-----------+ +-----------+
Figure 4: dual-view-2x1 video layout Figure 4: dual-view-2x1 video layout
<dual-view-2x1-crop/> layout presenting two streams one above the <dual-view-2x1-crop/>: layout presenting two streams one above the
other in two regions as shown in Figure 5. The MS MUST alter the other in two regions as shown in Figure 5. The MS MUST alter the
aspect ratio of each stream to fit its region so that no blanking aspect ratio of each stream to fit its region so that no blanking
is required. is required.
+-----------+ +-----------+
| | | |
| | | |
| 1 | | 1 |
| | | |
| | | |
+-----------+ +-----------+
| | | |
| | | |
| 2 | | 2 |
| | | |
| | | |
+-----------+ +-----------+
Figure 5: dual-view-2x1-crop video layout Figure 5: dual-view-2x1-crop video layout
<quad-view/> layout presenting four equal-sized regions in a 2x2 <quad-view/>: layout presenting four equal-sized regions in a 2x2
layout as shown in Figure 6. Typically the aspect ratio of the layout as shown in Figure 6. Typically, the aspect ratio of the
streams is preserved, so blanking is required. streams is preserved, so blanking is required.
+-----------+-----------+ +-----------+-----------+
| | | | | |
| | | | | |
| 1 | 2 | | 1 | 2 |
| | | | | |
| | | | | |
+-----------+-----------+ +-----------+-----------+
| | | | | |
| | | | | |
| 3 | 4 | | 3 | 4 |
| | | | | |
| | | | | |
+-----------+-----------+ +-----------+-----------+
Figure 6: quad-view video layout Figure 6: quad-view video layout
<multiple-3x3/> layout presenting nine equal-sized regions in a 3x3 <multiple-3x3/>: layout presenting nine equal-sized regions in a 3x3
layout as shown in Figure 7. Typically the aspect ratio of the layout as shown in Figure 7. Typically, the aspect ratio of the
streams is preserved, so blanking is required. streams is preserved, so blanking is required.
+-----------+-----------+-----------+ +-----------+-----------+-----------+
| | | | | | | |
| | | | | | | |
| 1 | 2 | 3 | | 1 | 2 | 3 |
| | | | | | | |
| | | | | | | |
+-----------+-----------+-----------+ +-----------+-----------+-----------+
| | | | | | | |
skipping to change at page 24, line 27 skipping to change at page 23, line 5
+-----------+-----------+-----------+ +-----------+-----------+-----------+
| | | | | | | |
| | | | | | | |
| 7 | 8 | 9 | | 7 | 8 | 9 |
| | | | | | | |
| | | | | | | |
+-----------+-----------+-----------+ +-----------+-----------+-----------+
Figure 7: multiple-3x3 video layout Figure 7: multiple-3x3 video layout
<multiple-4x4/> layout presenting sixteen equal-sized regions in a <multiple-4x4/>: layout presenting 16 equal-sized regions in a 4x4
4x4 layout as shown in Figure 8. Typically the aspect ratio of layout as shown in Figure 8. Typically, the aspect ratio of the
the streams is preserved, so blanking is required. streams is preserved, so blanking is required.
+-----------+-----------+-----------+-----------+ +-----------+-----------+-----------+-----------+
| | | | | | | | | |
| | | | | | | | | |
| 1 | 2 | 3 | 4 | | 1 | 2 | 3 | 4 |
| | | | | | | | | |
| | | | | | | | | |
+-----------+-----------+-----------+-----------+ +-----------+-----------+-----------+-----------+
| | | | | | | | | |
| | | | | | | | | |
skipping to change at page 25, line 33 skipping to change at page 24, line 5
+-----------+-----------+-----------+-----------+ +-----------+-----------+-----------+-----------+
| | | | | | | | | |
| | | | | | | | | |
| 13 | 14 | 15 | 16 | | 13 | 14 | 15 | 16 |
| | | | | | | | | |
| | | | | | | | | |
+-----------+-----------+-----------+-----------+ +-----------+-----------+-----------+-----------+
Figure 8: multiple-4x4 video layout Figure 8: multiple-4x4 video layout
<multiple-5x1/> layout presents a 5x1 layout as shown in Figure 9 <multiple-5x1/>: layout presents a 5x1 layout as shown in Figure 9
where one region will occupy 4/9 of the mixed video stream while where one region will occupy 4/9 of the mixed video stream, while
the others will each occupy 1/9 of the stream. Typically the the others will each occupy 1/9 of the stream. Typically, the
aspect ratio of the streams is preserved, so blanking is required. aspect ratio of the streams is preserved, so blanking is required.
+-----------------------+-----------+ +-----------------------+-----------+
| | | | | |
| | | | | |
| | 2 | | | 2 |
| | | | | |
| | | | | |
| 1 +-----------+ | 1 +-----------+
| | | | | |
skipping to change at page 26, line 29 skipping to change at page 24, line 34
| | | | | | | |
| 4 | 5 | 6 | | 4 | 5 | 6 |
| | | | | | | |
| | | | | | | |
+-----------+-----------+-----------+ +-----------+-----------+-----------+
Figure 9: multiple-5x1 video layout Figure 9: multiple-5x1 video layout
4.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 describes the configuration of the
conference policy for how participant's input video streams are conference policy for how participants' 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 child elements defined The <video-switch> element has the following child elements defined
(one child occurrence only) indicating the video switching policy of (one child occurrence only) to indicate the video-switching policy of
the conference: the conference:
<vas/> (Voice Activated Switching) enables automatic display of the <vas/>: (Voice-Activated Switching) enables automatic display of the
loudest speaker participant also providing a video input stream to loudest speaker participant that is contributing both audio and
the conference. Participants who do not provide an audio stream video to the conference mix. Participants who do not provide an
are not considered for automatic display. If a participant audio stream are not considered for automatic display. If a
provides more than one audio stream, then the policy for inclusion participant provides more than one audio stream, then the policy
of such a participant in the VAS is implementation-specific; an MS for inclusion of such a participant in the VAS is implementation-
could select one stream, sum audio streams or ignore the specific; an MS could select one stream, sum audio streams, or
participant for VAS consideration. If there is only one region in ignore the participant for VAS consideration. If there is only
the layout, then the loudest speaker is displayed there. If more one region in the layout, then the loudest speaker is displayed
than one region is available, then the loudest speaker is there. If more than one region is available, then the loudest
displayed in the largest region, if any, and then in the first speaker is displayed in the largest region (if any), and then in
region from the top-left corner of the layout. The MS assigns the the first region from the top-left corner of the layout. The MS
remaining regions based on the priority mechanism described in assigns the remaining regions based on the priority mechanism
Section 4.2.1.4.3.1. described in 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 an controller AS determines how the regions are assigned based on an
external floor control policy. The MS receives <join>, external floor control policy. The MS receives <join>,
<modifyjoin> and <unjoin> commands with a <stream> element <modifyjoin>, and <unjoin> commands with a <stream> element
(Section 4.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 the displayed. If no explicit region is specified, the MS assigns the
region based on the priority mechanism described in region based on the priority mechanism described in
Section 4.2.1.4.3.1. Section 4.2.1.4.3.1.
An MS MAY support other video switching policies. Other policies An MS MAY support other video-switching policies. Other policies
MUST be specified using an element from a namespace other than the MUST be specified using an element from a namespace other than the
one used in this specification. For example, one used in this specification. For example:
<video-switch> <video-switch>
<mypolicy xmlns='http://example.com/foo'/> <mypolicy xmlns='http://example.com/foo'/>
</video-switch> </video-switch>
The <video-switch> element has the following attributes: The <video-switch> element has the following attributes:
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
loudest speaker for the interval before the switch takes place. A loudest speaker for the interval before the switch takes place. A
valid value is a non-negative integer (see Section 4.7.2). A valid value is a non-negative integer (see Section 4.7.2). A
value of 0 indicates that switching is applied immediately. The value of 0 indicates that switching is applied immediately. The
attribute is optional. The default value is 3 (seconds). attribute is optional. The default value is 3 (seconds).
activespeakermix: indicates whether or not the active (loudest) activespeakermix: indicates whether or not the active (loudest)
speaker participant receives a video stream without themselves speaker participant receives a video stream without themselves
displayed in the case of the <vas/> switching policy. If enabled, displayed in the case of the <vas/> switching policy. If enabled,
the MS needs to generate two video streams for each conference the MS needs to generate two video streams for each conference
mix: one for the active speaker participant without themselves mix: one for the active speaker participant without themselves
displayed - details of this video layout are implementation- displayed (details of this video layout are implementation-
specific; and one for other participants as described in the specific) and one for other participants (as described in the
<vas/> switch policy above. A valid value is a boolean (see <vas/> switching policy above). A valid value is a boolean (see
Section 4.7.1). A value of true indicates that a separate video Section 4.7.1). A value of "true" indicates that a separate video
mix is generated for the active speaker without themselves being mix is generated for the active speaker without themselves being
displayed. A value of false indicates that all participants displayed. A value of "false" indicates that all participants
receive the same video mix. The attribute is optional. The receive the same video mix. The attribute is optional. The
default value is false. If the type attribute is not set to default value is "false". If the 'type' attribute is not set to
<vas/>, the MS ignores this 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 reports a 424 error (Section 4.6) in the video mixes), then the MS reports a 424 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 If the MS receives a <join> or <modifyjoin> request containing a
<stream> element (Section 4.2.2.5) specifying a region and the <stream> element (Section 4.2.2.5) that specifies a region and the
conference video switching policy is set to <vas/>, then the MS conference video-switching policy is set to <vas/>, then the MS
ignores 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 4.2.2.5) specifying a region which is not <stream> element (Section 4.2.2.5) specifying a region that 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 displays the participant if the layout changes to one which MS displays the participant if the layout changes to one that defines
defines the specified region. the specified region.
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 interval="2"><vas/></video-switch> <video-switch interval="2"><vas/></video-switch>
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 is as follows:
<video-switch interval="0"><controller/></video-switch> <video-switch interval="0"><controller/></video-switch>
4.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 a (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 4.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
1, then those with 2, 3, etc). priority 1, then those with 2, 3, etc.).
3. The policy for displaying participants with the same priority is 3. The policy for displaying participants with the same priority is
implementation-specific. implementation-specific.
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-switching 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.
4.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 4.2.4). element (see Section 4.2.4).
skipping to change at page 29, line 31 skipping to change at page 27, line 39
(Section 4.2.1.4.4.1). The element is optional. (Section 4.2.1.4.4.1). The element is optional.
The MS MUST support a <active-talkers-sub> subscription. It MAY The MS MUST support a <active-talkers-sub> subscription. It MAY
support other event subscriptions (specified using attributes and support other event subscriptions (specified using attributes and
child elements from a foreign namespace). If the MS does not support child elements from a foreign namespace). If the MS does not support
a subscription specified in a foreign namespace, it sends a a subscription specified in a foreign namespace, it sends a
<response> with a 428 status code (see Section 4.6). <response> with a 428 status code (see Section 4.6).
4.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 attribute:
interval: the minimum amount of time (in seconds) that elapses 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 4.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-talkers-sub> element has no child elements. The <active-talkers-sub> element has no child elements.
Active talker notifications are delivered in the <active-talkers- Active talker notifications are delivered in the <active-talkers-
notify> element (Section 4.2.4.1). notify> element (Section 4.2.4.1).
4.2.2. Joining Elements 4.2.2. Joining Elements
In this section, the joining model is defined (Section 4.2.2.1) as This section contains definitions of the joining model
well as definitions of the <join> (Section 4.2.2.2), <modifyjoin> (Section 4.2.2.1) as well as the <join> (Section 4.2.2.2),
(Section 4.2.2.3), <unjoin> (Section 4.2.2.4) and <stream> <modifyjoin> (Section 4.2.2.3), <unjoin> (Section 4.2.2.4) and
(Section 4.2.2.5) elements. <stream> (Section 4.2.2.5) elements.
4.2.2.1. Joining Model 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 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 mixer 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,
use a more complex algorithm so that participants do not hear however, use a more complex algorithm so that participants do not
themselves as part of the mix. That algorithm, sometimes called an hear themselves as part of the mix. That algorithm, sometimes called
n-minus mix, subtracts each participants input signal from the summed an "n-minus mix", subtracts each participants input signal from the
input signals, creating a unique output for each contributing summed 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
conference's available inputs and/or outputs, to the maximum number conference's available inputs and/or outputs, to the maximum number
of supported participants. of supported participants.
A connection is the termination of a RTP session(s) on a media A connection is the termination of one or more RTP sessions on a
server. It has a single input and output for each media session media server. It has a single input and output for each media
established by its SIP dialog. The output of a connection can feed session established by its SIP dialog. The output of a connection
several different inputs such as both a conference mixer and a can feed several different inputs such as both a conference mixer and
recording of that participant's audio. a recording of that participant's audio.
Joining two connections which are are not joined to anything else Joining two connections that are not joined to anything else simply
simply creates a media stream from the outputs(s) of one connection creates a media stream from the outputs(s) of one connection to the
to the corresponding inputs(s) of the other connection. It is not corresponding inputs(s) of the other connection. It is not necessary
necessary to combine media from multiple sources in this case. There to combine media from multiple sources in this case. There are,
are however several common scenarios where combining media from however, several common scenarios where combining media from several
several sources to create a single input to a connection is needed. sources to create a single input to a connection is needed.
In the first case, a connection can 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
whisper announcement is to have the announcement pre-empt the a whisper announcement is to have the announcement preempt 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 that are not heard by the
customer. customer.
Both of these cases can be solved by having the controlling AS create Both of these cases can be solved by having the controlling AS create
one or more conferences for audio mixing, and then join and unjoin one or more conferences for audio mixing, and then join and unjoin
the media streams as required. A better solution is to have the the media streams as required. A better solution is to have the
media server automatically mix media streams that are requested to be media server automatically mix media streams that are requested to be
joined to a common input when only the simple summing of audio joined to a common input when only the simple summing of audio
signals as described above is required. This is the case for both signals as described above is required. This is the case for both
the use cases presented above. the use cases presented above.
Automatically mixing streams has several benefits. Conceptually, it Automatically mixing streams has several benefits. Conceptually, it
is straight forward and simple, requiring no indirect requests on the is straightforward 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 (and it MUST fail the request and MUST NOT join any of the streams (and
MUST NOT change existing streams of the entities). A controlling AS MUST NOT change existing streams of the entities). A controlling AS
uses the <createconference> request for generic conferences where the uses the <createconference> request for generic conferences where the
complex mixing algorithm is required. complex mixing algorithm is required.
Specifications which extend this package to handle additional media Specifications that extend this package to handle additional media
types such as text, MUST define the semantics of the join operation types such as text MUST define the semantics of the join operation
when multiple streams are requested to be joined to a single input, when multiple streams are requested to be joined to a single input,
such as that for a connection with a single RTP session per media such as that for a connection with a single RTP session per media
type. type.
4.2.2.2. <join> 4.2.2.2. <join>
The <join> element is sent to the MS to request creation of one or The <join> element is sent to the MS to request creation of one or
more media streams either between a connection and a conference, more media streams either between a connection and a conference,
between connections, or between conferences. The two entities to between connections, or between conferences. The two entities to
join are specified by the attributes of <join>. join are specified by the attributes of <join>.
Streams can be of any media type, and can be bi-directional or uni- Streams can be of any media type and can be bidirectional or
directional. A bi-directional stream is implicitly composed of two unidirectional. A bidirectional stream is implicitly composed of two
uni-directional streams that can be manipulated independently. The unidirectional 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 4.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 16.1 of identifier MUST conform to the syntax defined in Appendix A.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [RFC6230]. 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 16.1 of identifier MUST conform to the syntax defined in Appendix A.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [RFC6230]. The attribute is mandatory.
mandatory.
Note: Section 16.1 of [I-D.ietf-mediactrl-sip-control-framework] Note: Appendix A.1 of [RFC6230] defines the semantics for a
defines the semantics for a conference identifier but not its syntax. conference identifier but not its syntax. Media server
Media server implementations need to distinguish between conferences implementations need to distinguish between conferences and
and connections based upon the values of the "id1" and "id2" connections based upon the values of the 'id1' and 'id2' attributes.
attributes.
If id1 or id2 specify a conference identifier and the conference does 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 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 specify a connection identifier and the connection does not exist on
the MS, the MS reports an error (412). 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 (zero 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 4.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 can be specified so that individual One or more <stream> elements can be specified so that individual
skipping to change at page 32, line 47 skipping to change at page 30, line 51
explicitly specified using <stream> elements. explicitly specified using <stream> elements.
Multiple <stream> elements can be specified for precise control over Multiple <stream> elements can be specified for precise control over
the media flow in different directions within the same media stream. the media flow in different directions within the same media stream.
One <stream> element can be specified for the receiving media flow One <stream> element can be specified for the receiving media flow
and another element for the sending media flow, where each and another element for the sending media flow, where each
independently controls features such as volume (see child element of independently controls features such as volume (see child element of
<stream> in Section 4.2.2.5). If there is only one <stream> element <stream> in Section 4.2.2.5). If there is only one <stream> element
for a given media specifying a 'sendonly' or 'recvonly' direction, for a given media specifying a 'sendonly' or 'recvonly' direction,
then the media flow in the opposite direction is inactive then the media flow in the opposite direction is inactive
(established but no actual flow of media) unless this leads to a (established but there's no actual flow of media) unless this leads
stream conflict. 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>
because a <stream> element is in conflict with (a) another <stream> because a <stream> element is in conflict with (a) another <stream>
element, (b) with specified connection or conference media element, (b) specified connection or conference media capabilities
capabilities (including supported or available codec information), or (including supported or available codec information), or (c) an
(c) with a SDP label value as part of the connection-id (see Section Session Description Protocol (SDP) label value as part of the
16.1 of [I-D.ietf-mediactrl-sip-control-framework]), then the MS connection-id (see Appendix A.1 of [RFC6230]), then the MS reports an
reports an error (407) and MUST NOT join the entities and MUST NOT error (407) and MUST NOT join the entities and MUST NOT change
change existing streams of the entities. existing streams of the entities.
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 because the MS does not support the media stream elements because the MS does not support the media stream
configuration, the MS reports an error (422) and MUST NOT join the configuration, the MS reports an error (422) and MUST NOT join the
entities and MUST NOT change existing streams of the entities. 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 reports an error (410). full, then the MS reports an error (410).
If the specified entities are already joined, then the MS reports an If the specified entities are already joined, then the MS reports an
skipping to change at page 33, line 33 skipping to change at page 31, line 37
If the MS does not support joining two specified conferences If the MS does not support joining two specified conferences
together, the MS reports 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 reports 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 4.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 connections together is as
follows:
<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="1536067209:913cd14c" id2="1536067209:913cd14c"/> <join id1="1536067209:913cd14c" id2="1536067209:913cd14c"/>
</mscmixer> </mscmixer>
and the response if the MS doesn't support joining media streams The response if the MS doesn't support joining media streams between
between connections: connections is as follows:
<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>
4.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 16.1 of identifier MUST conform to the syntax defined in Appendix A.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [RFC6230]. 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 16.1 of identifier MUST conform to the syntax defined in Appendix A.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [RFC6230]. The attribute is mandatory.
mandatory.
The <modifyjoin> element has the following child elements (1 or The <modifyjoin> element has the following child elements (one 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 is now to be modify and defines the way that each stream is to be configured
configured (see Section 4.2.2.5). from this point forward (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 MS MUST configure the streams that are included within The MS MUST configure the streams that are included within
<modifyjoin> to that stated by the child elements. <modifyjoin> to that stated by the child 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 because a <stream> element is in conflict with (a) another elements because a <stream> element is in conflict with (a) another
<stream> element, (b) with specified connection or conference media <stream> element, (b) specified connection or conference media
capabilities (including supported or available codec information), or capabilities (including supported or available codec information), or
(c) with a SDP label value as part of the connection-id (see Section (c) a SDP label value as part of the connection-id (see Appendix A.1
16.1 of [I-D.ietf-mediactrl-sip-control-framework]), then the MS of [RFC6230]), then the MS reports an error (407) and MUST NOT modify
reports an error (407) and MUST NOT modify the join between the the join between the entities and MUST NOT change existing streams of
entities and MUST NOT change existing streams of the entities. the entities.
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 because the MS does not support the media stream elements because the MS does not support the media stream
configuration, the MS reports an error (422) and MUST NOT modify the configuration, the MS reports an error (422) and MUST NOT modify the
join between the entities and MUST NOT change existing streams of the join between the entities and MUST NOT change existing streams of the
entities. entities.
If the specified entities are not already joined, then the MS reports If the specified entities are not already joined, then the MS reports
an error (409). an error (409).
skipping to change at page 35, line 33 skipping to change at page 33, line 39
then the following <modifyjoin> request then the following <modifyjoin> request
<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="conference1"> <modifyjoin id1="1536067209:913cd14c" id2="conference1">
<stream media="audio" direction="sendonly"> <stream media="audio" direction="sendonly">
<volume controltype="setgain" value="0"/> <volume controltype="setgain" value="0"/>
</stream> </stream>
</modifyjoin> </modifyjoin>
</mscmixer> </mscmixer>
would cause, in addition to the sendonly volume being modified, that would cause, in addition to the modification of the sendonly volume,
the overall stream directionality changes from sendrecv to sendonly the overall stream directionality to change from sendrecv to sendonly
since there is no <stream> element in this <modifyjoin> request for since there is no <stream> element in this <modifyjoin> request for
the recvonly direction. The following would change the sendonly the recvonly direction. The following would change the sendonly
volume and retain the recvonly stream together with its original volume and retain the recvonly stream together with its original
characteristics such as volume: characteristics such as volume:
<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="conference1"> <modifyjoin id1="1536067209:913cd14c" id2="conference1">
<stream media="audio" direction="sendonly"> <stream media="audio" direction="sendonly">
<volume controltype="setgain" value="0"/> <volume controltype="setgain" value="0"/>
</stream> </stream>
skipping to change at page 36, line 14 skipping to change at page 34, line 23
4.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 16.1 of identifier MUST conform to the syntax defined in Appendix A.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [RFC6230]. 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 15.1 of identifier MUST conform to the syntax defined in Section 15.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [RFC6230]. The attribute is mandatory.
mandatory.
The <unjoin> element has the following child element (0 or more The <unjoin> element has the following child element (zero 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 4.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 that has not already been removed by a previous
on the same stream. <unjoin> on the same stream.
If the MS is unable to terminate the join as specified in <stream> If the MS is unable to terminate the join as specified in <stream>
elements because a <stream> element is in conflict with (a) another elements because a <stream> element is in conflict with (a) another
<stream> element, (b) with specified connection or conference media <stream> element, (b) specified connection or conference media
capabilities or (c) with a SDP label value as part of the capabilities, or (c) a SDP label value as part of the connection-id
connection-id (see Section 16.1 of (see Appendix A.1 of [RFC6230]), then the MS reports an error (407)
[I-D.ietf-mediactrl-sip-control-framework]), then the MS reports an and MUST NOT terminate the join between the entities and MUST NOT
error (407) and MUST NOT terminate the join between the entities and change existing streams of the entities.
MUST NOT change existing streams of the entities.
If the MS is unable to terminate the join as specified in <stream> If the MS is unable to terminate the join as specified in <stream>
elements because the MS does not support the media stream elements because the MS does not support the media stream
configuration, the MS reports an error (422) and MUST NOT terminate configuration, the MS reports an error (422) and MUST NOT terminate
the join between the entities and MUST NOT change existing streams of the join between the entities and MUST NOT change existing streams of
the entities. the entities.
If the specified entities are not already joined, then the MS reports If the specified entities are not already joined, then the MS reports
an error (409). 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 reports 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 4.2.3). reply with a successful <response> element (Section 4.2.3).
4.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 manipulation 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
media stream(s) for the request and to specify the configuration of the media stream(s) for the request and to specify the configuration
the media stream. of 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. A valid value is a MIME type-name as defined in Section stream. A valid value is a MIME type name as defined in Section
4.2 of [RFC4288]. The following values MUST be used for common 4.2 of [RFC4288]. The following values MUST be used for common
types of media: "audio" for audio media, and "video" for video types of media: "audio" for audio media, and "video" for video
media. See IANA ([IANA]) for registered MIME type names. The media. See [IANA] for registered MIME type names. The attribute
attribute is mandatory. 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 4.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 4.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 4.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 4.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 indicated by the In each child element, the media stream affected is indicated by the
value of the direction 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 ignores <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 ignores a <region> element. MS ignores a <region> element.
For example, a request to join a connection to conference in both For example, a request to join a connection to conference in both
directions with volume control: directions with volume control is as follows:
<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="1536067209:913cd14c" id2="conference1"> <join id1="1536067209:913cd14c" id2="conference1">
<stream media="audio" direction="sendrecv"> <stream media="audio" direction="sendrecv">
<volume controltype="setgain" value="-3"/> <volume controltype="setgain" value="-3"/>
</stream> </stream>
</join> </join>
</mscmixer> </mscmixer>
where audio flow from the connection (id1) to the conference (id2) where audio flow from the connection (id1) to the conference (id2)
has the volume lowered by 3dB, and likewise the volume of the audio has the volume lowered by 3 dB, and likewise the volume of the audio
flow from the conference to the connection is lowered by 3 dB. flow from the conference to the connection is lowered by 3 dB.
In this example, the volume is independently controlled for each In this example, the volume is independently controlled for each
direction. direction.
<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="1536067209:913cd14c" id2="conference1"> <join id1="1536067209:913cd14c" id2="conference1">
<stream media="audio" direction="sendonly"> <stream media="audio" direction="sendonly">
<volume controltype="setgain" value="-3"/> <volume controltype="setgain" value="-3"/>
</stream> </stream>
<stream media="audio" direction="recvonly"> <stream media="audio" direction="recvonly">
<volume controltype="setgain" value="+3"/> <volume controltype="setgain" value="+3"/>
</stream> </stream>
</join> </join>
</mscmixer> </mscmixer>
where audio flow from the connection (id1) to the conference (id2) 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 has the volume lowered by 3 dB, but the volume of the audio flow from
the conference to the connection is raised by 3 dB. the conference to the connection is raised by 3 dB.
4.2.2.5.1. <volume> 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 can 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), and "setstate" (set the
of the stream to "mute" or "unmute" as specified by the value of state of the stream to "mute" or "unmute" as specified by the
the "value" attribute). The attribute is mandatory. value of 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.
If the audio media stream is in a muted state, then the MS also If the audio media stream is in a muted state, then the MS also
changes automatically the state to unmuted with an "automatic" or changes automatically the state to unmuted with an "automatic" or
"setgain" volume control. For the example, assume an audio stream "setgain" volume control. For example, assume an audio stream has
has been muted with <volume controltype="setstate" value="mute"/>. been muted with <volume controltype="setstate" value="mute"/>. If
If the gain on the same stream is changed with <volume the gain on the same stream is changed with <volume
controltype="setgain" value="+3"/>, then the volume is increased and controltype="setgain" value="+3"/>, then the volume is increased and
stream state is also changed to unmuted. stream state is also changed to unmuted.
4.2.2.5.2. <clamp> 4.2.2.5.2. <clamp>
The <clamp> element is used to configure whether tones are filtered The <clamp> element is used to configure whether tones are 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: attribute:
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 optional. The default value is "1 2 3 4 5 6 7 8 9 0 * # A B C is optional. The default value is "1 2 3 4 5 6 7 8 9 0 * # A B C
D" (i.e. all DTMF (Dual-Tone Multi-Frequency) tones removed). D" (i.e., all DTMF (Dual-Tone Multi-Frequency) tones are removed).
4.2.2.5.3. <region> 4.2.2.5.3. <region>
As described in Section 4.2.1.4.2.1, each <video-layout> is composed As described in Section 4.2.1.4.2.1, each <video-layout> is composed
of one or more named regions (or areas) in which video media can be of one or more named regions (or areas) in which video media can be
presented. For example, the XCON layout <dual-view> has two regions presented. For example, the XCON layout <dual-view> has two regions
named "1" and "2" respectively. named "1" and "2", respectively.
The <region> element is used to explicitly specify the name of the The <region> element is used to explicitly specify the name of the
area within a video layout where a video media stream is displayed. area within a video layout where a video 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. specifies the name of the region.
4.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 4.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 4.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.
4.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 4.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.
desclang: specifies the language used in the value of the the reason desclang: specifies the language used in the value of the 'reason'
attribute. A valid value is a language identifier attribute. A valid value is a language identifier
(Section 4.7.7). The attribute is optional. If not specified, (Section 4.7.7). The attribute is optional. If not specified,
the value of the desclang attribute on <mscmixer> (Section 4.1) the value of the 'desclang' attribute on <mscmixer> (Section 4.1)
applies. applies.
conferenceid: string identifying the conference (see Section 16.1 of conferenceid: string identifying the conference (see Appendix A.1 of
[I-D.ietf-mediactrl-sip-control-framework]). The attribute is [RFC6230]). The attribute is optional.
optional.
connectionid: string identifying the SIP dialog connection (see connectionid: string identifying the SIP dialog connection (see
Section 16.1 of [I-D.ietf-mediactrl-sip-control-framework]). The Appendix A.1 of [RFC6230]). The attribute is optional.
attribute is optional.
For example, a response when a conference was created successfully: For example, a response when a conference was created successfully is
as follows:
<response code="200"/> <response code="200"/>
The response if conference creation failed due to the requested If conference creation failed due to the requested conference ID
conference id already existing: already existing, the response is:
<response code="405" reason="Conference already exists"/> <response code="405" reason="Conference already exists"/>
4.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 (zero or more instances of each child):
<active-talkers-notify> specifies an active talkers notification <active-talkers-notify>: specifies an active talkers notification
(Section 4.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 4.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 4.2.4.3). (Section 4.2.4.3).
4.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 4.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 attribute:
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 occurrences): child elements (zero or more occurrences):
<active-talker> element describing an active talker <active-talker>: element describing an active talker
(Section 4.2.4.1.1). (Section 4.2.4.1.1).
4.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.
Note that the element does not describe an active talker if both the Note that the element does not describe an active talker if both the
connectionid and conferenceid attributes are specified, or if neither 'connectionid' and 'conferenceid' attributes are specified, or if
attribute is specified. neither attribute is specified.
The <active-talker> element has no child elements. The <active-talker> element has no child elements.
4.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:
skipping to change at page 42, line 42 skipping to change at page 41, line 12
2 indicates that the join terminated because a connection or 2 indicates that the join terminated because a connection or
conference has terminated. conference has terminated.
All other valid but undefined values are reserved for future use, All other valid but undefined values are reserved for future use,
where new status codes are assigned using the Standards Action where new status codes are assigned using the Standards Action
process defined in [RFC5226]. The AS MUST treat any status code process defined in [RFC5226]. The AS MUST treat any status code
it does not recognize as being equivalent to 1 (join execution it does not recognize as being equivalent to 1 (join execution
error). The attribute is mandatory. 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
Section 4.7.4). The attribute is optional. There is no default (see Section 4.7.4). The attribute is optional. There is no
value. default value.
desclang: specifies the language used in the value of the the reason desclang: specifies the language used in the value of the 'reason'
attribute. A valid value is a language identifier attribute. A valid value is a language identifier
(Section 4.7.7). The attribute is optional. If not specified, (Section 4.7.7). The attribute is optional. If not specified,
the value of the desclang attribute on <mscmixer> (Section 4.1) the value of the 'desclang' attribute on <mscmixer> (Section 4.1)
applies. applies.
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 16.1 of identifier MUST conform to the syntax defined in Appendix A.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [RFC6230]. 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 16.1 of identifier MUST conform to the syntax defined in Appendix A.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [RFC6230]. The attribute is mandatory.
mandatory.
The <unjoin-notify> element has no child elements. The <unjoin-notify> element has no child elements.
4.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.
skipping to change at page 43, line 49 skipping to change at page 42, line 15
2 indicates the conference terminated due to exceeding the 2 indicates the conference terminated due to exceeding the
maximum duration for a conference. maximum duration for a conference.
All other valid but undefined values are reserved for future use, All other valid but undefined values are reserved for future use,
where new status codes are assigned using the Standards Action where new status codes are assigned using the Standards Action
process defined in [RFC5226]. The AS MUST treat any status code process defined in [RFC5226]. The AS MUST treat any status code
it does not recognize as being equivalent to 1 (conference it does not recognize as being equivalent to 1 (conference
execution error). The attribute is mandatory. 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
Section 4.7.4). The attribute is optional. There is no default (see Section 4.7.4). The attribute is optional. There is no
value. default value.
desclang: specifies the language used in the value of the the reason desclang: specifies the language used in the value of the 'reason'
attribute. A valid value is a language identifier attribute. A valid value is a language identifier
(Section 4.7.7). The attribute is optional. If not specified, (Section 4.7.7). The attribute is optional. If not specified,
the value of the desclang attribute on <mscmixer> (Section 4.1) the value of the 'desclang' attribute on <mscmixer> (Section 4.1)
applies. applies.
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
can be reused for another conference. and 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="0"/> status="0"/>
</event> </event>
skipping to change at page 44, line 40 skipping to change at page 43, line 5
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 can 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 could be used when currently managed by the package on the MS. This could be used when
one AS takes over management of mixers if the AS which created the one AS takes over management of mixers if the AS that created the
mixers fails or is no longer available (see Security Considerations mixers fails or is no longer available (see the security
described in Section 7). considerations in Section 7).
4.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 4.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 4.7.1). A value of true indicates that mixer information Section 4.7.1). A value of "true" indicates that mixer
is to be reported. A value of false indicates that mixer information is to be reported. A value of "false" indicates that
information is not to be reported. The attribute is optional. mixer information is not to be reported. The attribute is
The default value is true. optional. 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'
is specified, then only audit information about the specified attribute is specified, then only audit information about the
conference mixer is reported. If the mixers attribute has the value specified conference mixer is reported. If the 'mixers' attribute
false, then no mixer audit information is reported even if a has the value "false", then no mixer audit information is reported
conferenceid attribute is specified. even if a '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 4.3.2) which includes a mandatory <auditresponse> element (Section 4.3.2) that 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 4.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 4.3.2.1) reporting package values) a <capabilities> element (Section 4.3.2.1) reporting package
capabilities and a <mixers> element (Section 4.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
specified for a class of error within this section, implementations specified for a class of error within this section, implementations
follow Section 4.6 in determining the appropriate status code for the follow Section 4.6 in determining the appropriate 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 is as follows:
<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"/>
skipping to change at page 46, line 29 skipping to change at page 44, line 45
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 4.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.
desclang: specifies the language used in the value of the the reason desclang: specifies the language used in the value of the 'reason'
attribute. A valid value is a language identifier attribute. A valid value is a language identifier
(Section 4.7.7). The attribute is optional. If not specified, (Section 4.7.7). The attribute is optional. If not specified,
the value of the desclang attribute on <mscmixer> (Section 4.1) the value of the 'desclang' attribute on <mscmixer> (Section 4.1)
applies. applies.
The <auditresponse> element has the following sequence of child The <auditresponse> element has the following sequence of child
elements: elements:
<capabilities> element (Section 4.3.2.1) describing capabilities of <capabilities>: element describing capabilities of the package (see
the package. The element is optional. Section 4.3.2.1). The element is optional.
<mixers> element (Section 4.3.2.2) describing information about <mixers>: element describing information about managed mixers (see
managed mixers. The element is optional. Section 4.3.2.2). The element is optional.
For example, a successful response to a <audit> request requesting For example, a successful response to an <audit> request for
capabilities and mixer information: capabilities and mixer information is as follows:
<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 name="video"> <codec name="video">
<subtype>H263</subtype> <subtype>H263</subtype>
</codec> </codec>
<codec name="video"> <codec name="video">
<subtype>H264</subtype> <subtype>H264</subtype>
skipping to change at page 48, line 8 skipping to change at page 46, line 18
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 4.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 is as follows:
<capabilities> <capabilities>
<codecs> <codecs>
<codec name="video"> <codec name="video">
<subtype>H263</subtype> <subtype>H263</subtype>
</codec> </codec>
<codec name="video"> <codec name="video">
<subtype>H264</subtype> <subtype>H264</subtype>
</codec> </codec>
<codec name="audio"> <codec name="audio">
skipping to change at page 48, line 33 skipping to change at page 46, line 43
</codec> </codec>
</codecs> </codecs>
</capabilities> </capabilities>
4.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
or more occurrences, any order): (zero or more occurrences, any order):
<conferenceaudit>: audit information for a conference mixer <conferenceaudit>: audit information for a conference mixer
(Section 4.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 4.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.
4.3.2.2.1. <conferenceaudit> 4.3.2.2.1. <conferenceaudit>
The <conferenceaudit> element has the following attributes: The <conferenceaudit> element has the following attribute:
conferenceid: string identifying the conference (see Section 16.1 of conferenceid: string identifying the conference (see Appendix A.1 of
[I-D.ietf-mediactrl-sip-control-framework]). The attribute is [RFC6230]). 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 4.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 4.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 4.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 that has been created
created but has no participants: but has no participants is as follows:
<conferenceaudit conferenceid="conference1"/> <conferenceaudit conferenceid="conference1"/>
And a fragment when the same conference has three participants (two A fragment when the same conference has three participants (two
connections and another conference) joined to it: connections and another conference) joined to it is as follows:
<conferenceaudit conferenceid="conference1"> <conferenceaudit conferenceid="conference1">
<codecs> <codecs>
<codec name="audio"> <codec name="audio">
<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>
4.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 4.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 (zero or more):
<participant>: specifies a participant (Section 4.3.2.2.1.1.1). <participant>: specifies a participant (Section 4.3.2.2.1.1.1).
4.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 attribute:
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 16.1 of identifier MUST conform to the syntax defined in Appendix A.1 of
[I-D.ietf-mediactrl-sip-control-framework]. The attribute is [RFC6230]. The attribute is mandatory.
mandatory.
The <participant> element has no children. The <participant> element has no children.
4.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 16.1 of identifier MUST conform to the syntax defined in Appendix A.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [RFC6230]. 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 16.1 of identifier MUST conform to the syntax defined in Appendix A.1 of
[I-D.ietf-mediactrl-sip-control-framework] The attribute is [RFC6230]. 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, is as
follows:
<mixers> <mixers>
<joinaudit id1="1536067209:913cd14" id2="1636067209:413cd14"/> <joinaudit id1="1536067209:913cd14" id2="1636067209:413cd14"/>
<joinaudit id1="conference1" id2="conference2"/> <joinaudit id1="conference1" id2="conference2"/>
</mixers> </mixers>
4.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
or more occurrences): (zero or more occurrences):
<codec>: defines a codec and optionally its policy (Section 4.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 is as follows:
<codecs> <codecs>
<codec name="audio"> <codec name="audio">
<subtype>PCMA</subtype> <subtype>PCMA</subtype>
</codec> </codec>
<codec name="video"> <codec name="video">
<subtype>H263</subtype> <subtype>H263</subtype>
</codec> </codec>
</codecs> </codecs>
4.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 ([RFC6501]) and allows additional information (e.g., rate, speed,
(e.g. rate, speed, etc) to be specified. etc.) to be specified.
The <codec> element has the following attributes: The <codec> element has the following attribute:
name: indicates the type name of the codec's media format as defined name: indicates the type name of the codec's media format as defined
in IANA ([IANA]). A valid value is a "type-name" as defined in in [IANA]. A valid value is a "type-name" as defined in Section
Section 4.2 of [RFC4288]. The attribute is manadatory. 4.2 of [RFC4288]. The attribute is mandatory.
The <codec> element has the following sequence of child elements: The <codec> element has the following sequence of child elements:
<subtype>: element whose content model describes the subtype of the <subtype>: element whose content model describes the subtype of the
codec's media format as defined in IANA ([IANA]). A valid value codec's media format as defined in [IANA]. A valid value is a
is a "subtype-name" as defined in Section 4.2 of [RFC4288]. The "subtype-name" as defined in Section 4.2 of [RFC4288]. The
element is mandatory. element is mandatory.
<params>: element (Section 4.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 is as follows:
<codec name=video"> <codec name="video">
<subtype>H263</subtype> <subtype>H263</subtype>
</codec> </codec>
A fragment where the <codec> element describes the H264 video codec
And a fragment where the <codec> element describes the H264 video with additional information about the profile level and packetization
codec with additional information about the profile level and mode is as follows:
packetization mode:
<codec name="video"> <codec name="video">
<subtype>H264</subtype> <subtype>H264</subtype>
<params> <params>
<param name="profile-level-id">42A01E</param> <param name="profile-level-id">42A01E</param>
<param name="packetization-mode">0</param> <param name="packetization-mode">0</param>
</params> </params>
</codec> </codec>
4.5. <params> 4.5. <params>
The <params> element is a container for <param> elements The <params> element is a container for <param> elements
(Section 4.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 (zero or more):
<param>: specifies a parameter name and value (Section 4.5.1). <param>: specifies a parameter name and value (Section 4.5.1).
4.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 in-line 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 4.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".
encoding: specifies a content-transfer-encoding schema applied to encoding: specifies a content-transfer-encoding schema applied to
the inline value of the parameter on top of the MIME media type the in-line value of the parameter on top of the MIME media type
specified with the type attribute. A valid value is a content- specified with the 'type' attribute. A valid value is a content-
transfer-encoding schema as defined by the "mechanism" token in transfer-encoding schema as defined by the "mechanism" token in
Section 6.1 of [RFC2045]. The attribute is optional. There is no Section 6.1 of [RFC2045]. The attribute is optional. There is no
default value. default value.
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 that contains XML characters (e.g., "<") needs to
be escaped following standard XML conventions. be escaped following standard XML conventions.
4.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 4.2.3) and audit attribute of mixer management <response> (Section 4.2.3) and
<auditresponse> (Section 4.3.2) responses. The MS MUST support the <auditresponse> (Section 4.3.2). The MS MUST support the status
status response codes defined here. All other valid but undefined response codes defined here. All other valid but undefined values
values are reserved for future use, where new status codes are are reserved for future use, where new status codes are assigned
assigned using the Standards Action process defined in [RFC5226]. using the Standards Action process defined in [RFC5226]. The AS MUST
The AS MUST treat any responses it does not recognize as being treat any responses it does not recognize as being equivalent to the
equivalent to the x00 response code for all classes. For example, if x00 response code for all classes. For example, if an AS receives an
an AS receives an unrecognized response code of 499, it can safely unrecognized response code of 499, it can safely assume that there
assume that there was something wrong with its request and treat the was something wrong with its request and treat the response as if it
response as if it had received a 400 (Syntax error) response code. 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
element" for a 400 (Syntax error) response code. element" for a 400 (Syntax error) response code.
The AS SHOULD NOT retry the same request without modification (for The AS SHOULD NOT retry the same request without modification (for
example, correcting a syntax error or changing the conferenceid to example, correcting a syntax error or changing the conferenceid to
use one available on the MS). However, the same request to a use one available on the MS). However, the same request to a
different MS might be successful; for example, if another MS supports different MS might be successful, for example, if another MS supports
a capability required in the request. a capability required in the request.
4xx failure responses can be grouped into three classes: failure due 4xx failure responses can be grouped into three classes: failure due
to a syntax error in the request (400); failure due to an error to a syntax error in the request (400); failure due to an error
executing the request on the MS (405-419); and failure due to the executing the request on the MS (405-419); and failure due to the
request requiring a capability not supported by the MS (420-435). request requiring a capability not supported by the MS (420-435).
In cases where more than one request code could be reported for a In cases where more than one request code could be reported for a
failure, the MS SHOULD use the most specific error code of the failure, the MS SHOULD use the most specific error code of the
failure class for the detected error. For example, if the MS detects failure class for the detected error. For example, if the MS detects
that the conference identifier in the request is invalid, then it that the conference identifier in the request is invalid, then it
uses a 406 status code. However, if the MS merely detects that an uses a 406 status code. However, if the MS merely detects that an
execution error occurred, then 419 is used. execution error occurred, then 419 is used.
+-------+---------------+----------------------+--------------------+ +-------+---------------+----------------------+--------------------+
| Code | Summary | Description | Informational: AS | | Code | Summary | Description | Informational: AS |
| | | | Possible Recovery | | | | | Possible Recovery |
| | | | Action | | | | | Action |
+-------+---------------+----------------------+--------------------+ +-------+---------------+----------------------+--------------------+
| 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 5 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 4. | | | | | Section 4. | |
| | | | | | | | | |
| 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 4.3.1) | | | exists | a new conference | (Section 4.3.1) |
| | | (Section 4.2.1.1) | requesting the | | | | (Section 4.2.1.1) | requesting the |
| | | which is already | list of conference | | | | that is already used | list of conference |
| | | used by another | mixer identifiers | | | | 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 that is |
| | | | is not listed. | | | | | 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 4.3.1) | | | exist | conference that does | (Section 4.3.1) |
| | | does not exist on | requesting the | | | | not exist on the MS. | requesting the |
| | | the MS. | list of conference | | | | | 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 that is |
| | | | is listed. | | | | | 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 that | configuration to |
| | | is in conflict with | match the | | | | is in conflict with | match the |
| | | itself, or the | capabilities of | | | | itself, the | capabilities of |
| | | connection or | the connection or | | | | connection, or | the connection or |
| | | conference | conference | | | | conference | conference. |
| | | capabilities (see | | | | | capabilities (see | |
| | | Section 4.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 4.2.2.2) | (Section 4.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 that 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 4.3.1) | | | joined | mixer where the | (Section 4.3.1) |
| | | which are not joined | requesting the | | | | entities are not | requesting the |
| | | | list of join | | | | joined. | list of join |
| | | | mixers on the MS | | | | | mixers on the MS |
| | | | and then use | | | | | and then use |
| | | | entities which are | | | | | entities that 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 4.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 | Connection | request uses an | | | 412 | Connection | request uses an | |
| | does not | identifier for a | | | | does not | identifier for a | |
| | exist | connection which | | | | exist | connection that does | |
| | | does not exist on | | | | | not exist on the MS. | |
| | | the MS. | | | | | | |
| 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 4.2.1.1) | | | | failed | (Section 4.2.1.1) | |
| | | failed due to | | | | | failed due to | |
| | | unsupported | | | | | unsupported | |
| | | reservation of | | | | | reservation of | |
skipping to change at page 57, line 7 skipping to change at page 55, line 7
| | | 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 4.2.2.2) | | | | connections | (Section 4.2.2.2) | |
| | not supported | failed due lack of | | | | not supported | failed due to lack | |
| | | support for mixing | | | | | of support for | |
| | | connections. | | | | | mixing connections. | |
| | | | | | | | | |
| 427 | Unable to | request to join | | | 427 | Unable to | request to join | |
| | join - mixing | conference entities | | | | join - mixing | conference entities | |
| | conferences | (Section 4.2.2.2) | | | | conferences | (Section 4.2.2.2) | |
| | not supported | failed due lack of | | | | not supported | failed due to lack | |
| | | support for mixing | | | | | of support for | |
| | | conferences. | | | | | mixing 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 | that the MS does not | |
| | | not support | | | | | support. | |
| | | | | | | | | |
| 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
4.7. Type Definitions 4.7. Type Definitions
This section defines types referenced in attribute definitions. This section defines types referenced in attribute definitions.
4.7.1. Boolean 4.7.1. Boolean
The value space of boolean is the set {true, false, 1, 0} as defined The value space of boolean is the set {true, false, 1, 0} as defined
in Section 3.2.2 of [XMLSchema:Part2]. In accordance with this in Section 3.2.2 of [XMLSchema:Part2]. In accordance with this
definition, the concept of false can be lexically represented by the definition, the concept of false can be lexically represented by the
skipping to change at page 58, line 26 skipping to change at page 56, line 26
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".
4.7.6. MIME Media Type 4.7.6. MIME Media Type
A string formated as an IANA MIME media type ([MIME.mediatypes]). A string formatted as an IANA MIME media type [MIME.mediatypes]. The
The ABNF ([RFC5234]) production for the string is: ABNF ([RFC5234]) production for the string is:
type-name "/" subtype-name *(";" parameter) media-type = type-name "/" subtype-name *(";" parameter)
parameter = parameter-name "=" value parameter = parameter-name "=" value
where "type-name" and "subtype-name" are defined in Section 4.2 of where "type-name" and "subtype-name" are defined in Section 4.2 of
[RFC4288], "parameter-name" is defined in Section 4.3 of [RFC4288] [RFC4288], "parameter-name" is defined in Section 4.3 of [RFC4288],
and "value" is defined in Section 5.1 of [RFC2045]. and "value" is defined in Section 5.1 of [RFC2045].
4.7.7. Language Identifier 4.7.7. Language Identifier
A language identifier labels information content as being of a A language identifier labels information content as being of a
particular human language variant. Following the XML specification particular human language variant. Following the XML specification
for language identification [XML], a legal language identifier is for language identification [XML], a legal language identifier is
identified by a RFC5646 code ([RFC5646]) and matched according to identified by a [RFC5646] code and matched according to [RFC4647].
RFC4647 ([RFC4647]).
5. 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 is normative. The schema is normative.
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.
The schema is dependent upon the schema (framework.xsd) defined in The schema is dependent upon the schema (framework.xsd) defined in
Section 16.1 of the Control Framework Appendix A.1 of the Control Framework [RFC6230].
[I-D.ietf-mediactrl-sip-control-framework].
<?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 (20110104) IETF MediaCtrl Mixer 1.0 (20110104)
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 60, line 36 skipping to change at page 58, line 25
allow attributes from other namespaces. allow attributes from other namespaces.
</xsd:documentation> </xsd:documentation>
</xsd:annotation> </xsd:annotation>
<xsd:sequence/> <xsd:sequence/>
<xsd:anyAttribute namespace="##other" processContents="lax" /> <xsd:anyAttribute namespace="##other" processContents="lax" />
</xsd:complexType> </xsd:complexType>
<!-- <!--
##################################################### #####################################################
TOP LEVEL ELEMENT: mscmixer TOP-LEVEL ELEMENT: mscmixer
##################################################### #####################################################
--> -->
<xsd:complexType name="mscmixerType"> <xsd:complexType name="mscmixerType">
<xsd:complexContent> <xsd:complexContent>
<xsd:extension base="Tcore"> <xsd:extension base="Tcore">
<xsd:sequence> <xsd:sequence>
<xsd:choice> <xsd:choice>
<xsd:element ref="createconference" /> <xsd:element ref="createconference" />
skipping to change at page 78, line 7 skipping to change at page 75, line 7
<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
6. Examples 6. Examples
This section provides examples of the Mixer Control package. This section provides examples of the Mixer Control Package.
6.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 assumes 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]). ([RFC6230]).
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
brackets. Other aspects of the protocol are omitted for readability. parentheses. Other aspects of the protocol are omitted for
readability.
6.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 79, 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 |
| ----------------------------------------> | | ----------------------------------------> |
6.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 |
| ----------------------------------------> | | ----------------------------------------> |
| | | |
6.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 79, line 48 skipping to change at page 76, line 48
| (5) CONTROL: <event ..> | | (5) CONTROL: <event ..> |
| (conferenceexit) | | (conferenceexit) |
| <---------------------------------------- | | <---------------------------------------- |
| | | |
| (6) 200 | | (6) 200 |
| ----------------------------------------> | | ----------------------------------------> |
6.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.
6.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>
</createconference> </createconference>
</mscmixer> </mscmixer>
The request specifies that the conference is assigned the conference The request specifies that the conference is assigned the conference
id "conf1" and is configured with 2 reserved talkers, 3 reserved id "conf1" and is configured with 2 reserved talkers, 3 reserved
listener slots, audio mixing policy set to nbest and with active listener slots, audio-mixing policy set to nbest, and with active
talkers notifications set to 5 seconds. talkers notifications set to 5 seconds.
If the MS is able to create this conference mixer, it sends 200 If the MS is able to create this conference mixer, it sends a 200
response: 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" reason="conference created" <response status="200" reason="conference created"
conferenceid="conf1"/> conferenceid="conf1"/>
</mscmixer> </mscmixer>
The AS is now able to join connections to the conference as The AS is now able to join connections to the conference as
participants. A participant able to contribute to the audio mix participants. A participant able to contribute to the audio mix
would be joined as follows: would be joined as follows:
skipping to change at page 81, line 12 skipping to change at page 78, line 12
The AS could also join listener-only participants to the conference The AS could also join listener-only participants to the conference
by setting the stream direction to receive only: by setting the stream direction to receive only:
<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="9936067209:914cd14c" id2="conf1"> <join id1="9936067209:914cd14c" id2="conf1">
<stream media="audio" direction="recvonly"/> <stream media="audio" direction="recvonly"/>
</join> </join>
</mscmixer> </mscmixer>
If the MS can join the participant 9936067209:914cd14c to the If the MS can join the participant 9936067209:914cd14c to the
conference conf1 then it would send a successful response (not conference conf1, then it would send a successful response (not
shown). shown).
As the active talker changes, the MS sends an active talker As the active talker changes, the MS sends an active talker
notification to the AS: notification to the AS:
<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>
<active-talkers-notify conferenceid="conf1"> <active-talkers-notify conferenceid="conf1">
<active-talker connectionid="1536067209:913cd14c"/> <active-talker connectionid="1536067209:913cd14c"/>
</active-talkers-notify> </active-talkers-notify>
skipping to change at page 82, line 30 skipping to change at page 79, line 30
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="0" conferenceid="conf1"/> <conferenceexit status="0" conferenceid="conf1"/>
</event> </event>
</mscmixer> </mscmixer>
6.2.2. Bridging connections 6.2.2. Bridging Connections
The mixer package can 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 bidirectional 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:
skipping to change at page 82, line 50 skipping to change at page 80, line 4
<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 whispered 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
connection would now be sent to both the agent and the supervisor. connection would now be sent to both the agent and the supervisor.
skipping to change at page 83, line 32 skipping to change at page 80, line 33
<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.
6.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 where 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"/>
<video-layouts> <video-layouts>
<video-layout min-participants="1"><single-view/></video-layout> <video-layout min-participants="1"><single-view/></video-layout>
skipping to change at page 84, line 4 skipping to change at page 81, line 17
<audio-mixing type="nbest"/> <audio-mixing type="nbest"/>
<video-layouts> <video-layouts>
<video-layout min-participants="1"><single-view/></video-layout> <video-layout min-participants="1"><single-view/></video-layout>
<video-layout min-participants="2"><dual-view/></video-layout> <video-layout min-participants="2"><dual-view/></video-layout>
<video-layout min-participants="3"><quad-view/></video-layout> <video-layout min-participants="3"><quad-view/></video-layout>
<video-layout min-participants="5"><multiple-5x1/></video-layout> <video-layout min-participants="5"><multiple-5x1/></video-layout>
</video-layouts> </video-layouts>
<video-switch><vas/></video-switch> <video-switch><vas/></video-switch>
</createconference> </createconference>
</mscmixer> </mscmixer>
In this configuration, the conference uses a nbest audio mixing In this configuration, the conference uses a nbest audio mixing
policy and a <vas/> video switch policy, so that the loudest speaker policy and a <vas/> video-switching policy, so that the loudest
receives the most prominent region in the layout. Multiple video speaker receives the most prominent region in the layout. Multiple
layouts are specified and active one depends on the number of video layouts are specified and the active one depends on the number
participants. of participants.
Assume that 4 participants are already joined to the conference. In Assume that 4 participants are already joined to the conference. In
that case, the video layout will be quad-view (Figure 6) with the that case, the video layout will be quad-view (Figure 6) with the
most active speaker displayed in region 1. When a fifth participant most active speaker displayed in region 1. When a fifth participant
joins, the video layout automatically switches to a multiple-5x1 joins, the video layout automatically switches to a multiple-5x1
layout (Figure 9), again with the most active speaker in region 1. layout (Figure 9), again with the most active speaker in region 1.
The AS can manipulate which participants are displayed in the The AS can manipulate which participants are displayed in the
remaining regions. For example, it could force an existing remaining regions. For example, it could force an existing
conference participant to be displayed in region 2: conference participant to be displayed in region 2:
skipping to change at page 85, line 7 skipping to change at page 81, line 44
<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>
7. 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 12 of the Control Channel MUST be addressed as described in Section 12 of
the Media Control channel Framework the Media Control Channel Framework ([RFC6230]), including transport-
([I-D.ietf-mediactrl-sip-control-framework]), including Transport level protection, Control Channel policy management, and session
Level Protection, Control Channel Policy Management and Session establishment. In addition, implementations MUST address security,
Establishment. In addition, implementations MUST address security, confidentiality, and integrity of User Agent sessions with the MS,
confidentiality and integrity of User Agent sessions with the MS, both in terms of SIP signaling and the associated RTP media flow; see
both in terms of SIP signaling and associated RTP media flow; see [RFC6230] for further details on this topic.
[I-D.ietf-mediactrl-sip-control-framework] for further details on
this topic.
Adequate transport protection and authentication are critical, Adequate transport protection and authentication are critical,
especially when the implementation is deployed in open networks. If especially when the implementation is deployed in open networks. If
the implementation fails to correctly address these issues, it risks the implementation fails to correctly address these issues, it risks
exposure to malicious attacks, including (but not limited to): exposure to malicious attacks, including (but not limited to):
Denial of Service: An attacker could insert a request message into Denial of Service: An attacker could insert a request message into
the transport stream causing specific conferences or join mixers the transport stream causing specific conferences or join mixers
on the MS to be destroyed. For example, <destroyconference on the MS to be destroyed. For example, <destroyconference
conferenceid="XXXX">, where the value of "XXXX" could be guessed conferenceid="XXXX">, where the value of "XXXX" could be guessed
or discovered by auditing active mixers on the MS using an <audit> or discovered by auditing active mixers on the MS using an <audit>
request. Likewise, an attacker could impersonate the MS and request. Likewise, an attacker could impersonate the MS and
insert error responses into the transport stream so denying the AS insert error responses into the transport stream thereby denying
access to package capabilities. the AS access to package capabilities.
Resource Exhaustion: An attacker could insert into the control Resource Exhaustion: An attacker could insert into the Control
channel new request messages (or modify existing ones) with, for Channel new request messages (or modify existing ones) with, for
instance, <createconference> elements causing large numbers of instance, <createconference> elements causing large numbers of
conference mixer resources to be allocated. At some point this conference mixer resources to be allocated. At some point, this
will exhaust the number of conference mixers that the MS is able will exhaust the number of conference mixers that the MS is able
to allocate. 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 (beyond that specified for the Media Control Channel
be specified at the control package level beyond that specified for Framework), including resource access and Control Channel usage, to
the Media Control Channel Framework (see Section 12.3 of be specified at the Control Package level. (See Section 12.3 of
[I-D.ietf-mediactrl-sip-control-framework]). [RFC6230].)
Since creation of conference and join mixers is associated with media Since creation of conference and join mixers is associated with
mixing resources on the MS, the security policy for this control media-mixing resources on the MS, the security policy for this
package needs to address how such mixers are securely managed across Control Package needs to address how such mixers are securely managed
more than one control channel. Such a security policy is only useful across more than one Control Channel. Such a security policy is only
for secure, confidential and integrity protected channels. The useful for secure, confidential, and integrity-protected channels.
identity of control channels is determined by the channel identifier: The identity of Control Channels is determined by the channel
i.e. the value of the cfw-id attribute in the SDP and Dialog-ID identifier, i.e., the value of the 'cfw-id' attribute in the SDP and
header in the channel protocol (see Dialog-ID header in the channel protocol (see [RFC6230]). Channels
[I-D.ietf-mediactrl-sip-control-framework]). Channels are the same are the same if they have the same identifier; otherwise, they are
if they have the same identifier; otherwise, they are different. different. This Control Package imposes the following additional
This control package imposes the following additional security security policies:
policies:
Responses: The MS MUST only send a response to a mixer management or 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 audit request using the same Control Channel as the one used to
send the request. send the request.
Notifications: The MS MUST only send notification events for Notifications: The MS MUST only send notification events for
conference and join mixers using the same control channel as it conference and join mixers using the same Control Channel as it
received the request creating the mixer. received the request creating the mixer.
Auditing: The MS MUST only provide audit information about Auditing: The MS MUST only provide audit information about
conference and join mixers which have been created on the same conference and join mixers that have been created on the same
control channel as the one upon the <audit> request is sent. For Control Channel as the one upon which the <audit> request is sent.
example, if a join between two connections has been created on one For example, if a join between two connections has been created on
channel, then a request on another channel to audit all mixers - one channel, then a request on another channel to audit all mixers
<audit mixers="true"/> - would not report on this join mixer. -- <audit mixers="true"/> -- would not report on this join mixer.
Rejection: The MS SHOULD reject requests to audit or manipulate an Rejection: The MS SHOULD reject requests to audit or manipulate an
existing conference or join mixer on the MS if the channel is not existing conference or join mixer on the MS if the channel is not
the same as the one used when the mixer was created. The MS the same as the one used when the mixer was created. The MS
rejects a request by sending a Control Framework 403 response (see rejects a request by sending a Control Framework 403 response (see
Section 7.4 and Section 12.3 of Sections 7.4 and 12.3 of [RFC6230]). For example, if a channel
[I-D.ietf-mediactrl-sip-control-framework]). For example, if a with identifier 'cfw1234' has been used to send a request to
channel with identifier 'cfw1234' has been used to send a request create a particular conference and the MS receives on channel
to create a particular conference and the MS receives on channel
'cfw98969' a request to audit or destroy this particular 'cfw98969' a request to audit or destroy this particular
conference, then the MS sends a 403 framework response. conference, then the MS sends a Control Framework 403 response.
There can be valid reasons why an implementation does not reject an There can be valid reasons why an implementation does not reject an
audit or mixer manipulation request on a different channel from the audit or mixer manipulation request on a different channel from the
one which created the mixer. For example, a system administrator one that created the mixer. For example, a system administrator
might require a separate channel to audit mixer resources created by might require a separate channel to audit mixer resources created by
system users and to terminate mixers consuming excessive system system users and to terminate mixers consuming excessive system
resources. Alternatively, a system monitor or resource broker might resources. Alternatively, a system monitor or resource broker might
require a separate channel to audit mixers managed by this package on require a separate channel to audit mixers managed by this package on
a MS. However, the full implications need to be understood by the a MS. However, the full implications need to be understood by the
implementation and carefully weighted before accepting these reasons implementation and carefully weighed before accepting these reasons
as valid. If the reasons are not valid in their particular as valid. If the reasons are not valid in their particular
circumstances, the MS rejects such requests. circumstances, the MS rejects such requests.
There can also be valid reasons for 'channel handover' including high There can also be valid reasons for 'channel handover' including high
availability support or where one AS needs to take over management of availability support or when one AS needs to take over management of
mixers after the AS which created them has failed. This could be mixers after the AS that created them has failed. This could be
achieved by the control channels using the same channel identifier, achieved by the Control Channels using the same channel identifier,
one after another. For example, assume a channel is created with the one after another. For example, assume a channel is created with the
identifier 'cfw1234' and the channel is used to create mixers on the identifier 'cfw1234', and the channel is used to create mixers on the
MS. This channel (and associated SIP dialog) then terminates due to MS. This channel (and associated SIP dialog) then terminates due to
a failure on the AS. As permitted by the Control Framework, the a failure on the AS. As permitted by the Control Framework, the
channel identifier 'cfw1234' could then be reused so that another channel identifier 'cfw1234' could then be reused so that another
channel is created with the same identifier 'cfw1234', allowing it to channel is created with the same identifier 'cfw1234', allowing it to
'take over' management of the mixers on the MS. Again, the 'take over' management of the mixers on the MS. Again, the
implementation needs to understand the full implications and implementation needs to understand the full implications and
carefully weight them before accepting these reasons as valid. If carefully weigh them before accepting these reasons as valid. If the
the reasons are not valid for their particular circumstances, the MS reasons are not valid for their particular circumstances, the MS uses
uses the appropriate SIP mechanisms to prevent session establishment the appropriate SIP mechanisms to prevent session establishment when
when the same channel identifier is used in setting up another the same channel identifier is used in setting up another Control
control channel (see Section 4 of Channel (see Section 4 of [RFC6230]).
[I-D.ietf-mediactrl-sip-control-framework]).
8. IANA Considerations 8. IANA Considerations
This specification instructs IANA to register a new Media Control Per this specification, IANA has registered a new Media Control
Channel Framework Package, a new XML namespace, a new XML schema and Channel Framework Package, a new XML namespace, a new XML schema, and
a new MIME type. a new MIME type.
IANA has further created a new registry for the response codes for
the MEDIACTRL Mixer Control Package, RFC 6505.
8.1. Control Package Registration 8.1. Control Package Registration
This section registers a new Media Control Channel Framework package, This section registers a new Media Control Channel Framework package,
per the instructions in Section 12.1 of per the instructions in Section 13.1 of [RFC6230].
[I-D.ietf-mediactrl-sip-control-framework].
To: ietf-sip-control@iana.org To: ietf-sip-control@iana.org
Subject: Registration of new Channel Framework package Subject: Registration of new Channel Framework package
Package Name: msc-mixer/1.0 Package Name: msc-mixer/1.0
[NOTE TO IANA/RFC-EDITOR: Please replace XXXX Published Specification(s): RFC 6505
with the RFC number for this specification.]
Published Specification(s): RFCXXXX
Person & email address to contact for further information: Person & email address to contact for further information:
IETF, MEDIACTRL working group, (mediactrl@ietf.org), IETF MEDIACTRL working group (mediactrl@ietf.org),
Scott McGlashan (smcg.stds01@mcglashan.org). Scott McGlashan (smcg.stds01@mcglashan.org).
8.2. URN Sub-Namespace Registration 8.2. URN Sub-Namespace Registration
This section registers a new XML namespace, This section registers a new XML namespace,
"urn:ietf:params:xml:ns:msc-mixer", per the guidelines in RFC 3688 "urn:ietf:params:xml:ns:msc-mixer", per the guidelines in RFC 3688
[RFC3688]. [RFC3688].
URI: urn:ietf:params:xml:ns:msc-mixer URI: urn:ietf:params:xml:ns:msc-mixer
Registrant Contact: IETF, MEDIACTRL working group, Registrant Contact:
(mediactrl@ietf.org), Scott McGlashan IETF MEDIACTRL working group (mediactrl@ietf.org),
(smcg.stds01@mcglashan.org). Scott McGlashan (smcg.stds01@mcglashan.org).
XML: XML:
BEGIN BEGIN
<?xml version="1.0"?> <?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head> <head>
<title>Media Control Channel Framework Mixer <title>Media Control Channel Framework Mixer
Package attributes</title> Package attributes</title>
</head> </head>
<body> <body>
<h1>Namespace for Media Control Channel <h1>Namespace for Media Control Channel
Framework Mixer Package attributes</h1> Framework Mixer Package attributes</h1>
<h2>urn:ietf:params:xml:ns:msc-mixer</h2> <h2>urn:ietf:params:xml:ns:msc-mixer</h2>
[NOTE TO IANA/RFC-EDITOR: Please replace XXXX <p>See <a href="http://www.rfc-editor.org/rfc/rfc6505.txt">
with the RFC number for this specification.] RFC 6505</a>.</p>
<p>See RFCXXXX</p>
</body> </body>
</html> </html>
END END
8.3. XML Schema Registration 8.3. XML Schema Registration
This section registers an XML schema as per the guidelines in RFC This section registers an XML schema as per the guidelines in RFC
3688 [RFC3688]. 3688 [RFC3688].
URI: urn:ietf:params:xml:ns:msc-mixer URI: urn:ietf:params:xml:schema:msc-mixer
Registrant Contact: IETF, MEDIACTRL working group, Registrant Contact:
(mediactrl@ietf.org), Scott McGlashan IETF MEDIACTRL working group (mediactrl@ietf.org),
(smcg.stds01@mcglashan.org). Scott McGlashan (smcg.stds01@mcglashan.org).
Schema: The XML for this schema can be found in Schema: The XML for this schema can be found in
Section 5 of this document. Section 5 of this document.
8.4. MIME Media Type Registration for 'application/msc-mixer+xml' 8.4. MIME Media Type Registration for 'application/msc-mixer+xml'
This section registers the "application/msc-mixer+xml" MIME type. This section registers the "application/msc-mixer+xml" MIME type.
To: ietf-types@iana.org To: ietf-types@iana.org
Subject: Registration of MIME media type Subject: Registration of MIME media type
application/msc-mixer+xml application/msc-mixer+xml
MIME media type name: application MIME media type name: application
MIME subtype name: msc-mixer+xml MIME subtype name: msc-mixer+xml
Required parameters: (none) Required parameters: (none)
Optional parameters: charset Optional parameters: charset
Indicates the character encoding of enclosed XML. Default is Indicates the character encoding of enclosed XML. Default is
UTF-8. UTF-8.
Encoding considerations: Uses XML, which can employ 8-bit Encoding considerations: Uses XML, which can employ 8-bit
characters, depending on the character encoding used. See RFC characters, depending on the character encoding used. See RFC
3023 [RFC3023], section 3.2. 3023 [RFC3023], Section 3.2.
Security considerations: No known security considerations outside
of those provided by the Media Control Channel Framework Mixer
Package.
Interoperability considerations: This content type provides
constructs for the Media Control Channel Framework Mixer package.
Published specification: RFC XXXX [NOTE TO IANA/RFC-EDITOR: Please
replace XXXX with the RFC number for this specification.]
Applications which use this media type: Implementations of
the Media Control Channel Framework Mixer package.
Additional Information: Magic Number(s): (none)
File extension(s): (none)
Macintosh File Type Code(s): (none)
Person & email address to contact for further information: Scott
McGlashan <smcg.stds01@mcglashan.org>
Intended usage: LIMITED USE
Author/Change controller: The IETF
Other information: None.
9. Change Summary
Note to RFC Editor: Please remove this whole section.
The following are the changes between the -14 and -13 versions
(addressing remaining IESG DISCUSS):
o 4.7.7 Language Identifier: deleted statement "where the language
code is required and a country code or other subtag identifier is
optional" and clarified that RFC 4647 specifies the matching
procedure.
The following are the changes between the -13 and -12 versions
(addressing remaining IESG DISCUSS):
o 4.0, 4.1, etc: Added language tags to identify the language of
descriptive text attributes. A desclang attribute is added to the
root element and has a default value of i-default. Subordinate
elements with descriptive text attributes also have this attribute
defined - if it is not specified on the subordinate element, then
the desclang value on the root element applies. Added example of
desclang in 4.1.
o 5: Updated schema with desclang attributes
o Section 4.7.6: Corrected ABNF definition of IANA MIME media type
to allow parameter values.
The following are the changes between the -12 and -11 versions
(primarily addressing IESG DISCUSS, comments and nits):
o Introduction: Clarified that Control Framework is an equivalent
term for the Media Control Channel Framework.
o 4.2.4.2, 4.2.4.3, 4.5: Replaced reference to standards-tracks RFC
for assignment of new values, with reference to using Standards
Action process defined in RFC 5226.
o 4.0: Clarified that while some elements contain attributes whose
value is descriptive text, this descriptive text is for diagnostic
use only and does not require a language indicator such as a
language tag.
o 4.2.2.5.2: expanded DTMF acronym.
o 4.2.1.4.2.1: Changed <video-layout> so that the layout is a child
element rather than content value. Changed examples to match.
Updated XML schema.
o 4.2.1.4.3: Changed <video-switch> so that the policy is a child
element rather than content value. Changed examples to match.
Updated XML schema.
o 4.4.1: changed <codec> to include name attribute; aligned
definition with RFC4288; updated XML schema.
o 4.2.2.5: Clarified that the media attribute of <stream> is a MIME
type-name with reference to RFC 4288.
o 4.5.1: Added encoding attribute to <param> to allow for
specification of content-transfer-encoding schema. Updated XML
schema.
o 4.5.1: Simplified content model of <param> to be text only.
Updated XML schema.
o 4.6.6: Clarified MIME media type format with ABNF production
referencing RFC 4288.
o 4.2.2.5.3: clarified the definition of <region> as an area in a
video layout
o 5: Stated that the schema is normative.
o 5: Corrected default value of tones attribute in schema to match
definition in 4.2.2.5.2.
o 4.6: Type definitions; added references to XML Schema datatypes
where appropriate; changed definition of boolean to match W3C
definition and updated boolean type in schema.
o Typos: in 4.2.1.4.2.1, added '/' to <video-layout>; in 4.2.1.4.3
<video-switch>, replaced second <join> with <unjoin>; in 4.2.3,
corrected code and status in <response> examples;
o Validated all examples against XML schema and corrected where
necessary.
The following are the changes between the -11 and -10 versions
(addressing IETF Last Call comments):
o 4.2.2.3: For <modifyjoin>, removed the statement "It MUST NOT
change the configuration of any streams not included as child
elements." since modifications in stream directionality can affect
other streams of the same type.
o 4.2.2.5.2: Changed definition of tones attribute of <clamp>
element so that if the element is specified, then all DTMF tones
are clamped by default. Updated XML schema.
o 7: Corrected references from Section 11 to Section 12 in Control
Framework.
o Fixed various typos.
The following are the changes between the -10 and -09 versions:
o References: Moved the XCON reference to the Normative References
section.
o 4.2: Mixer Elements: clarified that when a requested mixer
operation (partially) fails, the MS carries out no part of the
operation and sends an error response.
The following are the changes between the -09 and -08 versions
following shepherd writeup:
o 4.2.4.1.1: <active-talker>: Removed the statement that it is an
error if an <active-talker> element has both connectionid and
conferenceid attributes specified because the AS always sends a
framework 200 in response to notification events, including active
talker events. Instead, clarified that no active talker is
described if both attributes are specified or if neither attribute
is specified.
o Various spelling and grammatical errors fixed.
The following are the changes between the -08 and -07 versions.
o 8.4: Changed file extension from '.xml' to (none)
o Changed "~" to a ":" for connectionid
o 4.2.6.1: Clarified that <param> can contain an XML value.
o 4.2.4.2: Changed <unjoin-notify> status codes so that only 0-2
defined and all others are reserved for future use requiring a
standard-track RFC.
o 4.2.4.3: Changed <conferenceexit> status codes so that only 0-2
defined and all others are reserved for future use requiring a
standard-track RFC.
o 4.5: Changed status code for <response> and <auditresponse> so
that certain codes are defined and all others are reserved for
future use requiring a standard-track RFC.
The following are the changes between the -07 and -06 versions.
o Generally corrected references from Section 17.1 to Section 16.1
of Control Channel Framework.
o 4.2.2.2: removed "is" in "unless this is leads to a stream
conflict"
o 4.2.2.3: corrected error code from 408 to 409 for "If the
specified entities are not already joined, then the MS reports an
error (408)."
o 4.2.1.4.3: corrected error code from 409 to 424 for "If the MS
does not support the specified video switching policy or ..., then
MS reports a 409 error".
o 4.2.1.4.2: corrected error code from 408 to 423 for "If the MS
does not support video conferencing at all, or ...., the MS
reports an 408 error ..."
o 4.2.1.1, 4.2.1.2, 4.2.2.2, 4.2.2.3: Clarified that <codecs>
specified in <createconference> or <modifyconference> impose a
limitation in the media capability of a conference and this
limitation affects whether the conference can be <join> or
<modifyjoin>ed to another entity.
The following are the changes between the -06 and -05 versions.
o 4.4.1: <codec>: corrected typos, added an example of <params>
usage, added a <subtype> section and moved the <params> section
inside this section.
o 8: IANA Considerations: Updated IANA registration information and
added registration for the XML Schema
The following are the changes between the -05 and -04 versions.
o Schema: Fixed problem with non-deterministic content models.
o 7. Security Considerations: Added requirement that
implementations need to secure SIP and RTP sessions with User
Agents.
The following are the changes between the -04 and -03 versions.
o 4.2.1.4.3: corrected typo
o 4.2.2.3: Clarified the behavior of <modifyjoin> for cases where
each direction of a stream is independently controlled.
o 4.2.2.5: Corrected syntax error in examples.
o 4.2.2.5.1: Clarified that when an audio stream is in the muted
state, then a <volume> automatic or setgain control causes the
state to change automatically to unmuted.
o 7 Security: Clarified that both conference and join mixers are
covered by the package security policies.
o 7 Security: Added a denial of service example where the attacker
impersonates the MS.
o 7 Security: Clarified that the package security policy for
multiple channels is only useful if the channels themselves are
secured.
o Updated acknowledgements.
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.
o Section 4: Aligned Control Package definitions with requirements
in Section 8 of the Control Framework.
o Following October Interim meeting discussion on response codes,
generally clarified usage of error status codes, modified some
codes and re-organized the response codes section (Section 4.6)
with more guidance and details.
o MIXER-006. No action required following October 2008 interim
discussion.
o MIXER-008. No action required following October 2008 interim
discussion.
o MIXER-009. No action required for control package - addressed in
-05 framework draft following interim October 2008 discussion.
o MIXER-010/5.2.2.5: Clarified that in the <stream> element, an
"inactive" direction value indicates the stream is established but
there is no media flow. Such a stream can be manipulated by
<modifyjoin> and <unjoin>.
o 5.2.2.5: <stream>: Clarified that the media stream specified in
child elements <volume>, <clamp>, <region> and <priority> is the
stream originating from the entity identified as id1.
o 5.2.1.4.3: <video-switch>: Clarified that it is not an error if a
<stream> specifies a region which is not defined for the currently
active video layout.
o 5.2.1.4.2.1: <video-layout>: Added descriptions and ASCII art for
layout and regions of XCON video layouts.
o Added examples of audio conferencing, connection bridging and
video conferencing.
The following are the major changes between the -01 and -00 versions.
o [MIXER-001]/5.2.4.3: Added <conferenceexit> notification event.
o [MIXER-003]/5.2.1.4.2.1: Added ASCII diagrams for video layouts.
o [MIXER-004]/5.3.2.2.1: Added active <video-layout> information to
<conferenceaudit>.
o [MIXER-007]/5.4.1: Added <params> inside <codec> so additional
codec information can be specified.
o 5.2.1.1: Fixed <createconference> example with missing min-
participants attributes.
o 5: Changed handling of unsupported foreign namespace elements and
attributes. The MS send a 427 error response if it encounters
foreign elements and attributes it does not support.
o 5.2.1.4.3: <video-switch>. Clarified that the VAS policy is
implementation-specific if a participant provides more than one
audio stream.
o 5.2.2.2/5.2.2.3/5.2.2.4: Clarified that joining behavior so that
streams which have previously been <modifiedjoin>ed or <unjoin>ed
are not affected by a general <unjoin>.
o 5.2.1.4.3: <video-switch>: Added support for whether active
speaker is displayed on their video layout ('activespeakermix'
attribute) and clarified that personal video mixes are out of
scope for this package.
o 5.2.1.4.3/5.2.2.5.4: <video-switch>: Added support for a priority
mechanism in video switching policy and a <priority child element
on <stream>.
o 8:Updated security section
o 13:Updated references
o 5.2.1.4.4.1: Added default of 3 seconds for <active-talkers-sub>
interval.
o 5.2.2.5.1: <volume> controltype attribute set to mandatory.
o Updated schema
The following are the major changes between the -00 of this work
group item draft and the individual submission -04 version.
o Control package name is now 'msc-mixer/1.0'. Namespace is now
'urn:ietf:params:xml:ns:msc-mixer'. Mime type is now
'application/msc-mixer+xml'.
o Added XML root element <mscmixer>.
o Editorial tidy up of sections.
o Added audit request/response elements.
o Added video layout and switching conference configuration.
o <audio-mixing>: changed 'mix-type' attribute to 'type'
(consistency with video-switch)
o Added "inactive" as value of <stream>'s direction attribute.
o Added <region> child to <stream> element.
o <createconference>: <audio-mixing> element is no longer mandatory;
added <video-layouts> and <video-switch> child elements. reserved-
talkers and reserved-listeners as attributes.
o replaced conf-id attribute with conferenceid attribute.
o Removed <data> element. Active talkers subscription and
notifications used dedicated elements now.
o Added <unjoin-notify> notification event to indicate when
(un)expected joins occur. Use case: connection or conference
joined to a conference and conference exits (either by request or
runtime error.
The following are the major changes between the -04 of the draft and
the -03 version.
o Updated reference for Media Control Channel Framework
The following are the major changes between the -03 of the draft and
the -02 version.
o None
The following are the major changes between the -02 of the draft and Security considerations: No known security considerations outside
the -01 version. of those provided by the Media Control Channel Framework Mixer
Package.
Interoperability considerations: This content type provides
constructs for the Media Control Channel Framework Mixer Package.
Published specification: RFC 6505
Applications that use this media type: Implementations of
the Media Control Channel Framework Mixer package.
Additional Information:
Magic Number(s): (none)
File extension(s): (none)
Macintosh File Type Code(s): (none)
Person & email address to contact for further information:
Scott McGlashan <smcg.stds01@mcglashan.org>
Intended usage: LIMITED USE
Author/Change controller: The IETF
Other information: None.
o clarified the model for join operations and introduced several new 8.5. Mixer Control Package Status Code Registration
package error codes
o added definition for MS connection This section creates an IANA registry for the response codes for the
MEDIACTRL Mixer Control Package. New status codes are assigned using
the Standards Action process defined in RFC 5226 [RFC5226]. The
initial population of the registry is defined in Section 4.6.
The following are the major changes between the -01 of the draft and The format of this registry is as follows:
the -00 version.
o restructured into single request response model for non-trivial +----------+----------------+----------------+----------------------+
operations | Code | Summary | Description | Reference |
+----------+----------------+----------------+----------------------+
| status | brief summary | full | reference document |
| code | of the status | description of | defining the status |
| number | code | the status | code |
| | | code | |
+----------+----------------+----------------+----------------------+
o aligned with XML structure of other control framework packages Table 2: Fields for Mixer Control Package Status Code Registry
10. Contributors 9. Contributors
Asher Shiratzky provided valuable support and contributions to early Asher Shiratzky provided valuable support and contributions to early
versions of this document. draft 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.
11. Acknowledgments 10. Acknowledgments
The authors would like to thank Roni Even, Lorenzo Miniero, Steve The authors would like to thank Steve Buko and Stephane Bastien for
Buko and Stephane Bastien for expert reviews of this work. expert reviews of this work.
Shawn Emery carried out a thorough security review. Shawn Emery carried out a thorough security review.
12. References 11. References
12.1. Normative References 11.1. Normative References
[I-D.ietf-mediactrl-sip-control-framework] [RFC2045] Freed, N. and N. Borenstein, "Multipurpose
Boulton, C., Melanchuk, T., and S. McGlashan, "Media Internet Mail Extensions (MIME) Part One: Format
Control Channel Framework", of Internet Message Bodies", RFC 2045,
draft-ietf-mediactrl-sip-control-framework-12 (work in November 1996.
progress), September 2010.
[I-D.ietf-xcon-common-data-model] [RFC2119] Bradner, S., "Key words for use in RFCs to
Novo, O., Camarillo, G., Morgan, D., and J. Urpalainen, Indicate Requirement Levels", BCP 14, RFC 2119,
"Conference Information Data Model for Centralized March 1997.
Conferencing (XCON)", draft-ietf-xcon-common-data-model-22
(work in progress), December 2010.
[RFC2045] Freed, N. and N. Borenstein, "Multipurpose Internet Mail [RFC3023] Murata, M., St. Laurent, S., and D. Kohn, "XML
Extensions (MIME) Part One: Format of Internet Message Media Types", RFC 3023, January 2001.
Bodies", RFC 2045, November 1996.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81,
Requirement Levels", BCP 14, RFC 2119, March 1997. RFC 3688, January 2004.
[RFC3023] Murata, M., St. Laurent, S., and D. Kohn, "XML Media [RFC4288] Freed, N. and J. Klensin, "Media Type
Types", RFC 3023, January 2001. Specifications and Registration Procedures",
BCP 13, RFC 4288, December 2005.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC4574] Levin, O. and G. Camarillo, "The Session
January 2004. Description Protocol (SDP) Label Attribute",
RFC 4574, August 2006.
[RFC4288] Freed, N. and J. Klensin, "Media Type Specifications and [RFC4647] Phillips, A. and M. Davis, "Matching of Language
Registration Procedures", BCP 13, RFC 4288, December 2005. Tags", BCP 47, RFC 4647, September 2006.
[RFC4574] Levin, O. and G. Camarillo, "The Session Description [RFC5226] Narten, T. and H. Alvestrand, "Guidelines for
Protocol (SDP) Label Attribute", RFC 4574, August 2006. Writing an IANA Considerations Section in RFCs",
BCP 26, RFC 5226, May 2008.
[RFC4647] Phillips, A. and M. Davis, "Matching of Language Tags", [RFC5234] Crocker, D. and P. Overell, "Augmented BNF for
BCP 47, RFC 4647, September 2006. Syntax Specifications: ABNF", STD 68, RFC 5234,
January 2008.
[RFC5226] Narten, T. and H. Alvestrand, "Guidelines for Writing an [RFC5646] Phillips, A. and M. Davis, "Tags for Identifying
IANA Considerations Section in RFCs", BCP 26, RFC 5226, Languages", BCP 47, RFC 5646, September 2009.
May 2008.
[RFC5234] Crocker, D. and P. Overell, "Augmented BNF for Syntax [RFC6230] Boulton, C., Melanchuk, T., and S. McGlashan,
Specifications: ABNF", STD 68, RFC 5234, January 2008. "Media Control Channel Framework", RFC 6230,
May 2011.
[RFC5646] Phillips, A. and M. Davis, "Tags for Identifying [RFC6501] Novo, O., Camarillo, G., Morgan, D., and J.
Languages", BCP 47, RFC 5646, September 2009. Urpalainen, "Conference Information Data Model for
Centralized Conferencing (XCON)", RFC 6501,
March 2012.
[XML] Bray, T., Paoli, J., Sperberg-McQueen, C M., Maler, E., [XML] Bray, T., Paoli, J., Sperberg-McQueen, C., Maler,
and F. Yergeau, "Extensible Markup Language (XML) 1.0 E., and F. Yergeau, "Extensible Markup Language
(Third Edition)", W3C Recommendation, February 2004. (XML) 1.0 (Fifth Edition)", World Wide Web
Consortium Recommendation REC-xml-20081126,
November 2008,
<http://www.w3.org/TR/2008/REC-xml-20081126>.
[XMLSchema:Part2] [XMLSchema:Part2] Biron, P. and A. Malhotra, "XML Schema Part 2:
Biron, P. and A. Malhotra, "XML Schema Part 2: Datatypes Datatypes Second Edition", W3C Recommendation,
Second Edition", W3C Recommendation, October 2004. October 2004.
12.2. Informative References 11.2. Informative References
[IANA] "IANA registry for RTP Payload Types", [IANA] IANA, "RTP Payload Types",
<http://www.iana.org/assignments/rtp-parameters>. <http://www.iana.org/assignments/rtp-parameters>.
[MIME.mediatypes] [MIME.mediatypes] IANA, "MIME Media Types",
"IANA registry for MIME Media Types", <http://www.iana.org/assignments/media-types>.
<http://www.iana.org/assignments/media-types/>.
[RFC2277] Alvestrand, H., "IETF Policy on Character Sets and [RFC2277] Alvestrand, H., "IETF Policy on Character Sets and
Languages", BCP 18, RFC 2277, January 1998. Languages", BCP 18, RFC 2277, January 1998.
[RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, [RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G.,
A., Peterson, J., Sparks, R., Handley, M., and E. Johnston, A., Peterson, J., Sparks, R., Handley,
Schooler, "SIP: Session Initiation Protocol", RFC 3261, M., and E. Schooler, "SIP: Session Initiation
June 2002. Protocol", RFC 3261, June 2002.
[RFC3550] Schulzrinne, H., Casner, S., Frederick, R., and V. [RFC3550] Schulzrinne, H., Casner, S., Frederick, R., and V.
Jacobson, "RTP: A Transport Protocol for Real-Time Jacobson, "RTP: A Transport Protocol for Real-Time
Applications", STD 64, RFC 3550, July 2003. Applications", STD 64, RFC 3550, July 2003.
[RFC5022] Van Dyke, J., Burger, E., and A. Spitzer, "Media Server [RFC5022] Van Dyke, J., Burger, E., and A. Spitzer, "Media
Control Markup Language (MSCML) and Protocol", RFC 5022, Server Control Markup Language (MSCML) and
September 2007. Protocol", RFC 5022, September 2007.
[RFC5167] Dolly, M. and R. Even, "Media Server Control Protocol [RFC5167] Dolly, M. and R. Even, "Media Server Control
Requirements", RFC 5167, March 2008. Protocol Requirements", RFC 5167, March 2008.
[RFC5707] Saleem, A., Xin, Y., and G. Sharratt, "Media Server Markup [RFC5707] Saleem, A., Xin, Y., and G. Sharratt, "Media
Language (MSML)", RFC 5707, February 2010. Server Markup Language (MSML)", RFC 5707,
February 2010.
Authors' Addresses Authors' Addresses
Scott McGlashan Scott McGlashan
Hewlett-Packard Hewlett-Packard
Email: smcg.stds01@mcglashan.org EMail: smcg.stds01@mcglashan.org
Tim Melanchuk Tim Melanchuk
Rain Willow Communications Rainwillow
Email: tim.melanchuk@gmail.com EMail: timm@rainwillow.com
Chris Boulton Chris Boulton
NS-Technologies NS-Technologies
Email: chris@ns-technologies.com EMail: chris@ns-technologies.com
 End of changes. 376 change blocks. 
1240 lines changed or deleted 806 lines changed or added

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