@realsee/live 0.2.0 → 0.3.0-alpha.2

package/docs/classes/shared_utils.Subscribe.html

@@ -4,7 +4,7 @@
 </code></pre>
 </dd></dl></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules/shared_utils.html#EventMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventMap</a></h4><div class="tsd-comment tsd-typography"><div class="lead">
 <p>预设的监听回调类型</p>
-</div></div></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Subscribe</span><ul class="tsd-hierarchy"><li><a href="../interfaces/live.Live.html" class="tsd-signature-type" data-tsd-kind="Interface">Live</a></li><li><a href="../interfaces/RTCProtocol.RTCProtocol-1.html" class="tsd-signature-type" data-tsd-kind="Interface">RTCProtocol</a></li><li><a href="RTCProtocol.RTCExample.html" class="tsd-signature-type" data-tsd-kind="Class">RTCExample</a></li><li><a href="RTCProtocol.VRWebViewRTC.html" class="tsd-signature-type" data-tsd-kind="Class">VRWebViewRTC</a></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="shared_utils.Subscribe.html#hasListener" class="tsd-kind-icon">has<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#once" class="tsd-kind-icon">once</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>Subscribe<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="shared_utils.Subscribe.html" class="tsd-signature-type" data-tsd-kind="Class">Subscribe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules/shared_utils.html#EventMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventMap</a></h4></li></ul><h4 class="tsd-returns-title">Returns <a href="shared_utils.Subscribe.html" class="tsd-signature-type" data-tsd-kind="Class">Subscribe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="emit" class="tsd-anchor"></a><h3>emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, <span class="tsd-signature-symbol">...</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in shared-utils/Subscribe.ts:127</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+</div></div></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Subscribe</span><ul class="tsd-hierarchy"><li><a href="../interfaces/live.Live.html" class="tsd-signature-type" data-tsd-kind="Interface">Live</a></li><li><a href="../interfaces/RTCProtocol.RTCProtocol-1.html" class="tsd-signature-type" data-tsd-kind="Interface">RTCProtocol</a></li><li><a href="RTCProtocol.RTCExample.html" class="tsd-signature-type" data-tsd-kind="Class">RTCExample</a></li><li><a href="RTCProtocol.VRWebViewRTC.html" class="tsd-signature-type" data-tsd-kind="Class">VRWebViewRTC</a></li><li><a href="RTCProtocol.BrowserRTC.html" class="tsd-signature-type" data-tsd-kind="Class">BrowserRTC</a></li><li><a href="RTCProtocol.BrowserRTC4Chime.html" class="tsd-signature-type" data-tsd-kind="Class">BrowserRTC4Chime</a></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="shared_utils.Subscribe.html#hasListener" class="tsd-kind-icon">has<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="shared_utils.Subscribe.html#once" class="tsd-kind-icon">once</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">new <wbr/>Subscribe<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="shared_utils.Subscribe.html" class="tsd-signature-type" data-tsd-kind="Class">Subscribe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../modules/shared_utils.html#EventMap" class="tsd-signature-type" data-tsd-kind="Type alias">EventMap</a></h4></li></ul><h4 class="tsd-returns-title">Returns <a href="shared_utils.Subscribe.html" class="tsd-signature-type" data-tsd-kind="Class">Subscribe</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="emit" class="tsd-anchor"></a><h3>emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, <span class="tsd-signature-symbol">...</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in shared-utils/Subscribe.ts:127</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>触发事件</p>
 </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4><div class="tsd-comment tsd-typography"><div class="lead">
 <p>预设的监听事件名称</p>

package/docs/index.html

@@ -40,8 +40,11 @@ SDKs（iOS/Android/微信小程序）和 Live API 可以快速实现实时同屏
   <h3>安装 SDK</h3>
 </a>
 <p>可以通过 Node 包管理工具 <a href="https://www.npmjs.com/">npm</a> 或 <a href="https://yarnpkg.com/">yarn</a> 安装<strong>Live</strong>：</p>
-<pre><code class="hljs language-bash"><span class="hl-0"># npm</span><br/><span class="hl-1">npm i @realsee/live</span><br/><span class="hl-0"># yarn</span><br/><span class="hl-1">yarn add @realsee/live</span>
+<pre><code class="hljs language-bash"><span class="hl-0"># npm</span><br/><span class="hl-1">npm i @realsee/live tslib</span><br/><span class="hl-0"># yarn</span><br/><span class="hl-1">yarn add @realsee/live tslib</span>
 </code></pre>
+<blockquote>
+<p><strong>Live</strong> 通过 <a href="http://www.typescriptlang.org/">TypeScript</a> 编写，依赖 <a href="">tslib</a> 运行时，如果你的项目不是由 <a href="http://www.typescriptlang.org/">TypeScript</a> 构成，请安装此运行时。</p>
+</blockquote>
 
 <a href="#如何使用" id="如何使用" style="color: inherit; text-decoration: none;">
   <h3>如何使用</h3>
