mirror of
https://github.com/moparisthebest/xeps
synced 2024-11-16 06:15:07 -05:00
aee142589b
git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@2268 4b5297f7-1745-476d-ba37-a9c6900126ab
1782 lines
80 KiB
XML
1782 lines
80 KiB
XML
<?xml version='1.0' encoding='UTF-8'?>
|
|
<!DOCTYPE xep SYSTEM 'xep.dtd' [
|
|
<!ENTITY % ents SYSTEM 'xep.ent'>
|
|
%ents;
|
|
]>
|
|
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
|
|
<xep>
|
|
<header>
|
|
<title>Jingle RTP Sessions</title>
|
|
<abstract>This specification defines a Jingle application type for negotiating one or more sessions that use the Real-time Transport Protocol (RTP) to exchange media such as voice or video. The application type includes a straightforward mapping to Session Description Protocol (SDP) for interworking with SIP media endpoints.</abstract>
|
|
&LEGALNOTICE;
|
|
<number>0167</number>
|
|
<status>Experimental</status>
|
|
<type>Standards Track</type>
|
|
<sig>Standards</sig>
|
|
<approver>Council</approver>
|
|
<dependencies>
|
|
<spec>XMPP Core</spec>
|
|
<spec>XEP-0166</spec>
|
|
</dependencies>
|
|
<supersedes/>
|
|
<supersededby/>
|
|
<shortname>NOT_YET_ASSIGNED</shortname>
|
|
&scottlu;
|
|
&stpeter;
|
|
&seanegan;
|
|
&robmcqueen;
|
|
&diana;
|
|
<revision>
|
|
<version>0.24</version>
|
|
<date>2008-09-25</date>
|
|
<initials>psa/dc</initials>
|
|
<remark>
|
|
<ul>
|
|
<li>Defined handling of early media, including mappings to RFC 3959 and RFC 3960 using the newly-defined 'disposition' attribute for the <content/> element in XEP-0166.</li>
|
|
<li>Clarified handling of SRTP negotiation.</li>
|
|
<li>More fully specified invalid-crypto error condition.</li>
|
|
<li>Changed DTMF text to prefer native RTP methods and not recommend sending of DTMF in the XMPP signalling channel, per XEP-0181.</li>
|
|
<li>Modified namespaces to incorporate namespace versioning.</li>
|
|
<li>Cleaned up XML schemas.</li>
|
|
</ul>
|
|
</remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.23</version>
|
|
<date>2008-07-31</date>
|
|
<initials>ram/psa</initials>
|
|
<remark><p>Removed profile attribute; modified secure session establishment to align with SRTP usage.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.22</version>
|
|
<date>2008-06-09</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Added name attribute to active element to mirror usage for mute element; clarified meaning of session in the context of this specification; recommended that all sessions established via the same Jingle negotiation should be treated as synchronized.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.21</version>
|
|
<date>2008-06-09</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Added name attribute to mute element for more precise handling of informational messages.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.20</version>
|
|
<date>2008-06-04</date>
|
|
<initials>psa</initials>
|
|
<remark><p>In accordance with list consensus, generalized to cover all RTP media, not just audio; corrected text regarding payload types sent by responder in order to match SDP approach.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.19</version>
|
|
<date>2008-05-28</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Specified default value for profile attribute; clarified relationship to SDP offer-answer model.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.18</version>
|
|
<date>2008-05-28</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Removed content-replace from ICE-UDP examples per XEP-0176.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.17</version>
|
|
<date>2008-02-29</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Corrected use of content-replace action per XEP-0166.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.16</version>
|
|
<date>2008-02-28</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Moved profile attribute from XEP-0166 to this specification.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.15</version>
|
|
<date>2008-01-11</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Removed content-accept after content-remove per XEP-0166.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.14</version>
|
|
<date>2008-01-03</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Modified examples to track changes to XEP-0176.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.13</version>
|
|
<date>2007-12-06</date>
|
|
<initials>psa</initials>
|
|
<remark><p>To track changes to XEP-0166, modified busy scenario and removed unsupported-codecs error.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.12</version>
|
|
<date>2007-11-27</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Further editorial review.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.11</version>
|
|
<date>2007-11-15</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Editorial review and consistency check; moved voice chat scenarios from XEP-0166 to this specification.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.10</version>
|
|
<date>2007-11-13</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Removed info message for busy since it is now a Jingle-specific error condition defined in XEP-0166; defined info message for active.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.9</version>
|
|
<date>2007-04-17</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Specified Jingle conformance, including the preference for lossy transports over reliable transports and the process of sending and receiving audio content over each transport type.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.8</version>
|
|
<date>2007-03-23</date>
|
|
<initials>psa/ram</initials>
|
|
<remark><p>Renamed to mention RTP as the associated transport; corrected negotiation flow to be consistent with SIP/SDP (each party specifies a list of the payload types it can receive); added profile attribute to content element in order to specify RTP profile in use.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.7</version>
|
|
<date>2006-12-21</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Modified spec to use provisional namespace before advancement to Draft (per XEP-0053).</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.6</version>
|
|
<date>2006-10-31</date>
|
|
<initials>psa/se</initials>
|
|
<remark><p>Specified how to include SDP parameters and codec-specific parameters; clarified negotiation process; added Speex examples; removed queued info message.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.5</version>
|
|
<date>2006-08-23</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Modified namespace to track XEP-0166.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.4</version>
|
|
<date>2006-07-12</date>
|
|
<initials>se/psa</initials>
|
|
<remark><p>Specified when to play received audio (early media); specified that DTMF must use in-band signalling (XEP-0181).</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.3</version>
|
|
<date>2006-03-20</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Defined info messages for hold and mute.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.2</version>
|
|
<date>2006-02-13</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Defined info message for busy; added info message examples; recommended use of Speex; updated schema and XMPP Registrar considerations.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.1</version>
|
|
<date>2005-12-15</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Initial version.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.0.3</version>
|
|
<date>2005-12-05</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Described service discovery usage; defined initial informational messages.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.0.2</version>
|
|
<date>2005-10-27</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Added SDP mapping, security considerations, IANA considerations, XMPP Registrar considerations, and XML schema.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.0.1</version>
|
|
<date>2005-10-21</date>
|
|
<initials>psa/sl</initials>
|
|
<remark><p>First draft.</p></remark>
|
|
</revision>
|
|
</header>
|
|
|
|
<section1 topic='Introduction' anchor='intro'>
|
|
<p>&xep0166; can be used to initiate and negotiate a wide range of peer-to-peer sessions. One session type of interest is media such as voice or video. This document specifies an application format for negotiating Jingle media sessions, where the media is exchanged over the Realtime Transport Protocol (RTP; see &rfc3550;).</p>
|
|
</section1>
|
|
|
|
<section1 topic='Requirements' anchor='reqs'>
|
|
<p>The Jingle application format defined herein is designed to meet the following requirements:</p>
|
|
<ol>
|
|
<li>Enable negotiation of parameters necessary for media sessions using the Realtime Transport Protocol (RTP).</li>
|
|
<li>Map these parameters to Session Description Protocol (SDP; see &rfc4566;) to enable interoperability.</li>
|
|
<li>Define informational messages related to typical RTP uses such as audio chat and video chat (e.g., ringing, on hold, on mute).</li>
|
|
</ol>
|
|
</section1>
|
|
|
|
<section1 topic='Jingle Conformance' anchor='conformance'>
|
|
<p>In accordance with Section 10 of <cite>XEP-0166</cite>, this document specifies the following information related to the Jingle RTP application type:</p>
|
|
<ol>
|
|
<li><p>The application format negotiation process is defined in the <link url='#negotiation'>Negotiating a Jingle RTP Session</link> section of this document.</p></li>
|
|
<li><p>The semantics of the &DESCRIPTION; element are defined in the <link url='#format'>Application Format</link> section of this document.</p></li>
|
|
<li><p>A mapping of Jingle semantics to the Session Description Protocol is provided in the <link url='#sdp'>Mapping to Session Description Protocol</link> section of this document.</p></li>
|
|
<li><p>A Jingle RTP session SHOULD use a lossy transport method such as &xep0177; or the "ice-udp" method specified in &xep0176;, but MAY use a reliable transport such as "ice-tcp" if a low-bandwidth codec is employed and the media negotiated is not unduly heavy (e.g., it might be possible to use a reliable transport for audio, but not for video).</p></li>
|
|
<li>
|
|
<p>Content is to be sent and received as follows:</p>
|
|
<ul>
|
|
<li><p>For lossy transports, outbound content shall be encoded into RTP packets and each packet shall be sent individually over the transport. Each inbound packet received over the transport is an RTP packet.</p></li>
|
|
<li><p>For reliable transports, outbound content shall be encoded into RTP packets and each packet data shall be sent in succession over the transport. Incoming data received over the transport shall be processed as a stream of RTP packets, where each RTP packet boundary marks the location of the next packet.</p></li>
|
|
</ul>
|
|
</li>
|
|
</ol>
|
|
</section1>
|
|
|
|
<section1 topic='Application Format' anchor='format'>
|
|
<p>A Jingle RTP session is described by a content type that contains one application format and one transport method. Each <content/> element defines a single RTP session. A Jingle negotiation MAY result in the establishment of multiple RTP sessions (e.g., one for audio and one for video). An application SHOULD consider all of the RTP sessions that are established via the same Jingle negotiation to be synchronized for purposes of streaming, playback, recording, etc.</p>
|
|
<p>The application format consists of one or more encodings contained within a wrapper <description/> element qualified by the 'urn:xmpp:jingle:apps:rtp:0' namespace &VNOTE;. In the language of <cite>RFC 4566</cite> each encoding is a payload-type; therefore, each <payload-type/> element specifies an encoding that can be used for the RTP stream, as illustrated in the following example.</p>
|
|
<code><![CDATA[
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0'>
|
|
<payload-type id='96' name='speex' clockrate='16000'/>
|
|
<payload-type id='97' name='speex' clockrate='8000'/>
|
|
<payload-type id='18' name='G729'/>
|
|
<payload-type id='103' name='L16' clockrate='16000' channels='2'/>
|
|
<payload-type id='98' name='x-ISAC' clockrate='8000'/>
|
|
<payload-type id='102' name='iLBC'/>
|
|
<payload-type id='4' name='G723'/>
|
|
<payload-type id='0' name='PCMU' clockrate='16000'/>
|
|
<payload-type id='8' name='PCMA'/>
|
|
<payload-type id='13' name='CN'/>
|
|
</description>
|
|
]]></code>
|
|
<p>The &DESCRIPTION; element is intended to be a child of a Jingle &CONTENT; element as specified in <cite>XEP-0166</cite>.</p>
|
|
<p>The &DESCRIPTION; element MUST possess a 'media' attribute that specifies the media type, such as "audio" or "video", where the media type SHOULD be as registered at &ianamedia;.</p>
|
|
<p>The encodings SHOULD be provided in order of preference by placing the most-preferred payload type as the first &PAYLOADTYPE; child of the &DESCRIPTION; element and the least-preferred payload type as the last child.</p>
|
|
<p>The allowable attributes of the &PAYLOADTYPE; element are as follows:</p>
|
|
<table caption='Payload-Type Attributes'>
|
|
<tr>
|
|
<th>Attribute</th>
|
|
<th>Description</th>
|
|
<th>Datatype</th>
|
|
<th>Inclusion</th>
|
|
</tr>
|
|
<tr>
|
|
<td>channels</td>
|
|
<td>The number of channels; if omitted, it MUST be assumed to contain one channel</td>
|
|
<td>positiveInteger (defaults to 1)</td>
|
|
<td>RECOMMENDED</td>
|
|
</tr>
|
|
<tr>
|
|
<td>clockrate</td>
|
|
<td>The sampling frequency in Hertz</td>
|
|
<td>positiveInteger</td>
|
|
<td>RECOMMENDED</td>
|
|
</tr>
|
|
<tr>
|
|
<td>id</td>
|
|
<td>The payload identifier</td>
|
|
<td>positiveInteger</td>
|
|
<td>REQUIRED</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maxptime</td>
|
|
<td>Maximum packet time as specified in RFC 4566</td>
|
|
<td>positiveInteger</td>
|
|
<td>OPTIONAL</td>
|
|
</tr>
|
|
<tr>
|
|
<td>name</td>
|
|
<td>The appropriate subtype of the MIME type</td>
|
|
<td>string</td>
|
|
<td>RECOMMENDED for static payload types, REQUIRED for dynamic payload types</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ptime</td>
|
|
<td>Packet time as specified in RFC 4566</td>
|
|
<td>positiveInteger</td>
|
|
<td>OPTIONAL</td>
|
|
</tr>
|
|
</table>
|
|
<p>In Jingle RTP, the encodings are used in the context of RTP. The most common encodings for the Audio/Video Profile (AVP) of RTP are listed in &rfc3551; (these "static" types are reserved from payload ID 0 through payload ID 95), although other encodings are allowed (these "dynamic" types use payload IDs 96 to 127) in accordance with the dynamic assignment rules described in Section 3 of <cite>RFC 3551</cite>. The payload IDs are represented in the 'id' attribute.</p>
|
|
<p>Each <payload-type/> element MAY contain one or more child elements that specify particular parameters related to the payload. For example, as described in &rtpspeex;, the "cng", "mode", and "vbr" parameters can be specified in relation to usage of the Speex <note>See <<link url='http://www.speex.org/'>http://www.speex.org/</link>>.</note> codec. Where such parameters are encoded via the "fmtp" SDP attribute, they shall be represented in Jingle via the following format:</p>
|
|
<code><![CDATA[
|
|
<parameter name='foo' value='bar'/>
|
|
]]></code>
|
|
<p>The order of parameter elements MUST be ignored.</p>
|
|
<p>Parameter names MUST be treated as case-sensitive. However, parameter names are effectively guaranteed to be unique, since &IANA; maintains a registry of SDP parameters (see <<link url='http://www.iana.org/assignments/sdp-parameters'>http://www.iana.org/assignments/sdp-parameters</link>>).</p>
|
|
</section1>
|
|
|
|
<section1 topic='Negotiating a Jingle RTP Session' anchor='negotiation'>
|
|
<p>In general, the process for negotiating a Jingle RTP session is as follows:</p>
|
|
<code><![CDATA[
|
|
Initiator Responder
|
|
| |
|
|
| session-initiate |
|
|
|---------------------------->|
|
|
| ack |
|
|
|<----------------------------|
|
|
| [transport negotiation] |
|
|
|<--------------------------->|
|
|
| session-accept |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| AUDIO (RTP) |
|
|
|<===========================>|
|
|
| |
|
|
]]></code>
|
|
<p>When the initiator sends a session-initiate stanza to the responder, the &DESCRIPTION; element includes all of the payload types that the initiator can send and/or receive for Jingle RTP, each one encapsulated in a separate &PAYLOADTYPE; element (the rules specified in &rfc3264; SHOULD be followed regarding inclusion of payload types).</p>
|
|
<example caption="Initiation"><![CDATA[
|
|
<iq from='romeo@montague.net/orchard'
|
|
id='jingle1'
|
|
to='juliet@capulet.com/balcony'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'>
|
|
action='session-initiate'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='initiator' name='voice'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='96' name='speex' clockrate='16000'/>
|
|
<payload-type id='97' name='speex' clockrate='8000'/>
|
|
<payload-type id='18' name='G729'/>
|
|
<payload-type id='0' name='PCMU' />
|
|
<payload-type id='103' name='L16' clockrate='16000' channels='2'/>
|
|
<payload-type id='98' name='x-ISAC' clockrate='8000'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>Upon receiving the session-initiate stanza, the responder determines whether it can proceed with the negotiation. The general Jingle error cases are specified in <cite>XEP-0166</cite> and illustrated in the <link url='#scenarios'>Scenarios</link> section of this document.</p>
|
|
<p>If there is no error, the responder acknowledges the session initiation request.</p>
|
|
<example caption="Responder acknowledges session-initiate"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
id='jingle1'
|
|
to='romeo@montague.net/orchard'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>After successful transport negotiation (not shown here), the responder accepts the session by sending a session-accept action to the initiator. The session-accept SHOULD include a subset of the payload types sent by the initiator, i.e., a list of the offered payload types that the responder can send and/or receive. The list that the responder sends SHOULD retain the ID numbers specified by the initiator. The order of the &PAYLOADTYPE; elements indicates the responder's preferences, with the most-preferred types first.</p>
|
|
<p>In the following example, we imagine that the responder supports Speex at clockrate of 8000 but not 16000, G729, and PCMA but not PMCU. Therefore the responder returns only two payload types (since PMCA was not offered).</p>
|
|
<example caption="Responder definitively accepts the session"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
id='accept1'
|
|
to='romeo@montague.net/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-accept'
|
|
initiator='romeo@montague.net/orchard'
|
|
responder='juliet@capulet.com/balcony'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='initiator' name='voice'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='97' name='speex' clockrate='8000'/>
|
|
<payload-type id='18' name='G729'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'>
|
|
<candidate component='1'
|
|
foundation='1'
|
|
generation='0'
|
|
ip='192.0.2.3'
|
|
network='1'
|
|
port='45664'
|
|
priority='1678246398'
|
|
protocol='udp'
|
|
pwd='asd88fgpdd777uzjYhagZg'
|
|
type='srflx'
|
|
ufrag='8hhy'/>
|
|
</transport>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>And the initiator acknowledges session acceptance:</p>
|
|
<example caption="Initiator acknowledges session acceptance"><![CDATA[
|
|
<iq from='romeo@montague.net/orchard'
|
|
id='accept1'
|
|
to='juliet@capulet.com/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>The initiator and responder would then exchange media using any of the codecs that meet the following criteria:</p>
|
|
<ul>
|
|
<li>If the value of the 'senders' attribute is "initiator" then the initiator MAY use any codec that it can send and the responder can receive.</li>
|
|
<li>If the value of the 'senders' attribute is "responder" then the responder MAY use any codec that it can send and the initiator can receive.</li>
|
|
<li>If the value of the 'senders' attribute is "both" then the parties MAY use any codec that both parties can send and receive.</li>
|
|
</ul>
|
|
</section1>
|
|
|
|
<section1 topic='Mapping to Session Description Protocol' anchor='sdp'>
|
|
<p>The SDP media type for Jingle RTP is "audio" (see Section 8.2.1 of <cite>RFC 4566</cite>) for audio media, "video" (see Section 8.2.1 of <cite>RFC 4566</cite>) for video media, etc.</p>
|
|
<p>If the payload type is static (payload-type IDs 0 through 95 inclusive), it MUST be mapped to a media field defined in <cite>RFC 4566</cite>. The generic format for the media field is as follows:</p>
|
|
<code><![CDATA[
|
|
m=<media> <port> <transport> <fmt list>
|
|
]]></code>
|
|
<p>In the context of Jingle audio sessions, the <media> is "audio" or "video" or some other media type as specified by the 'media' attribute, the <port> is the preferred port for such communications (which might be determined dynamically), and the <fmt list> is the payload-type ID.</p>
|
|
<p>For example, consider the following static payload-type:</p>
|
|
<code><![CDATA[
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id="13" name="CN"/>
|
|
</description>
|
|
]]></code>
|
|
<p>That Jingle-formatted information would be mapped to SDP as follows:</p>
|
|
<code><![CDATA[
|
|
m=audio 9999 RTP/AVP 13
|
|
]]></code>
|
|
<p>If the payload type is dynamic (payload-type IDs 96 through 127 inclusive), it SHOULD be mapped to an SDP media field plus an SDP attribute field named "rtpmap".</p>
|
|
<p>For example, consider a payload of 16-bit linear-encoded stereo audio sampled at 16KHz associated with dynamic payload-type 96:</p>
|
|
<code><![CDATA[
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='96' name='speex' clockrate='16000'/>
|
|
</description>
|
|
]]></code>
|
|
<p>That Jingle-formatted information would be mapped to SDP as follows:</p>
|
|
<code><![CDATA[
|
|
m=audio 9999 RTP/AVP 96
|
|
a=rtpmap:96 speex/16000
|
|
]]></code>
|
|
<p>As noted, if additional parameters are to be specified, they shall be represented as attributes of the <parameter/> child of the &PAYLOADTYPE; element, as in the following example.</p>
|
|
<code><![CDATA[
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='96' name='speex' clockrate='16000' ptime='40'>
|
|
<parameter name='vbr' value='on'/>
|
|
<parameter name='cng' value='on'/>
|
|
</payload-type>
|
|
</description>
|
|
]]></code>
|
|
<p>That Jingle-formatted information would be mapped to SDP as follows:</p>
|
|
<code><![CDATA[
|
|
m=audio 9999 RTP/AVP 96
|
|
a=rtpmap:96 speex/16000
|
|
a=ptime:40
|
|
a=fmtp:96 vbr=on;cng=on
|
|
]]></code>
|
|
<p>The formatting is similar for video parameters, as shown in the following example.</p>
|
|
<code><![CDATA[
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='video'>
|
|
<payload-type id='98' name='theora' clockrate='90000'>
|
|
<parameter name='height' value='720'/>
|
|
<parameter name='width' value='1280'/>
|
|
<parameter name='delivery-method' value='inline'/>
|
|
<parameter name='configuration' value='somebase16string'/>
|
|
<parameter name='sampling' value='YCbCr-4:2:2'/>
|
|
</payload-type>
|
|
</description>
|
|
]]></code>
|
|
<p>That Jingle-formatted information would be mapped to SDP as follows:</p>
|
|
<code><![CDATA[
|
|
m=video 49170 RTP/AVP 98
|
|
a=rtpmap:98 theora/90000
|
|
a=fmtp:98 sampling=YCbCr-4:2:2; width=1280; height=720;
|
|
delivery-method=inline; configuration=somebase16string;
|
|
]]></code>
|
|
</section1>
|
|
|
|
<section1 topic='Early Media' anchor='earlymedia'>
|
|
<p>The term "early media" refers to media that is exchanged before a responder has definitively accepted a session request generated by an initiator. Early media is typically used to send ringing tones and announcements, using either audio streams or Dual Tone Multi-Frequency (DTMF) events.</p>
|
|
<p>In Jingle, the exchange of early media is established through use of the "content-add" action. In order to match the usage specified in &rfc3959; and &rfc3960;, when adding a content definition for early media the value of the &CONTENT; element's 'disposition' attribute MUST be "early-session" for mapping to a SIP Content-Disposition header value of "early-session" (if necessary). This enables endpoints or intermediate gateways to apply the application server model described in <cite>RFC3960</cite>.</p>
|
|
<p>An entity that generates a content-add for early media SHOULD specify the same codecs for both session media and early media (however, it is possible that the entity generating early media does not generate session media, for example in the case of an intermediate gateway or application server; in this case the entity MUST use one of the codecs advertised by the initiator).</p>
|
|
<p>Upon receiving a content-add action specifying the use of early media, the initiator's client SHOULD acknowledge the content-add and then send a content-accept to the sender. When the responder subsequently sends a session-accept action, the acceptance MUST NOT be construued to include the content definition whose disposition is "early-session".</p>
|
|
<p>In handling early media and deciding whether to generate local ringing or play early media received from the responder or an intermediate gateway, the initiator's client SHOULD proceed as follows:</p>
|
|
<ol>
|
|
<li>If no ringing notification is received via a session-info event containing a <ringing/> condition, do not generate local ringing.</li>
|
|
<li>If a ringing notification is received and no early media is received, generate local ringing.</li>
|
|
<li>If a ringing notification is received but early media is received, play the early media and do not generate local media.</li>
|
|
<li>Once the responder has accepted the session and the session (as opposed to early session) media has begun to flow, stop local ringing or stop playing early media.</li>
|
|
</ol>
|
|
<p>For examples of early media, see the <link url='#scenarios-earlymedia'>Jingle Audio via RTP with Early Media</link> section of this document.</p>
|
|
</section1>
|
|
|
|
<section1 topic='Negotiation of SRTP' anchor='srtp'>
|
|
<p>&rfc3711; defines the Secure Real-time Transport Protocol, and &rfc4568; defines the SDP "crypto" attribute for signalling and negotiating the use of SRTP in the context of offer-answer protocols such as SIP. To enable the use of SRTP and gatewaying to non-XMPP technologies that make use of the "crypto" SDP attribute, we define a corresponding <crypto/> element qualified by the 'urn:xmpp:jingle:apps:rtp:0' namespace.</p>
|
|
<p>If the initiator wishes to use SRTP, the session-initiate MUST include at least one <crypto/> element and MAY include multiple instances of the element. The <crypto/> element MUST be a child of the <description/> element.</p>
|
|
<p>The XML attributes of the <crypto/> element are as follows:</p>
|
|
<ul>
|
|
<li>crypto-suite -- this maps to the SDP "crypto-suite" parameter and has the same semantics (i.e., it is an identifier that describes the encryption and authentication algorithms).</li>
|
|
<li>key-params -- this maps to the SDP "key-params" parameter and has the same semantics (i.e., it provides one or more sets of keying material for the crypto-suite in question).</li>
|
|
<li>session-params -- this maps to the SDP "session-params" parameter and has the same semantics (i.e., it provides transport-specific parameters for SRTP negotiation).</li>
|
|
<li>tag -- this maps to the SDP "tag" parameter and has the same semantics (i.e., it is a decimal number used as an identifier for a particular crypto element).</li>
|
|
</ul>
|
|
<p>An example follows.</p>
|
|
<code><![CDATA[
|
|
<crypto
|
|
crypto-suite='AES_CM_128_HMAC_SHA1_80'
|
|
key-params='inline:WVNfX19zZW1jdGwgKCkgewkyMjA7fQp9CnVubGVz|2^20|1:32'
|
|
session-params='KDR=1;UNENCRYPTED_SRTCP'
|
|
tag='1'/>
|
|
]]></code>
|
|
<p>The mapping to SDP is as follows.</p>
|
|
<code><![CDATA[
|
|
a=crypto:1 AES_CM_128_HMAC_SHA1_80
|
|
inline:WVNfX19zZW1jdGwgKCkgewkyMjA7fQp9CnVubGVz|2^20|1:32
|
|
]]></code>
|
|
<p>When the responder receives a session-initiate action containing one or more instances of the <crypto/> element, it MUST either accept one of the <crypto/> elements or reject the offer by sending a session-terminate action with a Jingle reason of <general-error/> and an RTP-specific condition of <invalid-crypto/>; see the <link url='#scenarios'>Scenarios</link> section of this document for examples.</p>
|
|
</section1>
|
|
|
|
<section1 topic='Informational Messages' anchor='info'>
|
|
<section2 topic='Format' anchor='info-format'>
|
|
<p>Informational messages can be sent by either party within the context of Jingle to communicate the status of a Jingle RTP session, device, or principal. The informational message MUST be an IQ-set containing a &JINGLE; element of type "session-info", where the informational message is a payload element qualified by the 'urn:xmpp:jingle:apps:rtp:info:0' namespace; the following payload elements are defined: <note>A <trying/> element (equivalent to the SIP 100 Trying response code) is not necessary, since each session-level action is acknowledged via XMPP IQ semantics.</note></p>
|
|
<table caption='Information Payload Elements'>
|
|
<tr>
|
|
<th>Element</th>
|
|
<th>Meaning</th>
|
|
</tr>
|
|
<tr>
|
|
<td><active/></td>
|
|
<td>The principal or device is again actively participating in the session after having been on hold or on mute. The <active/< element MAY possess a 'name' attribute whose value specifies a particular session that is again active (e.g., activating the video aspect but not the audio aspect of a voice+video chat). If no 'name' attribute is included, the recipient MUST assume that all sessions are active.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><hold/></td>
|
|
<td>The principal is temporarily pausing the chat (i.e., putting the other party on hold).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><mute/></td>
|
|
<td>The principal is temporarily stopping media output but continues to accept media input. The <mute/< element MAY possess a 'name' attribute whose value specifies a particular session to be muted (e.g., muting the audio aspect but not the video aspect of a voice+video chat). If no 'name' attribute is included, the recipient MUST assume that all sessions are to be muted.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><ringing/></td>
|
|
<td>The device is ringing but the principal has not yet interacted with it to answer (this maps to the SIP 180 response code).</td>
|
|
</tr>
|
|
</table>
|
|
<p>Note: Because the informational message is sent in an IQ-set, the receiving party MUST return either an IQ-result or an IQ-error (normally only an IQ-result to acknowledge receipt; no error flows are defined or envisioned at this time).</p>
|
|
</section2>
|
|
<section2 topic='Examples' anchor='info-examples'>
|
|
<example caption="Responder sends active message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
id='active1'
|
|
to='romeo@montague.net/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'>
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<active xmlns='urn:xmpp:jingle:apps:rtp:info:0'
|
|
name='webcam'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Responder sends hold message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
id='hold1'
|
|
to='romeo@montague.net/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<hold xmlns='urn:xmpp:jingle:apps:rtp:info:0'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Responder sends mute message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
id='mute1'
|
|
to='romeo@montague.net/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<mute xmlns='urn:xmpp:jingle:apps:rtp:info:0'
|
|
name='voice'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Responder sends ringing message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
id='ringing1'
|
|
to='romeo@montague.net/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<ringing xmlns='urn:xmpp:jingle:apps:rtp:info:0'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
</section2>
|
|
</section1>
|
|
|
|
<section1 topic='Determining Support' anchor='support'>
|
|
<p>If an entity supports Jingle RTP session, it MUST advertise that fact by returning a feature of "urn:xmpp:jingle:apps:rtp:0" &VNOTE; in response to &xep0030; information requests.</p>
|
|
<example caption="Service discovery information request"><![CDATA[
|
|
<iq from='romeo@montague.net/orchard'
|
|
id='disco1'
|
|
to='juliet@capulet.com/balcony'
|
|
type='get'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'/>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Service discovery information response"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
id='disco1'
|
|
to='romeo@montague.net/orchard'
|
|
type='result'>
|
|
<query xmlns='http://jabber.org/protocol/disco#info'>
|
|
...
|
|
<feature var='urn:xmpp:jingle:0'/>
|
|
<feature var='urn:xmpp:jingle:apps:rtp:0'/>
|
|
...
|
|
</query>
|
|
</iq>
|
|
]]></example>
|
|
<p>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 &xep0115;. However, if an application has not received entity capabilities information from an entity, it SHOULD use explicit service discovery instead.</p>
|
|
</section1>
|
|
|
|
<section1 topic='Scenarios' anchor='scenarios'>
|
|
|
|
<p>The following sections show a number of Jingle RTP scenarios, roughly in order of increasing complexity.</p>
|
|
|
|
<section2 topic='Responder is Busy' anchor='scenarios-busy'>
|
|
<p>In this scenario, Romeo initiates a voice chat with Juliet but she is otherwise engaged.</p>
|
|
<p>The session flow is as follows:</p>
|
|
<code><![CDATA[
|
|
Romeo Juliet
|
|
| |
|
|
| session-initiate |
|
|
|---------------------------->|
|
|
| ack |
|
|
|<----------------------------|
|
|
| session-info (ringing) |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| terminate |
|
|
| (reason = busy) |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| |
|
|
]]></code>
|
|
<p>The protocol flow is as follows.</p>
|
|
<example caption="Initiator sends session-initiate"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='jingle1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-initiate'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='initiator' name='voice'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='96' name='speex' clockrate='16000'/>
|
|
<payload-type id='97' name='speex' clockrate='8000'/>
|
|
<payload-type id='18' name='G729'/>
|
|
<payload-type id='103' name='L16' clockrate='16000' channels='2'/>
|
|
<payload-type id='98' name='x-ISAC' clockrate='8000'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Responder acknowledges session-initiate"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='accept1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='result'/>
|
|
]]></example>
|
|
<example caption="Responder sends ringing message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
id='ringing1'
|
|
to='romeo@montague.net/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<ringing xmlns='urn:xmpp:jingle:apps:rtp:info:0'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Initiator acknowledges ringing message"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='ringing1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>Now the responder immediately terminates the session.</p>
|
|
<p>Note: It may be wondered why the responder does not accept the session and then terminate. That order would be acceptable, too, but here we assume that the responder's client has immediate information about the responder's free/busy status (e.g., because the responder is on the phone) and therefore returns an automated busy signal without requiring user interaction.</p>
|
|
<example caption="Responder terminates the session"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='term1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-terminate'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<reason>
|
|
<busy/>
|
|
</reason>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Initiator acknowledges termination"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='term1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
</section2>
|
|
|
|
<section2 topic='Jingle Audio via RTP, Negotiated with ICE-UDP' anchor='scenarios-voicechat'>
|
|
<p>In this scenario, Romeo initiates a voice chat with Juliet using a transport method of ICE-UDP. The parties also exchange informational messages.</p>
|
|
<p>The session flow is as follows:</p>
|
|
<code><![CDATA[
|
|
Romeo Juliet
|
|
| |
|
|
| session-initiate |
|
|
|---------------------------->|
|
|
| ack |
|
|
|<----------------------------|
|
|
| session-info (ringing) |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| transport-info (X times) |
|
|
| (with acks) |
|
|
|<--------------------------->|
|
|
| STUN connectivity checks |
|
|
|<===========================>|
|
|
| session-accept |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| AUDIO (RTP) |
|
|
|<===========================>|
|
|
| session-terminate |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| |
|
|
]]></code>
|
|
<p>The protocol flow is as follows.</p>
|
|
<example caption="Initiator sends session-initiate"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='jingle1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-initiate'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='initiator' name='voice'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='96' name='speex' clockrate='16000'/>
|
|
<payload-type id='97' name='speex' clockrate='8000'/>
|
|
<payload-type id='18' name='G729'/>
|
|
<payload-type id='103' name='L16' clockrate='16000' channels='2'/>
|
|
<payload-type id='98' name='x-ISAC' clockrate='8000'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Responder acknowledges session-initiate"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='accept1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='result'/>
|
|
]]></example>
|
|
<example caption="Responder sends ringing message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
id='ringing1'
|
|
to='romeo@montague.net/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<ringing xmlns='urn:xmpp:jingle:apps:rtp:info:0'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Initiator acknowledges ringing message"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='ringing1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>Because the parties have chosen the Jingle ICE-UDP Transport Method, the initiator and responder exchange an open-ended number of possible candidate transports, perform connectivity checks, and agree upon a candidate transport as explained in <cite>XEP-0176</cite>. Once ICE negotiation is completed, the responder sends a session-accept action to the initiator.</p>
|
|
<example caption="Responder sends session-accept"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='accept1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-accept'
|
|
initiator='romeo@montague.lit/orchard'
|
|
responder='juliet@capulet.lit/balcony'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='initiator' name='voice'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='97' name='speex' clockrate='8000'/>
|
|
<payload-type id='18' name='G729'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'>
|
|
<candidate component='1'
|
|
foundation='1'
|
|
generation='0'
|
|
ip='192.0.2.3'
|
|
network='1'
|
|
port='45664'
|
|
priority='1694498815'
|
|
protocol='udp'
|
|
pwd='asd88fgpdd777uzjYhagZg'
|
|
rel-addr='10.0.1.1'
|
|
rel-port='8998'
|
|
rem-addr='192.0.2.1'
|
|
rem-port='3478'
|
|
type='srflx'
|
|
ufrag='8hhy'/>
|
|
</transport>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>If the payload types and transport candidate can be successfully used by both parties, the initiator acknowledges the session-accept action.</p>
|
|
<example caption="Initiator acknowledges session-accept"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='accept1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>The parties now begin to exchange media. In this case they would exchange audio using the Speex codec at a clockrate of 8000 since that is the highest-priority codec for the responder (as determined by the XML order of the &PAYLOADTYPE; children).</p>
|
|
<p>The parties can continue the session as long as desired.</p>
|
|
<p>Eventually, one of the parties terminates the session.</p>
|
|
<example caption="Responder terminates the session"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='term1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-terminate'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<reason>
|
|
<no-error/>
|
|
<text>Sorry, gotta go!</text>
|
|
</reason>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>The other party then acknowledges termination of the session:</p>
|
|
<example caption="Initiator acknowledges termination"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='term1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
</section2>
|
|
|
|
<section2 topic='Jingle Audio via SRTP, Negotiated with ICE-UDP' anchor='scenarios-srtp'>
|
|
<p>In this scenario, Romeo initiates a secure voice chat with Juliet using a transport method of ICE-UDP. The parties also exchange informational messages.</p>
|
|
<p>The session flow is as follows:</p>
|
|
<code><![CDATA[
|
|
Romeo Juliet
|
|
| |
|
|
| session-initiate |
|
|
| (with keying material) |
|
|
|---------------------------->|
|
|
| ack |
|
|
|<----------------------------|
|
|
| session-info (ringing) |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| transport-info (X times) |
|
|
| (with acks) |
|
|
|<--------------------------->|
|
|
| STUN connectivity checks |
|
|
|<===========================>|
|
|
| session-accept |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| AUDIO (RTP) |
|
|
|<===========================>|
|
|
| session-terminate |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| |
|
|
]]></code>
|
|
<p>The protocol flow is as follows.</p>
|
|
<example caption="Initiator sends session-initiate"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='jingle1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-initiate'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='initiator' name='voice'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='96' name='speex' clockrate='16000'/>
|
|
<payload-type id='97' name='speex' clockrate='8000'/>
|
|
<payload-type id='18' name='G729'/>
|
|
<payload-type id='103' name='L16' clockrate='16000' channels='2'/>
|
|
<payload-type id='98' name='x-ISAC' clockrate='8000'/>
|
|
<crypto
|
|
crypto-suite='AES_CM_128_HMAC_SHA1_80'
|
|
key-params='inline:WVNfX19zZW1jdGwgKCkgewkyMjA7fQp9CnVubGVz|2^20|1:32'
|
|
session-params='KDR=1;UNENCRYPTED_SRTCP'
|
|
tag='1'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>To signal that the initiator wishes to use SRTP, the initiator's client includes keying material.</p>
|
|
<p>The responder immediately acknowledges the session initiation request.</p>
|
|
<example caption="Responder acknowledges session-initiate"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='accept1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>If the keying material is acceptable, the responder's continues with the negotiation. If the keying material is not acceptable, the responder's client terminates the session (and can do so at any time).</p>
|
|
<example caption="Responder acknowledges session-initiate"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='term1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-terminate'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<reason>
|
|
<general-error/>
|
|
<invalid-crypto xmlns='urn:xmpp:jingle:apps:rtp:errors:0'/>
|
|
</reason>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Responder sends ringing message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
id='ringing1'
|
|
to='romeo@montague.net/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<ringing xmlns='urn:xmpp:jingle:apps:rtp:info:0'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Initiator acknowledges ringing message"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='ringing1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>Because the parties have chosen the Jingle ICE-UDP Transport Method, the initiator and responder exchange an open-ended number of possible candidate transports, perform connectivity checks, and agree upon a candidate transport as explained in <cite>XEP-0176</cite>. Once ICE negotiation is completed, the responder sends a session-accept action to the initiator.</p>
|
|
<example caption="Responder sends session-accept"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='accept1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-accept'
|
|
initiator='romeo@montague.lit/orchard'
|
|
responder='juliet@capulet.lit/balcony'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='initiator' name='voice'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='97' name='speex' clockrate='8000'/>
|
|
<payload-type id='18' name='G729'/>
|
|
<crypto
|
|
crypto-suite='AES_CM_128_HMAC_SHA1_80'
|
|
key-params='inline:PS1uQCVeeCFCanVmcjkpPywjNWhcYD0mXXtxaVBR|2^20|1:32'
|
|
session-params='KDR=1;UNENCRYPTED_SRTCP'
|
|
tag='1'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'>
|
|
<candidate component='1'
|
|
foundation='1'
|
|
generation='0'
|
|
ip='192.0.2.3'
|
|
network='1'
|
|
port='45664'
|
|
priority='1694498815'
|
|
protocol='udp'
|
|
pwd='asd88fgpdd777uzjYhagZg'
|
|
rel-addr='10.0.1.1'
|
|
rel-port='8998'
|
|
rem-addr='192.0.2.1'
|
|
rem-port='3478'
|
|
type='srflx'
|
|
ufrag='8hhy'/>
|
|
</transport>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>If the payload types and transport candidate can be successfully used by both parties, then the initiator acknowledges the session-accept action.</p>
|
|
<example caption="Initiator acknowledges session-accept"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='accept1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>The parties now begin to exchange media. In this case they would exchange audio using the Speex codec at a clockrate of 8000 since that is the highest-priority codec for the responder (as determined by the XML order of the &PAYLOADTYPE; children).</p>
|
|
<p>The parties can continue the session as long as desired.</p>
|
|
<p>Eventually, one of the parties terminates the session.</p>
|
|
<example caption="Responder terminates the session"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='term1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-terminate'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<reason>
|
|
<no-error/>
|
|
<text>Sorry, gotta go!</text>
|
|
</reason>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>The other party then acknowledges termination of the session:</p>
|
|
<example caption="Initiator acknowledges termination"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='term1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
</section2>
|
|
|
|
<section2 topic='Jingle Audio via RTP with Early Media' anchor='scenarios-earlymedia'>
|
|
<p>In this scenario, Romeo initiates a voice chat with Juliet using a transport method of ICE-UDP. There is a gateway between Romeo and Juliet, and the gateway functions as an application server by returning early media to Romeo (perhaps some late medieval hold music or an old-fashioned IVR interaction). To simplify the flow, we have left out any ringing notifications generated by Juliet.</p>
|
|
<p>The session flow is as follows.</p>
|
|
<code><![CDATA[
|
|
Romeo Gateway Juliet
|
|
| | |
|
|
| session-initiate | |
|
|
| (audio definition) | |
|
|
|------------------------>| session-initiate |
|
|
| ack |------------------------>|
|
|
|<------------------------| |
|
|
| content-add | ack |
|
|
| (early media) x<------------------------|
|
|
|<------------------------| |
|
|
| ack | |
|
|
|------------------------>| |
|
|
| content-accept | |
|
|
|------------------------>| |
|
|
| ack | |
|
|
|<------------------------| |
|
|
| EARLY MEDIA (RTP) | |
|
|
|<=======================>| |
|
|
| | session-accept |
|
|
| |<------------------------|
|
|
| session-accept | |
|
|
|<------------------------| |
|
|
| ack | |
|
|
|------------------------>| ack |
|
|
| |------------------------>|
|
|
| AUDIO (RTP) |
|
|
|<=================================================>|
|
|
| | session-terminate |
|
|
| |<------------------------|
|
|
| session-terminate | |
|
|
|<------------------------| |
|
|
| ack | |
|
|
|------------------------>| ack |
|
|
| |------------------------>|
|
|
| | |
|
|
]]></code>
|
|
<p>The protocol flow is as follows, showing only the stanzas sent between Romeo and the gateway (acting on Juliet's behalf).</p>
|
|
<example caption="Initiator sends session-initiate"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='jingle1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-initiate'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='initiator' name='voice'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='96' name='speex' clockrate='16000'/>
|
|
<payload-type id='97' name='speex' clockrate='8000'/>
|
|
<payload-type id='18' name='G729'/>
|
|
<payload-type id='103' name='L16' clockrate='16000' channels='2'/>
|
|
<payload-type id='98' name='x-ISAC' clockrate='8000'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Responder acknowledges session-initiate"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='accept1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>Now the gateway sends a content-add action to Romeo while waiting for Juliet to pay attention to her telephony interface.</p>
|
|
<example caption="Gateway sends content-add on behalf of responder"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='add1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='content-add'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='responder'
|
|
disposition='early-session'
|
|
name='hold music'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='18' name='G729'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:raw-udp:0'>
|
|
<candidate generation='0'
|
|
id='a9j3mnbtu1'
|
|
ip='10.1.1.104'
|
|
port='13540'/>
|
|
</transport>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>Romeo then acknowledges the content-add action and immediately also sends a content-accept.</p>
|
|
<example caption="Initiator acknowledges content-add"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='add1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<example caption="Initiator accepts new content definition"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='accept1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='content-accept'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='responder'
|
|
disposition='early-session'
|
|
name='hold music'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='18' name='G729'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:raw-udp:0'>
|
|
<candidate generation='0'
|
|
id='a9j3mnbtu1'
|
|
ip='10.1.1.104'
|
|
port='13540'/>
|
|
</transport>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>The gateway then acknowledges the acceptance on behalf of Juliet.</p>
|
|
<example caption="Gateway acknowledges content-accept"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='accept1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>Now the gateway sends early media to Romeo.</p>
|
|
<p>Eventually, the responder sends a session-accept.</p>
|
|
<example caption="Responder sends session-accept"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='accept1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-accept'
|
|
initiator='romeo@montague.lit/orchard'
|
|
responder='juliet@capulet.lit/balcony'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='initiator' name='voice'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='97' name='speex' clockrate='8000'/>
|
|
<payload-type id='18' name='G729'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'>
|
|
<candidate component='1'
|
|
foundation='1'
|
|
generation='0'
|
|
ip='192.0.2.3'
|
|
network='1'
|
|
port='45664'
|
|
priority='1694498815'
|
|
protocol='udp'
|
|
pwd='asd88fgpdd777uzjYhagZg'
|
|
rel-addr='10.0.1.1'
|
|
rel-port='8998'
|
|
rem-addr='192.0.2.1'
|
|
rem-port='3478'
|
|
type='srflx'
|
|
ufrag='8hhy'/>
|
|
</transport>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Initiator acknowledges session-accept"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='accept1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>The endpoints now begin to exchange session media; as a result, Romeo and the gateway terminate the exchange of early media.</p>
|
|
<p>The endpoints can continue the session as long as desired.</p>
|
|
<p>Eventually, one of the endpoints terminates the session.</p>
|
|
<example caption="Responder terminates the session"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='term1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-terminate'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<reason>
|
|
<no-error/>
|
|
<text>Sorry, gotta go!</text>
|
|
</reason>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>The other party then acknowledges termination of the session:</p>
|
|
<example caption="Initiator acknowledges termination"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='term1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
</section2>
|
|
|
|
<section2 topic='Jingle Audio and Video via RTP, Negotiated with ICE-UDP' anchor='scenarios-audiovideo'>
|
|
<p>In this scenario, Romeo initiates a combined audio and video chat with Juliet using a transport method of ICE-UDP. Juliet at first refuses the video portion, then later offers to add video, which Romeo accepts. The parties also exchange various informational messages</p>
|
|
<p>The session flow is as follows:</p>
|
|
<code><![CDATA[
|
|
Romeo Juliet
|
|
| |
|
|
| session-initiate |
|
|
|---------------------------->|
|
|
| ack |
|
|
|<----------------------------|
|
|
| session-info (ringing) |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| content-remove |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| transport-info (X times) |
|
|
| (with acks) |
|
|
|<--------------------------->|
|
|
| STUN connectivity checks |
|
|
|<===========================>|
|
|
| session-accept |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| AUDIO (RTP) |
|
|
|<===========================>|
|
|
| session-info (hold) |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| session-info (active) |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| content-add |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| content-accept |
|
|
|---------------------------->|
|
|
| ack |
|
|
|<----------------------------|
|
|
| AUDIO + VIDEO (RTP) |
|
|
|<===========================>|
|
|
| session-terminate |
|
|
|<----------------------------|
|
|
| ack |
|
|
|---------------------------->|
|
|
| |
|
|
]]></code>
|
|
<p>The protocol flow is as follows.</p>
|
|
<example caption="Initiation"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='jingle1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-initiate'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='initiator' name='voice'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='96' name='speex' clockrate='16000'/>
|
|
<payload-type id='97' name='speex' clockrate='8000'/>
|
|
<payload-type id='18' name='G729'/>
|
|
<payload-type id='103' name='L16' clockrate='16000' channels='2'/>
|
|
<payload-type id='98' name='x-ISAC' clockrate='8000'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
|
|
</content>
|
|
<content creator='initiator' name='webcam'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='video'>
|
|
<payload-type id='98' name='theora' clockrate='90000'>
|
|
<parameter name='height' value='720'/>
|
|
<parameter name='width' value='1280'/>
|
|
<parameter name='delivery-method' value='inline'/>
|
|
<parameter name='configuration' value='somebase16string'/>
|
|
<parameter name='sampling' value='YCbCr-4:2:2'/>
|
|
</payload-type>
|
|
<payload-type id='28' name='nv' clockrate='90000'/>
|
|
<payload-type id='25' name='CelB' clockrate='90000'/>
|
|
<payload-type id='32' name='MPV' clockrate='90000'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Responder acknowledges session-initiate request"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='jingle1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='result'/>
|
|
]]></example>
|
|
<example caption="Responder sends ringing message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
id='ringing1'
|
|
to='romeo@montague.net/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<ringing xmlns='urn:xmpp:jingle:apps:rtp:info:0'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Initiator acknowledges ringing message"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='ringing1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>However, Juliet doesn't want to do video because she is having a bad hair day, so she sends a "content-remove" request to Romeo.</p>
|
|
<example caption="Responder requests content-remove"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='remove1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='content-remove'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='initiator' name='webcam'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>Romeo then acknowledges the content-remove request:</p>
|
|
<example caption="Initiator acknowledges content-remove"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='remove1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>Because the parties have chosen the Jingle ICE-UDP Transport Method, the initiator and responder exchange an open-ended number of possible candidate transports, perform connectivity checks, and agree upon a candidate transport as explained in <cite>XEP-0176</cite>. Once ICE negotiation is completed, the responder sends a session-accept action to the initiator.</p>
|
|
<example caption="Responder sends session-accept"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='accept1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-accept'
|
|
initiator='romeo@montague.lit/orchard'
|
|
responder='juliet@capulet.lit/balcony'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='initiator' name='voice'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='audio'>
|
|
<payload-type id='97' name='speex' clockrate='8000'/>
|
|
<payload-type id='18' name='G729'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'>
|
|
<candidate component='1'
|
|
foundation='1'
|
|
generation='0'
|
|
ip='192.0.2.3'
|
|
network='1'
|
|
port='45664'
|
|
priority='1694498815'
|
|
protocol='udp'
|
|
pwd='asd88fgpdd777uzjYhagZg'
|
|
rel-addr='10.0.1.1'
|
|
rel-port='8998'
|
|
rem-addr='192.0.2.1'
|
|
rem-port='3478'
|
|
type='srflx'
|
|
ufrag='8hhy'/>
|
|
</transport>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>As above, if the payload types and transport candidate can be successfully used by both parties, then the initiator acknowledges the session-accept action.</p>
|
|
<example caption="Initiator acknowledges session-accept"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='accept1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>The parties now begin to exchange media. In this case they would exchange audio using the Speex codec at a clockrate of 8000 since that is the highest-priority codec for the responder (as determined by the XML order of the &PAYLOADTYPE; children).</p>
|
|
<p>The parties chat for a while. Eventually Juliet wants to get her hair in order so she puts Romeo on hold.</p>
|
|
<example caption="Responder sends hold message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
id='hold1'
|
|
to='romeo@montague.net/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<hold xmlns='urn:xmpp:jingle:apps:rtp:info:0'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Initiator acknowledges hold message"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='hold1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>Juliet returns so she informs Romeo that she is actively engaged in the call again.</p>
|
|
<example caption="Responder sends active message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
id='active1'
|
|
to='romeo@montague.net/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<active xmlns='urn:xmpp:jingle:apps:rtp:info:0'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Initiator acknowledges active message"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='active1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>The parties now continue the audio chat.</p>
|
|
<p>Finally Juliet decides that she is presentable for a video chat so she sends a content-add request to Romeo.</p>
|
|
<example caption="Responder sends a content-add"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='add1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='content-add'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='responder' name='webcam'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='video'>
|
|
<payload-type id='98' name='theora' clockrate='90000'>
|
|
<parameter name='height' value='720'/>
|
|
<parameter name='width' value='1280'/>
|
|
<parameter name='delivery-method' value='inline'/>
|
|
<parameter name='configuration' value='somebase16string'/>
|
|
<parameter name='sampling' value='YCbCr-4:2:2'/>
|
|
</payload-type>
|
|
<payload-type id='32' name='MPV' clockrate='90000'/>
|
|
<payload-type id='33' name='MP2T' clockrate='90000'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>The entity receiving the content-add request then acknowledges the request and, if it is acceptable, returns a content-accept action:</p>
|
|
<example caption="Initiator acknowledges content-add"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='add1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='result'/>
|
|
]]></example>
|
|
<example caption="Initiator accepts new content definition"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='add2'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='content-accept'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='responder' name='webcam'>
|
|
<description xmlns='urn:xmpp:jingle:apps:rtp:0' media='video'>
|
|
<payload-type id='98' name='theora' clockrate='90000'>
|
|
<parameter name='height' value='720'/>
|
|
<parameter name='width' value='1280'/>
|
|
<parameter name='delivery-method' value='inline'/>
|
|
<parameter name='configuration' value='somebase16string'/>
|
|
<parameter name='sampling' value='YCbCr-4:2:2'/>
|
|
</payload-type>
|
|
<payload-type id='32' name='MPV' clockrate='90000'/>
|
|
</description>
|
|
<transport xmlns='urn:xmpp:jingle:transports:ice-udp:0'/>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>The other party then acknowledges the acceptance.</p>
|
|
<example caption="Responder acknowledges content-accept"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='add2'
|
|
to='romeo@montague.lit/orchard'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>The media session proceeds. Now they would exchange both audio and video, where the audio is exchanged via the Speex codec at a clockrate of 8000 and the video is exchanged using the Theora codec with a height of 720 pixels, a width of 1280 pixels, and so on.</p>
|
|
<p>The parties can continue the session as long as desired.</p>
|
|
<p>Eventually, one of the parties terminates the session.</p>
|
|
<example caption="Initiator sends session-terminate"><![CDATA[
|
|
<iq from='romeo@montague.lit/orchard'
|
|
id='term1'
|
|
to='juliet@capulet.lit/balcony'
|
|
type='set'>
|
|
<jingle xmlns='urn:xmpp:jingle:0'
|
|
action='session-terminate'
|
|
initiator='romeo@montague.lit/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<reason>
|
|
<no-error/>
|
|
<text>I'm outta here!</text>
|
|
</reason>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Responder acknowledges session-terminate"><![CDATA[
|
|
<iq from='juliet@capulet.lit/balcony'
|
|
id='term1'
|
|
to='romeo@montague.lit/orchard'
|
|
type='result'/>
|
|
]]></example>
|
|
</section2>
|
|
</section1>
|
|
|
|
<section1 topic='Implementation Notes' anchor='impl'>
|
|
<section2 topic='Audio Sessions' anchor='impl-audio'>
|
|
<section3 topic='Codecs' anchor='impl-audio-codecs'>
|
|
<section4 topic='Speex' anchor='impl-audio-codecs-speex'>
|
|
<p>For the sake of interoperability with a wide variety of free and open-source voice systems as well as deployment of patent-free technologies, support for the Speex codec is RECOMMENDED.</p>
|
|
</section4>
|
|
<section4 topic='G.711' anchor='impl-audio-codecs-g711'>
|
|
<p>For the sake of interoperability with the public switched telephone network (PSTN) and most VoIP providers, support for the Pulse Code Modulation (PCM) codec defined in &ITU; recommendation G.711 is RECOMMENDED, including both the μ-law ("U-law") version deployed in North America and in Japan, and the A-law version deployed in the rest of the world.</p>
|
|
</section4>
|
|
</section3>
|
|
<section3 topic='DTMF' anchor='impl-audio-dtmf'>
|
|
<p>XMPP applications that use Jingle RTP sessions for voice chat MUST support and prefer native RTP methods of communicating DTMF information, in particular the "audio/telephone-event" and "audio/tone" media types. It is NOT RECOMMENDED to use the protocol described in &xep0181; for communicating DTMF information with RTP-aware endpoints.</p>
|
|
</section3>
|
|
<section3 topic='When to Listen for Audio' anchor='impl-audio-listen'>
|
|
<p>When the Jingle RTP content type is accepted via a session-accept action, both initiator and responder SHOULD start listening for audio as defined by the negotiated transport method and audio application format. For interoperability with telephony systems, after the responder acknowledges the session initiation request, the responder SHOULD send a "ringing" message and both parties SHOULD play any audio received.</p>
|
|
</section3>
|
|
</section2>
|
|
<section2 topic='Video Sessions' anchor='impl-video'>
|
|
<section3 topic='Codecs' anchor='impl-video-codecs'>
|
|
<p>Support for the Theora codec is RECOMMENDED.</p>
|
|
</section3>
|
|
</section2>
|
|
</section1>
|
|
|
|
<section1 topic='Security Considerations' anchor='security'>
|
|
<p>In order to secure the data stream, implementations SHOULD use encryption methods appropriate to the transport method and media being exchanged. Such encryption methods are out of scope for this specification.</p>
|
|
</section1>
|
|
|
|
<section1 topic='IANA Considerations' anchor='iana'>
|
|
<p>This document requires no interaction with &IANA;.</p>
|
|
</section1>
|
|
|
|
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
|
|
<section2 topic='Protocol Namespaces' anchor='registrar-ns'>
|
|
<p>This specification defines the following XML namespaces:</p>
|
|
<ul>
|
|
<li>urn:xmpp:jingle:apps:rtp:0</li>
|
|
<li>urn:xmpp:jingle:apps:rtp:errors:0</li>
|
|
<li>urn:xmpp:jingle:apps:rtp:info:0</li>
|
|
</ul>
|
|
<p>Upon advancement of this specification from a status of Experimental to a status of Draft, the ®ISTRAR; shall add the foregoing namespaces to the registry located at &NAMESPACES;, as described in Section 4 of &xep0053;.</p>
|
|
</section2>
|
|
<section2 topic='Namespace Versioning' anchor='registrar-versioning'>
|
|
<p>If the protocol defined in this specification undergoes a major revision that is not fully backward-compatible with an older version, or that contains significant new features, 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 <cite>XEP-0053</cite>.</p>
|
|
</section2>
|
|
<section2 topic='Service Discovery Features' anchor='registrar-features'>
|
|
<p>For each RTP media type that an entity supports, it MUST advertise support for the "urn:xmpp:jingle:apps:rtp:[media]" feature, where the string "[media]" is replaced by the appropriate media type such as "audio" or "video".</p>
|
|
<p>The initial registry submission is as follows.</p>
|
|
<code caption='Registry Submission'><![CDATA[
|
|
<var>
|
|
<name>urn:xmpp:jingle:apps:rtp:audio</name>
|
|
<desc>Signals support for audio sessions via RTP</desc>
|
|
<doc>XEP-0167</doc>
|
|
</var>
|
|
<var>
|
|
<name>urn:xmpp:jingle:apps:rtp:video</name>
|
|
<desc>Signals support for video sessions via RTP</desc>
|
|
<doc>XEP-0167</doc>
|
|
</var>
|
|
]]></code>
|
|
</section2>
|
|
<section2 topic='Jingle Application Formats' anchor='registrar-content'>
|
|
<p>The XMPP Registrar shall include "rtp" in its registry of Jingle application formats. The registry submission is as follows:</p>
|
|
<code><![CDATA[
|
|
<application>
|
|
<name>rtp</name>
|
|
<desc>
|
|
Jingle sessions that support media exchange
|
|
via the Real-time Transport Protocol.
|
|
</desc>
|
|
<transport>lossy</transport>
|
|
<doc>XEP-0167</doc>
|
|
</application>
|
|
]]></code>
|
|
</section2>
|
|
</section1>
|
|
|
|
<section1 topic='XML Schemas' anchor='schema'>
|
|
<section2 topic='Application Format' anchor='schema-content'>
|
|
<code><![CDATA[
|
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
|
|
<xs:schema
|
|
xmlns:xs='http://www.w3.org/2001/XMLSchema'
|
|
targetNamespace='urn:xmpp:jingle:apps:rtp:0'
|
|
xmlns='urn:xmpp:jingle:apps:rtp:0'
|
|
elementFormDefault='qualified'>
|
|
|
|
<xs:element name='description'>
|
|
<xs:complexType>
|
|
<xs:sequence>
|
|
<xs:element name='payload-type'
|
|
type='payloadElementType'
|
|
minOccurs='0'
|
|
maxOccurs='unbounded'/>
|
|
<xs:element name='crypto'
|
|
type='cryptoElementType'
|
|
minOccurs='0'
|
|
maxOccurs='unbounded'/>
|
|
</xs:sequence>
|
|
</xs:complexType>
|
|
</xs:element>
|
|
|
|
<xs:complexType name='payloadElementType'>
|
|
<xs:sequence>
|
|
<xs:element name='parameter'
|
|
type='parameterElementType'
|
|
minOccurs='0'
|
|
maxOccurs='unbounded'/>
|
|
</xs:sequence>
|
|
<xs:attribute name='channels' type='xs:byte' use='optional' default='1'/>
|
|
<xs:attribute name='clockrate' type='xs:short' use='optional'/>
|
|
<xs:attribute name='id' type='xs:unsignedByte' use='required'/>
|
|
<xs:attribute name='maxptime' type='xs:short' use='optional'/>
|
|
<xs:attribute name='name' type='xs:string' use='optional'/>
|
|
<xs:attribute name='ptime' type='xs:short' use='optional'/>
|
|
</xs:complexType>
|
|
|
|
<xs:complexType name='parameterElementType'>
|
|
<xs:simpleContent>
|
|
<xs:extension base='empty'>
|
|
<xs:attribute name='name' type='xs:string' use='required'/>
|
|
<xs:attribute name='value' type='xs:string' use='required'/>
|
|
</xs:extension>
|
|
</xs:simpleContent>
|
|
</xs:complexType>
|
|
|
|
<xs:simpleType name='empty'>
|
|
<xs:restriction base='xs:string'>
|
|
<xs:enumeration value=''/>
|
|
</xs:restriction>
|
|
</xs:simpleType>
|
|
|
|
</xs:schema>
|
|
]]></code>
|
|
</section2>
|
|
<section2 topic='Errors' anchor='schema-errors'>
|
|
<code><![CDATA[
|
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
|
|
<xs:schema
|
|
xmlns:xs='http://www.w3.org/2001/XMLSchema'
|
|
targetNamespace='urn:xmpp:jingle:apps:rtp:errors:0'
|
|
xmlns='urn:xmpp:jingle:apps:rtp:errors:0'
|
|
elementFormDefault='qualified'>
|
|
|
|
<xs:element name='invalid-crypto' type='empty'/>
|
|
|
|
<xs:simpleType name='empty'>
|
|
<xs:restriction base='xs:string'>
|
|
<xs:enumeration value=''/>
|
|
</xs:restriction>
|
|
</xs:simpleType>
|
|
|
|
</xs:schema>
|
|
]]></code>
|
|
</section2>
|
|
<section2 topic='Informational Messages' anchor='schema-info'>
|
|
<code><![CDATA[
|
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
|
|
<xs:schema
|
|
xmlns:xs='http://www.w3.org/2001/XMLSchema'
|
|
targetNamespace='urn:xmpp:jingle:apps:rtp:info:0'
|
|
xmlns='urn:xmpp:jingle:apps:rtp:info:0'
|
|
elementFormDefault='qualified'>
|
|
|
|
<xs:element name='active'>
|
|
<xs:complexType>
|
|
<xs:simpleContent>
|
|
<xs:extension base='empty'>
|
|
<xs:attribute name='name' type='xs:string' use='optional'/>
|
|
</xs:extension>
|
|
</xs:simpleContent>
|
|
</xs:complexType>
|
|
</xs:element>
|
|
|
|
<xs:element name='hold' type='empty'/>
|
|
|
|
<xs:element name='mute'>
|
|
<xs:complexType>
|
|
<xs:simpleContent>
|
|
<xs:extension base='empty'>
|
|
<xs:attribute name='name' type='xs:string' use='optional'/>
|
|
</xs:extension>
|
|
</xs:simpleContent>
|
|
</xs:complexType>
|
|
</xs:element>
|
|
|
|
<xs:element name='ringing' type='empty'/>
|
|
|
|
<xs:simpleType name='empty'>
|
|
<xs:restriction base='xs:string'>
|
|
<xs:enumeration value=''/>
|
|
</xs:restriction>
|
|
</xs:simpleType>
|
|
|
|
</xs:schema>
|
|
]]></code>
|
|
</section2>
|
|
</section1>
|
|
<section1 topic='Acknowledgements' anchor='ack'>
|
|
<p>Thanks to Milton Chen, Olivier Crête, Tim Julien, Steffen Larsen, Jeff Muller, Mike Ruprecht, and Paul Witty for their feedback.</p>
|
|
</section1>
|
|
</xep>
|