UNPKG

@jp-web/ts-sdk

Version:

视频客服,视频会议Web端及微信小程序端SDK

356 lines 17.6 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ConferenceRole | 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="../modules/_mtcdef_conferencerole_.html">&quot;mtcDef/ConferenceRole&quot;</a> </li> <li> <a href="_mtcdef_conferencerole_.conferencerole.html">ConferenceRole</a> </li> </ul> <h1>Enumeration ConferenceRole</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"> <h3>Enumeration members</h3> <ul class="tsd-index-list"> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#actor" class="tsd-kind-icon">ACTOR</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#agent" class="tsd-kind-icon">AGENT</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#delivery_irc" class="tsd-kind-icon">DELIVERY_<wbr>IRC</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#delivery_mask" class="tsd-kind-icon">DELIVERY_<wbr>MASK</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#delivery_mcu" class="tsd-kind-icon">DELIVERY_<wbr>MCU</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#delivery_pstn" class="tsd-kind-icon">DELIVERY_<wbr>PSTN</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#delivery_webrtc" class="tsd-kind-icon">DELIVERY_<wbr>WEBRTC</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#guest" class="tsd-kind-icon">GUEST</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#owner" class="tsd-kind-icon">OWNER</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#partp" class="tsd-kind-icon">PARTP</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#player" class="tsd-kind-icon">PLAYER</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#sender" class="tsd-kind-icon">SENDER</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#service_mask" class="tsd-kind-icon">SERVICE_<wbr>MASK</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_mtcdef_conferencerole_.conferencerole.html#viewer" class="tsd-kind-icon">VIEWER</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Enumeration members</h2> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="actor" class="tsd-anchor"></a> <h3>ACTOR</h3> <div class="tsd-signature tsd-kind-icon">ACTOR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = VIEWER | SENDER</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>can receive and send</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="agent" class="tsd-anchor"></a> <h3>AGENT</h3> <div class="tsd-signature tsd-kind-icon">AGENT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 64</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>a call center role</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="delivery_irc" class="tsd-anchor"></a> <h3>DELIVERY_<wbr>IRC</h3> <div class="tsd-signature tsd-kind-icon">DELIVERY_<wbr>IRC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 256</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>the autogen by Conference and only one participant</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="delivery_mask" class="tsd-anchor"></a> <h3>DELIVERY_<wbr>MASK</h3> <div class="tsd-signature tsd-kind-icon">DELIVERY_<wbr>MASK<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = DELIVERY_IRC | DELIVERY_WEBRTC | DELIVERY_PSTN</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The valid delivery role mask</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="delivery_mcu" class="tsd-anchor"></a> <h3>DELIVERY_<wbr>MCU</h3> <div class="tsd-signature tsd-kind-icon">DELIVERY_<wbr>MCU<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 2048</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The role of ConfDelivery for MCU</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="delivery_pstn" class="tsd-anchor"></a> <h3>DELIVERY_<wbr>PSTN</h3> <div class="tsd-signature tsd-kind-icon">DELIVERY_<wbr>PSTN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 1024</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The role of ConfDelivery for PSTN</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="delivery_webrtc" class="tsd-anchor"></a> <h3>DELIVERY_<wbr>WEBRTC</h3> <div class="tsd-signature tsd-kind-icon">DELIVERY_<wbr>WEBRTC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 512</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The role of ConfDelivery for WebRTC</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="guest" class="tsd-anchor"></a> <h3>GUEST</h3> <div class="tsd-signature tsd-kind-icon">GUEST<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 128</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>a call center role</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="owner" class="tsd-anchor"></a> <h3>OWNER</h3> <div class="tsd-signature tsd-kind-icon">OWNER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 8</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>the autogen by Conference and only one participant</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="partp" class="tsd-anchor"></a> <h3>PARTP</h3> <div class="tsd-signature tsd-kind-icon">PARTP<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = VIEWER | SENDER | PLAYER</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>normal participant, this is default roles</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="player" class="tsd-anchor"></a> <h3>PLAYER</h3> <div class="tsd-signature tsd-kind-icon">PLAYER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 4</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>his event will be broadcast</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="sender" class="tsd-anchor"></a> <h3>SENDER</h3> <div class="tsd-signature tsd-kind-icon">SENDER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 2</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>only can send</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="service_mask" class="tsd-anchor"></a> <h3>SERVICE_<wbr>MASK</h3> <div class="tsd-signature tsd-kind-icon">SERVICE_<wbr>MASK<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 65535</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The valid service mask, keep for special purpose</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="viewer" class="tsd-anchor"></a> <h3>VIEWER</h3> <div class="tsd-signature tsd-kind-icon">VIEWER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 1</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>only can receive</p> </div> </div> </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="../modules/_mtcdef_conferencerole_.html">&quot;mtc<wbr>Def/<wbr>Conference<wbr>Role&quot;</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-enum tsd-parent-kind-module tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html" class="tsd-kind-icon">Conference<wbr>Role</a> <ul> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#actor" class="tsd-kind-icon">ACTOR</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#agent" class="tsd-kind-icon">AGENT</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#delivery_irc" class="tsd-kind-icon">DELIVERY_<wbr>IRC</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#delivery_mask" class="tsd-kind-icon">DELIVERY_<wbr>MASK</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#delivery_mcu" class="tsd-kind-icon">DELIVERY_<wbr>MCU</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#delivery_pstn" class="tsd-kind-icon">DELIVERY_<wbr>PSTN</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#delivery_webrtc" class="tsd-kind-icon">DELIVERY_<wbr>WEBRTC</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#guest" class="tsd-kind-icon">GUEST</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#owner" class="tsd-kind-icon">OWNER</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#partp" class="tsd-kind-icon">PARTP</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#player" class="tsd-kind-icon">PLAYER</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#sender" class="tsd-kind-icon">SENDER</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#service_mask" class="tsd-kind-icon">SERVICE_<wbr>MASK</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_mtcdef_conferencerole_.conferencerole.html#viewer" class="tsd-kind-icon">VIEWER</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-enum tsd-parent-kind-module tsd-is-external"> <a href="_mtcdef_conferencerole_.simplerolecompose.html" class="tsd-kind-icon">Simple<wbr>Role<wbr>Compose</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>