@realsee/live 0.7.4 → 0.7.6

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 (17) hide show
  1. package/README.md +245 -91
  2. package/dist/index.cjs.js +1 -1
  3. package/dist/index.es.js +44 -44
  4. package/docs/assets/highlight.css +6 -6
  5. package/docs/classes/BrowserRTC.html +2 -2
  6. package/docs/classes/BrowserRTC4Chime.html +2 -2
  7. package/docs/classes/CoreRTC.html +1 -1
  8. package/docs/classes/Live.html +14 -14
  9. package/docs/classes/Subscribe.html +1 -1
  10. package/docs/classes/VRWebViewRTC.html +1 -1
  11. package/docs/functions/GetVoiceSignFn.html +1 -1
  12. package/docs/functions/createLive.html +1 -1
  13. package/docs/functions/createLiveReact.html +10 -10
  14. package/docs/index.html +116 -110
  15. package/docs/interfaces/LiveOptions.html +1 -1
  16. package/docs/interfaces/VRWebViewRTCOptions.html +1 -1
  17. package/package.json +1 -1
package/docs/functions/createLiveReact.html CHANGED
@@ -7,7 +7,7 @@
7
7
  <ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">js<wbr/>Bridge</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JSBridgeProtocol</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">live</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="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">Live<wbr/>Provider</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveProviderPropTypes.html" class="tsd-signature-type tsd-kind-type-alias">LiveProviderPropTypes</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><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">FunctionComponentElement</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ProviderProps</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</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="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.LiveProvider.__type-1.__type-2"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">FunctionComponentElement</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ProviderProps</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</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="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>LiveProvider 组件</p>
8
8
  <p>用于在 React 组件树中提供 Live 实例的上下文。
9
9
  所有子组件都可以通过 Hooks 访问 Live 实例。</p>
10
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <a href="../types/LiveProviderPropTypes.html" class="tsd-signature-type tsd-kind-type-alias">LiveProviderPropTypes</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FunctionComponentElement</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ProviderProps</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</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="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">App</span><span class="hl-2">() {</span><br/><span class="hl-2"> </span><span class="hl-4">return</span><span class="hl-2"> (</span><br/><span class="hl-2"> &lt;</span><span class="hl-9">LiveProvider</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> &lt;</span><span class="hl-5">MyComponent</span><span class="hl-2"> /&gt;</span><br/><span class="hl-2"> &lt;/</span><span class="hl-5">LiveProvider</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> )</span><br/><span class="hl-2">}</span>
10
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <a href="../types/LiveProviderPropTypes.html" class="tsd-signature-type tsd-kind-type-alias">LiveProviderPropTypes</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">FunctionComponentElement</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ProviderProps</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">null</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="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">App</span><span class="hl-2">() {</span><br/><span class="hl-2"> </span><span class="hl-4">return</span><span class="hl-2"> (</span><br/><span class="hl-2"> &lt;</span><span class="hl-7">LiveProvider</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> &lt;</span><span class="hl-5">MyComponent</span><span class="hl-2"> /&gt;</span><br/><span class="hl-2"> &lt;/</span><span class="hl-5">LiveProvider</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> )</span><br/><span class="hl-2">}</span>
11
11
  </code><button type="button">Copy</button></pre>
12
12
 
13
13
  </div></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">unsafe__use<wbr/>Live<wbr/>Instance</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><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="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.unsafe__useLiveInstance.__type-3.__type-4"><span class="tsd-signature-symbol">(</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="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>不安全地获取 Live 实例（不推荐使用）</p>
@@ -21,7 +21,7 @@
21
21
  </div></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Connect</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-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveConnectOptions.html" class="tsd-signature-type tsd-kind-type-alias">LiveConnectOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useConnect.__type-7.__type-8"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveConnectOptions.html" class="tsd-signature-type tsd-kind-type-alias">LiveConnectOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>带看连接操作的 Hook</p>
22
22
  <p>返回一个连接函数，用于连接到带看房间。</p>
