@realsee/live 0.3.0-alpha.2 → 0.4.0-alpha.1

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.
Files changed (147) hide show
  1. package/dist/index.d.ts +4 -0
  2. package/dist/live/controller.d.ts +43 -0
  3. package/{lib → dist/live}/createLive.d.ts +6 -6
  4. package/dist/live/createLiveReact.d.ts +6 -0
  5. package/dist/realsee-live.cjs.development.js +52517 -0
  6. package/dist/realsee-live.cjs.development.js.map +1 -0
  7. package/dist/realsee-live.cjs.js +7 -0
  8. package/dist/realsee-live.cjs.production.js +2 -0
  9. package/dist/realsee-live.cjs.production.js.map +1 -0
  10. package/dist/realsee-live.esm.js +52506 -0
  11. package/dist/realsee-live.esm.js.map +1 -0
  12. package/dist/realsee-live.umd.development.js +52454 -0
  13. package/dist/realsee-live.umd.development.js.map +1 -0
  14. package/dist/realsee-live.umd.production.js +2 -0
  15. package/dist/realsee-live.umd.production.js.map +1 -0
  16. package/{lib/RTC → dist/rtc}/BrowserRTC.d.ts +29 -30
  17. package/{lib/RTC → dist/rtc}/BrowserRTC4Chime.d.ts +55 -53
  18. package/dist/rtc/CoreRTC.d.ts +23 -0
  19. package/{lib/RTC → dist/rtc}/VRWebViewRTC.d.ts +22 -23
  20. package/dist/rtc/index.d.ts +5 -0
  21. package/{lib/typings/Chime → dist/typings/chime}/AttendeeResponse.d.ts +5 -5
  22. package/{lib/typings/Chime → dist/typings/chime}/MeetingResponse.d.ts +12 -12
  23. package/{lib/typings/Chime → dist/typings/chime}/MeetingSessionConfigurationOptions.d.ts +16 -16
  24. package/dist/typings/chime/index.d.ts +3 -0
  25. package/dist/typings/index.d.ts +4 -0
  26. package/{lib/typings → dist/typings/live}/EventType.d.ts +90 -89
  27. package/{lib/typings → dist/typings/live}/GetVoiceSign.d.ts +17 -11
  28. package/{lib/typings → dist/typings/live}/Live.d.ts +123 -122
  29. package/{lib/typings → dist/typings/live}/LiveMsg.d.ts +119 -119
  30. package/{lib/typings → dist/typings/live}/LiveOptions.d.ts +65 -46
  31. package/{lib/typings → dist/typings/live}/RoomInfo.d.ts +13 -13
  32. package/{lib/typings → dist/typings/live}/UserInfo.d.ts +87 -87
  33. package/dist/typings/live/UserVolume.d.ts +7 -0
  34. package/{lib/typings → dist/typings/live}/WebSocket.d.ts +78 -78
  35. package/dist/typings/live/index.d.ts +9 -0
  36. package/{lib/createLiveReact.d.ts → dist/typings/react/LiveReact.d.ts} +162 -160
  37. package/dist/typings/react/RTCActionReactCallback.d.ts +2 -0
  38. package/dist/typings/react/index.d.ts +2 -0
  39. package/dist/typings/rtc/VRWebViewRTCOptions.d.ts +6 -0
  40. package/{lib/typings/RTCEventType.d.ts → dist/typings/rtc/eventType.d.ts} +29 -35
  41. package/dist/typings/rtc/index.d.ts +5 -0
  42. package/{lib/typings/RTCJoinedInfo.d.ts → dist/typings/rtc/joinedInfo.d.ts} +34 -28
  43. package/{lib/typings/RTCProtocol.d.ts → dist/typings/rtc/protocol.d.ts} +53 -42
  44. package/dist/typings/rtc/type.d.ts +8 -0
  45. package/{lib/shared-utils → dist/utils}/appendUri.d.ts +1 -1
  46. package/dist/utils/clientDetector.d.ts +4 -0
  47. package/{lib/shared-utils → dist/utils}/equal.d.ts +10 -11
  48. package/{lib/shared-utils/Subscribe.d.ts → dist/utils/subscribe.d.ts} +75 -76
  49. package/{lib/shared-utils → dist/utils}/uuid.d.ts +4 -4
  50. package/package.json +22 -36
  51. package/docs/.nojekyll +0 -1
  52. package/docs/assets/custom.css +0 -43
  53. package/docs/assets/highlight.css +0 -127
  54. package/docs/assets/icons.css +0 -1043
  55. package/docs/assets/icons.png +0 -0
  56. package/docs/assets/icons@2x.png +0 -0
  57. package/docs/assets/main.js +0 -52
  58. package/docs/assets/search.js +0 -1
  59. package/docs/assets/style.css +0 -1388
  60. package/docs/assets/widgets.png +0 -0
  61. package/docs/assets/widgets@2x.png +0 -0
  62. package/docs/classes/RTCProtocol.BrowserRTC.html +0 -60
  63. package/docs/classes/RTCProtocol.BrowserRTC4Chime.html +0 -66
  64. package/docs/classes/RTCProtocol.RTCExample.html +0 -62
  65. package/docs/classes/RTCProtocol.VRWebViewRTC.html +0 -60
  66. package/docs/classes/shared_utils.Subscribe.html +0 -56
  67. package/docs/enums/RTCProtocol.RTCJoinedInfoCodeEnum.html +0 -9
  68. package/docs/enums/RTCProtocol.RTCType.html +0 -1
  69. package/docs/enums/live.BuiltinActionType.html +0 -15
  70. package/docs/enums/live.BuiltinEventType.html +0 -7
  71. package/docs/enums/live.Command.html +0 -7
  72. package/docs/enums/live.MemUserStatus.html +0 -1
  73. package/docs/enums/live.MicroStatus.html +0 -3
  74. package/docs/enums/live.UserStatus.html +0 -9
  75. package/docs/enums/live.WebSocketCloseError.html +0 -19
  76. package/docs/enums/live.WebSocketErrorType.html +0 -1
  77. package/docs/enums/live.WebSocketState.html +0 -13
  78. package/docs/index.html +0 -382
  79. package/docs/interfaces/RTCProtocol.GetVoiceSignReturnType.html +0 -1
  80. package/docs/interfaces/RTCProtocol.RTCJoinedInfo.html +0 -1
  81. package/docs/interfaces/RTCProtocol.RTCProtocol-1.html +0 -60
  82. package/docs/interfaces/RTCProtocol.VRWebViewRTCOptions.html +0 -1
  83. package/docs/interfaces/live.Live.html +0 -119
  84. package/docs/interfaces/live.LiveOptions.html +0 -22
  85. package/docs/interfaces/live.LiveReact.html +0 -52
  86. package/docs/modules/RTCProtocol.html +0 -17
  87. package/docs/modules/live.html +0 -103
  88. package/docs/modules/shared_utils.html +0 -10
  89. package/docs/modules.html +0 -1
  90. package/lib/RTC/BrowserRTC.js +0 -169
  91. package/lib/RTC/BrowserRTC.js.map +0 -1
  92. package/lib/RTC/BrowserRTC4Chime.js +0 -299
  93. package/lib/RTC/BrowserRTC4Chime.js.map +0 -1
  94. package/lib/RTC/VRWebViewRTC.js +0 -125
  95. package/lib/RTC/VRWebViewRTC.js.map +0 -1
  96. package/lib/RTC/index.d.ts +0 -22
  97. package/lib/RTC/index.js +0 -50
  98. package/lib/RTC/index.js.map +0 -1
  99. package/lib/createLive.js +0 -590
  100. package/lib/createLive.js.map +0 -1
  101. package/lib/createLiveReact.js +0 -212
  102. package/lib/createLiveReact.js.map +0 -1
  103. package/lib/index.d.ts +0 -2
  104. package/lib/index.js +0 -8
  105. package/lib/index.js.map +0 -1
  106. package/lib/shared-utils/Subscribe.js +0 -134
  107. package/lib/shared-utils/Subscribe.js.map +0 -1
  108. package/lib/shared-utils/appendUri.js +0 -13
  109. package/lib/shared-utils/appendUri.js.map +0 -1
  110. package/lib/shared-utils/equal.js +0 -92
  111. package/lib/shared-utils/equal.js.map +0 -1
  112. package/lib/shared-utils/uuid.js +0 -17
  113. package/lib/shared-utils/uuid.js.map +0 -1
  114. package/lib/typings/Chime/AttendeeResponse.js +0 -3
  115. package/lib/typings/Chime/AttendeeResponse.js.map +0 -1
  116. package/lib/typings/Chime/MeetingResponse.js +0 -3
  117. package/lib/typings/Chime/MeetingResponse.js.map +0 -1
  118. package/lib/typings/Chime/MeetingSessionConfigurationOptions.js +0 -3
  119. package/lib/typings/Chime/MeetingSessionConfigurationOptions.js.map +0 -1
  120. package/lib/typings/EventType.js +0 -3
  121. package/lib/typings/EventType.js.map +0 -1
  122. package/lib/typings/GetVoiceSign.js +0 -3
  123. package/lib/typings/GetVoiceSign.js.map +0 -1
  124. package/lib/typings/Live.js +0 -3
  125. package/lib/typings/Live.js.map +0 -1
  126. package/lib/typings/LiveMsg.js +0 -111
  127. package/lib/typings/LiveMsg.js.map +0 -1
  128. package/lib/typings/LiveOptions.js +0 -3
  129. package/lib/typings/LiveOptions.js.map +0 -1
  130. package/lib/typings/RTCEventType.js +0 -3
  131. package/lib/typings/RTCEventType.js.map +0 -1
  132. package/lib/typings/RTCJoinedInfo.js +0 -23
  133. package/lib/typings/RTCJoinedInfo.js.map +0 -1
  134. package/lib/typings/RTCProtocol.js +0 -9
  135. package/lib/typings/RTCProtocol.js.map +0 -1
  136. package/lib/typings/RoomInfo.js +0 -3
  137. package/lib/typings/RoomInfo.js.map +0 -1
  138. package/lib/typings/UserInfo.js +0 -31
  139. package/lib/typings/UserInfo.js.map +0 -1
  140. package/lib/typings/VRWebViewRTCOptions.d.ts +0 -6
  141. package/lib/typings/VRWebViewRTCOptions.js +0 -3
  142. package/lib/typings/VRWebViewRTCOptions.js.map +0 -1
  143. package/lib/typings/WebSocket.js +0 -107
  144. package/lib/typings/WebSocket.js.map +0 -1
  145. package/umd/RTCProtocol.543610f0.js +0 -1
  146. package/umd/createLive.1ecf7dd4.js +0 -1
  147. package/umd/createLiveReact.9075a8fd.js +0 -1
