@realsee/live 0.7.3-alpha.0 → 0.7.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (143) hide show
  1. package/dist/index.cjs.js +3 -3
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.d.ts +1 -0
  4. package/dist/index.es.js +687 -130
  5. package/dist/index.es.js.map +1 -1
  6. package/dist/live/controller.d.ts +163 -42
  7. package/dist/live/createLive.d.ts +35 -3
  8. package/dist/live/createLiveReact.d.ts +51 -3
  9. package/dist/live/live.d.ts +501 -50
  10. package/dist/rtc/BrowserRTC.d.ts +63 -0
  11. package/dist/rtc/BrowserRTC4Chime.d.ts +38 -2
  12. package/dist/rtc/CoreRTC.d.ts +65 -1
  13. package/dist/rtc/VRWebViewRTC.d.ts +56 -6
  14. package/dist/typings/live/EventType.d.ts +58 -10
  15. package/dist/typings/live/GetVoiceSign.d.ts +27 -7
  16. package/dist/typings/live/UserInfo.d.ts +70 -0
  17. package/dist/typings/rtc/eventType.d.ts +55 -8
  18. package/dist/utils/appendUri.d.ts +17 -0
  19. package/dist/utils/uuid.d.ts +11 -1
  20. package/docs/.nojekyll +1 -0
  21. package/docs/assets/highlight.css +127 -0
  22. package/docs/assets/icons.js +18 -0
  23. package/docs/assets/icons.svg +1 -0
  24. package/docs/assets/main.js +60 -0
  25. package/docs/assets/navigation.js +1 -0
  26. package/docs/assets/search.js +1 -0
  27. package/docs/assets/style.css +1493 -0
  28. package/docs/classes/BrowserRTC.html +88 -0
  29. package/docs/classes/BrowserRTC4Chime.html +100 -0
  30. package/docs/classes/CoreRTC.html +65 -0
  31. package/docs/classes/Live.html +249 -0
  32. package/docs/classes/Subscribe.html +36 -0
  33. package/docs/classes/VRWebViewRTC.html +72 -0
  34. package/docs/enums/BuiltInRTCType.html +3 -0
  35. package/docs/enums/BuiltinActionType.html +14 -0
  36. package/docs/enums/BuiltinEventType.html +6 -0
  37. package/docs/enums/Command.html +22 -0
  38. package/docs/enums/LiveState.html +8 -0
  39. package/docs/enums/MemUserStatus.html +15 -0
  40. package/docs/enums/MicroStatus.html +6 -0
  41. package/docs/enums/RTCJoinedInfoCodeEnum.html +12 -0
  42. package/docs/enums/RTCType.html +5 -0
  43. package/docs/enums/UserStatus.html +8 -0
  44. package/docs/enums/WebSocketCloseError.html +20 -0
  45. package/docs/enums/WebSocketErrorType.html +8 -0
  46. package/docs/enums/WebSocketState.html +12 -0
  47. package/docs/functions/GetVoiceSignFn.html +20 -0
  48. package/docs/functions/_clearLiveInstanceIfNeed.html +1 -0
  49. package/docs/functions/createLive.html +9 -0
  50. package/docs/functions/createLiveReact.html +110 -0
  51. package/docs/functions/parseLiveMsg.html +4 -0
  52. package/docs/functions/parseWSClsErr.html +1 -0
  53. package/docs/hierarchy.html +1 -0
  54. package/docs/index.html +336 -0
  55. package/docs/interfaces/AttendeeResponse.html +4 -0
  56. package/docs/interfaces/LiveOptions.html +56 -0
  57. package/docs/interfaces/MeetingResponse.html +3 -0
  58. package/docs/interfaces/MeetingSessionConfigurationOptions.html +8 -0
  59. package/docs/interfaces/Permission.html +31 -0
  60. package/docs/interfaces/RTCJoinedInfo.html +7 -0
  61. package/docs/interfaces/RTCProtocol.html +65 -0
  62. package/docs/interfaces/SubscribeMixinType.emit.html +1 -0
  63. package/docs/interfaces/SubscribeMixinType.hasListener.html +1 -0
  64. package/docs/interfaces/SubscribeMixinType.off.html +1 -0
  65. package/docs/interfaces/SubscribeMixinType.on.html +1 -0
  66. package/docs/interfaces/SubscribeMixinType.once.html +1 -0
  67. package/docs/interfaces/VRWebViewRTCOptions.html +22 -0
  68. package/docs/modules/SubscribeMixinType.html +6 -0
  69. package/docs/modules.html +55 -0
  70. package/docs/types/BuiltinMsg.html +2 -0
  71. package/docs/types/EventMap.html +1 -0
  72. package/docs/types/EventType.html +2 -0
  73. package/docs/types/GetVoiceSign.html +3 -0
  74. package/docs/types/GetVoiceSignParams.html +5 -0
  75. package/docs/types/GetVoiceSignReturnType.html +6 -0
  76. package/docs/types/KeyframeEventType.html +2 -0
  77. package/docs/types/LiveBuiltInData.html +1 -0
  78. package/docs/types/LiveConnectOptions.html +8 -0
  79. package/docs/types/LiveEventType.html +41 -0
  80. package/docs/types/LiveMsg.html +2 -0
  81. package/docs/types/LiveProviderPropTypes.html +5 -0
  82. package/docs/types/RTCActionReactCallback.html +1 -0
  83. package/docs/types/RTCEventType.html +29 -0
  84. package/docs/types/ReqLiveMsg.html +6 -0
  85. package/docs/types/RoomInfo.html +1 -0
  86. package/docs/types/UserInfo.html +12 -0
  87. package/docs/types/UserInfoExt.html +5 -0
  88. package/docs/types/UserVolume.html +2 -0
  89. package/docs/types/WebSocketError.html +1 -0
  90. package/package.json +1 -2
  91. package/docs/README.md +0 -437
  92. package/docs/classes/BrowserRTC.md +0 -436
  93. package/docs/classes/BrowserRTC4Chime.md +0 -558
  94. package/docs/classes/CoreRTC.md +0 -448
  95. package/docs/classes/Live.md +0 -770
  96. package/docs/classes/VRWebViewRTC.md +0 -436
  97. package/docs/enumerations/BuiltInRTCType.md +0 -27
  98. package/docs/enumerations/BuiltinActionType.md +0 -81
  99. package/docs/enumerations/BuiltinEventType.md +0 -33
  100. package/docs/enumerations/Command.md +0 -107
  101. package/docs/enumerations/LiveState.md +0 -53
  102. package/docs/enumerations/MemUserStatus.md +0 -67
  103. package/docs/enumerations/MicroStatus.md +0 -33
  104. package/docs/enumerations/RTCJoinedInfoCodeEnum.md +0 -69
  105. package/docs/enumerations/RTCType.md +0 -39
  106. package/docs/enumerations/UserStatus.md +0 -45
  107. package/docs/enumerations/WebSocketCloseError.md +0 -117
  108. package/docs/enumerations/WebSocketErrorType.md +0 -77
  109. package/docs/enumerations/WebSocketState.md +0 -69
  110. package/docs/functions/GetVoiceSignFn.md +0 -27
  111. package/docs/functions/clearLiveInstanceIfNeed.md +0 -17
  112. package/docs/functions/createLive.md +0 -27
  113. package/docs/functions/createLiveReact.md +0 -449
  114. package/docs/functions/parseLiveMsg.md +0 -27
  115. package/docs/functions/parseWSClsErr.md +0 -21
  116. package/docs/globals.md +0 -71
  117. package/docs/interfaces/AttendeeResponse.md +0 -37
  118. package/docs/interfaces/LiveOptions.md +0 -246
  119. package/docs/interfaces/MeetingResponse.md +0 -55
  120. package/docs/interfaces/MeetingSessionConfigurationOptions.md +0 -93
  121. package/docs/interfaces/Permission.md +0 -147
  122. package/docs/interfaces/RTCJoinedInfo.md +0 -67
  123. package/docs/interfaces/RTCProtocol.md +0 -404
  124. package/docs/interfaces/VRWebViewRTCOptions.md +0 -41
  125. package/docs/type-aliases/BuiltinMsg.md +0 -41
  126. package/docs/type-aliases/EventType.md +0 -19
  127. package/docs/type-aliases/GetVoiceSign.md +0 -15
  128. package/docs/type-aliases/GetVoiceSignParams.md +0 -35
  129. package/docs/type-aliases/GetVoiceSignReturnType.md +0 -41
  130. package/docs/type-aliases/KeyframeEventType.md +0 -19
  131. package/docs/type-aliases/LiveBuiltInData.md +0 -47
  132. package/docs/type-aliases/LiveConnectOptions.md +0 -47
  133. package/docs/type-aliases/LiveEventType.md +0 -165
  134. package/docs/type-aliases/LiveMsg.md +0 -53
  135. package/docs/type-aliases/LiveProviderPropTypes.md +0 -27
  136. package/docs/type-aliases/RTCActionReactCallback.md +0 -13
  137. package/docs/type-aliases/RTCEventType.md +0 -65
  138. package/docs/type-aliases/ReqLiveMsg.md +0 -45
  139. package/docs/type-aliases/RoomInfo.md +0 -55
  140. package/docs/type-aliases/UserInfo.md +0 -77
  141. package/docs/type-aliases/UserInfoExt.md +0 -33
  142. package/docs/type-aliases/UserVolume.md +0 -25
  143. package/docs/type-aliases/WebSocketError.md +0 -31
