mirror of https://github.com/moparisthebest/xeps
603 lines
28 KiB
XML
603 lines
28 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 Audio via RTP</title>
|
|
<abstract>This document defines methods for negotiating Jingle audio sessions that use the Real-time Transport Protocol (RTP) for media exchange.</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>TO BE ASSIGNED</shortname>
|
|
&scottlu;
|
|
&stpeter;
|
|
&seanegan;
|
|
&robmcqueen;
|
|
<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 audio chat. This document specifies a format for negotiating Jingle audio sessions over the Realtime Transport Protocol (RTP; see &rfc3550;).</p>
|
|
</section1>
|
|
<section1 topic='Requirements' anchor='reqs'>
|
|
<p>The Jingle content description format defined herein is designed to meet the following requirements:</p>
|
|
<ol>
|
|
<li>Enable negotiation of parameters necessary for audio chat over Realtime Transport Protocol (RTP; see &rfc3550;).</li>
|
|
<li>Map these parameters to Session Description Protocol (SDP; see &rfc4566;) to enable interoperability.</li>
|
|
<li>Define informational messages related to audio chat (e.g., busy and ringing).</li>
|
|
</ol>
|
|
</section1>
|
|
<section1 topic='Jingle Conformance' anchor='conformance'>
|
|
<p>In accordance with Section 8 of <cite>XEP-0166</cite>, this document specifies the following information related to the Jingle Audio via RTP application type:</p>
|
|
<ol>
|
|
<li><p>The content negotiation process is defined in the <link url='#negotiation'>Negotiating a Jingle Audio Session</link> section of this document.</p></li>
|
|
<li><p>The semantics of the &DESCRIPTION; element are defined in the <link url='#format'>Content Description 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 audio 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".</p></li>
|
|
<li>
|
|
<p>Content is to be sent and received as follows:</p>
|
|
<ul>
|
|
<li><p>For lossy transports, outbound audio 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 audio 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='Content Description Format' anchor='format'>
|
|
<p>A Jingle audio session is described by one or more encodings contained within a wrapper <description/> element. In the language of <cite>RFC 4566</cite> these encodings are payload-types; therefore, each <payload-type/> element specifies an encoding that can be used for the audio stream. In Jingle Audio, these 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>.</p>
|
|
<p>The allowable attributes are as follows:</p>
|
|
<table caption='Defined 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 audio 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>The encodings SHOULD be provided in order of preference.</p>
|
|
<example caption="Audio Description Format"><![CDATA[
|
|
<description xmlns='http://www.xmpp.org/extensions/xep-0167.html#ns'>
|
|
<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>
|
|
]]></example>
|
|
<p>The <description/> element is intended to be a child of a &JINGLE; element as specified in <cite>XEP-0166</cite>.</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 may 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>Note: The 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 Audio Session' anchor='negotiation'>
|
|
<p>When the initiator sends a session-initiate stanza to the receiver, the &DESCRIPTION; element includes all of the payload types that the initiator can receive for Jingle audio (each one encapsulated in a separate &PAYLOADTYPE; element):</p>
|
|
<example caption="Initiation Example"><![CDATA[
|
|
<iq from='romeo@montague.net/orchard'
|
|
to='juliet@capulet.com/balcony'
|
|
id='jingleaudio1'
|
|
type='set'>
|
|
<jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'>
|
|
action='session-initiate'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content name='this-is-the-audio-content' profile='RTP/AVP'>
|
|
<description xmlns='http://www.xmpp.org/extensions/xep-0167.html#ns'>
|
|
<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='http://www.xmpp.org/extensions/xep-0176.html#ns-udp'/>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>Upon receiving the session-initiate stanza, the receiver determines whether it can provisionally accept the session and proceed with the negotiation. The general Jingle error cases are specified in <cite>XEP-0166</cite>. In addition, the receiver must determine if it supports any of the payload types advertised by the initiator; if it does not, it MUST reject the session by sending a <unsupported-codecs/> error:</p>
|
|
<example caption="Receiver Does Not Support Codecs"><![CDATA[
|
|
<iq type='error'
|
|
from='juliet@capulet.com/balcony'
|
|
to='romeo@montague.net/orchard'
|
|
id='jingleaudio1'>
|
|
<error type='cancel'>
|
|
<not-acceptable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
|
|
<unsupported-codecs xmlns='http://www.xmpp.org/extensions/xep-0167.html#ns-errors'/>
|
|
</error>
|
|
</iq>
|
|
]]></example>
|
|
<p>If there is no error, the receiver provisionally accepts the session:</p>
|
|
<example caption="Receiver Provisionally Accepts Session"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
to='romeo@montague.net/orchard'
|
|
id='jingleaudio1'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>The receiver then should send a list of the payload types that it can receive via a Jingle "content-accept" (or "session-accept") action. The list that the receiver sends MAY include any payload types (not a subset of the payload types sent by the initiator) but SHOULD retain the ID numbers and order specified by the initiator.</p>
|
|
<example caption="Receiver Accepts Content Type"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
to='romeo@montague.net/orchard'
|
|
id='jingleaudio2'
|
|
type='set'>
|
|
<jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'>
|
|
action='content-accept'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content name='this-is-the-audio-content' profile='RTP/AVP'>
|
|
<description xmlns='http://www.xmpp.org/extensions/xep-0167.html#ns'>
|
|
<payload-type id='97' name='speex' clockrate='8000'/>
|
|
<payload-type id='18' name='G729'/>
|
|
<payload-type id='0' name='PCMU' />
|
|
<payload-type id='102' name='iLBC'/>
|
|
<payload-type id='4' name='G723'/>
|
|
<payload-type id='8' name='PCMA'/>
|
|
<payload-type id='13' name='CN'/>
|
|
</description>
|
|
<transport xmlns='http://www.xmpp.org/extensions/xep-0176.html#ns-udp'/>
|
|
</content>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<p>The initiator acknowledges the 'content-accept' with an empty IQ result:</p>
|
|
<example caption="Initiator Acknowledges Modified Content Description"><![CDATA[
|
|
<iq from='romeo@montegue.net/orchard'
|
|
to='juliet@capulet.com/balcony'
|
|
id='jingleaudio2'
|
|
type='result'/>
|
|
]]></example>
|
|
<p>After successful transport negotiation (not shown here), the receiver then accepts the session:</p>
|
|
<example caption="Receiver Definitively Accepts the Session"><![CDATA[
|
|
<iq type='set' from='juliet@capulet.com/balcony' to='romeo@montague.net/orchard' id='accept1'>
|
|
<jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
|
|
action='session-accept'
|
|
initiator='romeo@montague.net/orchard'
|
|
responder='juliet@capulet.com/balcony'
|
|
sid='a73sjjvkla37jfea'>
|
|
<content creator='initiator' name='this-is-the-audio-content' profile='RTP/AVP'>
|
|
<description xmlns='http://www.xmpp.org/extensions/xep-0167.html#ns'/>
|
|
<transport xmlns='http://www.xmpp.org/extensions/xep-0176.html#ns-udp'>
|
|
<candidate component='2'
|
|
foundation='1'
|
|
generation='0'
|
|
ip='192.0.2.3'
|
|
network='1'
|
|
port='45664'
|
|
priority='1107821052'
|
|
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'
|
|
to='juliet@capulet.com/balcony'
|
|
id='accept1'
|
|
type='result'/>
|
|
]]></example>
|
|
</section1>
|
|
<section1 topic='Mapping to Session Description Protocol' anchor='sdp'>
|
|
<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", the <port> is the preferred port for such communications (which may be determined dynamically), the <transport> is whatever transport method is negotiated via the Jingle negotiation (e.g., "RTP/AVT"), and the <fmt list> is the payload-type ID.</p>
|
|
<p>For example, consider the following static payload-type:</p>
|
|
<example caption="Jingle Format for Static Payload-Type"><![CDATA[
|
|
<payload-type id="13" name="CN"/>
|
|
]]></example>
|
|
<example caption="SDP Mapping of Static Payload-Type"><![CDATA[
|
|
m=audio 9999 RTP/AVP 13
|
|
]]></example>
|
|
<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>
|
|
<example caption="Jingle Format for Dynamic Payload-Type"><![CDATA[
|
|
<payload-type id='96' name='speex' clockrate='16000'/>
|
|
]]></example>
|
|
<example caption="SDP Mapping of Dynamic Payload-Type"><![CDATA[
|
|
m=audio 9999 RTP/AVP 96
|
|
a=rtpmap:96 speex/16000
|
|
]]></example>
|
|
<p>As noted, if additional parameters are to be specified, they shall be represented as attributes of the <payload-type/> element of the child <parameter/> element, as in the following example.</p>
|
|
<example caption="Jingle Format for Dynamic Payload-Type With Parameters"><![CDATA[
|
|
<payload-type id='96' name='speex' clockrate='16000' ptime='40'>
|
|
<parameter name='vbr' value='on'/>
|
|
<parameter name='cng' value='on'/>
|
|
</payload-type>
|
|
]]></example>
|
|
<example caption="SDP Mapping of Dynamic Payload-Type With Parameters"><![CDATA[
|
|
m=audio 9999 RTP/AVP 96
|
|
a=rtpmap:96 speex/16000
|
|
a=ptime:40
|
|
a=fmtp:96 vbr=on;cng=on
|
|
]]></example>
|
|
</section1>
|
|
<section1 topic='Informational Messages' anchor='info'>
|
|
<section2 topic='Format' anchor='info-format'>
|
|
<p>Informational messages may be sent by either party within the context of Jingle to communicate the status of a Jingle audio 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 'http://www.xmpp.org/extensions/xep-0167.html#ns-info' 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><busy/></td>
|
|
<td>The principal or device is currently unavailable for a session because busy with another (audio or other) session.</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 audio output but continues to accept audio input.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><ringing/></td>
|
|
<td>The device is ringing but the principal has not yet interacted with it to answer (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="Receiver Sends Busy Message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
to='romeo@montague.net/orchard'
|
|
id='busy1'
|
|
type='set'>
|
|
<jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'>
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<busy xmlns='http://www.xmpp.org/extensions/xep-0167.html#ns-info'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Receiver Sends Hold Message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
to='romeo@montague.net/orchard'
|
|
id='hold1'
|
|
type='set'>
|
|
<jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<hold xmlns='http://www.xmpp.org/extensions/xep-0167.html#ns-info'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Receiver Sends Mute Message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
to='romeo@montague.net/orchard'
|
|
id='mute1'
|
|
type='set'>
|
|
<jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<mute xmlns='http://www.xmpp.org/extensions/xep-0167.html#ns-info'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
<example caption="Receiver Sends Ringing Message"><![CDATA[
|
|
<iq from='juliet@capulet.com/balcony'
|
|
to='romeo@montague.net/orchard'
|
|
id='ringing1'
|
|
type='set'>
|
|
<jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
|
|
action='session-info'
|
|
initiator='romeo@montague.net/orchard'
|
|
sid='a73sjjvkla37jfea'>
|
|
<ringing xmlns='http://www.xmpp.org/extensions/xep-0167.html#ns-info'/>
|
|
</jingle>
|
|
</iq>
|
|
]]></example>
|
|
</section2>
|
|
</section1>
|
|
|
|
<section1 topic='Error Handling' anchor='errors'>
|
|
<p>The Jingle Audio-specific error conditions are as follows:</p>
|
|
<table caption='Other Error Conditions'>
|
|
<tr>
|
|
<th>Jingle Condition</th>
|
|
<th>XMPP Condition</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><unsupported-codecs/></td>
|
|
<td>¬acceptable;</td>
|
|
<td>The recipient does not support any of the offered audio encodings.</td>
|
|
</tr>
|
|
</table>
|
|
</section1>
|
|
|
|
<section1 topic='Determining Support' anchor='support'>
|
|
<p>If an entity supports Jingle audio exchanges via RTP, it MUST advertise that fact by returning a feature of "http://www.xmpp.org/extensions/xep-0167.html#ns" &NSNOTE; 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='http://www.xmpp.org/extensions/xep-0166.html#ns'/>
|
|
<feature var='http://www.xmpp.org/extensions/xep-0167.html#ns'/>
|
|
...
|
|
</query>
|
|
</iq>
|
|
]]></example>
|
|
</section1>
|
|
|
|
<section1 topic='Implementation Notes' anchor='impl'>
|
|
<section2 topic='Codecs' anchor='impl-codecs'>
|
|
<p>Support for the Speex codec is RECOMMENDED.</p>
|
|
</section2>
|
|
<section2 topic='DTMF' anchor='impl-dtmf'>
|
|
<p>If it is necessary to send Dual Tone Multi-Frequency (DTMF) tones, it is REQUIRED to use the XML format specified &xep0181;.</p>
|
|
</section2>
|
|
<section2 topic='When to Listen' anchor='impl-listen'>
|
|
<p>When the Jingle Audio content is accepted via a 'content-accept' action, both initiator and responder SHOULD start listening for audio as defined by the negotiated transport method and audio description. For interoperability with telephony systems, each entity SHOULD both play any audio received and send a ringing tone at this time (i.e., before the receiver sends a 'session-accept' action).</p>
|
|
</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; for example, in the case of UDP, that would include Datagram Transport Layer Security (DTLS) as specified in &rfc4347;. &sdpdtls; defines such methods for the Session Description Protocol; the relevant RTP profile (e.g., "UDP/TLS/RTP/AVP" for transporting the RTP stream over DTLS with UDP) shall be specified as the value of the &CONTENT; element's 'profile' attribute.</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='ns'>
|
|
<p>Until this specification advances to a status of Draft, its associated namespaces shall be "http://www.xmpp.org/extensions/xep-0167.html#ns" and "http://www.xmpp.org/extensions/xep-0167.html#ns-info"; upon advancement of this specification, the ®ISTRAR; shall issue permanent namespaces in accordance with the process defined in Section 4 of &xep0053;.</p>
|
|
</section2>
|
|
<section2 topic='Jingle Content Description Formats' anchor='registrar-content'>
|
|
<p>The XMPP Registrar shall include "audio-rtp" in its registry of Jingle content description formats. The registry submission is as follows:</p>
|
|
<code><![CDATA[
|
|
<content>
|
|
<name>audio-rtp</name>
|
|
<desc>Jingle sessions that support audio exchange via the Real-time Transport Protocol</desc>
|
|
<transport>lossy</transport>
|
|
<doc>XEP-0167</doc>
|
|
</content>
|
|
]]></code>
|
|
</section2>
|
|
</section1>
|
|
|
|
<section1 topic='XML Schemas' anchor='schema'>
|
|
<section2 topic='Content Description Format' anchor='schema-content'>
|
|
<code><![CDATA[
|
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
|
|
<xs:schema
|
|
xmlns:xs='http://www.w3.org/2001/XMLSchema'
|
|
targetNamespace='http://www.xmpp.org/extensions/xep-0167.html#ns'
|
|
xmlns='http://www.xmpp.org/extensions/xep-0167.html#ns'
|
|
elementFormDefault='qualified'>
|
|
|
|
<xs:element name='description'>
|
|
<xs:complexType>
|
|
<xs:sequence minOccurs='0' maxOccurs='unbounded'/>
|
|
<xs:element ref='payload-type'/>
|
|
</xs:sequence>
|
|
</xs:complexType>
|
|
</xs:element>
|
|
|
|
<xs:element name='payload-type'>
|
|
<xs:complexType>
|
|
<xs:sequence minOccurs='0' maxOccurs='unbounded'> <xs:element ref='parameter'/>
|
|
</xs:choice>
|
|
<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:element>
|
|
|
|
<xs:element name='parameter'>
|
|
<xs:complexType>
|
|
<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:element>
|
|
|
|
<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='http://www.xmpp.org/extensions/xep-0167.html#ns-errors'
|
|
xmlns='http://www.xmpp.org/extensions/xep-0167.html#ns-errors'
|
|
elementFormDefault='qualified'>
|
|
|
|
<xs:element name='unsupported-codecs' 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='http://www.xmpp.org/extensions/xep-0167.html#ns-info'
|
|
xmlns='http://www.xmpp.org/extensions/xep-0167.html#ns-info'
|
|
elementFormDefault='qualified'>
|
|
|
|
<xs:element name='busy' type='empty'/>
|
|
<xs:element name='hold' type='empty'/>
|
|
<xs:element name='mute' type='empty'/>
|
|
<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>
|
|
</xep>
|