@realsee/live 0.2.1 → 0.3.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/README.md +60 -2
- package/docs/assets/highlight.css +1 -1
- package/docs/assets/main.js +2 -2
- package/docs/assets/search.js +1 -1
- package/docs/assets/style.css +25 -0
- package/docs/classes/RTCProtocol.BrowserRTC.html +60 -0
- package/docs/classes/RTCProtocol.BrowserRTC4Chime.html +66 -0
- package/docs/classes/RTCProtocol.RTCExample.html +10 -10
- package/docs/classes/RTCProtocol.VRWebViewRTC.html +10 -10
- package/docs/classes/shared_utils.Subscribe.html +5 -5
- package/docs/enums/RTCProtocol.RTCJoinedInfoCodeEnum.html +4 -4
- package/docs/enums/RTCProtocol.RTCType.html +1 -1
- package/docs/enums/live.BuiltinActionType.html +6 -6
- package/docs/enums/live.BuiltinEventType.html +2 -2
- package/docs/enums/live.Command.html +1 -1
- package/docs/enums/live.MemUserStatus.html +1 -1
- package/docs/enums/live.MicroStatus.html +1 -1
- package/docs/enums/live.UserStatus.html +3 -3
- package/docs/enums/live.WebSocketCloseError.html +8 -8
- package/docs/enums/live.WebSocketErrorType.html +1 -1
- package/docs/enums/live.WebSocketState.html +5 -5
- package/docs/index.html +32 -1
- package/docs/interfaces/RTCProtocol.GetVoiceSignReturnType.html +1 -1
- package/docs/interfaces/RTCProtocol.RTCJoinedInfo.html +1 -1
- package/docs/interfaces/RTCProtocol.RTCProtocol-1.html +10 -10
- package/docs/interfaces/RTCProtocol.VRWebViewRTCOptions.html +1 -1
- package/docs/interfaces/live.Live.html +24 -24
- package/docs/interfaces/live.LiveOptions.html +9 -9
- package/docs/interfaces/live.LiveReact.html +15 -15
- package/docs/modules/RTCProtocol.html +3 -3
- package/docs/modules/live.html +10 -10
- package/docs/modules/shared_utils.html +2 -2
- package/lib/RTC/BrowserRTC.js +9 -9
- package/lib/RTC/BrowserRTC.js.map +1 -1
- package/lib/RTC/BrowserRTC4Chime.d.ts +53 -0
- package/lib/RTC/BrowserRTC4Chime.js +299 -0
- package/lib/RTC/BrowserRTC4Chime.js.map +1 -0
- package/lib/RTC/VRWebViewRTC.js +12 -11
- package/lib/RTC/VRWebViewRTC.js.map +1 -1
- package/lib/RTC/index.js +7 -7
- package/lib/RTC/index.js.map +1 -1
- package/lib/createLive.js +22 -21
- package/lib/createLive.js.map +1 -1
- package/lib/createLiveReact.d.ts +1 -1
- package/lib/createLiveReact.js +9 -13
- package/lib/createLiveReact.js.map +1 -1
- package/lib/shared-utils/appendUri.js +1 -1
- package/lib/shared-utils/appendUri.js.map +1 -1
- package/lib/typings/Chime/AttendeeResponse.d.ts +5 -0
- package/lib/typings/Chime/AttendeeResponse.js +3 -0
- package/lib/typings/Chime/AttendeeResponse.js.map +1 -0
- package/lib/typings/Chime/MeetingResponse.d.ts +12 -0
- package/lib/typings/Chime/MeetingResponse.js +3 -0
- package/lib/typings/Chime/MeetingResponse.js.map +1 -0
- package/lib/typings/Chime/MeetingSessionConfigurationOptions.d.ts +16 -0
- package/lib/typings/Chime/MeetingSessionConfigurationOptions.js +3 -0
- package/lib/typings/Chime/MeetingSessionConfigurationOptions.js.map +1 -0
- package/lib/typings/LiveMsg.js +2 -2
- package/lib/typings/LiveMsg.js.map +1 -1
- package/package.json +10 -9
- package/umd/createLive.96395a4c.js +1 -0
- package/umd/createLiveReact.e1836101.js +1 -0
- package/umd/createLive.a6edf473.js +0 -1
- package/umd/createLiveReact.e21b4514.js +0 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WebSocketErrorType | 如视 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="../modules/live.html">live</a></li><li><a href="live.WebSocketErrorType.html">WebSocketErrorType</a></li></ul><h1>Enumeration WebSocketErrorType</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="live.WebSocketErrorType.html#Close" class="tsd-kind-icon">Close</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#DuplicateConnect" class="tsd-kind-icon">Duplicate<wbr/>Connect</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#Error" class="tsd-kind-icon">Error</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#IllegalArgs" class="tsd-kind-icon">Illegal<wbr/>Args</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#IllegalURL" class="tsd-kind-icon">IllegalURL</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#MicroAuth" class="tsd-kind-icon">Micro<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#Unknown" class="tsd-kind-icon">Unknown</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="Close" class="tsd-anchor"></a><h3>Close</h3><div class="tsd-signature tsd-kind-icon">Close<span class="tsd-signature-symbol"> = "Close"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:40</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="DuplicateConnect" class="tsd-anchor"></a><h3>Duplicate<wbr/>Connect</h3><div class="tsd-signature tsd-kind-icon">Duplicate<wbr/>Connect<span class="tsd-signature-symbol"> = "DuplicateConnect"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:42</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Error" class="tsd-anchor"></a><h3>Error</h3><div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol"> = "Error"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:39</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="IllegalArgs" class="tsd-anchor"></a><h3>Illegal<wbr/>Args</h3><div class="tsd-signature tsd-kind-icon">Illegal<wbr/>Args<span class="tsd-signature-symbol"> = "IllegalArgs"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:45</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="IllegalURL" class="tsd-anchor"></a><h3>IllegalURL</h3><div class="tsd-signature tsd-kind-icon">IllegalURL<span class="tsd-signature-symbol"> = "IllegalURL"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:43</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="MicroAuth" class="tsd-anchor"></a><h3>Micro<wbr/>Auth</h3><div class="tsd-signature tsd-kind-icon">Micro<wbr/>Auth<span class="tsd-signature-symbol"> = "MicroAuth"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:41</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Unknown" class="tsd-anchor"></a><h3>Unknown</h3><div class="tsd-signature tsd-kind-icon">Unknown<span class="tsd-signature-symbol"> = "Unknown"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:44</li></ul></aside></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">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/RTCProtocol.html">RTCProtocol</a></li><li class="current tsd-kind-module"><a href="../modules/live.html">live</a></li><li class=" tsd-kind-module"><a href="../modules/shared_utils.html">shared-<wbr/>utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum tsd-parent-kind-module"><a href="live.WebSocketErrorType.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Error<wbr/>Type</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#Close" class="tsd-kind-icon">Close</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#DuplicateConnect" class="tsd-kind-icon">Duplicate<wbr/>Connect</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#Error" class="tsd-kind-icon">Error</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#IllegalArgs" class="tsd-kind-icon">Illegal<wbr/>Args</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#IllegalURL" class="tsd-kind-icon">IllegalURL</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#MicroAuth" class="tsd-kind-icon">Micro<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#Unknown" class="tsd-kind-icon">Unknown</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-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WebSocketErrorType | 如视 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="../modules/live.html">live</a></li><li><a href="live.WebSocketErrorType.html">WebSocketErrorType</a></li></ul><h1>Enumeration WebSocketErrorType</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="live.WebSocketErrorType.html#Close" class="tsd-kind-icon">Close</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#DuplicateConnect" class="tsd-kind-icon">Duplicate<wbr/>Connect</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#Error" class="tsd-kind-icon">Error</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#IllegalArgs" class="tsd-kind-icon">Illegal<wbr/>Args</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#IllegalURL" class="tsd-kind-icon">IllegalURL</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#MicroAuth" class="tsd-kind-icon">Micro<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#Unknown" class="tsd-kind-icon">Unknown</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="Close" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Close<a href="#Close" 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">Close<span class="tsd-signature-symbol"> = "Close"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:40</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="DuplicateConnect" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Duplicate<wbr/>Connect<a href="#DuplicateConnect" 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">Duplicate<wbr/>Connect<span class="tsd-signature-symbol"> = "DuplicateConnect"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:42</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Error" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Error<a href="#Error" 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">Error<span class="tsd-signature-symbol"> = "Error"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:39</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="IllegalArgs" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Illegal<wbr/>Args<a href="#IllegalArgs" 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">Illegal<wbr/>Args<span class="tsd-signature-symbol"> = "IllegalArgs"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:45</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="IllegalURL" class="tsd-anchor"></a><h3 class="tsd-anchor-link">IllegalURL<a href="#IllegalURL" 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">IllegalURL<span class="tsd-signature-symbol"> = "IllegalURL"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:43</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="MicroAuth" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Micro<wbr/>Auth<a href="#MicroAuth" 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">Micro<wbr/>Auth<span class="tsd-signature-symbol"> = "MicroAuth"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:41</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Unknown" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Unknown<a href="#Unknown" 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">Unknown<span class="tsd-signature-symbol"> = "Unknown"</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:44</li></ul></aside></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">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/RTCProtocol.html">RTCProtocol</a></li><li class="current tsd-kind-module"><a href="../modules/live.html">live</a></li><li class=" tsd-kind-module"><a href="../modules/shared_utils.html">shared-<wbr/>utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum tsd-parent-kind-module"><a href="live.WebSocketErrorType.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Error<wbr/>Type</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#Close" class="tsd-kind-icon">Close</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#DuplicateConnect" class="tsd-kind-icon">Duplicate<wbr/>Connect</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#Error" class="tsd-kind-icon">Error</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#IllegalArgs" class="tsd-kind-icon">Illegal<wbr/>Args</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#IllegalURL" class="tsd-kind-icon">IllegalURL</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#MicroAuth" class="tsd-kind-icon">Micro<wbr/>Auth</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketErrorType.html#Unknown" class="tsd-kind-icon">Unknown</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-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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,13 +1,13 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WebSocketState | 如视 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="../modules/live.html">live</a></li><li><a href="live.WebSocketState.html">WebSocketState</a></li></ul><h1>Enumeration WebSocketState</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>WebSocket 连接状态枚举</p>
|
|
3
|
-
</div></div></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>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.html#CLOSED" class="tsd-kind-icon">CLOSED</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.html#CLOSING" class="tsd-kind-icon">CLOSING</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.html#CONNECTING" class="tsd-kind-icon">CONNECTING</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.html#NOTINITIALIZED" class="tsd-kind-icon">NOTINITIALIZED</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.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>CLOSED
|
|
3
|
+
</div></div></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>Enumeration members</h3><ul class="tsd-index-list"><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.html#CLOSED" class="tsd-kind-icon">CLOSED</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.html#CLOSING" class="tsd-kind-icon">CLOSING</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.html#CONNECTING" class="tsd-kind-icon">CONNECTING</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.html#NOTINITIALIZED" class="tsd-kind-icon">NOTINITIALIZED</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.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"> = 3</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:28</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-enum-member tsd-parent-kind-enum"><a id="CLOSING" class="tsd-anchor"></a><h3>CLOSING
|
|
5
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="CLOSING" class="tsd-anchor"></a><h3 class="tsd-anchor-link">CLOSING<a href="#CLOSING" 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">CLOSING<span class="tsd-signature-symbol"> = 2</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:23</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
6
6
|
<p>连接正在关闭</p>
|
|
7
|
-
</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>CONNECTING
|
|
7
|
+
</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"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:13</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
8
8
|
<p>正在链接中</p>
|
|
9
|
-
</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>NOTINITIALIZED
|
|
9
|
+
</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"> = -1</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:8</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
10
10
|
<p>尚未初始化</p>
|
|
11
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="OPEN" class="tsd-anchor"></a><h3>OPEN
|
|
11
|
+
</div></div></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"> = 1</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:18</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
12
12
|
<p>已经链接并且可以通讯</p>
|
|
13
13
|
</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">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/RTCProtocol.html">RTCProtocol</a></li><li class="current tsd-kind-module"><a href="../modules/live.html">live</a></li><li class=" tsd-kind-module"><a href="../modules/shared_utils.html">shared-<wbr/>utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-enum tsd-parent-kind-module"><a href="live.WebSocketState.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>State</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.html#CLOSED" class="tsd-kind-icon">CLOSED</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.html#CLOSING" class="tsd-kind-icon">CLOSING</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.html#CONNECTING" class="tsd-kind-icon">CONNECTING</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.html#NOTINITIALIZED" class="tsd-kind-icon">NOTINITIALIZED</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketState.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-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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
|
@@ -40,8 +40,11 @@ SDKs(iOS/Android/微信小程序)和 Live API 可以快速实现实时同屏
|
|
|
40
40
|
<h3>安装 SDK</h3>
|
|
41
41
|
</a>
|
|
42
42
|
<p>可以通过 Node 包管理工具 <a href="https://www.npmjs.com/">npm</a> 或 <a href="https://yarnpkg.com/">yarn</a> 安装<strong>Live</strong>:</p>
|
|
43
|
-
<pre><code class="hljs language-bash"><span class="hl-0"># npm</span><br/><span class="hl-1">npm i @realsee/live</span><br/><span class="hl-0"># yarn</span><br/><span class="hl-1">yarn add @realsee/live</span>
|
|
43
|
+
<pre><code class="hljs language-bash"><span class="hl-0"># npm</span><br/><span class="hl-1">npm i @realsee/live tslib</span><br/><span class="hl-0"># yarn</span><br/><span class="hl-1">yarn add @realsee/live tslib</span>
|
|
44
44
|
</code></pre>
|
|
45
|
+
<blockquote>
|
|
46
|
+
<p><strong>Live</strong> 通过 <a href="http://www.typescriptlang.org/">TypeScript</a> 编写,依赖 <a href="">tslib</a> 运行时,如果你的项目不是由 <a href="http://www.typescriptlang.org/">TypeScript</a> 构成,请安装此运行时。</p>
|
|
47
|
+
</blockquote>
|
|
45
48
|
|
|
46
49
|
<a href="#如何使用" id="如何使用" style="color: inherit; text-decoration: none;">
|
|
47
50
|
<h3>如何使用</h3>
|
|
@@ -319,6 +322,34 @@ SDKs(iOS/Android/微信小程序)和 Live API 可以快速实现实时同屏
|
|
|
319
322
|
<pre><code class="hljs language-js"><span class="hl-0">// 状态:用户是否成功加入语音房间</span><br/><span class="hl-3">live</span><span class="hl-1">.</span><span class="hl-3">$RTC</span><span class="hl-1">.</span><span class="hl-3">joined</span><br/><span class="hl-0">// 状态:用户麦克风状态</span><br/><span class="hl-3">live</span><span class="hl-1">.</span><span class="hl-3">$RTC</span><span class="hl-1">.</span><span class="hl-3">micro</span><br/><span class="hl-0">// 监听用户音量变化</span><br/><span class="hl-3">live</span><span class="hl-1">.</span><span class="hl-3">$RTC</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-4">'userVolumes'</span><span class="hl-1">, (</span><span class="hl-3">userVolumes</span><span class="hl-1">) </span><span class="hl-5">=></span><span class="hl-1"> {})</span>
|
|
320
323
|
</code></pre>
|
|
321
324
|
|
|
325
|
+
<a href="#浏览器端支持" id="浏览器端支持" style="color: inherit; text-decoration: none;">
|
|
326
|
+
<h2>浏览器端支持</h2>
|
|
327
|
+
</a>
|
|
328
|
+
<p>不同于客户端(Android\iOS) 已经内置 <strong>RTC</strong> 能力,浏览器端需要我们自己安装 第三方 <strong>RTC SDK</strong> 依赖。 <strong>Live</strong> 内置 腾讯<a href="https://github.com/tencentyun/TRTCSDK/blob/HEAD/Web/README-zh_CN.md">TRTC</a> 和 亚马逊<a href="https://github.com/aws/amazon-chime-sdk-js">Chime</a> 两个语音能力集成实现。</p>
|
|
329
|
+
<blockquote>
|
|
330
|
+
<p>纯浏览器端不需要 <strong>Native</strong> 中转能力,没有 <strong>jsBridge</strong> 依赖。</p>
|
|
331
|
+
</blockquote>
|
|
332
|
+
|
|
333
|
+
<a href="#trtc" id="trtc" style="color: inherit; text-decoration: none;">
|
|
334
|
+
<h3>TRTC</h3>
|
|
335
|
+
</a>
|
|
336
|
+
<p>安装依赖:</p>
|
|
337
|
+
<pre><code class="hljs language-shell"><span class="hl-0"># 需要您自行安装</span><br/><span class="hl-1">yarn add trtc-js-sdk</span>
|
|
338
|
+
</code></pre>
|
|
339
|
+
<p>使用方式:</p>
|
|
340
|
+
<pre><code class="hljs language-tsx"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-3">createLive</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-4">'@realsee/live'</span><br/><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-3">BrowserRTC</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-4">'@realsee/live/RTC/BrowserRTC'</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">rtcInstance</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-7">VRWebViewRTC</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-7">getVoiceSign</span><span class="hl-3">:</span><span class="hl-1"> () </span><span class="hl-5">=></span><span class="hl-1"> {},</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">live</span><span class="hl-1"> = </span><span class="hl-7">createLive</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-3">rtc:</span><span class="hl-1"> </span><span class="hl-3">rtcInstance</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">getTicket</span><span class="hl-3">:</span><span class="hl-1"> </span><span class="hl-5">async</span><span class="hl-1"> () </span><span class="hl-5">=></span><span class="hl-1"> </span><span class="hl-4">''</span><span class="hl-1">,</span><br/><span class="hl-1">})</span>
|
|
341
|
+
</code></pre>
|
|
342
|
+
|
|
343
|
+
<a href="#chime" id="chime" style="color: inherit; text-decoration: none;">
|
|
344
|
+
<h3>Chime</h3>
|
|
345
|
+
</a>
|
|
346
|
+
<p>安装依赖:</p>
|
|
347
|
+
<pre><code class="hljs language-shell"><span class="hl-0"># 需要您自行安装</span><br/><span class="hl-1">yarn add amazon-chime-sdk-js</span>
|
|
348
|
+
</code></pre>
|
|
349
|
+
<p>使用方式:</p>
|
|
350
|
+
<pre><code class="hljs language-tsx"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-3">createLive</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-4">'@realsee/live'</span><br/><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-3">BrowserRTC4Chime</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-4">'@realsee/live/RTC/BrowserRTC4Chime'</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">rtcInstance</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-7">BrowserRTC4Chime</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-7">getVoiceSign</span><span class="hl-3">:</span><span class="hl-1"> () </span><span class="hl-5">=></span><span class="hl-1"> {},</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">live</span><span class="hl-1"> = </span><span class="hl-7">createLive</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-3">rtc:</span><span class="hl-1"> </span><span class="hl-3">rtcInstance</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">getTicket</span><span class="hl-3">:</span><span class="hl-1"> </span><span class="hl-5">async</span><span class="hl-1"> () </span><span class="hl-5">=></span><span class="hl-1"> </span><span class="hl-4">''</span><span class="hl-1">,</span><br/><span class="hl-1">})</span>
|
|
351
|
+
</code></pre>
|
|
352
|
+
|
|
322
353
|
<a href="#typescript-amp-react-支持" id="typescript-amp-react-支持" style="color: inherit; text-decoration: none;">
|
|
323
354
|
<h2>TypeScript & React 支持</h2>
|
|
324
355
|
</a>
|
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GetVoiceSignReturnType | 如视 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="../modules/RTCProtocol.html">RTCProtocol</a></li><li><a href="RTCProtocol.GetVoiceSignReturnType.html">GetVoiceSignReturnType</a></li></ul><h1>Interface GetVoiceSignReturnType</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">GetVoiceSignReturnType</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="RTCProtocol.GetVoiceSignReturnType.html#roomId" class="tsd-kind-icon">room<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.GetVoiceSignReturnType.html#sdkAppId" class="tsd-kind-icon">sdk<wbr/>App<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.GetVoiceSignReturnType.html#userId" class="tsd-kind-icon">user<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.GetVoiceSignReturnType.html#userSig" class="tsd-kind-icon">user<wbr/>Sig</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="roomId" class="tsd-anchor"></a><h3>room<wbr/>Id
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GetVoiceSignReturnType | 如视 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="../modules/RTCProtocol.html">RTCProtocol</a></li><li><a href="RTCProtocol.GetVoiceSignReturnType.html">GetVoiceSignReturnType</a></li></ul><h1>Interface GetVoiceSignReturnType</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">GetVoiceSignReturnType</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="RTCProtocol.GetVoiceSignReturnType.html#roomId" class="tsd-kind-icon">room<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.GetVoiceSignReturnType.html#sdkAppId" class="tsd-kind-icon">sdk<wbr/>App<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.GetVoiceSignReturnType.html#userId" class="tsd-kind-icon">user<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.GetVoiceSignReturnType.html#userSig" class="tsd-kind-icon">user<wbr/>Sig</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="roomId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">room<wbr/>Id<a href="#roomId" 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">room<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in typings/GetVoiceSign.ts:4</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sdkAppId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">sdk<wbr/>App<wbr/>Id<a href="#sdkAppId" 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">sdk<wbr/>App<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in typings/GetVoiceSign.ts:2</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="userId" class="tsd-anchor"></a><h3 class="tsd-anchor-link">user<wbr/>Id<a href="#userId" 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">user<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in typings/GetVoiceSign.ts:3</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="userSig" class="tsd-anchor"></a><h3 class="tsd-anchor-link">user<wbr/>Sig<a href="#userSig" 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">user<wbr/>Sig<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in typings/GetVoiceSign.ts:5</li></ul></aside></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">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/RTCProtocol.html">RTCProtocol</a></li><li class=" tsd-kind-module"><a href="../modules/live.html">live</a></li><li class=" tsd-kind-module"><a href="../modules/shared_utils.html">shared-<wbr/>utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="RTCProtocol.GetVoiceSignReturnType.html" class="tsd-kind-icon">Get<wbr/>Voice<wbr/>Sign<wbr/>Return<wbr/>Type</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.GetVoiceSignReturnType.html#roomId" class="tsd-kind-icon">room<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.GetVoiceSignReturnType.html#sdkAppId" class="tsd-kind-icon">sdk<wbr/>App<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.GetVoiceSignReturnType.html#userId" class="tsd-kind-icon">user<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.GetVoiceSignReturnType.html#userSig" class="tsd-kind-icon">user<wbr/>Sig</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-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RTCJoinedInfo | 如视 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="../modules/RTCProtocol.html">RTCProtocol</a></li><li><a href="RTCProtocol.RTCJoinedInfo.html">RTCJoinedInfo</a></li></ul><h1>Interface RTCJoinedInfo</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">RTCJoinedInfo</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="RTCProtocol.RTCJoinedInfo.html#code" class="tsd-kind-icon">code</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#errInfo" class="tsd-kind-icon">err<wbr/>Info</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#roomId" class="tsd-kind-icon">room<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#userId" class="tsd-kind-icon">user<wbr/>Id</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="code" class="tsd-anchor"></a><h3>code</h3><div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <a href="../enums/RTCProtocol.RTCJoinedInfoCodeEnum.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCJoinedInfoCodeEnum</a></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:22</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="errInfo" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> err<wbr/>Info</h3><div class="tsd-signature tsd-kind-icon">err<wbr/>Info<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>trtcErrCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>trtcErrMsg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:26</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>trtc<wbr/>Err<wbr/>Code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>trtc<wbr/>Err<wbr/>Msg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="message" class="tsd-anchor"></a><h3>message</h3><div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="roomId" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> room<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">room<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:25</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="userId" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> user<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">user<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:24</li></ul></aside></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">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/RTCProtocol.html">RTCProtocol</a></li><li class=" tsd-kind-module"><a href="../modules/live.html">live</a></li><li class=" tsd-kind-module"><a href="../modules/shared_utils.html">shared-<wbr/>utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="RTCProtocol.RTCJoinedInfo.html" class="tsd-kind-icon">RTCJoined<wbr/>Info</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#code" class="tsd-kind-icon">code</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#errInfo" class="tsd-kind-icon">err<wbr/>Info</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#roomId" class="tsd-kind-icon">room<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#userId" class="tsd-kind-icon">user<wbr/>Id</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-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RTCJoinedInfo | 如视 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="../modules/RTCProtocol.html">RTCProtocol</a></li><li><a href="RTCProtocol.RTCJoinedInfo.html">RTCJoinedInfo</a></li></ul><h1>Interface RTCJoinedInfo</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">RTCJoinedInfo</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="RTCProtocol.RTCJoinedInfo.html#code" class="tsd-kind-icon">code</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#errInfo" class="tsd-kind-icon">err<wbr/>Info</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#roomId" class="tsd-kind-icon">room<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#userId" class="tsd-kind-icon">user<wbr/>Id</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="code" class="tsd-anchor"></a><h3 class="tsd-anchor-link">code<a href="#code" 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">code<span class="tsd-signature-symbol">:</span> <a href="../enums/RTCProtocol.RTCJoinedInfoCodeEnum.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCJoinedInfoCodeEnum</a></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:22</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="errInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> err<wbr/>Info<a href="#errInfo" 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">err<wbr/>Info<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>trtcErrCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>trtcErrMsg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:26</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>trtc<wbr/>Err<wbr/>Code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>trtc<wbr/>Err<wbr/>Msg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link">message<a href="#message" 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">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="roomId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> room<wbr/>Id<a href="#roomId" 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">room<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:25</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="userId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> user<wbr/>Id<a href="#userId" 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">user<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:24</li></ul></aside></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">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/RTCProtocol.html">RTCProtocol</a></li><li class=" tsd-kind-module"><a href="../modules/live.html">live</a></li><li class=" tsd-kind-module"><a href="../modules/shared_utils.html">shared-<wbr/>utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="RTCProtocol.RTCJoinedInfo.html" class="tsd-kind-icon">RTCJoined<wbr/>Info</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#code" class="tsd-kind-icon">code</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#errInfo" class="tsd-kind-icon">err<wbr/>Info</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#message" class="tsd-kind-icon">message</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#roomId" class="tsd-kind-icon">room<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCJoinedInfo.html#userId" class="tsd-kind-icon">user<wbr/>Id</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-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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>
|