Deployed 3d65851 to R5.3 with MkDocs 1.6.1 and mike 2.1.3

Author: volkan-aslan

R5.3/api/AudioStreamAPI/index.html

@@ -3447,7 +3447,7 @@ <h4 id="response">Response</h4>
 <h2 id="register-method"><em>register <a href="#head_Methods"><sup>method</sup></a></em></h2>
 <p>Registers for an asynchronous JSON-RPC notification.</p>
 <h3 id="description_2">Description</h3>
-<p>This method supports the following event names: <em><a href="#notification_audioframe">audioframe</a>, <a href="#notification_audiotransmission">audiotransmission</a></em>.</p>
+<p>This method supports the following event names: <em><a href="#notification_audiotransmission">audiotransmission</a>, <a href="#notification_audioframe">audioframe</a></em>.</p>
 <h3 id="parameters_1">Parameters</h3>
 <table>
 <thead>
@@ -3536,7 +3536,7 @@ <h4 id="response_1">Response</h4>
 <h2 id="unregister-method"><em>unregister <a href="#head_Methods"><sup>method</sup></a></em></h2>
 <p>Unregisters from an asynchronous JSON-RPC notification.</p>
 <h3 id="description_3">Description</h3>
-<p>This method supports the following event names: <em><a href="#notification_audioframe">audioframe</a>, <a href="#notification_audiotransmission">audiotransmission</a></em>.</p>
+<p>This method supports the following event names: <em><a href="#notification_audiotransmission">audiotransmission</a>, <a href="#notification_audioframe">audioframe</a></em>.</p>
 <h3 id="parameters_2">Parameters</h3>
 <table>
 <thead>
@@ -4185,18 +4185,21 @@ <h1 id="notifications">Notifications</h1>
 </thead>
 <tbody>
 <tr>
-<td style="text-align: left;"><a href="#notification_audioframe">audioframe</a></td>
-<td style="text-align: left;">Provides audio data</td>
-</tr>
-<tr>
 <td style="text-align: left;"><a href="#notification_audiotransmission">audiotransmission</a></td>
 <td style="text-align: left;">Signals state of the stream</td>
 </tr>
+<tr>
+<td style="text-align: left;"><a href="#notification_audioframe">audioframe</a></td>
+<td style="text-align: left;">Provides audio data</td>
+</tr>
 </tbody>
 </table>
-<p><a id="notification_audioframe"></a></p>
-<h2 id="audioframe-notification"><em>audioframe <a href="#head_Notifications"><sup>notification</sup></a></em></h2>
-<p>Provides audio data.</p>
+<p><a id="notification_audiotransmission"></a></p>
+<h2 id="audiotransmission-notification"><em>audiotransmission <a href="#head_Notifications"><sup>notification</sup></a></em></h2>
+<p>Signals state of the stream.</p>
+<blockquote>
+<p>This notification may also be triggered by client registration.</p>
+</blockquote>
 <h3 id="notification-parameters">Notification Parameters</h3>
 <table>
 <thead>
@@ -4215,28 +4218,52 @@ <h3 id="notification-parameters">Notification Parameters</h3>
 <td style="text-align: left;"><em>...</em></td>
 </tr>
 <tr>
-<td style="text-align: left;">params?.seq</td>
-<td style="text-align: left;">integer</td>
+<td style="text-align: left;">params.state</td>
+<td style="text-align: left;">string</td>
+<td style="text-align: left;">mandatory</td>
+<td style="text-align: left;">New state of the stream (must be one of the following: <em>Idle, Started, Unavailable</em>)</td>
+</tr>
+<tr>
+<td style="text-align: left;">params?.profile</td>
+<td style="text-align: left;">object</td>
 <td style="text-align: left;">optional</td>
-<td style="text-align: left;">Frame number in current transmission</td>
+<td style="text-align: left;">Details on the format used in the stream</td>
 </tr>
 <tr>
-<td style="text-align: left;">params?.timestamp</td>
-<td style="text-align: left;">integer</td>
+<td style="text-align: left;">params?.profile.codec</td>
+<td style="text-align: left;">string</td>
+<td style="text-align: left;">mandatory</td>
+<td style="text-align: left;">Compression method (PCM: uncompressed) (must be one of the following: <em>IMA-ADPCM, PCM</em>)</td>
+</tr>
+<tr>
+<td style="text-align: left;">params?.profile?.codecparams</td>
+<td style="text-align: left;">opaque object</td>
 <td style="text-align: left;">optional</td>
