Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Android API reference docs PR #2282

Merged
merged 1 commit into from
Jun 17, 2024
Merged

Android API reference docs PR #2282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,287 changes: 706 additions & 581 deletions public/api-reference/android/v2/hls-player/navigation.html
View file
Open in desktop

Large diffs are not rendered by default.

1,287 changes: 706 additions & 581 deletions public/api-reference/android/v2/hms-noise-cancellation-android/navigation.html
View file
Open in desktop

Large diffs are not rendered by default.

28 changes: 28 additions & 0 deletions public/api-reference/android/v2/lib/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,34 @@ <h2 class="">Packages</h2>
<div></div>
</div>
</div>
<a data-name="-1870127751%2FPackages%2F1464059712" anchor-label="live.hms.video.diagnostics" id="-1870127751%2FPackages%2F1464059712" data-filterable-set=":lib:dokkaHtmlPartial/release"></a>
<div class="table-row" data-filterable-current=":lib:dokkaHtmlPartial/release" data-filterable-set=":lib:dokkaHtmlPartial/release">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="live.hms.video.diagnostics/index.html">live.hms.video.diagnostics</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1870127751%2FPackages%2F1464059712"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right"></div>
</div>
<div></div>
</div>
</div>
<a data-name="-1476546941%2FPackages%2F1464059712" anchor-label="live.hms.video.diagnostics.models" id="-1476546941%2FPackages%2F1464059712" data-filterable-set=":lib:dokkaHtmlPartial/release"></a>
<div class="table-row" data-filterable-current=":lib:dokkaHtmlPartial/release" data-filterable-set=":lib:dokkaHtmlPartial/release">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="live.hms.video.diagnostics.models/index.html">live.hms.video.diagnostics.models</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1476546941%2FPackages%2F1464059712"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right"></div>
</div>
<div></div>
</div>
</div>
<a data-name="-939596011%2FPackages%2F1464059712" anchor-label="live.hms.video.error" id="-939596011%2FPackages%2F1464059712" data-filterable-set=":lib:dokkaHtmlPartial/release"></a>
<div class="table-row" data-filterable-current=":lib:dokkaHtmlPartial/release" data-filterable-set=":lib:dokkaHtmlPartial/release">
<div>
Expand Down
2 changes: 1 addition & 1 deletion ...ve.hms.video.audio.manager/-audio-manager-compat/get-available-communication-devices.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
<div class="cover ">
<h1 class="cover"><span>get</span><wbr><span>Available</span><wbr><span>Communication</span><wbr><span><span>Devices</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi.html"><span class="token annotation builtin">RequiresApi</span></a><span class="token punctuation">(</span><span>value<span class="token operator"> = </span><span class="breakable-word"><span class="token constant">31</span></span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-available-communication-devices.html"><span class="token function">getAvailableCommunicationDevices</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html">List</a><span class="token operator">&lt;</span><a href="https://developer.android.com/reference/kotlin/android/media/AudioDeviceInfo.html">AudioDeviceInfo</a><span class="token operator">&gt;</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi.html"><span class="token annotation builtin">RequiresApi</span></a><span class="token punctuation">(</span><span>value<span class="token operator"> = </span><span class="breakable-word"><span class="token constant">31</span></span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-available-communication-devices.html"><span class="token function">getAvailableCommunicationDevices</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><span class="token operator">&lt;</span><a href="https://developer.android.com/reference/kotlin/android/media/AudioDeviceInfo.html">AudioDeviceInfo</a><span class="token operator">&gt;</span></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 ...pi-reference/android/v2/lib/live.hms.video.audio.manager/-audio-manager-compat/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ <h2 class="">Functions</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi.html"><span class="token annotation builtin">RequiresApi</span></a><span class="token punctuation">(</span><span>value<span class="token operator"> = </span><span class="breakable-word"><span class="token constant">31</span></span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-available-communication-devices.html"><span class="token function">getAvailableCommunicationDevices</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html">List</a><span class="token operator">&lt;</span><a href="https://developer.android.com/reference/kotlin/android/media/AudioDeviceInfo.html">AudioDeviceInfo</a><span class="token operator">&gt;</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi.html"><span class="token annotation builtin">RequiresApi</span></a><span class="token punctuation">(</span><span>value<span class="token operator"> = </span><span class="breakable-word"><span class="token constant">31</span></span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-available-communication-devices.html"><span class="token function">getAvailableCommunicationDevices</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><span class="token operator">&lt;</span><a href="https://developer.android.com/reference/kotlin/android/media/AudioDeviceInfo.html">AudioDeviceInfo</a><span class="token operator">&gt;</span></div></div></div>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion ...erence/android/v2/lib/live.hms.video.audio/-h-m-s-audio-manager-legacy/audio-devices.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
<div class="cover ">
<h1 class="cover"><span>audio</span><wbr><span><span>Devices</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@get:</span><a href="https://developer.android.com/reference/kotlin/androidx/annotation/MainThread.html"><span class="token annotation builtin">MainThread</span></a></div></div><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">val </span><a href="audio-devices.html">audioDevices</a><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html">Set</a><span class="token operator">&lt;</span><a href="../-h-m-s-audio-manager/-audio-device/index.html">HMSAudioManager.AudioDevice</a><span class="token operator">&gt;</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@get:</span><a href="https://developer.android.com/reference/kotlin/androidx/annotation/MainThread.html"><span class="token annotation builtin">MainThread</span></a></div></div><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">val </span><a href="audio-devices.html">audioDevices</a><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/util/Set.html">Set</a><span class="token operator">&lt;</span><a href="../-h-m-s-audio-manager/-audio-device/index.html">HMSAudioManager.AudioDevice</a><span class="token operator">&gt;</span></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 .../v2/lib/live.hms.video.audio/-h-m-s-audio-manager-legacy/get-audio-devices-info-list.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
<div class="cover ">
<h1 class="cover"><span>get</span><wbr><span>Audio</span><wbr><span>Devices</span><wbr><span>Info</span><wbr><span><span>List</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html"><span class="token annotation builtin">NonNull</span></a></div></div><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-audio-devices-info-list.html"><span class="token function">getAudioDevicesInfoList</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html">List</a><span class="token operator">&lt;</span><a href="../-h-m-s-audio-device-info/index.html">HMSAudioDeviceInfo</a><span class="token operator">&gt;</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html"><span class="token annotation builtin">NonNull</span></a></div></div><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-audio-devices-info-list.html"><span class="token function">getAudioDevicesInfoList</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><span class="token operator">&lt;</span><a href="../-h-m-s-audio-device-info/index.html">HMSAudioDeviceInfo</a><span class="token operator">&gt;</span></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
6 changes: 3 additions & 3 deletions .../api-reference/android/v2/lib/live.hms.video.audio/-h-m-s-audio-manager-legacy/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h2 class="">Functions</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-h-m-s-audio-manager/get-audio-devices.html"><span class="token function">getAudioDevices</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html">Set</a><span class="token operator">&lt;</span><a href="../-h-m-s-audio-manager/-audio-device/index.html">HMSAudioManager.AudioDevice</a><span class="token operator">&gt;</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-h-m-s-audio-manager/get-audio-devices.html"><span class="token function">getAudioDevices</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/util/Set.html">Set</a><span class="token operator">&lt;</span><a href="../-h-m-s-audio-manager/-audio-device/index.html">HMSAudioManager.AudioDevice</a><span class="token operator">&gt;</span></div></div></div>
</div>
</div>
</div>
Expand All @@ -113,7 +113,7 @@ <h2 class="">Functions</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html"><span class="token annotation builtin">NonNull</span></a></div></div><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-audio-devices-info-list.html"><span class="token function">getAudioDevicesInfoList</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html">List</a><span class="token operator">&lt;</span><a href="../-h-m-s-audio-device-info/index.html">HMSAudioDeviceInfo</a><span class="token operator">&gt;</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html"><span class="token annotation builtin">NonNull</span></a></div></div><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-audio-devices-info-list.html"><span class="token function">getAudioDevicesInfoList</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/util/List.html">List</a><span class="token operator">&lt;</span><a href="../-h-m-s-audio-device-info/index.html">HMSAudioDeviceInfo</a><span class="token operator">&gt;</span></div></div></div>
</div>
</div>
</div>
Expand Down Expand Up @@ -250,7 +250,7 @@ <h2 class="">Properties</h2>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><a data-name="1635919623%2FProperties%2F1464059712" anchor-label="audioDevices" id="1635919623%2FProperties%2F1464059712" data-filterable-set=":lib:dokkaHtmlPartial/release"></a><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@get:</span><a href="https://developer.android.com/reference/kotlin/androidx/annotation/MainThread.html"><span class="token annotation builtin">MainThread</span></a></div></div><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">val </span><a href="audio-devices.html">audioDevices</a><span class="token operator">: </span><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html">Set</a><span class="token operator">&lt;</span><a href="../-h-m-s-audio-manager/-audio-device/index.html">HMSAudioManager.AudioDevice</a><span class="token operator">&gt;</span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":lib:dokkaHtmlPartial/release"><a data-name="1635919623%2FProperties%2F1464059712" anchor-label="audioDevices" id="1635919623%2FProperties%2F1464059712" data-filterable-set=":lib:dokkaHtmlPartial/release"></a><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@get:</span><a href="https://developer.android.com/reference/kotlin/androidx/annotation/MainThread.html"><span class="token annotation builtin">MainThread</span></a></div></div><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">val </span><a href="audio-devices.html">audioDevices</a><span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/java/util/Set.html">Set</a><span class="token operator">&lt;</span><a href="../-h-m-s-audio-manager/-audio-device/index.html">HMSAudioManager.AudioDevice</a><span class="token operator">&gt;</span></div></div></div>
</div>
</div>
</div>
Expand Down
Loading
Loading