XEP-0338: Jingle Grouping Framework

Abstract
This specification provides an XML mapping for translating the RFC 5888 SDP Grouping Framework to Jingle
Author
Philipp Hancke
Copyright
© 2013 – 2020 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status

Stable

NOTICE: The protocol defined herein is a Stable Standard of the XMPP Standards Foundation. Implementations are encouraged and the protocol is appropriate for deployment in production systems, but some changes to the protocol are possible before it becomes a Final Standard.
Type
Standards Track
Version
1.0.0 (2020-07-21)
Document Lifecycle
  1. Experimental
  2. Proposed
  3. Stable
  4. Final

1. Introduction

RFC 5888 [1] defines a framework to group SDP 'm' lines for different purposes. A mapping to Jingle as an extension to Jingle (XEP-0166) [2] is defined in this document.

It is anticipated that the primary use of this is with the draft-ietf-mmusic-sdp-bundle-negotiation [3] framework used in WebRTC.

2. Mapping to Session Description Protocol

The SDP format defined in RFC 5888 [1] is shown below.

a=group:semantics identification-tag
  

An example follows.

a=group:LS voice webcam
  

This SDP attribute is translated to Jingle as a <group/> element qualified by the 'urn:xmpp:jingle:apps:grouping:0' namespace, as shown below. The semantics is mapped to a 'semantics' attribute. The identification-tags are mapped to content elements whose name attribute is set to the identification-tag.

<group xmlns='urn:xmpp:jingle:apps:grouping:0' semantics='semantics'>
  <content name='identification-tag 1'/>
  <content name='identification-tag 2'/>
</group>

An example follows.

<group xmlns='urn:xmpp:jingle:apps:grouping:0' semantics='LS'>
  <content name='voice'/>
  <content name='webcam'/>
</group>

The <group/> element is included as child of the <jingle/> element.

<iq from='romeo@montague.lit/orchard'
    id='rg6s5134'
    to='juliet@capulet.lit/balcony'
    type='set'>
  <jingle xmlns='urn:xmpp:jingle:1'
          action='session-initiate'
          initiator='romeo@montague.lit/orchard'
          sid='a73sjjvkla37jfea'>
    <group xmlns='urn:xmpp:jingle:apps:grouping:0' semantics='BUNDLE'>
      <content name='voice'/>
      <content name='webcam'/>
    </group>
    <content creator='initiator' name='voice'>
      [ ... ]
    </content>
    <content creator='initiator' name='webcam'>
      [ ... ]
    </content>
  </jingle>
</iq>

Note: the identification-tags correspond to the <content/> 'name' attributes. These in turn map to the 'mid' attribute in SDP.

3. Determining Support

If an entity supports the grouping framework described in RFC 5888 [1], it MUST advertise that fact in its responses to Service Discovery (XEP-0030) [4] information ("disco#info") requests by returning a feature of 'urn:ietf:rfc:5888':

Example 1. A disco#info query
<iq type='get'
    from='calvin@usrobots.lit/lab'
    to='herbie@usrobots.lit/home'
    id='disco1'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
Example 2. A disco#info response
<iq type='result'
    from='herbie@usrobots.lit/home'
    to='calvin@usrobots.lit/lab'
    id='disco1'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    <feature var='urn:xmpp:jingle:1'/>
    <feature var='urn:ietf:rfc:5888'/>
  </query>
</iq>

In order for an application to determine whether an entity supports this protocol, where possible it SHOULD use the dynamic, presence-based profile of service discovery defined in Entity Capabilities (XEP-0115) [5]. However, if an application has not received entity capabilities information from an entity, it SHOULD use explicit service discovery instead.

4. Acknowledgements

Thanks to Emil Ivov and Lance Stout for their feedback.

The XML format for this specification originates from libjingle [6].

5. Security Considerations

This document introduces no additional security considerations above and beyond those defined in the documents on which it depends.

6. IANA Considerations

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [7].

7. XMPP Registrar Considerations

7.1 Protocol Namespaces

This specification defines the following XML namespace:

The XMPP Registrar [8] includes the foregoing namespace to the registry located at <https://xmpp.org/registrar/namespaces.html>, as described in Section 4 of XMPP Registrar Function (XEP-0053) [9].

7.2 Protocol Versioning

If the protocol defined in this specification undergoes a revision that is not fully backwards-compatible with an older version, the XMPP Registrar shall increment the protocol version number found at the end of the XML namespaces defined herein, as described in Section 4 of XEP-0053.

8. XML Schema

TODO


Appendices

Appendix A: Document Information

Series
XEP
Number
0338
Publisher
XMPP Standards Foundation
Status
Stable
Type
Standards Track
Version
1.0.0
Last Updated
2020-07-21
Approving Body
XMPP Council
Dependencies
XEP-0166
Supersedes
None
Superseded By
None
Short Name
NOT_YET_ASSIGNED
Source Control
HTML

This document in other formats: XML  PDF

Appendix B: Author Information

Philipp Hancke
Email
fippo@andyet.com
JabberID
fippo@goodadvice.pages.de

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2024 by the XMPP Standards Foundation (XSF).

Permissions

Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.

Disclaimer of Warranty

## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##

Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.

IPR Conformance

This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).

Visual Presentation

The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.

Appendix E: Discussion Venue

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Discussion on other xmpp.org discussion lists might also be appropriate; see <https://xmpp.org/community/> for a complete list.

Errata can be sent to <editor@xmpp.org>.

Appendix F: Requirements Conformance

The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".

Appendix G: Notes

1. RFC 5888: The Session Description Protocol (SDP) Grouping Framework <http://tools.ietf.org/html/rfc5888>.

2. XEP-0166: Jingle <https://xmpp.org/extensions/xep-0166.html>.

3. Negotiating Media Multiplexing Using the Session Description Protocol (SDP) <https://datatracker.ietf.org/doc/draft-ietf-mmusic-sdp-bundle-negotiation/>. Work in progress.

4. XEP-0030: Service Discovery <https://xmpp.org/extensions/xep-0030.html>.

5. XEP-0115: Entity Capabilities <https://xmpp.org/extensions/xep-0115.html>.

6. libjingle is now part of the WebRTC Native Code Package available from webrtc.org.

7. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

8. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <https://xmpp.org/registrar/>.

9. XEP-0053: XMPP Registrar Function <https://xmpp.org/extensions/xep-0053.html>.

Appendix H: Revision History

Note: Older versions of this specification might be available at https://xmpp.org/extensions/attic/

  1. Version 1.0.0 (2020-07-21)
    Advance to Draft as per Council vote from 2020-07-01
    XEP Editor (jsc)
  2. Version 0.2 (2017-09-11)
    Defer due to lack of activity.
    XEP Editor (jwi)
  3. Version 0.1 (2014-01-08)

    Initial published version approved by the XMPP Council.

    psa
  4. Version 0.0.1 (2013-11-25)

    First draft.

    ph

Appendix I: Bib(La)TeX Entry

@report{hancke2013xep0338,
  title = {Jingle Grouping Framework},
  author = {Hancke, Philipp},
  type = {XEP},
  number = {0338},
  version = {1.0.0},
  institution = {XMPP Standards Foundation},
  url = {https://xmpp.org/extensions/xep-0338.html},
  date = {2013-11-25/2020-07-21},
}

END