@jp-web/ts-sdk

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>JuphoonRTCGuest | webrtc-guest-sdk</title> <meta name="description" content="Documentation for webrtc-guest-sdk"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </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">webrtc-guest-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> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../index.html">Globals</a> </li> <li> <a href="index_ts.html">index.ts</a> </li> <li> <a href="index_ts.juphoonrtcguest.html">JuphoonRTCGuest</a> </li> </ul> <h1>Namespace JuphoonRTCGuest</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section tsd-is-external tsd-is-not-exported"> <h3>Variables</h3> <ul class="tsd-index-list"> <li class="tsd-kind-variable tsd-parent-kind-namespace tsd-is-external tsd-is-not-exported"><a href="index_ts.juphoonrtcguest.html#reporter" class="tsd-kind-icon">reporter</a></li> <li class="tsd-kind-variable tsd-parent-kind-namespace tsd-is-external tsd-is-not-exported"><a href="index_ts.juphoonrtcguest.html#tokenmap" class="tsd-kind-icon">token<wbr>Map</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-is-external"><a href="index_ts.juphoonrtcguest.html#createguestclient" class="tsd-kind-icon">create<wbr>Guest<wbr>Client</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-is-external"><a href="index_ts.juphoonrtcguest.html#getmediadevices" class="tsd-kind-icon">get<wbr>Media<wbr>Devices</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-is-external"><a href="index_ts.juphoonrtcguest.html#gettoken" class="tsd-kind-icon">get<wbr>Token</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-is-external"><a href="index_ts.juphoonrtcguest.html#getversion" class="tsd-kind-icon">get<wbr>Version</a></li> <li class="tsd-kind-function tsd-parent-kind-namespace tsd-is-external"><a href="index_ts.juphoonrtcguest.html#setconfig" class="tsd-kind-icon">set<wbr>Config</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Object literals</h3> <ul class="tsd-index-list"> <li class="tsd-kind-object-literal tsd-parent-kind-namespace tsd-is-external"><a href="index_ts.juphoonrtcguest.html#config" class="tsd-kind-icon">config</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external tsd-is-not-exported"> <h2>Variables</h2> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external tsd-is-not-exported"> <a name="reporter" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> reporter</h3> <div class="tsd-signature tsd-kind-icon">reporter<span class="tsd-signature-symbol">:</span> <a href="../classes/_reporter_reporter_.reporter.html" class="tsd-signature-type">Reporter</a><span class="tsd-signature-symbol"> = new Reporter('JuphoonRTCGuest')</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace tsd-is-external tsd-is-not-exported"> <a name="tokenmap" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> token<wbr>Map</h3> <div class="tsd-signature tsd-kind-icon">token<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5> </li> </ul> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <a name="createguestclient" class="tsd-anchor"></a> <h3>create<wbr>Guest<wbr>Client</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <li class="tsd-signature tsd-kind-icon">create<wbr>Guest<wbr>Client<span class="tsd-signature-symbol">(</span>appKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, token<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, socketAddress<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><a href="../classes/_webrtc_guest_rtcguest_.rtcguest.html" class="tsd-signature-type">RTCGuest</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>创建会议客户端</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>appKey: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>appKey</p> </div> </li> <li> <h5>token: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>自行获取到的token</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> socketAddress: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>WebSocket的连接地址</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../classes/_webrtc_guest_rtcguest_.rtcguest.html" class="tsd-signature-type">RTCGuest</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <a name="getmediadevices" class="tsd-anchor"></a> <h3>get<wbr>Media<wbr>Devices</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get<wbr>Media<wbr>Devices<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"><</span><a href="../classes/_webrtc_web_devices_info_webdevicesinfo_._webdevicesinfo.html" class="tsd-signature-type">_WebDevicesInfo</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_webrtc_web_devices_info_webdevicesinfo_._webdevicesinfo.html" class="tsd-signature-type">_WebDevicesInfo</a><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <a name="gettoken" class="tsd-anchor"></a> <h3>get<wbr>Token</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get<wbr>Token<span class="tsd-signature-symbol">(</span>url<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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>获取用于WebSocket校验的token</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>获取token的http地址</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <a name="getversion" class="tsd-anchor"></a> <h3>get<wbr>Version</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get<wbr>Version<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>desc</dt> <dd><p>获取SDK版本信息</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <a name="setconfig" class="tsd-anchor"></a> <h3>set<wbr>Config</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <li class="tsd-signature tsd-kind-icon">set<wbr>Config<span class="tsd-signature-symbol">(</span>_config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>address<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">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>配置SDK参数</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>_config: <span class="tsd-signature-symbol">{ </span>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>设置服务环境地址. 支持类型 <code>http(s)://IP:PORT</code>. 设置后<a href="index_ts.juphoonrtcguest.html#createguestclient">createGuestClient</a>不再需要传入 <code>socketAddress</code> 参数</p> </div> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Object literals</h2> <section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-namespace tsd-is-external"> <a name="config" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> config</h3> <div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <aside class="tsd-sources"> </aside> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external"> <a name="config.client" class="tsd-anchor"></a> <h3>client</h3> <div class="tsd-signature tsd-kind-icon">client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external"> <a name="config.envinfo" class="tsd-anchor"></a> <h3>env<wbr>Info</h3> <div class="tsd-signature tsd-kind-icon">env<wbr>Info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external"> <a name="config.socket" class="tsd-anchor"></a> <h3>socket</h3> <div class="tsd-signature tsd-kind-icon">socket<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal tsd-is-external"> <a name="config.userid" class="tsd-anchor"></a> <h3>user<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">user<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div> <aside class="tsd-sources"> </aside> </section> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../index.html"><em>Globals</em></a> </li> <li class="current tsd-kind-module tsd-is-external"> <a href="index_ts.html">index.ts</a> <ul> <li class="current tsd-kind-namespace tsd-parent-kind-module tsd-is-external"> <a href="index_ts.juphoonrtcguest.html">JuphoonRTCGuest</a> </li> </ul> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-variable tsd-parent-kind-namespace tsd-is-external tsd-is-not-exported"> <a href="index_ts.juphoonrtcguest.html#reporter" class="tsd-kind-icon">reporter</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-namespace tsd-is-external tsd-is-not-exported"> <a href="index_ts.juphoonrtcguest.html#tokenmap" class="tsd-kind-icon">token<wbr>Map</a> </li> <li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <a href="index_ts.juphoonrtcguest.html#createguestclient" class="tsd-kind-icon">create<wbr>Guest<wbr>Client</a> </li> <li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <a href="index_ts.juphoonrtcguest.html#getmediadevices" class="tsd-kind-icon">get<wbr>Media<wbr>Devices</a> </li> <li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <a href="index_ts.juphoonrtcguest.html#gettoken" class="tsd-kind-icon">get<wbr>Token</a> </li> <li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <a href="index_ts.juphoonrtcguest.html#getversion" class="tsd-kind-icon">get<wbr>Version</a> </li> <li class=" tsd-kind-function tsd-parent-kind-namespace tsd-is-external"> <a href="index_ts.juphoonrtcguest.html#setconfig" class="tsd-kind-icon">set<wbr>Config</a> </li> <li class=" tsd-kind-object-literal tsd-parent-kind-namespace tsd-is-external"> <a href="index_ts.juphoonrtcguest.html#config" class="tsd-kind-icon">config</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>