@realsee/live 0.7.3 → 0.7.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs.js +3 -3
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.es.js +644 -87
- package/dist/index.es.js.map +1 -1
- package/dist/live/controller.d.ts +163 -42
- package/dist/live/createLive.d.ts +35 -3
- package/dist/live/createLiveReact.d.ts +51 -3
- package/dist/live/live.d.ts +501 -50
- package/dist/rtc/BrowserRTC.d.ts +63 -0
- package/dist/rtc/BrowserRTC4Chime.d.ts +38 -2
- package/dist/rtc/CoreRTC.d.ts +65 -1
- package/dist/rtc/VRWebViewRTC.d.ts +56 -6
- package/dist/typings/live/EventType.d.ts +58 -10
- package/dist/typings/live/GetVoiceSign.d.ts +27 -7
- package/dist/typings/live/UserInfo.d.ts +70 -0
- package/dist/typings/rtc/eventType.d.ts +55 -8
- package/dist/utils/appendUri.d.ts +17 -0
- package/dist/utils/uuid.d.ts +11 -1
- package/docs/assets/highlight.css +28 -0
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/BrowserRTC.html +50 -22
- package/docs/classes/BrowserRTC4Chime.html +51 -23
- package/docs/classes/CoreRTC.html +28 -23
- package/docs/classes/Live.html +197 -41
- package/docs/classes/Subscribe.html +36 -0
- package/docs/classes/VRWebViewRTC.html +32 -13
- package/docs/enums/MemUserStatus.html +10 -2
- package/docs/functions/GetVoiceSignFn.html +20 -4
- package/docs/functions/createLive.html +9 -2
- package/docs/functions/createLiveReact.html +110 -17
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +2 -15
- package/docs/interfaces/LiveOptions.html +20 -4
- package/docs/interfaces/Permission.html +18 -2
- package/docs/interfaces/RTCProtocol.html +6 -6
- package/docs/interfaces/SubscribeMixinType.emit.html +1 -0
- package/docs/interfaces/SubscribeMixinType.hasListener.html +1 -0
- package/docs/interfaces/SubscribeMixinType.off.html +1 -0
- package/docs/interfaces/SubscribeMixinType.on.html +1 -0
- package/docs/interfaces/SubscribeMixinType.once.html +1 -0
- package/docs/interfaces/VRWebViewRTCOptions.html +20 -4
- package/docs/modules/SubscribeMixinType.html +6 -0
- package/docs/modules.html +4 -1
- package/docs/types/EventMap.html +1 -0
- package/docs/types/EventType.html +1 -1
- package/docs/types/GetVoiceSign.html +2 -1
- package/docs/types/KeyframeEventType.html +1 -1
- package/docs/types/LiveEventType.html +38 -12
- package/docs/types/LiveProviderPropTypes.html +5 -1
- package/docs/types/RTCEventType.html +29 -7
- package/docs/types/UserInfo.html +1 -1
- package/docs/types/UserInfoExt.html +1 -1
- package/package.json +1 -1
package/docs/hierarchy.html
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>如视 Live SDK</title><meta name="description" content="Documentation for 如视 Live SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><link rel="stylesheet" href="assets/custom.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">如视 Live SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>如视 Live SDK</h1></div><h2>Class Hierarchy</h2><ul class="tsd-full-hierarchy"><li><a id="
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>如视 Live SDK</title><meta name="description" content="Documentation for 如视 Live SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><link rel="stylesheet" href="assets/custom.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">如视 Live SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>如视 Live SDK</h1></div><h2>Class Hierarchy</h2><ul class="tsd-full-hierarchy"><li><a id="Subscribe" class="tsd-anchor"></a><a href="classes/Subscribe.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>Subscribe</a><ul><li><a id="CoreRTC" class="tsd-anchor"></a><a href="classes/CoreRTC.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>CoreRTC</a><ul><li><a id="BrowserRTC" class="tsd-anchor"></a><a href="classes/BrowserRTC.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>BrowserRTC</a><ul></ul></li><li><a id="BrowserRTC4Chime" class="tsd-anchor"></a><a href="classes/BrowserRTC4Chime.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>BrowserRTC4Chime</a><ul></ul></li><li><a id="VRWebViewRTC" class="tsd-anchor"></a><a href="classes/VRWebViewRTC.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>VRWebViewRTC</a><ul></ul></li></ul></li><li><a id="RTCProtocol" class="tsd-anchor"></a><a href="interfaces/RTCProtocol.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>RTCProtocol</a><ul></ul></li><li><a id="Live" class="tsd-anchor"></a><a href="classes/Live.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg>Live</a><ul></ul></li></ul></li></ul></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>如视 Live SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|
package/docs/index.html
CHANGED
|
@@ -319,24 +319,11 @@ SDKs(iOS/Android/微信小程序)和 Live API 可以快速实现实时同屏
|
|
|
319
319
|
</code><button type="button">Copy</button></pre>
|
|
320
320
|
|
|
321
321
|
<p>步骤二:通过 <code>LiveProvider</code> 将 <code>live</code> 实例集成到 <code>React</code> 的 <a href="https://reactjs.org/docs/context.html" target="_blank" class="external">Context</a> 上下文环境中。</p>
|
|
322
|
-
<pre><code class="jsx">import { LiveProvider } from
|
|
323
|
-
|
|
324
|
-
ReactDOM.render(
|
|
325
|
-
<LiveProvider>
|
|
326
|
-
<RootApp />
|
|
327
|
-
</LiveProvider>,
|
|
328
|
-
containter,
|
|
329
|
-
)
|
|
322
|
+
<pre><code class="jsx"><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">LiveProvider</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">'./LiveReact'</span><br/><br/><span class="hl-5">ReactDOM</span><span class="hl-2">.</span><span class="hl-1">render</span><span class="hl-2">(</span><br/><span class="hl-2"> </span><span class="hl-11"><</span><span class="hl-9">LiveProvider</span><span class="hl-11">></span><br/><span class="hl-2"> </span><span class="hl-11"><</span><span class="hl-9">RootApp</span><span class="hl-2"> </span><span class="hl-11">/></span><br/><span class="hl-2"> </span><span class="hl-11"></</span><span class="hl-9">LiveProvider</span><span class="hl-11">></span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">containter</span><span class="hl-2">,</span><br/><span class="hl-2">)</span>
|
|
330
323
|
</code><button type="button">Copy</button></pre>
|
|
331
324
|
|
|
332
325
|
<p>步骤三:在您的 <code>React</code> 函数组件中使用相关 <code>Hooks</code> 函数。</p>
|
|
333
|
-
<pre><code class="jsx">import { useConnect } from
|
|
334
|
-
|
|
335
|
-
function ReconnectBtn() {
|
|
336
|
-
const connect = useConnect()
|
|
337
|
-
|
|
338
|
-
return <button onClick={() => connect()}>重新连接</button>
|
|
339
|
-
}
|
|
326
|
+
<pre><code class="jsx"><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">useConnect</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">'./LiveReact'</span><br/><br/><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">ReconnectBtn</span><span class="hl-2">() {</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">connect</span><span class="hl-2"> = </span><span class="hl-1">useConnect</span><span class="hl-2">()</span><br/><br/><span class="hl-2"> </span><span class="hl-4">return</span><span class="hl-2"> </span><span class="hl-11"><</span><span class="hl-12">button</span><span class="hl-2"> </span><span class="hl-13">onClick</span><span class="hl-2">=</span><span class="hl-6">{</span><span class="hl-10">() </span><span class="hl-6">=></span><span class="hl-10"> </span><span class="hl-1">connect</span><span class="hl-10">()</span><span class="hl-6">}</span><span class="hl-11">></span><span class="hl-2">重新连接</span><span class="hl-11"></</span><span class="hl-12">button</span><span class="hl-11">></span><br/><span class="hl-2">}</span>
|
|
340
327
|
</code><button type="button">Copy</button></pre>
|
|
341
328
|
|
|
342
329
|
<a id="md:live-api-文档" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Live API 文档<a href="#md:live-api-文档" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>欢迎查看 <a href="https://unpkg.com/@realsee/live/docs/index.html" target="_blank" class="external">Live API</a> 文档 。<br>
|
|
@@ -24,10 +24,26 @@ trtc or chime , default trtc</p>
|
|
|
24
24
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:78</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getTicket" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>get<wbr/>Ticket</span><a href="#getTicket" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Ticket</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>获取建立 WebSocket 连接的依赖Tick</p>
|
|
25
25
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:35</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getVoiceSign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>get<wbr/>Voice<wbr/>Sign</span><a href="#getVoiceSign" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Voice<wbr/>Sign</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">: </span><a href="../types/GetVoiceSignParams.html" class="tsd-signature-type tsd-kind-type-alias">GetVoiceSignParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/GetVoiceSignReturnType.html" class="tsd-signature-type tsd-kind-type-alias">GetVoiceSignReturnType</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>获取语音签名的接口
|
|
26
26
|
使用内置rtc时提供给rtc实例使用</p>
|
|
27
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getVoiceSign.__type-10.__type-11"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/GetVoiceSignReturnType.html" class="tsd-signature-type tsd-kind-type-alias">GetVoiceSignReturnType</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
27
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getVoiceSign.__type-10.__type-11"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/GetVoiceSignReturnType.html" class="tsd-signature-type tsd-kind-type-alias">GetVoiceSignReturnType</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>获取用户语音签名的函数</p>
|
|
28
|
+
<p>用于获取加入 RTC 语音房间所需的签名信息。
|
|
29
|
+
通常需要调用后端 API 来生成签名。</p>
|
|
30
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">params</span>: <a href="../types/GetVoiceSignParams.html" class="tsd-signature-type tsd-kind-type-alias">GetVoiceSignParams</a></span><div class="tsd-comment tsd-typography"><p>获取语音签名所需的参数,包含以下属性:</p>
|
|
31
|
+
<ul>
|
|
32
|
+
<li>voiceId: 语音房间ID</li>
|
|
33
|
+
<li>userId: 用户ID</li>
|
|
34
|
+
<li>roomId: 房间ID</li>
|
|
35
|
+
</ul>
|
|
36
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/GetVoiceSignReturnType.html" class="tsd-signature-type tsd-kind-type-alias">GetVoiceSignReturnType</a><span class="tsd-signature-symbol">></span></h4><p>Promise<GetVoiceSignReturnType> 返回包含签名信息的 Promise,包含:</p>
|
|
37
|
+
<ul>
|
|
38
|
+
<li>sdkAppId: RTC的sdkAppId</li>
|
|
39
|
+
<li>userId: RTC的用户ID</li>
|
|
40
|
+
<li>roomId: RTC的语音房间号</li>
|
|
41
|
+
<li>userSig: RTC的用户签名</li>
|
|
42
|
+
</ul>
|
|
43
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">getVoiceSign</span><span class="hl-2">: </span><span class="hl-9">GetVoiceSign</span><span class="hl-2"> = </span><span class="hl-6">async</span><span class="hl-2"> (</span><span class="hl-5">params</span><span class="hl-2">) </span><span class="hl-6">=></span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">response</span><span class="hl-2"> = </span><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetch</span><span class="hl-2">(</span><span class="hl-3">'/api/get-voice-sign'</span><span class="hl-2">, {</span><br/><span class="hl-2"> </span><span class="hl-5">method:</span><span class="hl-2"> </span><span class="hl-3">'POST'</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">headers:</span><span class="hl-2"> { </span><span class="hl-3">'Content-Type'</span><span class="hl-5">:</span><span class="hl-2"> </span><span class="hl-3">'application/json'</span><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-5">body:</span><span class="hl-2"> </span><span class="hl-7">JSON</span><span class="hl-2">.</span><span class="hl-1">stringify</span><span class="hl-2">(</span><span class="hl-5">params</span><span class="hl-2">)</span><br/><span class="hl-2"> })</span><br/><span class="hl-2"> </span><span class="hl-4">return</span><span class="hl-2"> </span><span class="hl-5">response</span><span class="hl-2">.</span><span class="hl-1">json</span><span class="hl-2">()</span><br/><span class="hl-2">}</span>
|
|
44
|
+
</code><button type="button">Copy</button></pre>
|
|
45
|
+
|
|
46
|
+
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:47</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="initialMicroStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>initial<wbr/>Micro<wbr/>Status</span><a href="#initialMicroStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">initial<wbr/>Micro<wbr/>Status</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/MicroStatus.html" class="tsd-signature-type tsd-kind-enum">MicroStatus</a></div><div class="tsd-comment tsd-typography"><p>麦克风初始状态</p>
|
|
31
47
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:30</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="jsBridge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>js<wbr/>Bridge</span><a href="#jsBridge" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">js<wbr/>Bridge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JSBridgeProtocol</span></div><div class="tsd-comment tsd-typography"><p>jsBridge实例
|
|
32
48
|
使用内置rtc时提供给rtc实例使用</p>
|
|
33
49
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:41</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="rtc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>rtc</span><a href="#rtc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">rtc</span><span class="tsd-signature-symbol">?:</span> <a href="RTCProtocol.html" class="tsd-signature-type tsd-kind-interface">RTCProtocol</a></div><div class="tsd-comment tsd-typography"><p>RTC实例。
|
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Permission | 如视 Live SDK</title><meta name="description" content="Documentation for 如视 Live SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Live SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">如视 Live SDK</a></li><li><a href="Permission.html">Permission</a></li></ul><h1> InterfacePermission</h1></div><
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Permission | 如视 Live SDK</title><meta name="description" content="Documentation for 如视 Live SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Live SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">如视 Live SDK</a></li><li><a href="Permission.html">Permission</a></li></ul><h1> InterfacePermission</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>用户权限配置接口</p>
|
|
2
|
+
<p>定义了用户在带看房间中的各种权限。所有权限都是布尔值,true 表示拥有该权限。</p>
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Permission</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#apply_other_phone">apply_other_phone</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#change_other_status">change_other_status</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#close_live_room">close_live_room</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#control_other_micro">control_other_micro</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#control_other_sync">control_other_sync</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#control_own_micro">control_own_micro</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#dynamic_enter">dynamic_enter</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#extension">extension</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#invite_other">invite_other</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#more_vr_scene">more_vr_scene</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#sync_frame">sync_frame</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#transfer_role">transfer_role</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#view_other_micro_status">view_other_micro_status</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="Permission.html#view_own_micro_status">view_own_micro_status</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:120</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Permission.html#apply_other_phone" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>apply_<wbr/>other_<wbr/>phone</span></a>
|
|
2
4
|
<a href="Permission.html#change_other_status" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>change_<wbr/>other_<wbr/>status</span></a>
|
|
3
5
|
<a href="Permission.html#close_live_room" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>close_<wbr/>live_<wbr/>room</span></a>
|
|
4
6
|
<a href="Permission.html#control_other_micro" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>control_<wbr/>other_<wbr/>micro</span></a>
|
|
@@ -12,4 +14,18 @@
|
|
|
12
14
|
<a href="Permission.html#transfer_role" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transfer_<wbr/>role</span></a>
|
|
13
15
|
<a href="Permission.html#view_other_micro_status" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>view_<wbr/>other_<wbr/>micro_<wbr/>status</span></a>
|
|
14
16
|
<a href="Permission.html#view_own_micro_status" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>view_<wbr/>own_<wbr/>micro_<wbr/>status</span></a>
|
|
15
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="apply_other_phone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>apply_<wbr/>other_<wbr/>phone</span><a href="#apply_other_phone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">apply_<wbr/>other_<wbr/>phone</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:108</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="change_other_status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>change_<wbr/>other_<wbr/>status</span><a href="#change_other_status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">change_<wbr/>other_<wbr/>status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:116</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="close_live_room" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>close_<wbr/>live_<wbr/>room</span><a href="#close_live_room" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">close_<wbr/>live_<wbr/>room</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:106</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="control_other_micro" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>control_<wbr/>other_<wbr/>micro</span><a href="#control_other_micro" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">control_<wbr/>other_<wbr/>micro</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:100</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="control_other_sync" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>control_<wbr/>other_<wbr/>sync</span><a href="#control_other_sync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">control_<wbr/>other_<wbr/>sync</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:118</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="control_own_micro" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>control_<wbr/>own_<wbr/>micro</span><a href="#control_own_micro" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">control_<wbr/>own_<wbr/>micro</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:98</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dynamic_enter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dynamic_<wbr/>enter</span><a href="#dynamic_enter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dynamic_<wbr/>enter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:110</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="extension" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>extension</span><a href="#extension" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">extension</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:120</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="invite_other" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>invite_<wbr/>other</span><a href="#invite_other" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">invite_<wbr/>other</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:96</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="more_vr_scene" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>more_<wbr/>vr_<wbr/>scene</span><a href="#more_vr_scene" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">more_<wbr/>vr_<wbr/>scene</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:94</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sync_frame" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sync_<wbr/>frame</span><a href="#sync_frame" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sync_<wbr/>frame</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:112</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transfer_role" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transfer_<wbr/>role</span><a href="#transfer_role" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transfer_<wbr/>role</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:114</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="view_other_micro_status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>view_<wbr/>other_<wbr/>micro_<wbr/>status</span><a href="#view_other_micro_status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">view_<wbr/>other_<wbr/>micro_<wbr/>status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:104</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="view_own_micro_status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>view_<wbr/>own_<wbr/>micro_<wbr/>status</span><a href="#view_own_micro_status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">view_<wbr/>own_<wbr/>micro_<wbr/>status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:102</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#apply_other_phone" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>apply_<wbr/>other_<wbr/>phone</span></a><a href="#change_other_status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>change_<wbr/>other_<wbr/>status</span></a><a href="#close_live_room" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>close_<wbr/>live_<wbr/>room</span></a><a href="#control_other_micro" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>control_<wbr/>other_<wbr/>micro</span></a><a href="#control_other_sync" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>control_<wbr/>other_<wbr/>sync</span></a><a href="#control_own_micro" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>control_<wbr/>own_<wbr/>micro</span></a><a href="#dynamic_enter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dynamic_<wbr/>enter</span></a><a href="#extension" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extension</span></a><a href="#invite_other" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>invite_<wbr/>other</span></a><a href="#more_vr_scene" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>more_<wbr/>vr_<wbr/>scene</span></a><a href="#sync_frame" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sync_<wbr/>frame</span></a><a href="#transfer_role" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transfer_<wbr/>role</span></a><a href="#view_other_micro_status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>view_<wbr/>other_<wbr/>micro_<wbr/>status</span></a><a href="#view_own_micro_status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>view_<wbr/>own_<wbr/>micro_<wbr/>status</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>如视 Live SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|
|
17
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="apply_other_phone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>apply_<wbr/>other_<wbr/>phone</span><a href="#apply_other_phone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">apply_<wbr/>other_<wbr/>phone</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>申请获取其他用户电话的权限</p>
|
|
18
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:152</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="change_other_status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>change_<wbr/>other_<wbr/>status</span><a href="#change_other_status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">change_<wbr/>other_<wbr/>status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>改变其他用户状态的权限(如踢出用户)</p>
|
|
19
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:168</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="close_live_room" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>close_<wbr/>live_<wbr/>room</span><a href="#close_live_room" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">close_<wbr/>live_<wbr/>room</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>关闭带看房间的权限</p>
|
|
20
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:148</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="control_other_micro" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>control_<wbr/>other_<wbr/>micro</span><a href="#control_other_micro" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">control_<wbr/>other_<wbr/>micro</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>控制其他用户麦克风的权限</p>
|
|
21
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:136</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="control_other_sync" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>control_<wbr/>other_<wbr/>sync</span><a href="#control_other_sync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">control_<wbr/>other_<wbr/>sync</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>控制其他用户全量同步帧数据权限的权限</p>
|
|
22
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:172</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="control_own_micro" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>control_<wbr/>own_<wbr/>micro</span><a href="#control_own_micro" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">control_<wbr/>own_<wbr/>micro</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>控制自己麦克风的权限</p>
|
|
23
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:132</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dynamic_enter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dynamic_<wbr/>enter</span><a href="#dynamic_enter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dynamic_<wbr/>enter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>动态进入房间的权限</p>
|
|
24
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:156</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="extension" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>extension</span><a href="#extension" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">extension</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>其他扩展权限点</p>
|
|
25
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:176</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="invite_other" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>invite_<wbr/>other</span><a href="#invite_other" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">invite_<wbr/>other</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>邀请其他用户进入房间的权限</p>
|
|
26
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:128</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="more_vr_scene" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>more_<wbr/>vr_<wbr/>scene</span><a href="#more_vr_scene" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">more_<wbr/>vr_<wbr/>scene</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>切换更多 VR 场景的权限</p>
|
|
27
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:124</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sync_frame" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sync_<wbr/>frame</span><a href="#sync_frame" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sync_<wbr/>frame</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>同步帧数据的权限</p>
|
|
28
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:160</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="transfer_role" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>transfer_<wbr/>role</span><a href="#transfer_role" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">transfer_<wbr/>role</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>改变用户角色的权限</p>
|
|
29
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:164</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="view_other_micro_status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>view_<wbr/>other_<wbr/>micro_<wbr/>status</span><a href="#view_other_micro_status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">view_<wbr/>other_<wbr/>micro_<wbr/>status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>查看其他用户麦克风状态的权限</p>
|
|
30
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:144</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="view_own_micro_status" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>view_<wbr/>own_<wbr/>micro_<wbr/>status</span><a href="#view_own_micro_status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">view_<wbr/>own_<wbr/>micro_<wbr/>status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>查看自己麦克风状态的权限</p>
|
|
31
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in typings/live/UserInfo.ts:140</li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#apply_other_phone" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>apply_<wbr/>other_<wbr/>phone</span></a><a href="#change_other_status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>change_<wbr/>other_<wbr/>status</span></a><a href="#close_live_room" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>close_<wbr/>live_<wbr/>room</span></a><a href="#control_other_micro" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>control_<wbr/>other_<wbr/>micro</span></a><a href="#control_other_sync" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>control_<wbr/>other_<wbr/>sync</span></a><a href="#control_own_micro" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>control_<wbr/>own_<wbr/>micro</span></a><a href="#dynamic_enter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dynamic_<wbr/>enter</span></a><a href="#extension" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extension</span></a><a href="#invite_other" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>invite_<wbr/>other</span></a><a href="#more_vr_scene" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>more_<wbr/>vr_<wbr/>scene</span></a><a href="#sync_frame" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sync_<wbr/>frame</span></a><a href="#transfer_role" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transfer_<wbr/>role</span></a><a href="#view_other_micro_status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>view_<wbr/>other_<wbr/>micro_<wbr/>status</span></a><a href="#view_own_micro_status" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>view_<wbr/>own_<wbr/>micro_<wbr/>status</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>如视 Live SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|