23
23
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveConnectOptions.html" class="tsd-signature-type tsd-kind-type-alias">LiveConnectOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h4><p>连接函数</p>
24
- <ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useConnect.__type-7.__type-8.__type-9.__type-10"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/LiveConnectOptions.html" class="tsd-signature-type tsd-kind-type-alias">LiveConnectOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</span><span class="hl-2">() {</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-7">connect</span><span class="hl-2"> = </span><span class="hl-1">useConnect</span><span class="hl-2">()</span><br/><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-1">handleConnect</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-4">await</span><span class="hl-2"> </span><span class="hl-1">connect</span><span class="hl-2">({</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><span class="hl-3">&#39;ticket&#39;</span><br/><span class="hl-2"> })</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span>
24
+ <ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useConnect.__type-7.__type-8.__type-9.__type-10"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/LiveConnectOptions.html" class="tsd-signature-type tsd-kind-type-alias">LiveConnectOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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-8">connect</span><span class="hl-2"> = </span><span class="hl-1">useConnect</span><span class="hl-2">()</span><br/><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-1">handleConnect</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-4">await</span><span class="hl-2"> </span><span class="hl-1">connect</span><span class="hl-2">({</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><span class="hl-3">&#39;ticket&#39;</span><br/><span class="hl-2"> })</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span>
25
25
  </code><button type="button">Copy</button></pre>
26
26
 
27
27
  </div></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Keyframe</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframe.__type-11.__type-12.K">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframe.__type-11.__type-12.K">K</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframe.__type-11.__type-12.K">K</a><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-kind-parameter">frame</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframe.__type-11.__type-12.K">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</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></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useKeyframe.__type-11.__type-12"><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframe.__type-11.__type-12.K">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframe.__type-11.__type-12.K">K</a><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-kind-parameter">frame</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframe.__type-11.__type-12.K">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>使用指定键的帧数据 Hook</p>
@@ -30,13 +30,13 @@
30
30
  </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="createLiveReact.__type.useKeyframe.__type-11.__type-12.K" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">K</span><span class="tsd-signature-keyword"> extends </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></span><div class="tsd-comment tsd-typography"><p>帧数据的键类型</p>
31
31
  </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">key</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframe.__type-11.__type-12.K">K</a></span><div class="tsd-comment tsd-typography"><p>帧数据的键</p>
32
32
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframe.__type-11.__type-12.K">K</a><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-kind-parameter">frame</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframe.__type-11.__type-12.K">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h4><p>包含帧数据状态和更新函数的元组 [state, setState]</p>
33
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-2" class="tsd-anchor"></a>Example<a href="#Example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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">camera</span><span class="hl-2">, </span><span class="hl-7">setCamera</span><span class="hl-2">] = </span><span class="hl-1">useKeyframe</span><span class="hl-2">(</span><span class="hl-3">&#39;camera&#39;</span><span class="hl-2">)</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 读取帧数据</span><br/><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-3">&#39;当前相机位置:&#39;</span><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><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 更新帧数据</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleUpdateCamera</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-1">setCamera</span><span class="hl-2">({ </span><span class="hl-5">position:</span><span class="hl-2"> [</span><span class="hl-8">1</span><span class="hl-2">, </span><span class="hl-8">2</span><span class="hl-2">, </span><span class="hl-8">3</span><span class="hl-2">], </span><span class="hl-5">rotation:</span><span class="hl-2"> [</span><span class="hl-8">0</span><span class="hl-2">, </span><span class="hl-8">0</span><span class="hl-2">, </span><span class="hl-8">0</span><span class="hl-2">] })</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span>
33
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-2" class="tsd-anchor"></a>Example<a href="#Example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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-8">camera</span><span class="hl-2">, </span><span class="hl-8">setCamera</span><span class="hl-2">] = </span><span class="hl-1">useKeyframe</span><span class="hl-2">(</span><span class="hl-3">&#39;camera&#39;</span><span class="hl-2">)</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 读取帧数据</span><br/><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-3">&#39;当前相机位置:&#39;</span><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><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 更新帧数据</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleUpdateCamera</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-1">setCamera</span><span class="hl-2">({ </span><span class="hl-5">position:</span><span class="hl-2"> [</span><span class="hl-9">1</span><span class="hl-2">, </span><span class="hl-9">2</span><span class="hl-2">, </span><span class="hl-9">3</span><span class="hl-2">], </span><span class="hl-5">rotation:</span><span class="hl-2"> [</span><span class="hl-9">0</span><span class="hl-2">, </span><span class="hl-9">0</span><span class="hl-2">, </span><span class="hl-9">0</span><span class="hl-2">] })</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span>
34
34
  </code><button type="button">Copy</button></pre>
35
35
 
36
36
  </div></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Keyframes<wbr/>Snapshot</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">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useKeyframesSnapshot.__type-13.__type-14"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>获取所有帧数据快照的 Hook</p>
37
37
  <p>返回当前所有帧数据的快照，当任何帧数据发生变化时会自动更新。</p>
38
38
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span></h4><p>当前所有帧数据的快照</p>
39
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-3" class="tsd-anchor"></a>Example<a href="#Example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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">snapshot</span><span class="hl-2"> = </span><span class="hl-1">useKeyframesSnapshot</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><br/><span class="hl-2"> &lt;</span><span class="hl-9">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> &lt;</span><span class="hl-9">div</span><span class="hl-2">&gt;相机位置: {</span><span class="hl-9">snapshot</span><span class="hl-2">.</span><span class="hl-9">camera</span><span class="hl-2">?.</span><span class="hl-9">position</span><span class="hl-2">?.</span><span class="hl-9">join</span><span class="hl-2">(</span><span class="hl-3">&#39;, &#39;</span><span class="hl-2">)}&lt;/</span><span class="hl-9">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> &lt;</span><span class="hl-9">div</span><span class="hl-2">&gt;标注: {</span><span class="hl-9">snapshot</span><span class="hl-2">.</span><span class="hl-9">annotation</span><span class="hl-2">?.</span><span class="hl-5">text</span><span class="hl-2">}&lt;/</span><span class="hl-9">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> &lt;/</span><span class="hl-5">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> )</span><br/><span class="hl-2">}</span>
39
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-3" class="tsd-anchor"></a>Example<a href="#Example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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-8">snapshot</span><span class="hl-2"> = </span><span class="hl-1">useKeyframesSnapshot</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><br/><span class="hl-2"> &lt;</span><span class="hl-7">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> &lt;</span><span class="hl-7">div</span><span class="hl-2">&gt;相机位置: {</span><span class="hl-7">snapshot</span><span class="hl-2">.</span><span class="hl-7">camera</span><span class="hl-2">?.</span><span class="hl-7">position</span><span class="hl-2">?.</span><span class="hl-7">join</span><span class="hl-2">(</span><span class="hl-3">&#39;, &#39;</span><span class="hl-2">)}&lt;/</span><span class="hl-7">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> &lt;</span><span class="hl-7">div</span><span class="hl-2">&gt;标注: {</span><span class="hl-7">snapshot</span><span class="hl-2">.</span><span class="hl-7">annotation</span><span class="hl-2">?.</span><span class="hl-5">text</span><span class="hl-2">}&lt;/</span><span class="hl-7">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> &lt;/</span><span class="hl-5">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> )</span><br/><span class="hl-2">}</span>
40
40
  </code><button type="button">Copy</button></pre>
41
41
 
42
42
  </div></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Keyframe<wbr/>Update<wbr/>Callback</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframeUpdateCallback.__type-15.__type-16.KeyOfKeyframe">KeyOfKeyframe</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframeUpdateCallback.__type-15.__type-16.KeyOfKeyframe">KeyOfKeyframe</a>, <span class="tsd-kind-parameter">callback</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-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/KeyframeEventType.html" class="tsd-signature-type tsd-kind-type-alias">KeyframeEventType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframeUpdateCallback.__type-15.__type-16.KeyOfKeyframe">KeyOfKeyframe</a><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><a href="../types/KeyframeEventType.html" class="tsd-signature-type tsd-kind-type-alias">KeyframeEventType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframeUpdateCallback.__type-15.__type-16.KeyOfKeyframe">KeyOfKeyframe</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span>, <span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DependencyList</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useKeyframeUpdateCallback.__type-15.__type-16"><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useKeyframeUpdateCallback.__type-15.__type-16.KeyOfKeyframe">KeyOfKeyframe</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">callback</span>, <span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>监听指定键的帧数据更新回调 Hook</p>
@@ -54,7 +54,7 @@
54
54
  <p>返回一组用于操作带看功能的函数，包括连接、发送帧数据、控制麦克风等。
55
55
  所有函数都使用 useCallback 包装，避免不必要的重新渲染。</p>
56
56
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">broadcast</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">: </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 class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, <span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">connect</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveConnectOptions.html" class="tsd-signature-type tsd-kind-type-alias">LiveConnectOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">exit</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">forbidMicro</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">micro</span><span class="tsd-signature-symbol">: </span><a href="../enums/MicroStatus.html" class="tsd-signature-type tsd-kind-enum">MicroStatus</a>, <span class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">forbidSync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">getFramesByKey</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">kick</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">sendKeyframe</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a>, <span class="tsd-kind-parameter">frame</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">setSelfInfo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userInfo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/UserInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserInfo</a><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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">toggleMicro</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">microStatus</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">updateStatus</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evtType</span><span class="tsd-signature-symbol">: </span><a href="../enums/BuiltinEventType.html" class="tsd-signature-type tsd-kind-enum">BuiltinEventType</a>, <span class="tsd-kind-parameter">atnType</span><span class="tsd-signature-symbol">: </span><a href="../enums/BuiltinActionType.html" class="tsd-signature-type tsd-kind-enum">BuiltinActionType</a>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">: </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 class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><p>包含各种带看操作函数的对象</p>
57
- <ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">broadcast</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">: </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 class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, <span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.broadcast.__type-22.__type-23"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">toUserIds</span>, <span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</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></li><li><span><span class="tsd-kind-parameter">toUserIds</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">connect</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveConnectOptions.html" class="tsd-signature-type tsd-kind-type-alias">LiveConnectOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.connect.__type-24.__type-25"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/LiveConnectOptions.html" class="tsd-signature-type tsd-kind-type-alias">LiveConnectOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">exit</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.exit.__type-26.__type-27"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">forbid<wbr/>Micro</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">micro</span><span class="tsd-signature-symbol">: </span><a href="../enums/MicroStatus.html" class="tsd-signature-type tsd-kind-enum">MicroStatus</a>, <span class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.forbidMicro.__type-28.__type-29"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">micro</span>, <span class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">micro</span>: <a href="../enums/MicroStatus.html" class="tsd-signature-type tsd-kind-enum">MicroStatus</a></span></li><li><span><span class="tsd-kind-parameter">toUserIds</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">forbid<wbr/>Sync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.forbidSync.__type-30.__type-31"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sync</span>, <span class="tsd-kind-parameter">toUserIds</span><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><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">sync</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">toUserIds</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Frames<wbr/>By<wbr/>Key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.getFramesByKey.__type-32.__type-33"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">]</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">]</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">kick</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.kick.__type-34.__type-35"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">toUserIds</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">send<wbr/>Keyframe</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a>, <span class="tsd-kind-parameter">frame</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><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><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.sendKeyframe.__type-36.__type-37"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">frame</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a></span></li><li><span><span class="tsd-kind-parameter">frame</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">set<wbr/>Self<wbr/>Info</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userInfo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/UserInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserInfo</a><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">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.setSelfInfo.__type-38.__type-39"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userInfo</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">userInfo</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/UserInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserInfo</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">toggle<wbr/>Micro</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">microStatus</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.toggleMicro.__type-40.__type-41"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">microStatus</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">microStatus</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">update<wbr/>Status</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evtType</span><span class="tsd-signature-symbol">: </span><a href="../enums/BuiltinEventType.html" class="tsd-signature-type tsd-kind-enum">BuiltinEventType</a>, <span class="tsd-kind-parameter">atnType</span><span class="tsd-signature-symbol">: </span><a href="../enums/BuiltinActionType.html" class="tsd-signature-type tsd-kind-enum">BuiltinActionType</a>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">: </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 class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.updateStatus.__type-42.__type-43"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evtType</span>, <span class="tsd-kind-parameter">atnType</span>, <span class="tsd-kind-parameter">status</span>, <span class="tsd-kind-parameter">toUserIds</span><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><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">evtType</span>: <a href="../enums/BuiltinEventType.html" class="tsd-signature-type tsd-kind-enum">BuiltinEventType</a></span></li><li><span><span class="tsd-kind-parameter">atnType</span>: <a href="../enums/BuiltinActionType.html" class="tsd-signature-type tsd-kind-enum">BuiltinActionType</a></span></li><li><span><span class="tsd-kind-parameter">status</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></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">toUserIds</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-5" class="tsd-anchor"></a>Example<a href="#Example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</span><span class="hl-2">() {</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-7">connect</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">sendKeyframe</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">toggleMicro</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">broadcast</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">exit</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">kick</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">forbidMicro</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">forbidSync</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">getFramesByKey</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">setSelfInfo</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-7">updateStatus</span><br/><span class="hl-2"> } = </span><span class="hl-1">useLiveAction</span><span class="hl-2">()</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 连接带看</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleConnect</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-4">await</span><span class="hl-2"> </span><span class="hl-1">connect</span><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><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><span class="hl-3">&#39;ticket&#39;</span><span class="hl-2"> })</span><br/><span class="hl-2"> }</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 发送帧数据</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleSendFrame</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-1">sendKeyframe</span><span class="hl-2">(</span><span class="hl-3">&#39;camera&#39;</span><span class="hl-2">, { </span><span class="hl-5">position:</span><span class="hl-2"> [</span><span class="hl-8">1</span><span class="hl-2">, </span><span class="hl-8">2</span><span class="hl-2">, </span><span class="hl-8">3</span><span class="hl-2">] })</span><br/><span class="hl-2"> }</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 切换麦克风</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleToggleMicro</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-1">toggleMicro</span><span class="hl-2">(</span><span class="hl-6">true</span><span class="hl-2">)</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span>
57
+ <ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">broadcast</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">: </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 class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, <span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.broadcast.__type-22.__type-23"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">toUserIds</span>, <span class="tsd-kind-parameter">timeout</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</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></li><li><span><span class="tsd-kind-parameter">toUserIds</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">timeout</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">connect</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><a href="../types/LiveConnectOptions.html" class="tsd-signature-type tsd-kind-type-alias">LiveConnectOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.connect.__type-24.__type-25"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/LiveConnectOptions.html" class="tsd-signature-type tsd-kind-type-alias">LiveConnectOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">exit</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.exit.__type-26.__type-27"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">forbid<wbr/>Micro</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">micro</span><span class="tsd-signature-symbol">: </span><a href="../enums/MicroStatus.html" class="tsd-signature-type tsd-kind-enum">MicroStatus</a>, <span class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.forbidMicro.__type-28.__type-29"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">micro</span>, <span class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">micro</span>: <a href="../enums/MicroStatus.html" class="tsd-signature-type tsd-kind-enum">MicroStatus</a></span></li><li><span><span class="tsd-kind-parameter">toUserIds</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">forbid<wbr/>Sync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.forbidSync.__type-30.__type-31"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sync</span>, <span class="tsd-kind-parameter">toUserIds</span><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><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">sync</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">toUserIds</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">get<wbr/>Frames<wbr/>By<wbr/>Key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.getFramesByKey.__type-32.__type-33"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">]</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">]</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">kick</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.kick.__type-34.__type-35"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">toUserIds</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">send<wbr/>Keyframe</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a>, <span class="tsd-kind-parameter">frame</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><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><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.sendKeyframe.__type-36.__type-37"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">frame</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a></span></li><li><span><span class="tsd-kind-parameter">frame</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">set<wbr/>Self<wbr/>Info</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userInfo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/UserInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserInfo</a><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">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.setSelfInfo.__type-38.__type-39"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userInfo</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">userInfo</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/UserInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserInfo</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">toggle<wbr/>Micro</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">microStatus</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.toggleMicro.__type-40.__type-41"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">microStatus</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">microStatus</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">update<wbr/>Status</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evtType</span><span class="tsd-signature-symbol">: </span><a href="../enums/BuiltinEventType.html" class="tsd-signature-type tsd-kind-enum">BuiltinEventType</a>, <span class="tsd-kind-parameter">atnType</span><span class="tsd-signature-symbol">: </span><a href="../enums/BuiltinActionType.html" class="tsd-signature-type tsd-kind-enum">BuiltinActionType</a>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">: </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 class="tsd-kind-parameter">toUserIds</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveAction.__type-19.__type-20.__type-21.updateStatus.__type-42.__type-43"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evtType</span>, <span class="tsd-kind-parameter">atnType</span>, <span class="tsd-kind-parameter">status</span>, <span class="tsd-kind-parameter">toUserIds</span><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><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">evtType</span>: <a href="../enums/BuiltinEventType.html" class="tsd-signature-type tsd-kind-enum">BuiltinEventType</a></span></li><li><span><span class="tsd-kind-parameter">atnType</span>: <a href="../enums/BuiltinActionType.html" class="tsd-signature-type tsd-kind-enum">BuiltinActionType</a></span></li><li><span><span class="tsd-kind-parameter">status</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></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">toUserIds</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-5" class="tsd-anchor"></a>Example<a href="#Example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</span><span class="hl-2">() {</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-8">connect</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">sendKeyframe</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">toggleMicro</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">broadcast</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">exit</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">kick</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">forbidMicro</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">forbidSync</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">getFramesByKey</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">setSelfInfo</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-8">updateStatus</span><br/><span class="hl-2"> } = </span><span class="hl-1">useLiveAction</span><span class="hl-2">()</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 连接带看</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleConnect</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-4">await</span><span class="hl-2"> </span><span class="hl-1">connect</span><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><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><span class="hl-3">&#39;ticket&#39;</span><span class="hl-2"> })</span><br/><span class="hl-2"> }</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 发送帧数据</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleSendFrame</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-1">sendKeyframe</span><span class="hl-2">(</span><span class="hl-3">&#39;camera&#39;</span><span class="hl-2">, { </span><span class="hl-5">position:</span><span class="hl-2"> [</span><span class="hl-9">1</span><span class="hl-2">, </span><span class="hl-9">2</span><span class="hl-2">, </span><span class="hl-9">3</span><span class="hl-2">] })</span><br/><span class="hl-2"> }</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 切换麦克风</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleToggleMicro</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-1">toggleMicro</span><span class="hl-2">(</span><span class="hl-6">true</span><span class="hl-2">)</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span>
58
58
  </code><button type="button">Copy</button></pre>
59
59
 
60
60
  </div></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Live<wbr/>Event<wbr/>Callback</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useLiveEventCallback.__type-44.__type-45.K-1">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useLiveEventCallback.__type-44.__type-45.K-1">K</a>, <span class="tsd-kind-parameter">callback</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-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/LiveEventType.html" class="tsd-signature-type tsd-kind-type-alias">LiveEventType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useLiveEventCallback.__type-44.__type-45.K-1">K</a><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><a href="../types/LiveEventType.html" class="tsd-signature-type tsd-kind-type-alias">LiveEventType</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.KeyframesSnapshot">KeyframesSnapshot</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useLiveEventCallback.__type-44.__type-45.K-1">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span>, <span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DependencyList</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveEventCallback.__type-44.__type-45"><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useLiveEventCallback.__type-44.__type-45.K-1">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">callback</span>, <span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>监听带看事件的 Hook</p>
@@ -71,13 +71,13 @@
71
71
  </div></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>Live<wbr/>State</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><a href="../enums/LiveState.html" class="tsd-signature-type tsd-kind-enum">LiveState</a><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useLiveState.__type-48.__type-49"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/LiveState.html" class="tsd-signature-type tsd-kind-enum">LiveState</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>获取带看连接状态的 Hook</p>
72
72
  <p>返回当前带看连接的状态，当状态发生变化时会自动更新。</p>
73
73
  </div><h4 class="tsd-returns-title">Returns <a href="../enums/LiveState.html" class="tsd-signature-type tsd-kind-enum">LiveState</a></h4><p>当前连接状态</p>
74
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-7" class="tsd-anchor"></a>Example<a href="#Example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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">state</span><span class="hl-2"> = </span><span class="hl-1">useLiveState</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><br/><span class="hl-2"> &lt;</span><span class="hl-9">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> 连接状态: {</span><span class="hl-5">state</span><span class="hl-2">}</span><br/><span class="hl-2"> {</span><span class="hl-5">state</span><span class="hl-2"> === </span><span class="hl-5">LiveState</span><span class="hl-2">.</span><span class="hl-5">OPEN</span><span class="hl-2"> &amp;&amp; &lt;</span><span class="hl-5">div</span><span class="hl-2">&gt;已连接&lt;/</span><span class="hl-5">div</span><span class="hl-2">&gt;}</span><br/><span class="hl-2"> {</span><span class="hl-5">state</span><span class="hl-2"> === </span><span class="hl-5">LiveState</span><span class="hl-2">.</span><span class="hl-5">CONNECTING</span><span class="hl-2"> &amp;&amp; &lt;</span><span class="hl-5">div</span><span class="hl-2">&gt;连接中...&lt;/</span><span class="hl-5">div</span><span class="hl-2">&gt;}</span><br/><span class="hl-2"> &lt;/</span><span class="hl-5">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> )</span><br/><span class="hl-2">}</span>
74
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-7" class="tsd-anchor"></a>Example<a href="#Example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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-8">state</span><span class="hl-2"> = </span><span class="hl-1">useLiveState</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><br/><span class="hl-2"> &lt;</span><span class="hl-7">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> 连接状态: {</span><span class="hl-5">state</span><span class="hl-2">}</span><br/><span class="hl-2"> {</span><span class="hl-5">state</span><span class="hl-2"> === </span><span class="hl-5">LiveState</span><span class="hl-2">.</span><span class="hl-5">OPEN</span><span class="hl-2"> &amp;&amp; &lt;</span><span class="hl-5">div</span><span class="hl-2">&gt;已连接&lt;/</span><span class="hl-5">div</span><span class="hl-2">&gt;}</span><br/><span class="hl-2"> {</span><span class="hl-5">state</span><span class="hl-2"> === </span><span class="hl-5">LiveState</span><span class="hl-2">.</span><span class="hl-5">CONNECTING</span><span class="hl-2"> &amp;&amp; &lt;</span><span class="hl-5">div</span><span class="hl-2">&gt;连接中...&lt;/</span><span class="hl-5">div</span><span class="hl-2">&gt;}</span><br/><span class="hl-2"> &lt;/</span><span class="hl-5">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> )</span><br/><span class="hl-2">}</span>
75
75
  </code><button type="button">Copy</button></pre>
76
76
 
77
77
  </div></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">useRTCAction</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-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">detectMicro</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">join</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">roomId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><a href="../enums/RTCType.html" class="tsd-signature-type tsd-kind-enum">RTCType</a><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">userId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">voiceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">quit</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">shock</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">toggleMicro</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">flag</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useRTCAction.__type-50.__type-51"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">detectMicro</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">join</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">roomId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><a href="../enums/RTCType.html" class="tsd-signature-type tsd-kind-enum">RTCType</a><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">userId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">voiceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">quit</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">shock</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">toggleMicro</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">flag</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>RTC 操作函数的 Hook</p>
78
78
  <p>返回一组用于操作 RTC 语音通信的函数。</p>
79
79
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">detectMicro</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">join</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span><span class="tsd-kind-property">roomId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><a href="../enums/RTCType.html" class="tsd-signature-type tsd-kind-enum">RTCType</a><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">userId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span><span class="tsd-kind-property">voiceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">quit</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">shock</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">toggleMicro</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">flag</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4><p>包含各种 RTC 操作函数的对象</p>
80
- <ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">detect<wbr/>Micro</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useRTCAction.__type-50.__type-51.__type-52.detectMicro.__type-53.__type-54"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">join</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">roomId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><a href="../enums/RTCType.html" class="tsd-signature-type tsd-kind-enum">RTCType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">userId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">voiceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useRTCAction.__type-50.__type-51.__type-52.join.__type-55.__type-56"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">roomId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><a href="../enums/RTCType.html" class="tsd-signature-type tsd-kind-enum">RTCType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">userId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">voiceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">room<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><a href="../enums/RTCType.html" class="tsd-signature-type tsd-kind-enum">RTCType</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">user<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">voice<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">quit</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useRTCAction.__type-50.__type-51.__type-52.quit.__type-57.__type-58"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">shock</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useRTCAction.__type-50.__type-51.__type-52.shock.__type-59.__type-60"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">toggle<wbr/>Micro</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">flag</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useRTCAction.__type-50.__type-51.__type-52.toggleMicro-1.__type-61.__type-62"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">flag</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">flag</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-8" class="tsd-anchor"></a>Example<a href="#Example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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">join</span><span class="hl-2">, </span><span class="hl-7">quit</span><span class="hl-2">, </span><span class="hl-7">toggleMicro</span><span class="hl-2">, </span><span class="hl-7">detectMicro</span><span class="hl-2">, </span><span class="hl-7">shock</span><span class="hl-2"> } = </span><span class="hl-1">useRTCAction</span><span class="hl-2">()</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 加入语音房间</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleJoin</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-4">await</span><span class="hl-2"> </span><span class="hl-1">join</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-5">voiceId:</span><span class="hl-2"> </span><span class="hl-3">&#39;voice-id&#39;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">userId:</span><span class="hl-2"> </span><span class="hl-3">&#39;user-id&#39;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">roomId:</span><span class="hl-2"> </span><span class="hl-3">&#39;room-id&#39;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">type:</span><span class="hl-2"> </span><span class="hl-5">RTCType</span><span class="hl-2">.</span><span class="hl-5">RealseeBrowserRTC</span><br/><span class="hl-2"> })</span><br/><span class="hl-2"> }</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 检测麦克风权限</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleDetectMicro</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">hasPermission</span><span class="hl-2"> = </span><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">detectMicro</span><span class="hl-2">()</span><br/><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-3">&#39;麦克风权限:&#39;</span><span class="hl-2">, </span><span class="hl-5">hasPermission</span><span class="hl-2">)</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span>
80
+ <ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">detect<wbr/>Micro</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useRTCAction.__type-50.__type-51.__type-52.detectMicro.__type-53.__type-54"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">join</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">roomId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><a href="../enums/RTCType.html" class="tsd-signature-type tsd-kind-enum">RTCType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">userId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">voiceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useRTCAction.__type-50.__type-51.__type-52.join.__type-55.__type-56"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">roomId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><a href="../enums/RTCType.html" class="tsd-signature-type tsd-kind-enum">RTCType</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">userId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">voiceId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">room<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">: </span><a href="../enums/RTCType.html" class="tsd-signature-type tsd-kind-enum">RTCType</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">user<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">voice<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">quit</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useRTCAction.__type-50.__type-51.__type-52.quit.__type-57.__type-58"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">shock</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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useRTCAction.__type-50.__type-51.__type-52.shock.__type-59.__type-60"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">toggle<wbr/>Micro</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">flag</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useRTCAction.__type-50.__type-51.__type-52.toggleMicro-1.__type-61.__type-62"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">flag</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">flag</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-8" class="tsd-anchor"></a>Example<a href="#Example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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-8">join</span><span class="hl-2">, </span><span class="hl-8">quit</span><span class="hl-2">, </span><span class="hl-8">toggleMicro</span><span class="hl-2">, </span><span class="hl-8">detectMicro</span><span class="hl-2">, </span><span class="hl-8">shock</span><span class="hl-2"> } = </span><span class="hl-1">useRTCAction</span><span class="hl-2">()</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 加入语音房间</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleJoin</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-4">await</span><span class="hl-2"> </span><span class="hl-1">join</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-5">voiceId:</span><span class="hl-2"> </span><span class="hl-3">&#39;voice-id&#39;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">userId:</span><span class="hl-2"> </span><span class="hl-3">&#39;user-id&#39;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">roomId:</span><span class="hl-2"> </span><span class="hl-3">&#39;room-id&#39;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">type:</span><span class="hl-2"> </span><span class="hl-5">RTCType</span><span class="hl-2">.</span><span class="hl-5">RealseeBrowserRTC</span><br/><span class="hl-2"> })</span><br/><span class="hl-2"> }</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 检测麦克风权限</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleDetectMicro</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-8">hasPermission</span><span class="hl-2"> = </span><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-1">detectMicro</span><span class="hl-2">()</span><br/><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-3">&#39;麦克风权限:&#39;</span><span class="hl-2">, </span><span class="hl-5">hasPermission</span><span class="hl-2">)</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span>
81
81
  </code><button type="button">Copy</button></pre>
