git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@1895 4b5297f7-1745-476d-ba37-a9c6900126ab
This commit is contained in:
Peter Saint-Andre 2008-05-30 16:11:40 +00:00
parent 15052ed57d
commit 145d61d306
1 changed files with 37 additions and 16 deletions

View File

@ -20,9 +20,15 @@
</dependencies>
<supersedes/>
<supersededby/>
<shortname>TO-BE-ASSIGNED</shortname>
<shortname>NOT_YET_ASSIGNED</shortname>
&stpeter;
&seanegan;
<revision>
<version>0.10</version>
<date>2008-05-30</date>
<initials>psa</initials>
<remark><p>Simplified syntax by removing button-down and button-up actions (all actions are assumed to be button-down) and setting 100ms default value for duration.</p></remark>
</revision>
<revision>
<version>0.9</version>
<date>2008-04-18</date>
@ -92,16 +98,39 @@
<p>The format for the representation of DTMF events in XMPP is as follows &NSNOTE;:</p>
<example caption="Basic DTMF Format"><![CDATA[
<dtmf xmlns='urn:xmpp:tmp:jingle:dtmf'
action='[button-down|button-up]'
code='0-9,#,*,A-D'
duration='milliseconds'
volume='0-63'/>
]]></example>
<p>The &lt;dtmf/&gt; element SHOULD possess an 'action' attribute, the value of which MUST be either "button-up" or "button-down" (specifying whether the button is being depressed or released). This enables DTMF tones to be reconstructed in real time. If the 'action' attribute is not included, the recipient MUST assume that the action is a "button-down" event.</p>
<p>Unless the 'action' attribute has a value of "button-up", the &lt;dmtf/&gt; element MUST possess a 'code' attribute that specifies the tone to be generated. The value of the 'code' attribute SHOULD be one the following characters: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, #, and * (however, the characters A, B, C, and D MAY be sent as well <note>Although A, B, C, and D were originally defined as part of DTMF, they were never deployed to telephony consumers and were used only for control purposes at private branch exchanges (PBXs) and central office operator stations; however, they are used in certain non-telephony applications of DTMF, such as ham radio.</note>).</p>
<p>The OPTIONAL 'duration' attribute specifies indicates the duration of the event, in milliseconds, expressed as an unsigned integer. The receiver SHOULD ignore the event if the 'duration' value is zero. If the 'duration' attribute is not included and the event is explicitly or implicitly a "button-down" event, the recipient MUST assume that the event expires after a reasonable timeout (100 milliseconds is RECOMMENDED) or when a "button-up" event is received, whichever comes first.</p>
<p>The OPTIONAL 'volume' attribute specifies the power level of the tone, expressed in dBm0 after dropping the sign. Power levels range from 0 to -63 dBm0. Thus, larger values denote lower volume.</p>
<p>The &lt;dtmf&gt; element SHOULD be sent as the payload of a Jingle session-info message as illustrated in the following example &NSNOTE;.</p>
<p>The &lt;dmtf/&gt; element MUST be empty.</p>
<p>The attributes of the &lt;dmtf/&gt; element are as follows.</p>
<table caption='Defined Attributes'>
<tr>
<th>Attribute</th>
<th>Definition</th>
<th>Example</th>
<th>Inclusion</th>
</tr>
<tr>
<td>code</td>
<td>The tone to be generated. The value of the 'code' attribute SHOULD be one the following characters: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, #, and * (however, the characters A, B, C, and D MAY be sent as well <note>Although A, B, C, and D were originally defined as part of DTMF, they were never deployed to telephony consumers and were used only for control purposes at private branch exchanges (PBXs) and central office operator stations; however, they are used in certain non-telephony applications of DTMF, such as ham radio.</note>).</td>
<td>6</td>
<td>REQUIRED</td>
</tr>
<tr>
<td>duration</td>
<td>The duration of the event, in milliseconds, expressed as a non-negative integer. The receiver SHOULD ignore the event if the value is zero. The default value is 100 (i.e., 100ms).</td>
<td>400</td>
<td>RECOMMENDED</td>
</tr>
<tr>
<td>volume</td>
<td>The power level of the tone, expressed in dBm0 after dropping the sign. Power levels range from 0 to -63 dBm0. Thus, a larger value denotes a lower volume.</td>
<td>37</td>
<td>OPTIONAL</td>
</tr>
</table>
<p>The &lt;dtmf&gt; element SHOULD be sent as the payload of a Jingle session-info message as illustrated in the following example.</p>
<example caption="Entity Sends DTMF Message"><![CDATA[
<iq from='juliet@capulet.com/balcony'
id='dtmf1'
@ -193,16 +222,8 @@
<xs:complexType>
<xs:simpleContent>
<xs:extension base='empty'>
<xs:attribute name='action' use='optional' default='button-down'>
<xs:simpleType>
<xs:restriction base='xs:NCName'>
<xs:enumeration value='button-down'/>
<xs:enumeration value='button-up'/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name='code' type='DTMFString' use='required'/>
<xs:attribute name='duration' type='xs:nonNegativeInteger' use='optional'/>
<xs:attribute name='duration' type='xs:nonNegativeInteger' use='optional' default='100'/>
<xs:attribute name='volume' type='VolumeDigit' use='optional'/>
</xs:extension>
</xs:simpleContent>