add an enumeration for the DTMF event codestelepathy-spec-0.15.1

20070413014711-0e791-c7cce225ec58267a8895d0378aeaacbf9c0111b3.gz

1 files changed, 60 insertions, 18 deletions

diff --git a/spec/Channel_Interface_DTMF.xml b/spec/Channel_Interface_DTMF.xml
index bda268fb..e393ab1b 100644
--- a/spec/Channel_Interface_DTMF.xml
+++ b/spec/Channel_Interface_DTMF.xml
@@ -25,24 +25,14 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</p>
         <tp:docstring>A stream ID as defined in the StreamedMedia channel type.</tp:docstring>
       </arg>
       <arg direction="in" name="event" type="u">
-        <tp:docstring>A numeric event code.</tp:docstring>
+        <tp:docstring>A numeric event code from the DTMF_Event enum.</tp:docstring>
       </arg>
-      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
-        <p>Start sending a DTMF tone on this stream. Where possible, the tone
+      <tp:docstring>
+        Start sending a DTMF tone on this stream. Where possible, the tone
         will continue until StopTone is called. On certain protocols, it may
         only be possible to send events with a predetermined length. In this
         case, the implementation may emit a fixed-length tone, and the StopTone
-        method call should return NotAvailable.</p>
-
-        <p>In common with <a href="http://www.rfc-editor.org/rfc/rfc4733.txt">
-        RFC4733</a>, the event codes are defined as follows:</p>
-        <table>
-          <tr><th>Event</th><th>Code</th></tr>
-          <tr><td>0 - 9</td><td>0 - 9</td></tr>
-          <tr><td>*</td><td>10</td></tr>
-          <tr><td>#</td><td>11</td></tr>
-          <tr><td>A - D</td><td>12 - 15</td></tr>
-        </table>
+        method call should return NotAvailable.
       </tp:docstring>
       <tp:possible-errors>
         <tp:error name="org.freedesktop.Telepathy.Error.NetworkError" />
@@ -80,10 +70,62 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</p>
         </tp:error>
       </tp:possible-errors>
     </method>
-    <tp:docstring>
-      An interface that gives a Channel the ability to send DTMF signalling tones
-      over audio streams which have been established using the StreamedMedia
-      channel type.
+    <tp:enum name="DTMF_Event" type="u">
+      <tp:enumvalue suffix="Digit_0" value="0">
+        <tp:docstring>0</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Digit_1" value="1">
+        <tp:docstring>1</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Digit_2" value="2">
+        <tp:docstring>2</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Digit_3" value="3">
+        <tp:docstring>3</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Digit_4" value="4">
+        <tp:docstring>4</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Digit_5" value="5">
+        <tp:docstring>5</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Digit_6" value="6">
+        <tp:docstring>6</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Digit_7" value="7">
+        <tp:docstring>7</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Digit_8" value="8">
+        <tp:docstring>8</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Digit_9" value="9">
+        <tp:docstring>9</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Asterisk" value="10">
+        <tp:docstring>*</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Hash" value="11">
+        <tp:docstring>#</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Letter_A" value="12">
+        <tp:docstring>A</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Letter_B" value="13">
+        <tp:docstring>B</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Letter_C" value="14">
+        <tp:docstring>C</tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="Letter_D" value="15">
+        <tp:docstring>D</tp:docstring>
+      </tp:enumvalue>
+    </tp:enum>
+    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+      An interface that gives a Channel the ability to send DTMF events over
+      audio streams which have been established using the StreamedMedia channel
+      type. The event codes used are in common with those defined in <a
+      href="http://www.rfc-editor.org/rfc/rfc4733.txt">RFC4733</a>, and are
+      listed in the DTMF_Event enumeration.
     </tp:docstring>
   </interface>
 </node>