82
82
 
83
83
  </div></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">useRTCEvent<wbr/>Callback</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useRTCEventCallback.__type-63.__type-64.K-2">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useRTCEventCallback.__type-63.__type-64.K-2">K</a>, <span class="tsd-kind-parameter">callback</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-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/RTCEventType.html" class="tsd-signature-type tsd-kind-type-alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useRTCEventCallback.__type-63.__type-64.K-2">K</a><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><a href="../types/RTCEventType.html" class="tsd-signature-type tsd-kind-type-alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useRTCEventCallback.__type-63.__type-64.K-2">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span>, <span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DependencyList</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useRTCEventCallback.__type-63.__type-64"><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createLiveReact.html#createLiveReact.__type.useRTCEventCallback.__type-63.__type-64.K-2">K</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">callback</span>, <span class="tsd-kind-parameter">deps</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>监听 RTC 事件的 Hook</p>
@@ -95,16 +95,16 @@
95
95
  <p>返回当前用户信息的状态和更新函数，类似于 useState。
96
96
  当用户信息发生变化时，状态会自动更新。</p>
97
97
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/UserInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserInfo</a><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-kind-parameter">userInfo</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/UserInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserInfo</a><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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</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></h4><p>包含用户信息状态和更新函数的元组 [state, setState]</p>
98
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-10" class="tsd-anchor"></a>Example<a href="#Example-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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">selfInfo</span><span class="hl-2">, </span><span class="hl-7">setSelfInfo</span><span class="hl-2">] = </span><span class="hl-1">useSelfInfo</span><span class="hl-2">()</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 读取用户信息</span><br/><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-3">&#39;用户ID:&#39;</span><span class="hl-2">, </span><span class="hl-5">selfInfo</span><span class="hl-2">?.</span><span class="hl-5">id</span><span class="hl-2">)</span><br/><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-3">&#39;麦克风状态:&#39;</span><span class="hl-2">, </span><span class="hl-5">selfInfo</span><span class="hl-2">?.</span><span class="hl-5">micro_status</span><span class="hl-2">)</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 更新用户信息</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleUpdateInfo</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-4">await</span><span class="hl-2"> </span><span class="hl-1">setSelfInfo</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-5">extension:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-5">nickname:</span><span class="hl-2"> </span><span class="hl-3">&#39;新昵称&#39;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">avatar:</span><span class="hl-2"> </span><span class="hl-3">&#39;https://example.com/avatar.jpg&#39;</span><br/><span class="hl-2"> }</span><br/><span class="hl-2"> })</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span>
98
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-10" class="tsd-anchor"></a>Example<a href="#Example-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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-8">selfInfo</span><span class="hl-2">, </span><span class="hl-8">setSelfInfo</span><span class="hl-2">] = </span><span class="hl-1">useSelfInfo</span><span class="hl-2">()</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 读取用户信息</span><br/><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-3">&#39;用户ID:&#39;</span><span class="hl-2">, </span><span class="hl-5">selfInfo</span><span class="hl-2">?.</span><span class="hl-5">id</span><span class="hl-2">)</span><br/><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-3">&#39;麦克风状态:&#39;</span><span class="hl-2">, </span><span class="hl-5">selfInfo</span><span class="hl-2">?.</span><span class="hl-5">micro_status</span><span class="hl-2">)</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 更新用户信息</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">handleUpdateInfo</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-4">await</span><span class="hl-2"> </span><span class="hl-1">setSelfInfo</span><span class="hl-2">({</span><br/><span class="hl-2"> </span><span class="hl-5">extension:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-5">nickname:</span><span class="hl-2"> </span><span class="hl-3">&#39;新昵称&#39;</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-5">avatar:</span><span class="hl-2"> </span><span class="hl-3">&#39;https://example.com/avatar.jpg&#39;</span><br/><span class="hl-2"> }</span><br/><span class="hl-2"> })</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span>
99
99
  </code><button type="button">Copy</button></pre>