package/docs/functions/createLive.html ADDED
@@ -0,0 +1,9 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createLive | 如视 Live SDK</title><meta name="description" content="Documentation for 如视 Live SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Live SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">如视 Live SDK</a></li><li><a href="createLive.html">createLive</a></li></ul><h1> FunctioncreateLive</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>创建 Live 带看实例</p>
2
+ <p>这是一个工厂函数，用于创建 Live 实例。在创建新实例前，会先清理全局的旧实例（如果存在）。</p>
3
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-0">// 定义帧数据类型</span><br/><span class="hl-6">interface</span><span class="hl-2"> </span><span class="hl-9">MyKeyframes</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-5">camera</span><span class="hl-2">: { </span><span class="hl-5">position</span><span class="hl-2">: [</span><span class="hl-9">number</span><span class="hl-2">, </span><span class="hl-9">number</span><span class="hl-2">, </span><span class="hl-9">number</span><span class="hl-2">] }</span><br/><span class="hl-2"> </span><span class="hl-5">annotation</span><span class="hl-2">: { </span><span class="hl-5">text</span><span class="hl-2">: </span><span class="hl-9">string</span><span class="hl-2">; </span><span class="hl-5">position</span><span class="hl-2">: [</span><span class="hl-9">number</span><span class="hl-2">, </span><span class="hl-9">number</span><span class="hl-2">] }</span><br/><span class="hl-2">}</span><br/><br/><span class="hl-0">// 创建 Live 实例</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">live</span><span class="hl-2"> = </span><span class="hl-1">createLive</span><span class="hl-2">&lt;</span><span class="hl-9">MyKeyframes</span><span class="hl-2">&gt;({</span><br/><span class="hl-2"> </span><span class="hl-5">url:</span><span class="hl-2"> </span><span class="hl-3">&#39;wss://example.com/live&#39;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-1">getTicket</span><span class="hl-5">:</span><span class="hl-2"> </span><span class="hl-6">async</span><span class="hl-2"> () </span><span class="hl-6">=&gt;</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">response</span><span class="hl-2"> = </span><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetch</span><span class="hl-2">(</span><span class="hl-3">&#39;/api/get-ticket&#39;</span><span class="hl-2">)</span><br/><span class="hl-2"> </span><span class="hl-4">return</span><span class="hl-2"> </span><span class="hl-5">response</span><span class="hl-2">.</span><span class="hl-1">json</span><span class="hl-2">().</span><span class="hl-5">ticket</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-1">getVoiceSign</span><span class="hl-5">:</span><span class="hl-2"> </span><span class="hl-6">async</span><span class="hl-2"> (</span><span class="hl-5">params</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">response</span><span class="hl-2"> = </span><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">fetch</span><span class="hl-2">(</span><span class="hl-3">&#39;/api/get-voice-sign&#39;</span><span class="hl-2">, {</span><br/><span class="hl-2"> </span><span class="hl-5">method:</span><span class="hl-2"> </span><span class="hl-3">&#39;POST&#39;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">body:</span><span class="hl-2"> </span><span class="hl-7">JSON</span><span class="hl-2">.</span><span class="hl-1">stringify</span><span class="hl-2">(</span><span class="hl-5">params</span><span class="hl-2">)</span><br/><span class="hl-2"> })</span><br/><span class="hl-2"> </span><span class="hl-4">return</span><span class="hl-2"> </span><span class="hl-5">response</span><span class="hl-2">.</span><span class="hl-1">json</span><span class="hl-2">()</span><br/><span class="hl-2"> },</span><br/><span class="hl-2"> </span><span class="hl-5">useBuiltInRTC:</span><span class="hl-2"> </span><span class="hl-6">true</span><br/><span class="hl-2">})</span><br/><br/><span class="hl-0">// 连接带看</span><br/><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-5">live</span><span class="hl-2">.</span><span class="hl-1">connect</span><span class="hl-2">()</span>
4
+ </code><button type="button">Copy</button></pre>
5
+
6
+ </div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createLive" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Live</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLive.html#createLive.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Live.html" class="tsd-signature-type tsd-kind-class">Live</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLive.html#createLive.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><a href="#createLive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="createLive.KeyframesSnapshot" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">KeyframesSnapshot</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>帧数据快照类型，必须是一个对象类型</p>
7
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/LiveOptions.html" class="tsd-signature-type tsd-kind-interface">LiveOptions</a></span><div class="tsd-comment tsd-typography"><p>带看配置选项，详见 <a href="../interfaces/LiveOptions.html" class="tsd-kind-interface">LiveOptions</a></p>
8
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/Live.html" class="tsd-signature-type tsd-kind-class">Live</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLive.html#createLive.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Live 实例</p>
9
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in live/createLive.ts:42</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>如视 Live SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>