@@ -319,6 +322,34 @@ SDKs（iOS/Android/微信小程序）和 Live API 可以快速实现实时同屏
 <pre><code class="hljs language-js"><span class="hl-0">// 状态：用户是否成功加入语音房间</span><br/><span class="hl-3">live</span><span class="hl-1">.</span><span class="hl-3">$RTC</span><span class="hl-1">.</span><span class="hl-3">joined</span><br/><span class="hl-0">// 状态：用户麦克风状态</span><br/><span class="hl-3">live</span><span class="hl-1">.</span><span class="hl-3">$RTC</span><span class="hl-1">.</span><span class="hl-3">micro</span><br/><span class="hl-0">// 监听用户音量变化</span><br/><span class="hl-3">live</span><span class="hl-1">.</span><span class="hl-3">$RTC</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-4">&#39;userVolumes&#39;</span><span class="hl-1">, (</span><span class="hl-3">userVolumes</span><span class="hl-1">) </span><span class="hl-5">=&gt;</span><span class="hl-1"> {})</span>
 </code></pre>
 
+<a href="#浏览器端支持" id="浏览器端支持" style="color: inherit; text-decoration: none;">
+  <h2>浏览器端支持</h2>
+</a>
+<p>不同于客户端(Android\iOS) 已经内置 <strong>RTC</strong> 能力，浏览器端需要我们自己安装 第三方 <strong>RTC SDK</strong> 依赖。 <strong>Live</strong> 内置 腾讯<a href="https://github.com/tencentyun/TRTCSDK/blob/HEAD/Web/README-zh_CN.md">TRTC</a> 和 亚马逊<a href="https://github.com/aws/amazon-chime-sdk-js">Chime</a> 两个语音能力集成实现。</p>
+<blockquote>
+<p>纯浏览器端不需要 <strong>Native</strong> 中转能力，没有 <strong>jsBridge</strong> 依赖。</p>
+</blockquote>
+
+<a href="#trtc" id="trtc" style="color: inherit; text-decoration: none;">
+  <h3>TRTC</h3>
+</a>
+<p>安装依赖：</p>
+<pre><code class="hljs language-shell"><span class="hl-0"># 需要您自行安装</span><br/><span class="hl-1">yarn add trtc-js-sdk</span>
+</code></pre>
+<p>使用方式：</p>
+<pre><code class="hljs language-tsx"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-3">createLive</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-4">&#39;@realsee/live&#39;</span><br/><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-3">BrowserRTC</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-4">&#39;@realsee/live/RTC/BrowserRTC&#39;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">rtcInstance</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-7">VRWebViewRTC</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-7">getVoiceSign</span><span class="hl-3">:</span><span class="hl-1"> () </span><span class="hl-5">=&gt;</span><span class="hl-1"> {},</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">live</span><span class="hl-1"> = </span><span class="hl-7">createLive</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-3">rtc:</span><span class="hl-1"> </span><span class="hl-3">rtcInstance</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-7">getTicket</span><span class="hl-3">:</span><span class="hl-1"> </span><span class="hl-5">async</span><span class="hl-1"> () </span><span class="hl-5">=&gt;</span><span class="hl-1"> </span><span class="hl-4">&#39;&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">})</span>
+</code></pre>
+
+<a href="#chime" id="chime" style="color: inherit; text-decoration: none;">
+  <h3>Chime</h3>
+</a>
+<p>安装依赖：</p>
+<pre><code class="hljs language-shell"><span class="hl-0"># 需要您自行安装</span><br/><span class="hl-1">yarn add amazon-chime-sdk-js</span>
+</code></pre>
+<p>使用方式：</p>
+<pre><code class="hljs language-tsx"><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-3">createLive</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-4">&#39;@realsee/live&#39;</span><br/><span class="hl-2">import</span><span class="hl-1"> { </span><span class="hl-3">BrowserRTC4Chime</span><span class="hl-1"> } </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-4">&#39;@realsee/live/RTC/BrowserRTC4Chime&#39;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">rtcInstance</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-7">BrowserRTC4Chime</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-7">getVoiceSign</span><span class="hl-3">:</span><span class="hl-1"> () </span><span class="hl-5">=&gt;</span><span class="hl-1"> {},</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">live</span><span class="hl-1"> = </span><span class="hl-7">createLive</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-3">rtc:</span><span class="hl-1"> </span><span class="hl-3">rtcInstance</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-7">getTicket</span><span class="hl-3">:</span><span class="hl-1"> </span><span class="hl-5">async</span><span class="hl-1"> () </span><span class="hl-5">=&gt;</span><span class="hl-1"> </span><span class="hl-4">&#39;&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">})</span>
+</code></pre>
+
 <a href="#typescript-amp-react-支持" id="typescript-amp-react-支持" style="color: inherit; text-decoration: none;">
   <h2>TypeScript &amp; React 支持</h2>
 </a>

package/docs/interfaces/RTCProtocol.RTCProtocol-1.html

