Skip to content

Commit

Permalink
Apidocs regenerated
Browse files Browse the repository at this point in the history
  • Loading branch information
@britov
britov committed Mar 25, 2021
1 parent 2a718a1 commit 5f8938f
Show file tree
Hide file tree
Showing 16 changed files with 56 additions and 24 deletions.
2 changes: 1 addition & 1 deletion doc/api/__404error.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ <h1>404: Something's gone wrong :-(</h1>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h2>Libraries</h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
18 changes: 9 additions & 9 deletions doc/api/medcorder_audio/MedcorderAudio-class.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ <h2>Methods</h2>
</span>
</dt>
<dd>

iOS only. close PlayAndRecord audio session

</dd>
<dt id="checkMicrophonePermissions" class="callable">
Expand All @@ -133,7 +133,7 @@ <h2>Methods</h2>
</span>
</dt>
<dd>

Check if you have recording audio permissions

</dd>
<dt id="noSuchMethod" class="callable inherited">
Expand All @@ -151,7 +151,7 @@ <h2>Methods</h2>
</span>
</dt>
<dd>

iOS only. open PlayAndRecord audio session

</dd>
<dt id="setCallBack" class="callable">
Expand All @@ -160,7 +160,7 @@ <h2>Methods</h2>
</span>
</dt>
<dd>
Callback function <a href="../medcorder_audio/MedcorderAudio/setCallBack.html">[...]</a>

</dd>
<dt id="startPlay" class="callable">
Expand All @@ -169,7 +169,7 @@ <h2>Methods</h2>
</span>
</dt>
<dd>

Start audio playing for file with position

</dd>
<dt id="startRecord" class="callable">
Expand All @@ -178,7 +178,7 @@ <h2>Methods</h2>
</span>
</dt>
<dd>

Start record audio file to app documents path

</dd>
<dt id="stopPlay" class="callable">
Expand All @@ -187,7 +187,7 @@ <h2>Methods</h2>
</span>
</dt>
<dd>

Stop audio playing

</dd>
<dt id="stopRecord" class="callable">
Expand All @@ -196,7 +196,7 @@ <h2>Methods</h2>
</span>
</dt>
<dd>

Stop audio recording process

</dd>
<dt id="toString" class="callable inherited">
Expand Down Expand Up @@ -303,7 +303,7 @@ <h2>Constants</h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/medcorder_audio/MedcorderAudio/MedcorderAudio.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h2><span>Implementation</span></h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
5 changes: 4 additions & 1 deletion doc/api/medcorder_audio/MedcorderAudio/backAudioSettings.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,9 @@ <h5>MedcorderAudio class</h5>
(<wbr>)

</section>
<section class="desc markdown">
<p>iOS only. close PlayAndRecord audio session</p>
</section>

<section class="summary source-code" id="source">
<h2><span>Implementation</span></h2>
Expand All @@ -125,7 +128,7 @@ <h2><span>Implementation</span></h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/medcorder_audio/MedcorderAudio/callback.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h2><span>Implementation</span></h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
5 changes: 4 additions & 1 deletion doc/api/medcorder_audio/MedcorderAudio/checkMicrophonePermissions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,9 @@ <h5>MedcorderAudio class</h5>
(<wbr>)

</section>
<section class="desc markdown">
<p>Check if you have recording audio permissions</p>
</section>

<section class="summary source-code" id="source">
<h2><span>Implementation</span></h2>
Expand All @@ -126,7 +129,7 @@ <h2><span>Implementation</span></h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/medcorder_audio/MedcorderAudio/eventChannel-constant.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ <h2><span>Implementation</span></h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/medcorder_audio/MedcorderAudio/platform-constant.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h2><span>Implementation</span></h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
5 changes: 4 additions & 1 deletion doc/api/medcorder_audio/MedcorderAudio/setAudioSettings.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,9 @@ <h5>MedcorderAudio class</h5>
(<wbr>)

</section>
<section class="desc markdown">
<p>iOS only. open PlayAndRecord audio session</p>
</section>

