@realsee/live 0.4.0-beta.8 → 0.5.0-alpha.3
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/live/controller.d.ts +75 -38
- package/dist/live/createLive.d.ts +5 -3
- package/dist/live/createLiveReact.d.ts +49 -3
- package/dist/live/live.d.ts +162 -0
- package/dist/realsee-live.cjs.development.js +1561 -1447
- package/dist/realsee-live.cjs.development.js.map +1 -1
- package/dist/realsee-live.cjs.production.js +1 -1
- package/dist/realsee-live.cjs.production.js.map +1 -1
- package/dist/realsee-live.esm.js +1564 -1450
- package/dist/realsee-live.esm.js.map +1 -1
- package/dist/realsee-live.umd.development.js +51492 -51332
- package/dist/realsee-live.umd.development.js.map +1 -1
- package/dist/realsee-live.umd.production.js +1 -1
- package/dist/realsee-live.umd.production.js.map +1 -1
- package/dist/typings/live/EventType.d.ts +17 -33
- package/dist/typings/live/LiveConnectOptions.d.ts +7 -0
- package/dist/typings/live/LiveErrorType.d.ts +9 -0
- package/dist/typings/live/LiveOptions.d.ts +5 -12
- package/dist/typings/live/LiveState.d.ts +15 -0
- package/dist/typings/live/index.d.ts +2 -1
- package/dist/typings/react/index.d.ts +0 -1
- package/dist/utils/RobustWebSocket.d.ts +130 -0
- package/dist/utils/logger.d.ts +16 -0
- package/docs/assets/search.js +1 -1
- package/docs/enums/LiveState.html +7 -0
- package/docs/index.html +1 -1
- package/docs/interfaces/LiveOptions.html +16 -19
- package/docs/modules.html +34 -40
- package/package.json +2 -2
- package/dist/typings/live/Live.d.ts +0 -128
- package/dist/typings/react/LiveReact.d.ts +0 -164
- package/docs/interfaces/Live.html +0 -116
- package/docs/interfaces/LiveReact.html +0 -52
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LiveState | 如视 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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">如视 Live SDK</a></li><li><a href="LiveState.html">LiveState</a></li></ul><h1>Enumeration LiveState </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumeration Members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LiveState.html#CLOSED" class="tsd-kind-icon">CLOSED</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LiveState.html#CONNECTING" class="tsd-kind-icon">CONNECTING</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LiveState.html#NOTINITIALIZED" class="tsd-kind-icon">NOTINITIALIZED</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LiveState.html#OPEN" class="tsd-kind-icon">OPEN</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Enumeration Members</h2><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="CLOSED" class="tsd-anchor"></a><h3 class="tsd-anchor-link">CLOSED<a href="#CLOSED" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">CLOSED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">3</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveState.ts:20</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
+
<p>连接已关闭或者链接失败</p>
|
|
3
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="CONNECTING" class="tsd-anchor"></a><h3 class="tsd-anchor-link">CONNECTING<a href="#CONNECTING" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">CONNECTING<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveState.ts:10</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
|
+
<p>正在链接中</p>
|
|
5
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="NOTINITIALIZED" class="tsd-anchor"></a><h3 class="tsd-anchor-link">NOTINITIALIZED<a href="#NOTINITIALIZED" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">NOTINITIALIZED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">-1</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveState.ts:5</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="OPEN" class="tsd-anchor"></a><h3 class="tsd-anchor-link">OPEN<a href="#OPEN" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">OPEN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveState.ts:15</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
6
|
+
<p>已经链接并且可以通讯</p>
|
|
7
|
+
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum"><a href="LiveState.html" class="tsd-kind-icon">Live<wbr/>State</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LiveState.html#CLOSED" class="tsd-kind-icon">CLOSED</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LiveState.html#CONNECTING" class="tsd-kind-icon">CONNECTING</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LiveState.html#NOTINITIALIZED" class="tsd-kind-icon">NOTINITIALIZED</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="LiveState.html#OPEN" class="tsd-kind-icon">OPEN</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
package/docs/index.html
CHANGED
|
@@ -383,4 +383,4 @@ SDKs(iOS/Android/微信小程序)和 Live API 可以快速实现实时同屏
|
|
|
383
383
|
<li><a href="https://www.npmjs.com/package/@realsee/jsbridge">@realsee/jsbridge</a></li>
|
|
384
384
|
<li><a href="https://developers.realsee.com/docs/#/docs/live/README">如视开发者中心 VRTC 服务</a></li>
|
|
385
385
|
</ul>
|
|
386
|
-
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum"><a href="enums/BuiltInRTCType.html" class="tsd-kind-icon">Built<wbr/>InRTCType</a></li><li class="tsd-kind-enum"><a href="enums/BuiltinActionType.html" class="tsd-kind-icon">Builtin<wbr/>Action<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/BuiltinEventType.html" class="tsd-kind-icon">Builtin<wbr/>Event<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/Command.html" class="tsd-kind-icon">Command</a></li><li class="tsd-kind-enum"><a href="enums/MemUserStatus.html" class="tsd-kind-icon">Mem<wbr/>User<wbr/>Status</a></li><li class="tsd-kind-enum"><a href="enums/MicroStatus.html" class="tsd-kind-icon">Micro<wbr/>Status</a></li><li class="tsd-kind-enum"><a href="enums/RTCJoinedInfoCodeEnum.html" class="tsd-kind-icon">RTCJoined<wbr/>Info<wbr/>Code<wbr/>Enum</a></li><li class="tsd-kind-enum"><a href="enums/RTCType.html" class="tsd-kind-icon">RTCType</a></li><li class="tsd-kind-enum"><a href="enums/UserStatus.html" class="tsd-kind-icon">User<wbr/>Status</a></li><li class="tsd-kind-enum"><a href="enums/WebSocketCloseError.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Close<wbr/>Error</a></li><li class="tsd-kind-enum"><a href="enums/WebSocketErrorType.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Error<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/WebSocketState.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>State</a></li><li class="tsd-kind-class"><a href="classes/BrowserRTC.html" class="tsd-kind-icon">BrowserRTC</a></li><li class="tsd-kind-class"><a href="classes/BrowserRTC4Chime.html" class="tsd-kind-icon">BrowserRTC4<wbr/>Chime</a></li><li class="tsd-kind-class"><a href="classes/CoreRTC.html" class="tsd-kind-icon">CoreRTC</a></li><li class="tsd-kind-class"><a href="classes/VRWebViewRTC.html" class="tsd-kind-icon">VRWeb<wbr/>ViewRTC</a></li><li class="tsd-kind-interface"><a href="interfaces/AttendeeResponse.html" class="tsd-kind-icon">Attendee<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/GetVoiceSignReturnType.html" class="tsd-kind-icon">Get<wbr/>Voice<wbr/>Sign<wbr/>Return<wbr/>Type</a></li><li class="tsd-kind-interface
|
|
386
|
+
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum"><a href="enums/BuiltInRTCType.html" class="tsd-kind-icon">Built<wbr/>InRTCType</a></li><li class="tsd-kind-enum"><a href="enums/BuiltinActionType.html" class="tsd-kind-icon">Builtin<wbr/>Action<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/BuiltinEventType.html" class="tsd-kind-icon">Builtin<wbr/>Event<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/Command.html" class="tsd-kind-icon">Command</a></li><li class="tsd-kind-enum"><a href="enums/LiveState.html" class="tsd-kind-icon">Live<wbr/>State</a></li><li class="tsd-kind-enum"><a href="enums/MemUserStatus.html" class="tsd-kind-icon">Mem<wbr/>User<wbr/>Status</a></li><li class="tsd-kind-enum"><a href="enums/MicroStatus.html" class="tsd-kind-icon">Micro<wbr/>Status</a></li><li class="tsd-kind-enum"><a href="enums/RTCJoinedInfoCodeEnum.html" class="tsd-kind-icon">RTCJoined<wbr/>Info<wbr/>Code<wbr/>Enum</a></li><li class="tsd-kind-enum"><a href="enums/RTCType.html" class="tsd-kind-icon">RTCType</a></li><li class="tsd-kind-enum"><a href="enums/UserStatus.html" class="tsd-kind-icon">User<wbr/>Status</a></li><li class="tsd-kind-enum"><a href="enums/WebSocketCloseError.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Close<wbr/>Error</a></li><li class="tsd-kind-enum"><a href="enums/WebSocketErrorType.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Error<wbr/>Type</a></li><li class="tsd-kind-enum"><a href="enums/WebSocketState.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>State</a></li><li class="tsd-kind-class"><a href="classes/BrowserRTC.html" class="tsd-kind-icon">BrowserRTC</a></li><li class="tsd-kind-class"><a href="classes/BrowserRTC4Chime.html" class="tsd-kind-icon">BrowserRTC4<wbr/>Chime</a></li><li class="tsd-kind-class"><a href="classes/CoreRTC.html" class="tsd-kind-icon">CoreRTC</a></li><li class="tsd-kind-class"><a href="classes/VRWebViewRTC.html" class="tsd-kind-icon">VRWeb<wbr/>ViewRTC</a></li><li class="tsd-kind-interface"><a href="interfaces/AttendeeResponse.html" class="tsd-kind-icon">Attendee<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/GetVoiceSignReturnType.html" class="tsd-kind-icon">Get<wbr/>Voice<wbr/>Sign<wbr/>Return<wbr/>Type</a></li><li class="tsd-kind-interface"><a href="interfaces/LiveOptions.html" class="tsd-kind-icon">Live<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/MeetingResponse.html" class="tsd-kind-icon">Meeting<wbr/>Response</a></li><li class="tsd-kind-interface"><a href="interfaces/MeetingSessionConfigurationOptions.html" class="tsd-kind-icon">Meeting<wbr/>Session<wbr/>Configuration<wbr/>Options</a></li><li class="tsd-kind-interface"><a href="interfaces/RTCJoinedInfo.html" class="tsd-kind-icon">RTCJoined<wbr/>Info</a></li><li class="tsd-kind-interface"><a href="interfaces/RTCProtocol.html" class="tsd-kind-icon">RTCProtocol</a></li><li class="tsd-kind-interface"><a href="interfaces/VRWebViewRTCOptions.html" class="tsd-kind-icon">VRWeb<wbr/>ViewRTCOptions</a></li><li class="tsd-kind-type-alias"><a href="modules.html#BuiltinMsg" class="tsd-kind-icon">Builtin<wbr/>Msg</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#EventType" class="tsd-kind-icon">Event<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#GetVoiceSign" class="tsd-kind-icon">Get<wbr/>Voice<wbr/>Sign</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#KeyframeTypes" class="tsd-kind-icon">Keyframe<wbr/>Types</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LiveConnectOptions" class="tsd-kind-icon">Live<wbr/>Connect<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#LiveEventType" class="tsd-kind-icon">Live<wbr/>Event<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#LiveMsg" class="tsd-kind-icon">Live<wbr/>Msg</a></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><a href="modules.html#LiveProviderPropTypes" class="tsd-kind-icon">Live<wbr/>Provider<wbr/>Prop<wbr/>Types</a></li><li class="tsd-kind-type-alias"><a href="modules.html#RTCActionReactCallback" class="tsd-kind-icon">RTCAction<wbr/>React<wbr/>Callback</a></li><li class="tsd-kind-type-alias"><a href="modules.html#RTCEventType" class="tsd-kind-icon">RTCEvent<wbr/>Type</a></li><li class="tsd-kind-type-alias"><a href="modules.html#ReqLiveMsg" class="tsd-kind-icon">Req<wbr/>Live<wbr/>Msg</a></li><li class="tsd-kind-type-alias"><a href="modules.html#RoomInfo" class="tsd-kind-icon">Room<wbr/>Info</a></li><li class="tsd-kind-type-alias"><a href="modules.html#UserInfo" class="tsd-kind-icon">User<wbr/>Info</a></li><li class="tsd-kind-type-alias"><a href="modules.html#UserInfoExt" class="tsd-kind-icon">User<wbr/>Info<wbr/>Ext</a></li><li class="tsd-kind-type-alias"><a href="modules.html#UserVolume" class="tsd-kind-icon">User<wbr/>Volume</a></li><li class="tsd-kind-type-alias"><a href="modules.html#WebSocketError" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Error</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#createLive" class="tsd-kind-icon">create<wbr/>Live</a></li><li class="tsd-kind-function tsd-has-type-parameter"><a href="modules.html#createLiveReact" class="tsd-kind-icon">create<wbr/>Live<wbr/>React</a></li><li class="tsd-kind-function"><a href="modules.html#parseLiveMsg" class="tsd-kind-icon">parse<wbr/>Live<wbr/>Msg</a></li><li class="tsd-kind-function"><a href="modules.html#parseWSClsErr" class="tsd-kind-icon">parseWSCls<wbr/>Err</a></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
|
@@ -1,39 +1,36 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LiveOptions | 如视 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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">如视 Live SDK</a></li><li><a href="LiveOptions.html">LiveOptions</a></li></ul><h1>Interface LiveOptions </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
2
|
<p>依赖配置。</p>
|
|
3
|
-
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">LiveOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#__debug__" class="tsd-kind-icon">__debug__</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#
|
|
3
|
+
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">LiveOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#__debug__" class="tsd-kind-icon">__debug__</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#builtInRTCType" class="tsd-kind-icon">built<wbr/>InRTCType</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#getVoiceSign" class="tsd-kind-icon">get<wbr/>Voice<wbr/>Sign</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#initialMicroStatus" class="tsd-kind-icon">initial<wbr/>Micro<wbr/>Status</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#jsBridge" class="tsd-kind-icon">js<wbr/>Bridge</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#rtc" class="tsd-kind-icon">rtc</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#rtcType" class="tsd-kind-icon">rtc<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#useBuiltInJsBridge" class="tsd-kind-icon">use<wbr/>Built<wbr/>In<wbr/>Js<wbr/>Bridge</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#useBuiltInRTC" class="tsd-kind-icon">use<wbr/>Built<wbr/>InRTC</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="LiveOptions.html#canForbidUserKick" class="tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Kick</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="LiveOptions.html#canForbidUserMicro" class="tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Micro</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="LiveOptions.html#canForbidUserSync" class="tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Sync</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="LiveOptions.html#getTicket" class="tsd-kind-icon">get<wbr/>Ticket</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="__debug__" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> __debug__<a href="#__debug__" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">__debug__<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:79</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
4
|
<p>是否开启调试模式:此模式下会在终端打印日志方便调试。</p>
|
|
5
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="
|
|
6
|
-
<p>异常断开是否自动重连:默认 <code>true</code> 重连三次.
|
|
7
|
-
可以设置 <code>false</code> 关闭自动重连,以监控 <code>ws.readyStateUpdate</code> 事件自己来实现重连逻辑。</p>
|
|
8
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="builtInRTCType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> built<wbr/>InRTCType<a href="#builtInRTCType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">built<wbr/>InRTCType<span class="tsd-signature-symbol">?:</span> <a href="../enums/BuiltInRTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BuiltInRTCType</a></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:52</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
5
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="builtInRTCType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> built<wbr/>InRTCType<a href="#builtInRTCType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">built<wbr/>InRTCType<span class="tsd-signature-symbol">?:</span> <a href="../enums/BuiltInRTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">BuiltInRTCType</a></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:58</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
9
6
|
<p>内置的rtc通道类型
|
|
10
7
|
trtc or chime , default trtc</p>
|
|
11
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="getVoiceSign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> get<wbr/>Voice<wbr/>Sign<a href="#getVoiceSign" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">get<wbr/>Voice<wbr/>Sign<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#GetVoiceSign" class="tsd-signature-type" data-tsd-kind="Type alias">GetVoiceSign</a></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:
|
|
8
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="getVoiceSign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> get<wbr/>Voice<wbr/>Sign<a href="#getVoiceSign" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">get<wbr/>Voice<wbr/>Sign<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#GetVoiceSign" class="tsd-signature-type" data-tsd-kind="Type alias">GetVoiceSign</a></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:47</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
12
9
|
<p>获取语音签名的接口
|
|
13
10
|
使用内置rtc时提供给rtc实例使用</p>
|
|
14
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="
|
|
15
|
-
<p
|
|
16
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="jsBridge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> js<wbr/>Bridge<a href="#jsBridge" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">js<wbr/>Bridge<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JSBridgeProtocol</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:
|
|
11
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="initialMicroStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> initial<wbr/>Micro<wbr/>Status<a href="#initialMicroStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">initial<wbr/>Micro<wbr/>Status<span class="tsd-signature-symbol">?:</span> <a href="../enums/MicroStatus.html" class="tsd-signature-type" data-tsd-kind="Enumeration">MicroStatus</a></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:30</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
12
|
+
<p>麦克风初始状态</p>
|
|
13
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="jsBridge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> js<wbr/>Bridge<a href="#jsBridge" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">js<wbr/>Bridge<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JSBridgeProtocol</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:41</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
17
14
|
<p>jsBridge实例
|
|
18
15
|
使用内置rtc时提供给rtc实例使用</p>
|
|
19
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="rtc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> rtc<a href="#rtc" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">rtc<span class="tsd-signature-symbol">?:</span> <a href="RTCProtocol.html" class="tsd-signature-type" data-tsd-kind="Interface">RTCProtocol</a></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:
|
|
16
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="rtc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> rtc<a href="#rtc" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">rtc<span class="tsd-signature-symbol">?:</span> <a href="RTCProtocol.html" class="tsd-signature-type" data-tsd-kind="Interface">RTCProtocol</a></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:19</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
20
17
|
<p>RTC实例。
|
|
21
18
|
优先使用该实例。</p>
|
|
22
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="rtcType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> rtc<wbr/>Type<a href="#rtcType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">rtc<wbr/>Type<span class="tsd-signature-symbol">?:</span> <a href="../enums/RTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCType</a></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:
|
|
19
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="rtcType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> rtc<wbr/>Type<a href="#rtcType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">rtc<wbr/>Type<span class="tsd-signature-symbol">?:</span> <a href="../enums/RTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCType</a></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:25</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
23
20
|
<p>RTC类型
|
|
24
21
|
rtc 为空时使用内置的rtc实例类型</p>
|
|
25
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> url<a href="#url" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:
|
|
22
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> url<a href="#url" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:14</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
26
23
|
<p>创建<code>WebSocket</code>所依赖的URL。</p>
|
|
27
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="useBuiltInJsBridge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr/>Built<wbr/>In<wbr/>Js<wbr/>Bridge<a href="#useBuiltInJsBridge" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Built<wbr/>In<wbr/>Js<wbr/>Bridge<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:
|
|
24
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="useBuiltInJsBridge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr/>Built<wbr/>In<wbr/>Js<wbr/>Bridge<a href="#useBuiltInJsBridge" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Built<wbr/>In<wbr/>Js<wbr/>Bridge<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:63</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
28
25
|
<p>使用内置的jsBridge实例</p>
|
|
29
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="useBuiltInRTC" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr/>Built<wbr/>InRTC<a href="#useBuiltInRTC" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Built<wbr/>InRTC<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:
|
|
26
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="useBuiltInRTC" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr/>Built<wbr/>InRTC<a href="#useBuiltInRTC" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Built<wbr/>InRTC<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:52</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
30
27
|
<p>使用内置的rtc实例</p>
|
|
31
|
-
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="canForbidUserKick" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr/>Forbid<wbr/>User<wbr/>Kick<a href="#canForbidUserKick" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Kick<span class="tsd-signature-symbol">(</span>users<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:
|
|
28
|
+
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="canForbidUserKick" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr/>Forbid<wbr/>User<wbr/>Kick<a href="#canForbidUserKick" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Kick<span class="tsd-signature-symbol">(</span>users<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:75</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
32
29
|
<p>能否强制"踢掉"某个/些用户。</p>
|
|
33
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>users: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="canForbidUserMicro" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr/>Forbid<wbr/>User<wbr/>Micro<a href="#canForbidUserMicro" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Micro<span class="tsd-signature-symbol">(</span>users<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:
|
|
30
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>users: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="canForbidUserMicro" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr/>Forbid<wbr/>User<wbr/>Micro<a href="#canForbidUserMicro" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Micro<span class="tsd-signature-symbol">(</span>users<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:67</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
34
31
|
<p>能否禁用某个/些用户的麦克风</p>
|
|
35
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>users: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="canForbidUserSync" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr/>Forbid<wbr/>User<wbr/>Sync<a href="#canForbidUserSync" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Sync<span class="tsd-signature-symbol">(</span>users<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:
|
|
32
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>users: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="canForbidUserSync" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> can<wbr/>Forbid<wbr/>User<wbr/>Sync<a href="#canForbidUserSync" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Sync<span class="tsd-signature-symbol">(</span>users<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:71</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
36
33
|
<p>能否限制某个/些用户的帧数据同步</p>
|
|
37
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>users: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getTicket" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> get<wbr/>Ticket<a href="#getTicket" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Ticket<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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:
|
|
34
|
+
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>users: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getTicket" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> get<wbr/>Ticket<a href="#getTicket" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Ticket<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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/live/LiveOptions.ts:35</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
38
35
|
<p>获取建立 WebSocket 连接的依赖Tick</p>
|
|
39
|
-
</div></div><h4 class="tsd-returns-title">Returns <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></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="LiveOptions.html" class="tsd-kind-icon">Live<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#__debug__" class="tsd-kind-icon">__debug__</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#
|
|
36
|
+
</div></div><h4 class="tsd-returns-title">Returns <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></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="LiveOptions.html" class="tsd-kind-icon">Live<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#__debug__" class="tsd-kind-icon">__debug__</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#builtInRTCType" class="tsd-kind-icon">built<wbr/>InRTCType</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#getVoiceSign" class="tsd-kind-icon">get<wbr/>Voice<wbr/>Sign</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#initialMicroStatus" class="tsd-kind-icon">initial<wbr/>Micro<wbr/>Status</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#jsBridge" class="tsd-kind-icon">js<wbr/>Bridge</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#rtc" class="tsd-kind-icon">rtc</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#rtcType" class="tsd-kind-icon">rtc<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#url" class="tsd-kind-icon">url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#useBuiltInJsBridge" class="tsd-kind-icon">use<wbr/>Built<wbr/>In<wbr/>Js<wbr/>Bridge</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LiveOptions.html#useBuiltInRTC" class="tsd-kind-icon">use<wbr/>Built<wbr/>InRTC</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="LiveOptions.html#canForbidUserKick" class="tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Kick</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="LiveOptions.html#canForbidUserMicro" class="tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Micro</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="LiveOptions.html#canForbidUserSync" class="tsd-kind-icon">can<wbr/>Forbid<wbr/>User<wbr/>Sync</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="LiveOptions.html#getTicket" class="tsd-kind-icon">get<wbr/>Ticket</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|