100
100
 
101
101
  </div></div></li></ul></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">use<wbr/>User<wbr/>List</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><a href="../types/UserInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserInfo</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="createLiveReact.__type.useUserList.__type-69.__type-70"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/UserInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserInfo</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>获取用户列表的 Hook</p>
102
102
  <p>返回当前房间内的用户列表，当用户列表发生变化时会自动更新。</p>
103
103
  </div><h4 class="tsd-returns-title">Returns <a href="../types/UserInfo.html" class="tsd-signature-type tsd-kind-type-alias">UserInfo</a><span class="tsd-signature-symbol">[]</span></h4><p>用户信息数组</p>
104
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-11" class="tsd-anchor"></a>Example<a href="#Example-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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">userList</span><span class="hl-2"> = </span><span class="hl-1">useUserList</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><br/><span class="hl-2"> &lt;</span><span class="hl-9">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> &lt;</span><span class="hl-9">h3</span><span class="hl-2">&gt;房间用户 ({userList.</span><span class="hl-5">length</span><span class="hl-2">})&lt;/</span><span class="hl-5">h3</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> {</span><span class="hl-5">userList</span><span class="hl-2">.</span><span class="hl-5">map</span><span class="hl-2">(</span><span class="hl-5">user</span><span class="hl-2"> =&gt; (</span><br/><span class="hl-2"> &lt;</span><span class="hl-5">div</span><span class="hl-2"> </span><span class="hl-5">key</span><span class="hl-2">={user.</span><span class="hl-5">id</span><span class="hl-2">}&gt;</span><br/><span class="hl-2"> {</span><span class="hl-5">user</span><span class="hl-2">.</span><span class="hl-5">extension</span><span class="hl-2">?.</span><span class="hl-5">nickname</span><span class="hl-2"> || </span><span class="hl-5">user</span><span class="hl-2">.</span><span class="hl-5">id</span><span class="hl-2">}</span><br/><span class="hl-2"> {</span><span class="hl-5">user</span><span class="hl-2">.</span><span class="hl-5">micro_status</span><span class="hl-2"> ? </span><span class="hl-3">&#39;🎤&#39;</span><span class="hl-2"> : </span><span class="hl-3">&#39;🔇&#39;</span><span class="hl-2">}</span><br/><span class="hl-2"> &lt;/</span><span class="hl-5">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> ))}</span><br/><span class="hl-2"> &lt;/</span><span class="hl-5">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> )</span><br/><span class="hl-2">}</span>
104
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-11" class="tsd-anchor"></a>Example<a href="#Example-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="typescript"><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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-8">userList</span><span class="hl-2"> = </span><span class="hl-1">useUserList</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><br/><span class="hl-2"> &lt;</span><span class="hl-7">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> &lt;</span><span class="hl-7">h3</span><span class="hl-2">&gt;房间用户 ({userList.</span><span class="hl-5">length</span><span class="hl-2">})&lt;/</span><span class="hl-5">h3</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> {</span><span class="hl-5">userList</span><span class="hl-2">.</span><span class="hl-5">map</span><span class="hl-2">(</span><span class="hl-5">user</span><span class="hl-2"> =&gt; (</span><br/><span class="hl-2"> &lt;</span><span class="hl-5">div</span><span class="hl-2"> </span><span class="hl-5">key</span><span class="hl-2">={user.</span><span class="hl-5">id</span><span class="hl-2">}&gt;</span><br/><span class="hl-2"> {</span><span class="hl-5">user</span><span class="hl-2">.</span><span class="hl-5">extension</span><span class="hl-2">?.</span><span class="hl-5">nickname</span><span class="hl-2"> || </span><span class="hl-5">user</span><span class="hl-2">.</span><span class="hl-5">id</span><span class="hl-2">}</span><br/><span class="hl-2"> {</span><span class="hl-5">user</span><span class="hl-2">.</span><span class="hl-5">micro_status</span><span class="hl-2"> ? </span><span class="hl-3">&#39;🎤&#39;</span><span class="hl-2"> : </span><span class="hl-3">&#39;🔇&#39;</span><span class="hl-2">}</span><br/><span class="hl-2"> &lt;/</span><span class="hl-5">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> ))}</span><br/><span class="hl-2"> &lt;/</span><span class="hl-5">div</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> )</span><br/><span class="hl-2">}</span>
105
105
  </code><button type="button">Copy</button></pre>
