Skip to content

Commit

Permalink
Deploying to gh-pages from @ 908f7f0 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@ThibaultBee
ThibaultBee committed Feb 7, 2024
1 parent 93fcb1c commit d6076f5
Show file tree
Hide file tree
Showing 54 changed files with 174 additions and 174 deletions.
2 changes: 1 addition & 1 deletion core/io.github.thibaultbee.streampack.data/-audio-config/-companion/get-channel-config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<div class="cover ">
<h1 class="cover"><span>get</span><wbr><span>Channel</span><wbr><span><span>Config</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-channel-config.html"><span class="token function">getChannelConfig</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">nChannel<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><p class="paragraph">Returns channel configuration from the number of channels.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">channel configuration (either <a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#channel_in_mono">AudioFormat.CHANNEL_IN_MONO</a> or <a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#channel_in_stereo">AudioFormat.CHANNEL_IN_STEREO</a>)</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>n</span><wbr><span><span>Channel</span></span></u></div></span></div><div><div class="title"><p class="paragraph">1 for mono, 2 for stereo</p></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-channel-config.html"><span class="token function">getChannelConfig</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">nChannel<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><p class="paragraph">Returns channel configuration from the number of channels.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">channel configuration (either <a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#CHANNEL_IN_MONO--">AudioFormat.CHANNEL_IN_MONO</a> or <a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#CHANNEL_IN_STEREO--">AudioFormat.CHANNEL_IN_STEREO</a>)</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>n</span><wbr><span><span>Channel</span></span></u></div></span></div><div><div class="title"><p class="paragraph">1 for mono, 2 for stereo</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
2 changes: 1 addition & 1 deletion ...hub.thibaultbee.streampack.data/-audio-config/-companion/get-num-of-bytes-per-sample.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<div class="cover ">
<h1 class="cover"><span>get</span><wbr><span>Num</span><wbr><span>Of</span><wbr><span>Bytes</span><wbr><span>Per</span><wbr><span><span>Sample</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-num-of-bytes-per-sample.html"><span class="token function">getNumOfBytesPerSample</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">byteFormat<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><p class="paragraph">Returns the number of bytes for a single audio sample.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">number of bytes per sample</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>byte</span><wbr><span><span>Format</span></span></u></div></span></div><div><div class="title"><p class="paragraph">byte format (either <a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#encoding_pcm_8bit">AudioFormat.ENCODING_PCM_8BIT</a> or <a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#encoding_pcm_16bit">AudioFormat.ENCODING_PCM_16BIT</a>,...)</p></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-num-of-bytes-per-sample.html"><span class="token function">getNumOfBytesPerSample</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">byteFormat<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><p class="paragraph">Returns the number of bytes for a single audio sample.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">number of bytes per sample</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>byte</span><wbr><span><span>Format</span></span></u></div></span></div><div><div class="title"><p class="paragraph">byte format (either <a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#ENCODING_PCM_8BIT--">AudioFormat.ENCODING_PCM_8BIT</a> or <a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#ENCODING_PCM_16BIT--">AudioFormat.ENCODING_PCM_16BIT</a>,...)</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
2 changes: 1 addition & 1 deletion ...o.github.thibaultbee.streampack.data/-audio-config/-companion/get-number-of-channels.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<div class="cover ">
<h1 class="cover"><span>get</span><wbr><span>Number</span><wbr><span>Of</span><wbr><span><span>Channels</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-number-of-channels.html"><span class="token function">getNumberOfChannels</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">channelConfig<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><p class="paragraph">Returns number of channels from a channel configuration.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">number of channels</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>channel</span><wbr><span><span>Config</span></span></u></div></span></div><div><div class="title"><p class="paragraph"><a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#channel_in_mono">AudioFormat.CHANNEL_IN_MONO</a> or <a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#channel_in_stereo">AudioFormat.CHANNEL_IN_STEREO</a></p></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-number-of-channels.html"><span class="token function">getNumberOfChannels</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">channelConfig<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><p class="paragraph">Returns number of channels from a channel configuration.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">number of channels</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>channel</span><wbr><span><span>Config</span></span></u></div></span></div><div><div class="title"><p class="paragraph"><a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#CHANNEL_IN_MONO--">AudioFormat.CHANNEL_IN_MONO</a> or <a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#CHANNEL_IN_STEREO--">AudioFormat.CHANNEL_IN_STEREO</a></p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
2 changes: 1 addition & 1 deletion core/io.github.thibaultbee.streampack.data/-audio-config/byte-format.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<div class="cover ">
<h1 class="cover"><span>byte</span><wbr><span><span>Format</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="byte-format.html">byteFormat</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><p class="paragraph">Audio byte format.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#encoding_pcm_8bit"><span>Audio</span><wbr><span>Format.</span><wbr><span><span>ENCODING_PCM_8BIT</span></span></a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#encoding_pcm_16bit"><span>Audio</span><wbr><span>Format.</span><wbr><span><span>ENCODING_PCM_16BIT</span></span></a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#encoding_pcm_float"><span>Audio</span><wbr><span>Format.</span><wbr><span><span>ENCODING_PCM_FLOAT</span></span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="byte-format.html">byteFormat</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><p class="paragraph">Audio byte format.</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#ENCODING_PCM_8BIT--"><span>Audio</span><wbr><span>Format.</span><wbr><span><span>ENCODING_PCM_8BIT</span></span></a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#ENCODING_PCM_16BIT--"><span>Audio</span><wbr><span>Format.</span><wbr><span><span>ENCODING_PCM_16BIT</span></span></a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#ENCODING_PCM_FLOAT--"><span>Audio</span><wbr><span>Format.</span><wbr><span><span>ENCODING_PCM_FLOAT</span></span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
2 changes: 1 addition & 1 deletion core/io.github.thibaultbee.streampack.data/-audio-config/channel-config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<div class="cover ">
<h1 class="cover"><span>channel</span><wbr><span><span>Config</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="channel-config.html">channelConfig</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><p class="paragraph">Audio channel configuration. From <a href="https://developer.android.com/reference/android/media/AudioRecord?hl=en#AudioRecord(int,%20int,%20int,%20int,%20int)">AudioRecord API</a>: " AudioFormat#CHANNEL_IN_MONO is guaranteed to work on all devices."</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#channel_in_mono"><span>Audio</span><wbr><span>Format.</span><wbr><span><span>CHANNEL_IN_MONO</span></span></a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#channel_in_stereo"><span>Audio</span><wbr><span>Format.</span><wbr><span><span>CHANNEL_IN_STEREO</span></span></a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="channel-config.html">channelConfig</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></div><p class="paragraph">Audio channel configuration. From <a href="https://developer.android.com/reference/android/media/AudioRecord?hl=en#AudioRecord(int,%20int,%20int,%20int,%20int)">AudioRecord API</a>: " AudioFormat#CHANNEL_IN_MONO is guaranteed to work on all devices."</p><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#CHANNEL_IN_MONO--"><span>Audio</span><wbr><span>Format.</span><wbr><span><span>CHANNEL_IN_MONO</span></span></a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/release" data-filterable-set=":core:dokkaHtmlPartial/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://developer.android.com/reference/kotlin/android/media/AudioFormat.html#CHANNEL_IN_STEREO--"><span>Audio</span><wbr><span>Format.</span><wbr><span><span>CHANNEL_IN_STEREO</span></span></a></div></span></div><div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
Loading

0 comments on commit d6076f5

Please sign in to comment.