-<td style="text-align: left;">Timestamp of the frame</td>
+<td style="text-align: left;">Additional parameters for codec</td>
 </tr>
 <tr>
-<td style="text-align: left;">params.length</td>
+<td style="text-align: left;">params?.profile.channels</td>
 <td style="text-align: left;">integer</td>
 <td style="text-align: left;">mandatory</td>
-<td style="text-align: left;">Size of the raw data frame in bytes</td>
+<td style="text-align: left;">Number of audio channels</td>
 </tr>
 <tr>
-<td style="text-align: left;">params.data</td>
-<td style="text-align: left;">string (base64)</td>
+<td style="text-align: left;">params?.profile.resolution</td>
+<td style="text-align: left;">integer</td>
 <td style="text-align: left;">mandatory</td>
-<td style="text-align: left;">Raw audio data, the format of the data is specified in the most recent <em>audiotransmission</em> notification</td>
+<td style="text-align: left;">Sample resultion in bits</td>
+</tr>
+<tr>
+<td style="text-align: left;">params?.profile.samplerate</td>
+<td style="text-align: left;">integer</td>
+<td style="text-align: left;">mandatory</td>
+<td style="text-align: left;">Sample rate in hertz</td>
+</tr>
+<tr>
+<td style="text-align: left;">params?.profile?.bitrate</td>
+<td style="text-align: left;">integer</td>
+<td style="text-align: left;">optional</td>
+<td style="text-align: left;">Data rate of the compressed stream in bits per second</td>
 </tr>
 </tbody>
 </table>
@@ -4247,32 +4274,34 @@ <h4 id="registration">Registration</h4>
   &quot;id&quot;: 42,
   &quot;method&quot;: &quot;&lt;callsign&gt;.1.register&quot;,
   &quot;params&quot;: {
-    &quot;event&quot;: &quot;audioframe&quot;,
+    &quot;event&quot;: &quot;audiotransmission&quot;,
     &quot;id&quot;: &quot;myid&quot;
   }
 }
 </code></pre>
 <h4 id="notification">Notification</h4>
 <pre><code class="language-json">{
   &quot;jsonrpc&quot;: &quot;2.0&quot;,
-  &quot;method&quot;: &quot;myid.audioframe&quot;,
+  &quot;method&quot;: &quot;myid.audiotransmission&quot;,
   &quot;params&quot;: {
-    &quot;seq&quot;: 1,
-    &quot;timestamp&quot;: 0,
-    &quot;length&quot;: 400,
-    &quot;data&quot;: &quot;...&quot;
+    &quot;state&quot;: &quot;Idle&quot;,
+    &quot;profile&quot;: {
+      &quot;codec&quot;: &quot;IMA-ADPCM&quot;,
+      &quot;codecparams&quot;: {},
+      &quot;channels&quot;: 1,
+      &quot;resolution&quot;: 16,
+      &quot;samplerate&quot;: 16000,
+      &quot;bitrate&quot;: 64000
+    }
   }
 }
 </code></pre>
 <blockquote>
-<p>The <em>client ID</em> parameter is passed within the notification designator, i.e. <code>&lt;client-id&gt;.audioframe</code>.</p>
-</blockquote>
-<p><a id="notification_audiotransmission"></a></p>
-<h2 id="audiotransmission-notification"><em>audiotransmission <a href="#head_Notifications"><sup>notification</sup></a></em></h2>
-<p>Signals state of the stream.</p>
-<blockquote>
-<p>This notification may also be triggered by client registration.</p>
+<p>The <em>client ID</em> parameter is passed within the notification designator, i.e. <code>&lt;client-id&gt;.audiotransmission</code>.</p>
 </blockquote>
+<p><a id="notification_audioframe"></a></p>
+<h2 id="audioframe-notification"><em>audioframe <a href="#head_Notifications"><sup>notification</sup></a></em></h2>
+<p>Provides audio data.</p>
 <h3 id="notification-parameters_1">Notification Parameters</h3>
 <table>
 <thead>
@@ -4291,52 +4320,28 @@ <h3 id="notification-parameters_1">Notification Parameters</h3>
 <td style="text-align: left;"><em>...</em></td>
 </tr>
 <tr>