@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RTCProtocol | 如视 Live SDK</title><meta name="description" content="Documentation for 如视 Live SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Live SDK</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">如视 Live SDK</a></li><li><a href="../modules/RTCProtocol.html">RTCProtocol</a></li><li><a href="RTCProtocol.RTCProtocol-1.html">RTCProtocol</a></li></ul><h1>Interface RTCProtocol</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="../classes/shared_utils.Subscribe.html" class="tsd-signature-type" data-tsd-kind="Class">Subscribe</a><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">RTCProtocol</span></li></ul></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/RTCProtocol.RTCExample.html" class="tsd-signature-type" data-tsd-kind="Class">RTCExample</a></li><li><a href="../classes/RTCProtocol.VRWebViewRTC.html" class="tsd-signature-type" data-tsd-kind="Class">VRWebViewRTC</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#joined" class="tsd-kind-icon">joined</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#micro" class="tsd-kind-icon">micro</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#voiceId" class="tsd-kind-icon">voice<wbr/>Id</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#detectMicro" class="tsd-kind-icon">detect<wbr/>Micro</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#hasListener" class="tsd-kind-icon">has<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#join" class="tsd-kind-icon">join</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#quit" class="tsd-kind-icon">quit</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#shock" class="tsd-kind-icon">shock</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#toggleMicro" class="tsd-kind-icon">toggle<wbr/>Micro</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="joined" class="tsd-anchor"></a><h3>joined</h3><div class="tsd-signature tsd-kind-icon">joined<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:10</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="micro" class="tsd-anchor"></a><h3>micro</h3><div class="tsd-signature tsd-kind-icon">micro<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:11</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/RTCProtocol.RTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCType</a></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="voiceId" class="tsd-anchor"></a><h3>voice<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">voice<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:12</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="detectMicro" class="tsd-anchor"></a><h3>detect<wbr/>Micro</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">detect<wbr/>Micro<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></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:30</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RTCProtocol | 如视 Live SDK</title><meta name="description" content="Documentation for 如视 Live SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Live SDK</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">如视 Live SDK</a></li><li><a href="../modules/RTCProtocol.html">RTCProtocol</a></li><li><a href="RTCProtocol.RTCProtocol-1.html">RTCProtocol</a></li></ul><h1>Interface RTCProtocol</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="../classes/shared_utils.Subscribe.html" class="tsd-signature-type" data-tsd-kind="Class">Subscribe</a><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">RTCProtocol</span></li></ul></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/RTCProtocol.BrowserRTC.html" class="tsd-signature-type" data-tsd-kind="Class">BrowserRTC</a></li><li><a href="../classes/RTCProtocol.BrowserRTC4Chime.html" class="tsd-signature-type" data-tsd-kind="Class">BrowserRTC4Chime</a></li><li><a href="../classes/RTCProtocol.RTCExample.html" class="tsd-signature-type" data-tsd-kind="Class">RTCExample</a></li><li><a href="../classes/RTCProtocol.VRWebViewRTC.html" class="tsd-signature-type" data-tsd-kind="Class">VRWebViewRTC</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#joined" class="tsd-kind-icon">joined</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#micro" class="tsd-kind-icon">micro</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#voiceId" class="tsd-kind-icon">voice<wbr/>Id</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#detectMicro" class="tsd-kind-icon">detect<wbr/>Micro</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#hasListener" class="tsd-kind-icon">has<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#join" class="tsd-kind-icon">join</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a href="RTCProtocol.RTCProtocol-1.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#quit" class="tsd-kind-icon">quit</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#shock" class="tsd-kind-icon">shock</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="RTCProtocol.RTCProtocol-1.html#toggleMicro" class="tsd-kind-icon">toggle<wbr/>Micro</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="joined" class="tsd-anchor"></a><h3>joined</h3><div class="tsd-signature tsd-kind-icon">joined<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:10</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="micro" class="tsd-anchor"></a><h3>micro</h3><div class="tsd-signature tsd-kind-icon">micro<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:11</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="type" class="tsd-anchor"></a><h3>type</h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/RTCProtocol.RTCType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RTCType</a></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="voiceId" class="tsd-anchor"></a><h3>voice<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">voice<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:12</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="detectMicro" class="tsd-anchor"></a><h3>detect<wbr/>Micro</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">detect<wbr/>Micro<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></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in typings/RTCProtocol.ts:30</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>监测麦克风授权。</p>
 </div></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><div></div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><a id="emit" class="tsd-anchor"></a><h3>emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span>, <span class="tsd-signature-symbol">...</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/RTCProtocol.html#RTCEventType" class="tsd-signature-type" data-tsd-kind="Type alias">RTCEventType</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="../classes/shared_utils.Subscribe.html">Subscribe</a>.<a href="../classes/shared_utils.Subscribe.html#emit">emit</a></p><ul><li>Defined in shared-utils/Subscribe.ts:127</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>触发事件</p>