106
106
 
107
- </div></div></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-12" class="tsd-anchor"></a>Example<a href="#Example-12" 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">// 创建 LiveReact 实例</span><br/><span class="hl-6">const</span><span class="hl-2"> { </span><span class="hl-7">LiveProvider</span><span class="hl-2">, </span><span class="hl-7">useLiveAction</span><span class="hl-2">, </span><span class="hl-7">useKeyframe</span><span class="hl-2"> } = </span><span class="hl-1">createLiveReact</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><span class="hl-3">&#39;ticket&#39;</span><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><span class="hl-5">sdkAppId:</span><span class="hl-2"> </span><span class="hl-8">0</span><span class="hl-2">, </span><span class="hl-5">userId:</span><span class="hl-2"> </span><span class="hl-3">&#39;&#39;</span><span class="hl-2">, </span><span class="hl-5">userSig:</span><span class="hl-2"> </span><span class="hl-3">&#39;&#39;</span><span class="hl-2">, </span><span class="hl-5">roomId:</span><span class="hl-2"> </span><span class="hl-3">&#39;&#39;</span><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-6">function</span><span class="hl-2"> </span><span class="hl-1">App</span><span class="hl-2">() {</span><br/><span class="hl-2"> </span><span class="hl-4">return</span><span class="hl-2"> (</span><br/><span class="hl-2"> &lt;</span><span class="hl-9">LiveProvider</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> &lt;</span><span class="hl-5">MyComponent</span><span class="hl-2"> /&gt;</span><br/><span class="hl-2"> &lt;/</span><span class="hl-5">LiveProvider</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> )</span><br/><span class="hl-2">}</span><br/><br/><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</span><span class="hl-2">() {</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> { </span><span class="hl-7">connect</span><span class="hl-2">, </span><span class="hl-7">sendKeyframe</span><span class="hl-2"> } = </span><span class="hl-1">useLiveAction</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">camera</span><span class="hl-2">, </span><span class="hl-7">setCamera</span><span class="hl-2">] = </span><span class="hl-1">useKeyframe</span><span class="hl-2">(</span><span class="hl-3">&#39;camera&#39;</span><span class="hl-2">)</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 使用带看功能...</span><br/><span class="hl-2">}</span>
107
+ </div></div></li></ul></li></ul></li></ul><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example-12" class="tsd-anchor"></a>Example<a href="#Example-12" 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-7">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-7">number</span><span class="hl-2">, </span><span class="hl-7">number</span><span class="hl-2">, </span><span class="hl-7">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-7">string</span><span class="hl-2">; </span><span class="hl-5">position</span><span class="hl-2">: [</span><span class="hl-7">number</span><span class="hl-2">, </span><span class="hl-7">number</span><span class="hl-2">] }</span><br/><span class="hl-2">}</span><br/><br/><span class="hl-0">// 创建 LiveReact 实例</span><br/><span class="hl-6">const</span><span class="hl-2"> { </span><span class="hl-8">LiveProvider</span><span class="hl-2">, </span><span class="hl-8">useLiveAction</span><span class="hl-2">, </span><span class="hl-8">useKeyframe</span><span class="hl-2"> } = </span><span class="hl-1">createLiveReact</span><span class="hl-2">&lt;</span><span class="hl-7">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><span class="hl-3">&#39;ticket&#39;</span><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><span class="hl-5">sdkAppId:</span><span class="hl-2"> </span><span class="hl-9">0</span><span class="hl-2">, </span><span class="hl-5">userId:</span><span class="hl-2"> </span><span class="hl-3">&#39;&#39;</span><span class="hl-2">, </span><span class="hl-5">userSig:</span><span class="hl-2"> </span><span class="hl-3">&#39;&#39;</span><span class="hl-2">, </span><span class="hl-5">roomId:</span><span class="hl-2"> </span><span class="hl-3">&#39;&#39;</span><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-6">function</span><span class="hl-2"> </span><span class="hl-1">App</span><span class="hl-2">() {</span><br/><span class="hl-2"> </span><span class="hl-4">return</span><span class="hl-2"> (</span><br/><span class="hl-2"> &lt;</span><span class="hl-7">LiveProvider</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> &lt;</span><span class="hl-5">MyComponent</span><span class="hl-2"> /&gt;</span><br/><span class="hl-2"> &lt;/</span><span class="hl-5">LiveProvider</span><span class="hl-2">&gt;</span><br/><span class="hl-2"> )</span><br/><span class="hl-2">}</span><br/><br/><span class="hl-6">function</span><span class="hl-2"> </span><span class="hl-1">MyComponent</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-8">connect</span><span class="hl-2">, </span><span class="hl-8">sendKeyframe</span><span class="hl-2"> } = </span><span class="hl-1">useLiveAction</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-8">camera</span><span class="hl-2">, </span><span class="hl-8">setCamera</span><span class="hl-2">] = </span><span class="hl-1">useKeyframe</span><span class="hl-2">(</span><span class="hl-3">&#39;camera&#39;</span><span class="hl-2">)</span><br/><span class="hl-2"> </span><br/><span class="hl-2"> </span><span class="hl-0">// 使用带看功能...</span><br/><span class="hl-2">}</span>
108
108
  </code><button type="button">Copy</button></pre>
109
109
 
110
110
  </div></div><aside class="tsd-sources"><ul><li>Defined in live/createLiveReact.ts:77</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>