-<td style="text-align: left;">params.state</td>
-<td style="text-align: left;">string</td>
-<td style="text-align: left;">mandatory</td>
-<td style="text-align: left;">New state of the stream (must be one of the following: <em>Idle, Started, Unavailable</em>)</td>
-</tr>
-<tr>
-<td style="text-align: left;">params?.profile</td>
-<td style="text-align: left;">object</td>
-<td style="text-align: left;">optional</td>
-<td style="text-align: left;">Details on the format used in the stream</td>
-</tr>
-<tr>
-<td style="text-align: left;">params?.profile.codec</td>
-<td style="text-align: left;">string</td>
-<td style="text-align: left;">mandatory</td>
-<td style="text-align: left;">Compression method (PCM: uncompressed) (must be one of the following: <em>IMA-ADPCM, PCM</em>)</td>
-</tr>
-<tr>
-<td style="text-align: left;">params?.profile?.codecparams</td>
-<td style="text-align: left;">opaque object</td>
+<td style="text-align: left;">params?.seq</td>
+<td style="text-align: left;">integer</td>
 <td style="text-align: left;">optional</td>
-<td style="text-align: left;">Additional parameters for codec</td>
+<td style="text-align: left;">Frame number in current transmission</td>
 </tr>
 <tr>
-<td style="text-align: left;">params?.profile.channels</td>
+<td style="text-align: left;">params?.timestamp</td>
 <td style="text-align: left;">integer</td>
-<td style="text-align: left;">mandatory</td>
-<td style="text-align: left;">Number of audio channels</td>
+<td style="text-align: left;">optional</td>
+<td style="text-align: left;">Timestamp of the frame</td>
 </tr>
 <tr>
-<td style="text-align: left;">params?.profile.resolution</td>
+<td style="text-align: left;">params.length</td>
 <td style="text-align: left;">integer</td>
 <td style="text-align: left;">mandatory</td>
-<td style="text-align: left;">Sample resultion in bits</td>
+<td style="text-align: left;">Size of the raw data frame in bytes</td>
 </tr>
 <tr>
-<td style="text-align: left;">params?.profile.samplerate</td>
-<td style="text-align: left;">integer</td>
+<td style="text-align: left;">params.data</td>
+<td style="text-align: left;">string (base64)</td>
 <td style="text-align: left;">mandatory</td>
-<td style="text-align: left;">Sample rate in hertz</td>
-</tr>
-<tr>
-<td style="text-align: left;">params?.profile?.bitrate</td>
-<td style="text-align: left;">integer</td>
-<td style="text-align: left;">optional</td>
-<td style="text-align: left;">Data rate of the compressed stream in bits per second</td>
+<td style="text-align: left;">Raw audio data, the format of the data is specified in the most recent <em>audiotransmission</em> notification</td>
 </tr>
 </tbody>
 </table>
@@ -4347,30 +4352,25 @@ <h4 id="registration_1">Registration</h4>
   &quot;id&quot;: 42,
   &quot;method&quot;: &quot;&lt;callsign&gt;.1.register&quot;,
   &quot;params&quot;: {
-    &quot;event&quot;: &quot;audiotransmission&quot;,
+    &quot;event&quot;: &quot;audioframe&quot;,
     &quot;id&quot;: &quot;myid&quot;
   }
 }
 </code></pre>
 <h4 id="notification_1">Notification</h4>
 <pre><code class="language-json">{
   &quot;jsonrpc&quot;: &quot;2.0&quot;,
-  &quot;method&quot;: &quot;myid.audiotransmission&quot;,
+  &quot;method&quot;: &quot;myid.audioframe&quot;,
   &quot;params&quot;: {
-    &quot;state&quot;: &quot;Idle&quot;,
-    &quot;profile&quot;: {
-      &quot;codec&quot;: &quot;IMA-ADPCM&quot;,
-      &quot;codecparams&quot;: {},
-      &quot;channels&quot;: 1,
-      &quot;resolution&quot;: 16,
-      &quot;samplerate&quot;: 16000,
-      &quot;bitrate&quot;: 64000
-    }
+    &quot;seq&quot;: 1,
+    &quot;timestamp&quot;: 0,
+    &quot;length&quot;: 400,
+    &quot;data&quot;: &quot;...&quot;
   }
 }
 </code></pre>
 <blockquote>
-<p>The <em>client ID</em> parameter is passed within the notification designator, i.e. <code>&lt;client-id&gt;.audiotransmission</code>.</p>
+<p>The <em>client ID</em> parameter is passed within the notification designator, i.e. <code>&lt;client-id&gt;.audioframe</code>.</p>
 </blockquote>