package/docs/classes/shared_utils.Subscribe.html DELETED
@@ -1,56 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Subscribe | 如视 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/shared_utils.html">shared-utils</a></li><li><a href="shared_utils.Subscribe.html">Subscribe</a></li></ul><h1>Class Subscribe&lt;T&gt;</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
- <p>监听者模式</p>
3
- </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-7">Subscribe</span><span class="hl-1">&lt;{</span><br/><span class="hl-4">&quot;foo&quot;</span><span class="hl-1">: [</span><span class="hl-14">arg1</span><span class="hl-1">: </span><span class="hl-9">number</span><span class="hl-1">, </span><span class="hl-14">arg2</span><span class="hl-1">: </span><span class="hl-9">string</span><span class="hl-1">],</span><br/><span class="hl-4">&quot;bar&quot;</span><span class="hl-1">: [</span><span class="hl-14">arg</span><span class="hl-1">: </span><span class="hl-9">boolean</span><span class="hl-1">],</span><br/><span class="hl-1">}&gt;()</span>
4
- </code></pre>
5
- </dd></dl></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules/shared_utils.html#EventMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventMap</a></h4><div class="tsd-comment tsd-typography"><div class="lead">
6
- <p>预设的监听回调类型</p>
7
- </div></div></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Subscribe</span><ul class="tsd-hierarchy"><li><a href="../interfaces/live.Live.html" class="tsd-signature-type" data-tsd-kind="Interface">Live</a></li><li><a href="../interfaces/RTCProtocol.RTCProtocol-1.html" class="tsd-signature-type" data-tsd-kind="Interface">RTCProtocol</a></li><li><a href="RTCProtocol.RTCExample.html" class="tsd-signature-type" data-tsd-kind="Class">RTCExample</a></li><li><a href="RTCProtocol.VRWebViewRTC.html" class="tsd-signature-type" data-tsd-kind="Class">VRWebViewRTC</a></li><li><a href="RTCProtocol.BrowserRTC.html" class="tsd-signature-type" data-tsd-kind="Class">BrowserRTC</a></li><li><a href="RTCProtocol.BrowserRTC4Chime.html" class="tsd-signature-type" data-tsd-kind="Class">BrowserRTC4Chime</a></li></ul></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>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#constructor" class="tsd-kind-icon">constructor</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-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="shared_utils.Subscribe.html#hasListener" class="tsd-kind-icon">has<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#once" class="tsd-kind-icon">once</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>Subscribe<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="shared_utils.Subscribe.html" class="tsd-signature-type" data-tsd-kind="Class">Subscribe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules/shared_utils.html#EventMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventMap</a></h4></li></ul><h4 class="tsd-returns-title">Returns <a href="shared_utils.Subscribe.html" class="tsd-signature-type" data-tsd-kind="Class">Subscribe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></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-class tsd-has-type-parameter"><a id="emit" class="tsd-anchor"></a><h3>emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, <span class="tsd-signature-symbol">...</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</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 shared-utils/Subscribe.ts:127</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
- <p>触发事件</p>
9
- </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>K<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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4><div class="tsd-comment tsd-typography"><div class="lead">
10
- <p>预设的监听事件名称</p>
11
- </div></div></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
12
- <p>事件类型</p>
13
- </div></div></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>data: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
14
- <p>触发事件的数据</p>
15
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>canceled 是否被触发取消</p>
16
- </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="hasListener" class="tsd-anchor"></a><h3>has<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">has<wbr/>Listener<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</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 shared-utils/Subscribe.ts:48</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
17
- <p>判断是否注册了事件</p>
18
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
19
- <p>事件类型</p>
20
- </div></div></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-class tsd-has-type-parameter"><a id="off" class="tsd-anchor"></a><h3>off</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in shared-utils/Subscribe.ts:97</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
21
- <p>解除事件</p>
22
- </div><div><p>如果 name 不传的话解除对应所有事件
23
- 如果 name, callback 不传的话解除所有name的所有事件</p>
24
- </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>K<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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4><div class="tsd-comment tsd-typography"><div class="lead">
25
- <p>预设的监听事件名称</p>
26
- </div></div></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> name: <span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
27
- <p>事件类型</p>
28
- </div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
29
- <p>事件回调函数</p>
30
- </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="on" class="tsd-anchor"></a><h3>on</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span>, once<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in shared-utils/Subscribe.ts:62</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
31
- <p>注册事件</p>
32
- </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>K<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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4><div class="tsd-comment tsd-typography"><div class="lead">
33
- <p>预设的监听事件名称</p>
34
- </div></div></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
35
- <p>事件类型</p>
36
- </div></div></li><li><h5>callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
37
- <p>事件回调函数</p>
38
- </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> once: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
39
- <p>是否只执行一次</p>
40
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h4><div><p>解除事件</p>
41
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
42
- <p>注册事件</p>
43
- </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>解除事件</p>
44
- </div></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="once" class="tsd-anchor"></a><h3>once</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in shared-utils/Subscribe.ts:81</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
45
- <p>注册事件(是否只执行一次)</p>
46
- </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>K<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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4><div class="tsd-comment tsd-typography"><div class="lead">
47
- <p>预设的监听事件名称</p>
48
- </div></div></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
49
- <p>事件类型</p>
50
- </div></div></li><li><h5>callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
51
- <p>事件回调函数</p>
52
- </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h4><div><p>解除事件</p>
53
- </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
54
- <p>注册事件(是否只执行一次)</p>
55
- </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>解除事件</p>
56
- </div></li></ul></li></ul></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">Modules</a></li><li class=" 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="current 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-class tsd-parent-kind-module tsd-has-type-parameter"><a href="shared_utils.Subscribe.html" class="tsd-kind-icon">Subscribe</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="shared_utils.Subscribe.html#hasListener" class="tsd-kind-icon">has<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#once" class="tsd-kind-icon">once</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-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><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-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-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/enums/RTCProtocol.RTCJoinedInfoCodeEnum.html DELETED
@@ -1,9 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RTCJoinedInfoCodeEnum | 如视 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.RTCJoinedInfoCodeEnum.html">RTCJoinedInfoCodeEnum</a></li></ul><h1>Enumeration RTCJoinedInfoCodeEnum</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="RTCProtocol.RTCJoinedInfoCodeEnum.html#Failure" class="tsd-kind-icon">Failure</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="RTCProtocol.RTCJoinedInfoCodeEnum.html#NoMicroPermission" class="tsd-kind-icon">No<wbr/>Micro<wbr/>Permission</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="RTCProtocol.RTCJoinedInfoCodeEnum.html#ReJoin" class="tsd-kind-icon">Re<wbr/>Join</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="RTCProtocol.RTCJoinedInfoCodeEnum.html#Success" class="tsd-kind-icon">Success</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="Failure" class="tsd-anchor"></a><h3>Failure</h3><div class="tsd-signature tsd-kind-icon">Failure<span class="tsd-signature-symbol"> = 1</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:10</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="NoMicroPermission" class="tsd-anchor"></a><h3>No<wbr/>Micro<wbr/>Permission</h3><div class="tsd-signature tsd-kind-icon">No<wbr/>Micro<wbr/>Permission<span class="tsd-signature-symbol"> = 3</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:18</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="ReJoin" class="tsd-anchor"></a><h3>Re<wbr/>Join</h3><div class="tsd-signature tsd-kind-icon">Re<wbr/>Join<span class="tsd-signature-symbol"> = 2</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:14</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
- <p>重复加入</p>
7
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Success" class="tsd-anchor"></a><h3>Success</h3><div class="tsd-signature tsd-kind-icon">Success<span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCJoinedInfo.ts:6</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
- <p>成功</p>
9
- </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="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-enum tsd-parent-kind-module"><a href="RTCProtocol.RTCJoinedInfoCodeEnum.html" class="tsd-kind-icon">RTCJoined<wbr/>Info<wbr/>Code<wbr/>Enum</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="RTCProtocol.RTCJoinedInfoCodeEnum.html#Failure" class="tsd-kind-icon">Failure</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="RTCProtocol.RTCJoinedInfoCodeEnum.html#NoMicroPermission" class="tsd-kind-icon">No<wbr/>Micro<wbr/>Permission</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="RTCProtocol.RTCJoinedInfoCodeEnum.html#ReJoin" class="tsd-kind-icon">Re<wbr/>Join</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="RTCProtocol.RTCJoinedInfoCodeEnum.html#Success" class="tsd-kind-icon">Success</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/enums/RTCProtocol.RTCType.html DELETED
@@ -1 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RTCType | 如视 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.RTCType.html">RTCType</a></li></ul><h1>Enumeration RTCType</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="RTCProtocol.RTCType.html#custom" class="tsd-kind-icon">custom</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="RTCProtocol.RTCType.html#realsee" class="tsd-kind-icon">realsee</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="custom" class="tsd-anchor"></a><h3>custom</h3><div class="tsd-signature tsd-kind-icon">custom<span class="tsd-signature-symbol"> = &quot;custom&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:6</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="realsee" class="tsd-anchor"></a><h3>realsee</h3><div class="tsd-signature tsd-kind-icon">realsee<span class="tsd-signature-symbol"> = &quot;realsee&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.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-enum tsd-parent-kind-module"><a href="RTCProtocol.RTCType.html" class="tsd-kind-icon">RTCType</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="RTCProtocol.RTCType.html#custom" class="tsd-kind-icon">custom</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="RTCProtocol.RTCType.html#realsee" class="tsd-kind-icon">realsee</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/enums/live.BuiltinActionType.html DELETED
@@ -1,15 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BuiltinActionType | 如视 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.BuiltinActionType.html">BuiltinActionType</a></li></ul><h1>Enumeration BuiltinActionType</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
- <p>内置事件行为类型。</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.BuiltinActionType.html#RoomClose" class="tsd-kind-icon">Room<wbr/>Close</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinActionType.html#UserInfo" class="tsd-kind-icon">User<wbr/>Info</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinActionType.html#UserMicroStatus" class="tsd-kind-icon">User<wbr/>Micro<wbr/>Status</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinActionType.html#UserMicroStatusSync" class="tsd-kind-icon">User<wbr/>Micro<wbr/>Status<wbr/>Sync</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinActionType.html#UserPermission" class="tsd-kind-icon">User<wbr/>Permission</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinActionType.html#UserStatus" class="tsd-kind-icon">User<wbr/>Status</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="RoomClose" class="tsd-anchor"></a><h3>Room<wbr/>Close</h3><div class="tsd-signature tsd-kind-icon">Room<wbr/>Close<span class="tsd-signature-symbol"> = &quot;close&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:90</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="UserInfo" class="tsd-anchor"></a><h3>User<wbr/>Info</h3><div class="tsd-signature tsd-kind-icon">User<wbr/>Info<span class="tsd-signature-symbol"> = &quot;change_info&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:86</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
- <p>更新用户信息。</p>
7
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="UserMicroStatus" class="tsd-anchor"></a><h3>User<wbr/>Micro<wbr/>Status</h3><div class="tsd-signature tsd-kind-icon">User<wbr/>Micro<wbr/>Status<span class="tsd-signature-symbol"> = &quot;change_micro_status&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:70</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
- <p>修改麦克风状态。</p>
9
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="UserMicroStatusSync" class="tsd-anchor"></a><h3>User<wbr/>Micro<wbr/>Status<wbr/>Sync</h3><div class="tsd-signature tsd-kind-icon">User<wbr/>Micro<wbr/>Status<wbr/>Sync<span class="tsd-signature-symbol"> = &quot;sync_micro_status&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:74</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
10
- <p>同步当前用户状态：客户端麦克风状态已经修改成功，通知服务端</p>
11
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="UserPermission" class="tsd-anchor"></a><h3>User<wbr/>Permission</h3><div class="tsd-signature tsd-kind-icon">User<wbr/>Permission<span class="tsd-signature-symbol"> = &quot;change_permission&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:78</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-enum-member tsd-parent-kind-enum"><a id="UserStatus" class="tsd-anchor"></a><h3>User<wbr/>Status</h3><div class="tsd-signature tsd-kind-icon">User<wbr/>Status<span class="tsd-signature-symbol"> = &quot;change_status&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:82</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
14
- <p>用户状态发生改变。</p>
15
- </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.BuiltinActionType.html" class="tsd-kind-icon">Builtin<wbr/>Action<wbr/>Type</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinActionType.html#RoomClose" class="tsd-kind-icon">Room<wbr/>Close</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinActionType.html#UserInfo" class="tsd-kind-icon">User<wbr/>Info</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinActionType.html#UserMicroStatus" class="tsd-kind-icon">User<wbr/>Micro<wbr/>Status</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinActionType.html#UserMicroStatusSync" class="tsd-kind-icon">User<wbr/>Micro<wbr/>Status<wbr/>Sync</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinActionType.html#UserPermission" class="tsd-kind-icon">User<wbr/>Permission</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinActionType.html#UserStatus" class="tsd-kind-icon">User<wbr/>Status</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/enums/live.BuiltinEventType.html DELETED
@@ -1,7 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BuiltinEventType | 如视 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.BuiltinEventType.html">BuiltinEventType</a></li></ul><h1>Enumeration BuiltinEventType</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
- <p>内置事件类型。</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.BuiltinEventType.html#RoomChange" class="tsd-kind-icon">Room<wbr/>Change</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinEventType.html#UserChange" class="tsd-kind-icon">User<wbr/>Change</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="RoomChange" class="tsd-anchor"></a><h3>Room<wbr/>Change</h3><div class="tsd-signature tsd-kind-icon">Room<wbr/>Change<span class="tsd-signature-symbol"> = &quot;room_change&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:60</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="UserChange" class="tsd-anchor"></a><h3>User<wbr/>Change</h3><div class="tsd-signature tsd-kind-icon">User<wbr/>Change<span class="tsd-signature-symbol"> = &quot;user_change&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:56</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">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.BuiltinEventType.html" class="tsd-kind-icon">Builtin<wbr/>Event<wbr/>Type</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinEventType.html#RoomChange" class="tsd-kind-icon">Room<wbr/>Change</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.BuiltinEventType.html#UserChange" class="tsd-kind-icon">User<wbr/>Change</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/enums/live.Command.html DELETED
@@ -1,7 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Command | 如视 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.Command.html">Command</a></li></ul><h1>Enumeration Command</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
- <p>WebSocket 通信指令</p>
3
- <ul>
4
- <li>下行：服务端推送数据</li>
5
- <li>上行：客户端上报数据</li>
6
- </ul>
7
- </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.Command.html#BuiltinMsg" class="tsd-kind-icon">Builtin<wbr/>Msg</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#CustomEvent" class="tsd-kind-icon">Custom<wbr/>Event</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#KeyframeSync" class="tsd-kind-icon">Keyframe<wbr/>Sync</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#RTCInfo" class="tsd-kind-icon">RTCInfo</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#RoomInfo" class="tsd-kind-icon">Room<wbr/>Info</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#SelfUserInfo" class="tsd-kind-icon">Self<wbr/>User<wbr/>Info</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#UserKickOut" class="tsd-kind-icon">User<wbr/>Kick<wbr/>Out</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#UserList" class="tsd-kind-icon">User<wbr/>List</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="BuiltinMsg" class="tsd-anchor"></a><h3>Builtin<wbr/>Msg</h3><div class="tsd-signature tsd-kind-icon">Builtin<wbr/>Msg<span class="tsd-signature-symbol"> = &quot;BUILTIN_MSG&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:16</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="CustomEvent" class="tsd-anchor"></a><h3>Custom<wbr/>Event</h3><div class="tsd-signature tsd-kind-icon">Custom<wbr/>Event<span class="tsd-signature-symbol"> = &quot;CUSTOM_EVENT&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="KeyframeSync" class="tsd-anchor"></a><h3>Keyframe<wbr/>Sync</h3><div class="tsd-signature tsd-kind-icon">Keyframe<wbr/>Sync<span class="tsd-signature-symbol"> = &quot;KEYFRAME_SYNC&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:20</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="RTCInfo" class="tsd-anchor"></a><h3>RTCInfo</h3><div class="tsd-signature tsd-kind-icon">RTCInfo<span class="tsd-signature-symbol"> = &quot;RTC_INFO&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:12</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="RoomInfo" class="tsd-anchor"></a><h3>Room<wbr/>Info</h3><div class="tsd-signature tsd-kind-icon">Room<wbr/>Info<span class="tsd-signature-symbol"> = &quot;ROOM_INFO&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:10</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="SelfUserInfo" class="tsd-anchor"></a><h3>Self<wbr/>User<wbr/>Info</h3><div class="tsd-signature tsd-kind-icon">Self<wbr/>User<wbr/>Info<span class="tsd-signature-symbol"> = &quot;SELF_USER_INFO&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:8</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="UserKickOut" class="tsd-anchor"></a><h3>User<wbr/>Kick<wbr/>Out</h3><div class="tsd-signature tsd-kind-icon">User<wbr/>Kick<wbr/>Out<span class="tsd-signature-symbol"> = &quot;USER_KICK_OUT&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:22</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="UserList" class="tsd-anchor"></a><h3>User<wbr/>List</h3><div class="tsd-signature tsd-kind-icon">User<wbr/>List<span class="tsd-signature-symbol"> = &quot;USER_LIST&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:14</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.Command.html" class="tsd-kind-icon">Command</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#BuiltinMsg" class="tsd-kind-icon">Builtin<wbr/>Msg</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#CustomEvent" class="tsd-kind-icon">Custom<wbr/>Event</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#KeyframeSync" class="tsd-kind-icon">Keyframe<wbr/>Sync</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#RTCInfo" class="tsd-kind-icon">RTCInfo</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#RoomInfo" class="tsd-kind-icon">Room<wbr/>Info</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#SelfUserInfo" class="tsd-kind-icon">Self<wbr/>User<wbr/>Info</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#UserKickOut" class="tsd-kind-icon">User<wbr/>Kick<wbr/>Out</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.Command.html#UserList" class="tsd-kind-icon">User<wbr/>List</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/enums/live.MemUserStatus.html DELETED
@@ -1 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MemUserStatus | 如视 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.MemUserStatus.html">MemUserStatus</a></li></ul><h1>Enumeration MemUserStatus</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.MemUserStatus.html#BE_REPLACE" class="tsd-kind-icon">BE_<wbr/>REPLACE</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MemUserStatus.html#EXCEPTION" class="tsd-kind-icon">EXCEPTION</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MemUserStatus.html#KICK_OUT" class="tsd-kind-icon">KICK_<wbr/>OUT</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MemUserStatus.html#LEAVE" class="tsd-kind-icon">LEAVE</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MemUserStatus.html#ONLINE" class="tsd-kind-icon">ONLINE</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MemUserStatus.html#WAIT_ENTER" class="tsd-kind-icon">WAIT_<wbr/>ENTER</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="BE_REPLACE" class="tsd-anchor"></a><h3>BE_<wbr/>REPLACE</h3><div class="tsd-signature tsd-kind-icon">BE_<wbr/>REPLACE<span class="tsd-signature-symbol"> = &quot;BE_REPLACE&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/UserInfo.ts:24</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="EXCEPTION" class="tsd-anchor"></a><h3>EXCEPTION</h3><div class="tsd-signature tsd-kind-icon">EXCEPTION<span class="tsd-signature-symbol"> = &quot;EXCEPTION&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/UserInfo.ts:25</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="KICK_OUT" class="tsd-anchor"></a><h3>KICK_<wbr/>OUT</h3><div class="tsd-signature tsd-kind-icon">KICK_<wbr/>OUT<span class="tsd-signature-symbol"> = &quot;KICK_OUT&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/UserInfo.ts:23</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="LEAVE" class="tsd-anchor"></a><h3>LEAVE</h3><div class="tsd-signature tsd-kind-icon">LEAVE<span class="tsd-signature-symbol"> = &quot;LEAVE&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/UserInfo.ts:22</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ONLINE" class="tsd-anchor"></a><h3>ONLINE</h3><div class="tsd-signature tsd-kind-icon">ONLINE<span class="tsd-signature-symbol"> = &quot;ONLINE&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/UserInfo.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="WAIT_ENTER" class="tsd-anchor"></a><h3>WAIT_<wbr/>ENTER</h3><div class="tsd-signature tsd-kind-icon">WAIT_<wbr/>ENTER<span class="tsd-signature-symbol"> = &quot;WAIT_ENTER&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/UserInfo.ts:20</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.MemUserStatus.html" class="tsd-kind-icon">Mem<wbr/>User<wbr/>Status</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MemUserStatus.html#BE_REPLACE" class="tsd-kind-icon">BE_<wbr/>REPLACE</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MemUserStatus.html#EXCEPTION" class="tsd-kind-icon">EXCEPTION</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MemUserStatus.html#KICK_OUT" class="tsd-kind-icon">KICK_<wbr/>OUT</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MemUserStatus.html#LEAVE" class="tsd-kind-icon">LEAVE</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MemUserStatus.html#ONLINE" class="tsd-kind-icon">ONLINE</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MemUserStatus.html#WAIT_ENTER" class="tsd-kind-icon">WAIT_<wbr/>ENTER</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/enums/live.MicroStatus.html DELETED
@@ -1,3 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MicroStatus | 如视 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.MicroStatus.html">MicroStatus</a></li></ul><h1>Enumeration MicroStatus</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
- <p>麦克风状态。</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.MicroStatus.html#CLOSE" class="tsd-kind-icon">CLOSE</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MicroStatus.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="CLOSE" class="tsd-anchor"></a><h3>CLOSE</h3><div class="tsd-signature tsd-kind-icon">CLOSE<span class="tsd-signature-symbol"> = &quot;CLOSE&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:113</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>OPEN</h3><div class="tsd-signature tsd-kind-icon">OPEN<span class="tsd-signature-symbol"> = &quot;OPEN&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/LiveMsg.ts:112</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.MicroStatus.html" class="tsd-kind-icon">Micro<wbr/>Status</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MicroStatus.html#CLOSE" class="tsd-kind-icon">CLOSE</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.MicroStatus.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/enums/live.UserStatus.html DELETED
@@ -1,9 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UserStatus | 如视 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.UserStatus.html">UserStatus</a></li></ul><h1>Enumeration UserStatus</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
- <p>用户当前状态枚举。</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.UserStatus.html#Normal" class="tsd-kind-icon">Normal</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.UserStatus.html#Removed" class="tsd-kind-icon">Removed</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.UserStatus.html#Replaced" class="tsd-kind-icon">Replaced</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="Normal" class="tsd-anchor"></a><h3>Normal</h3><div class="tsd-signature tsd-kind-icon">Normal<span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in typings/UserInfo.ts:8</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="Removed" class="tsd-anchor"></a><h3>Removed</h3><div class="tsd-signature tsd-kind-icon">Removed<span class="tsd-signature-symbol"> = 1</span></div><aside class="tsd-sources"><ul><li>Defined in typings/UserInfo.ts:12</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
- <p>被移除</p>
7
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Replaced" class="tsd-anchor"></a><h3>Replaced</h3><div class="tsd-signature tsd-kind-icon">Replaced<span class="tsd-signature-symbol"> = 2</span></div><aside class="tsd-sources"><ul><li>Defined in typings/UserInfo.ts:16</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
- <p>被替换</p>
9
- </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.UserStatus.html" class="tsd-kind-icon">User<wbr/>Status</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.UserStatus.html#Normal" class="tsd-kind-icon">Normal</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.UserStatus.html#Removed" class="tsd-kind-icon">Removed</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.UserStatus.html#Replaced" class="tsd-kind-icon">Replaced</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/enums/live.WebSocketCloseError.html DELETED
@@ -1,19 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WebSocketCloseError | 如视 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.WebSocketCloseError.html">WebSocketCloseError</a></li></ul><h1>Enumeration WebSocketCloseError</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
- <p>WebSocket 异常关闭枚举：<a href="https://developer.mozilla.org/zh-CN/docs/Web/API/CloseEvent%E3%80%82">https://developer.mozilla.org/zh-CN/docs/Web/API/CloseEvent。</a></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.WebSocketCloseError.html#Err_1001" class="tsd-kind-icon">Err_<wbr/>1001</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1002" class="tsd-kind-icon">Err_<wbr/>1002</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1003" class="tsd-kind-icon">Err_<wbr/>1003</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1006" class="tsd-kind-icon">Err_<wbr/>1006</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1007" class="tsd-kind-icon">Err_<wbr/>1007</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1008" class="tsd-kind-icon">Err_<wbr/>1008</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1009" class="tsd-kind-icon">Err_<wbr/>1009</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_unknown" class="tsd-kind-icon">Err_<wbr/>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="Err_1001" class="tsd-anchor"></a><h3>Err_<wbr/>1001</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1001<span class="tsd-signature-symbol"> = &quot;CLOSE_GOING_AWAY&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:55</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="Err_1002" class="tsd-anchor"></a><h3>Err_<wbr/>1002</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1002<span class="tsd-signature-symbol"> = &quot;CLOSE_PROTOCOL_ERROR&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:60</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
- <p>由于协议错误而中断连接。</p>
7
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_1003" class="tsd-anchor"></a><h3>Err_<wbr/>1003</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1003<span class="tsd-signature-symbol"> = &quot;CLOSE_UNSUPPORTED&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:65</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
- <p>由于接收到不允许的数据类型而断开连接 (如仅接收文本数据的终端接收到了二进制数据)。</p>
9
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_1006" class="tsd-anchor"></a><h3>Err_<wbr/>1006</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1006<span class="tsd-signature-symbol"> = &quot;CLOSE_ABNORMAL&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:70</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
10
- <p>安全因素或WebSocket连接次数达到上限。</p>
11
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_1007" class="tsd-anchor"></a><h3>Err_<wbr/>1007</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1007<span class="tsd-signature-symbol"> = &quot;Unsupported Data&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:75</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
12
- <p>由于收到了格式不符的数据而断开连接 (如文本消息中包含了非 UTF-8 数据)。</p>
13
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_1008" class="tsd-anchor"></a><h3>Err_<wbr/>1008</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1008<span class="tsd-signature-symbol"> = &quot;Policy Violation&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:79</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
14
- <p>由于收到不符合约定的数据而断开连接。</p>
15
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_1009" class="tsd-anchor"></a><h3>Err_<wbr/>1009</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>1009<span class="tsd-signature-symbol"> = &quot;CLOSE_TOO_LARGE&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:83</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
16
- <p>由于收到过大的数据帧而断开连接。</p>
17
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="Err_unknown" class="tsd-anchor"></a><h3>Err_<wbr/>unknown</h3><div class="tsd-signature tsd-kind-icon">Err_<wbr/>unknown<span class="tsd-signature-symbol"> = &quot;unknown&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in typings/WebSocket.ts:87</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
18
- <p>未知错误。</p>
19
- </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.WebSocketCloseError.html" class="tsd-kind-icon">Web<wbr/>Socket<wbr/>Close<wbr/>Error</a><ul><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1001" class="tsd-kind-icon">Err_<wbr/>1001</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1002" class="tsd-kind-icon">Err_<wbr/>1002</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1003" class="tsd-kind-icon">Err_<wbr/>1003</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1006" class="tsd-kind-icon">Err_<wbr/>1006</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1007" class="tsd-kind-icon">Err_<wbr/>1007</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1008" class="tsd-kind-icon">Err_<wbr/>1008</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_1009" class="tsd-kind-icon">Err_<wbr/>1009</a></li><li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="live.WebSocketCloseError.html#Err_unknown" class="tsd-kind-icon">Err_<wbr/>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>
package/docs/enums/live.WebSocketErrorType.html DELETED
@@ -1 +0,0 @@
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"> = &quot;Close&quot;</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"> = &quot;DuplicateConnect&quot;</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"> = &quot;Error&quot;</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"> = &quot;IllegalArgs&quot;</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"> = &quot;IllegalURL&quot;</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"> = &quot;MicroAuth&quot;</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"> = &quot;Unknown&quot;</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>