Skip to content

Commit e1e349d

Browse files
authored
Merge pull request #8 from xanderzhao-zb/main
【TUILiveKit】【Android】api docs update
2 parents ccbe80d + 115091e commit e1e349d

385 files changed

Lines changed: 741 additions & 741 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
0 Bytes
Binary file not shown.

docs/-atomic-x -core -a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-state/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
<div class="breadcrumbs"><a href="../../../index.html">AtomicX Core API</a><span class="delimiter">/</span><a href="../index.html">io.trtc.tuikit.atomicxcore.api.barrage</a><span class="delimiter">/</span><span class="current">BarrageState</span></div>
5959
<div class="cover ">
6060
<h1 class="cover"><span>Barrage</span><wbr></wbr><span><span>State</span></span></h1>
61-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">BarrageState</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>messageList<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-barrage/index.html">Barrage</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">allowSendMessage<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">弹幕状态,管理当前房间的弹幕数据状态。</p></div></div>
61+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">BarrageState</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>messageList<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-barrage/index.html">Barrage</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">allowSendMessage<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><p class="paragraph">Barrage state, managing the barrage data state of the current room.</p></div></div>
6262
</div>
6363
<div class="tabbedcontent">
6464
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
@@ -94,7 +94,7 @@ <h2 class="">Properties</h2>
9494
</span></span></div>
9595
<div>
9696
<div class="title">
97-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="message-list.html">messageList</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-barrage/index.html">Barrage</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">当前房间的弹幕消息列表,支持实时更新并可被订阅监听。{@link $Barrage$}</p></div></div></div>
97+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="message-list.html">messageList</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-barrage/index.html">Barrage</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Barrage message list of the current room, supporting real-time updates and subscription listening. {@link Barrage}</p></div></div></div>
9898
</div>
9999
</div>
100100
</div>

docs/-atomic-x -core -a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-state/message-list.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
<div class="cover ">
6060
<h1 class="cover"><span>message</span><wbr></wbr><span><span>List</span></span></h1>
6161
</div>
62-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="message-list.html">messageList</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-barrage/index.html">Barrage</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span></div><p class="paragraph">当前房间的弹幕消息列表,支持实时更新并可被订阅监听。{@link $Barrage$}</p></div></div>
62+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="message-list.html">messageList</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-barrage/index.html">Barrage</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span></div><p class="paragraph">Barrage message list of the current room, supporting real-time updates and subscription listening. {@link Barrage}</p></div></div>
6363
</div>
6464
<div class="footer">
6565
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 Copyright</span><span

docs/-atomic-x -core -a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-store/-companion/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
<div class="breadcrumbs"><a href="../../../../index.html">AtomicX Core API</a><span class="delimiter">/</span><a href="../../index.html">io.trtc.tuikit.atomicxcore.api.barrage</a><span class="delimiter">/</span><a href="../index.html">BarrageStore</a><span class="delimiter">/</span><span class="current">Companion</span></div>
5959
<div class="cover ">
6060
<h1 class="cover"><span><span>Companion</span></span></h1>
61-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a></div><p class="paragraph">弹幕管理核心类,用于处理直播间/语音聊天房内的弹幕相关业务逻辑。</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">BarrageStore 指定房间的弹幕管理实例</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":atomicxcore:dokkaHtml/release" data-filterable-set=":atomicxcore:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>live</span><wbr></wbr><span><span>ID</span></span></u></div></span></div><div><div class="title"><p class="paragraph">直播间ID</p></div></div></div></div></div></div></div>
61+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">Companion</a></div><p class="paragraph">Barrage management core class, used to handle barrage related business logic in live rooms/voice chat rooms.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">BarrageStore Barrage management instance for the specified room</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":atomicxcore:dokkaHtml/release" data-filterable-set=":atomicxcore:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>live</span><wbr></wbr><span><span>ID</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Live room ID</p></div></div></div></div></div></div></div>
6262
</div>
6363
<div class="tabbedcontent">
6464
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>

docs/-atomic-x -core -a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-store/append-local-tip.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
<div class="cover ">
6060
<h1 class="cover"><span>append</span><wbr></wbr><span>Local</span><wbr></wbr><span><span>Tip</span></span></h1>
6161
</div>
62-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="append-local-tip.html"><span class="token function">appendLocalTip</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">message<span class="token operator">: </span><a href="../-barrage/index.html">Barrage</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">添加本地提示消息(在本地添加提示或操作反馈消息,仅当前客户端可见)。</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":atomicxcore:dokkaHtml/release" data-filterable-set=":atomicxcore:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>message</span></span></u></div></span></div><div><div class="title"><p class="paragraph">本地弹幕消息(如系统提示、操作反馈等,仅当前用户可见){@link $Barrage$}</p></div></div></div></div></div></div></div>
62+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="append-local-tip.html"><span class="token function">appendLocalTip</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">message<span class="token operator">: </span><a href="../-barrage/index.html">Barrage</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Add local tip message (add tip or operation feedback message locally, visible only to the current client).</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":atomicxcore:dokkaHtml/release" data-filterable-set=":atomicxcore:dokkaHtml/release"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>message</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Local barrage message (such as system tips, operation feedback, etc., visible only to the current user) {@link Barrage}</p></div></div></div></div></div></div></div>
6363
</div>
6464
<div class="footer">
6565
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 Copyright</span><span

docs/-atomic-x -core -a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-store/barrage-state.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
<div class="cover ">
6060
<h1 class="cover"><span>barrage</span><wbr></wbr><span><span>State</span></span></h1>
6161
</div>
62-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="barrage-state.html">barrageState</a><span class="token operator">: </span><a href="../-barrage-state/index.html">BarrageState</a></div><p class="paragraph">当前房间的弹幕状态订阅,包含弹幕消息列表等信息。通过订阅该状态,可实时获取房间内弹幕数据的更新。{@link $BarrageState$}</p></div></div>
62+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":atomicxcore:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="barrage-state.html">barrageState</a><span class="token operator">: </span><a href="../-barrage-state/index.html">BarrageState</a></div><p class="paragraph">Barrage state subscription of the current room, containing barrage message list and other information. By subscribing to this state, you can get real-time updates of barrage data in the room. {@link BarrageState}</p></div></div>
6363
</div>
6464
<div class="footer">
6565
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2025 Copyright</span><span

0 commit comments

Comments
 (0)