<section class="summary source-code" id="source">
<h2><span>Implementation</span></h2>
Expand All @@ -125,7 +128,7 @@ <h2><span>Implementation</span></h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
13 changes: 12 additions & 1 deletion doc/api/medcorder_audio/MedcorderAudio/setCallBack.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,17 @@ <h5>MedcorderAudio class</h5>
</ol>)

</section>
<section class="desc markdown">
<p>Callback function</p>
<pre class="language-dart"><code class="language-dart"> void Function(dynamic event)
</code></pre>
<p>Event has <code>code</code> field for get event code</p>
<h2 id="available-events">Available events:</h2>
<h3 id="recording-events">recording events</h3>
<table><thead><tr><th>Key</th><th style="text-align: center;">Type</th><th style="text-align: right;">Description</th></tr></thead><tbody><tr><td>'code'</td><td style="text-align: center;">String</td><td style="text-align: right;">'recording',</td></tr><tr><td>'url'</td><td style="text-align: center;">String</td><td style="text-align: right;">recording file url</td></tr><tr><td>'peakPowerForChannel'</td><td style="text-align: center;">double</td><td style="text-align: right;">peak power for channel</td></tr><tr><td>'currentTime'</td><td style="text-align: center;">double</td><td style="text-align: right;">recording time in seconds</td></tr></tbody></table>
<h3 id="playing-events">playing events</h3>
<table><thead><tr><th>Key</th><th style="text-align: center;">Type</th><th style="text-align: right;">Description</th></tr></thead><tbody><tr><td>'code'</td><td style="text-align: center;">String</td><td style="text-align: right;">'playing', 'audioPlayerDidFinishPlaying'</td></tr><tr><td>'url'</td><td style="text-align: center;">String</td><td style="text-align: right;">playing file url</td></tr><tr><td>'currentTime'</td><td style="text-align: center;">double</td><td style="text-align: right;">playing time in seconds</td></tr><tr><td>'duration'</td><td style="text-align: center;">double</td><td style="text-align: right;">playing file duration</td></tr></tbody></table>
</section>

<section class="summary source-code" id="source">
<h2><span>Implementation</span></h2>
Expand All @@ -119,7 +130,7 @@ <h2><span>Implementation</span></h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
5 changes: 4 additions & 1 deletion doc/api/medcorder_audio/MedcorderAudio/startPlay.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ <h5>MedcorderAudio class</h5>
</ol>)

</section>
<section class="desc markdown">
<p>Start audio playing for file with position</p>
</section>

<section class="summary source-code" id="source">
<h2><span>Implementation</span></h2>
Expand All @@ -126,7 +129,7 @@ <h2><span>Implementation</span></h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
5 changes: 4 additions & 1 deletion doc/api/medcorder_audio/MedcorderAudio/startRecord.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ <h5>MedcorderAudio class</h5>
</ol>)

</section>
<section class="desc markdown">
<p>Start record audio file to app documents path</p>
</section>

<section class="summary source-code" id="source">
<h2><span>Implementation</span></h2>
Expand All @@ -126,7 +129,7 @@ <h2><span>Implementation</span></h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
5 changes: 4 additions & 1 deletion doc/api/medcorder_audio/MedcorderAudio/stopPlay.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,9 @@ <h5>MedcorderAudio class</h5>
(<wbr>)

</section>
<section class="desc markdown">
<p>Stop audio playing</p>
</section>

<section class="summary source-code" id="source">
<h2><span>Implementation</span></h2>
Expand All @@ -125,7 +128,7 @@ <h2><span>Implementation</span></h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
5 changes: 4 additions & 1 deletion doc/api/medcorder_audio/MedcorderAudio/stopRecord.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,9 @@ <h5>MedcorderAudio class</h5>
(<wbr>)

</section>
<section class="desc markdown">
<p>Stop audio recording process</p>
</section>

<section class="summary source-code" id="source">
<h2><span>Implementation</span></h2>
Expand All @@ -125,7 +128,7 @@ <h2><span>Implementation</span></h2>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down
2 changes: 1 addition & 1 deletion doc/api/medcorder_audio/medcorder_audio-library.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h5>medcorder_audio library</h5>
<footer>
<span class="no-break">
medcorder_audio
0.0.6
0.0.7
</span>

</footer>
Expand Down

0 comments on commit 5f8938f

Please sign in to comment.