UNPKG

@jp-web/ts-sdk

Version:

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

368 lines 21.1 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>GuestCDProps | 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/_interface_guest_guestconstants_.html">&quot;interface/guest/GuestConstants&quot;</a> </li> <li> <a href="_interface_guest_guestconstants_.guestcdprops.html">GuestCDProps</a> </li> </ul> <h1>Interface GuestCDProps</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p><a href="../classes/_we_chat_guest_guest_wechatguest_.wechatguest.html">WeChatGuest</a>参数定义</p> </div> <dl class="tsd-comment-tags"> <dt>param</dt> <dd><p>appKey</p> </dd> <dt>param</dt> <dd><p>用户名</p> </dd> <dt>param</dt> <dd><p>密码</p> </dd> <dt>param</dt> <dd><p>账号密码(已弃用)</p> </dd> <dt>param</dt> <dd><p>-jmds类型, 访客小程序: JSM.JMDS.WeChat, 访客Web: JSM.JMDS.CallCenter</p> </dd> <dt>param</dt> <dd><p>区域 Id</p> </dd> <dt>param</dt> <dd><p>媒体类型, 0: 音频,1: 视频 默认1</p> </dd> <dt>param</dt> <dd><p>cd类型, Guest: 访客, meeting: 会议, WeChat: 微信小程序</p> </dd> <dt>param</dt> <dd><p>可选的会议密码,默认‘123456’</p> </dd> <dt>param</dt> <dd><p>会议视频尺寸级别</p> </dd> <dt>param</dt> <dd><p>是否加密传输</p> </dd> <dt>param</dt> <dd><p>收到视频的混合模式</p> </dd> <dt>param</dt> <dd><p>加入时的初始状态</p> </dd> <dt>param</dt> <dd><p>会议允许最大人数</p> </dd> <dt>param</dt> <dd><p>在会议中的角色</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">GuestCDProps</span> </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 tsd-is-external"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#accountname" class="tsd-kind-icon">account<wbr>Name</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#accountpwd" class="tsd-kind-icon">account<wbr>Pwd</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#appkey" class="tsd-kind-icon">app<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#cdtype" class="tsd-kind-icon">cd<wbr>Type</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#jmdstype" class="tsd-kind-icon">jmds<wbr>Type</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#mediatype" class="tsd-kind-icon">media<wbr>Type</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfcapacitykey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>Capacity<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfcompositemodekey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>Composite<wbr>Mode<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfpasswordkey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>Password<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfqualitygradekey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>Quality<wbr>Grade<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfrolekey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>Role<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfsecuritykey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>Security<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfstatekey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>State<wbr>Key</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#nickname" class="tsd-kind-icon">nick<wbr>Name</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestconstants_.guestcdprops.html#regionid" class="tsd-kind-icon">region<wbr>Id</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="accountname" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> account<wbr>Name</h3> <div class="tsd-signature tsd-kind-icon">account<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="accountpwd" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> account<wbr>Pwd</h3> <div class="tsd-signature tsd-kind-icon">account<wbr>Pwd<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="appkey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> app<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">app<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="cdtype" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> cd<wbr>Type</h3> <div class="tsd-signature tsd-kind-icon">cd<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"Guest"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"meeting"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"WeChat"</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="jmdstype" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> jmds<wbr>Type</h3> <div class="tsd-signature tsd-kind-icon">jmds<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"JSM.JMDS.WeChat"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"JSM.JMDS.CallCenter"</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="mediatype" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> media<wbr>Type</h3> <div class="tsd-signature tsd-kind-icon">media<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"1"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"0"</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="mtcconfcapacitykey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> mtc<wbr>Conf<wbr>Capacity<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">mtc<wbr>Conf<wbr>Capacity<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="mtcconfcompositemodekey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> mtc<wbr>Conf<wbr>Composite<wbr>Mode<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">mtc<wbr>Conf<wbr>Composite<wbr>Mode<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="mtcconfpasswordkey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> mtc<wbr>Conf<wbr>Password<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">mtc<wbr>Conf<wbr>Password<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="mtcconfqualitygradekey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> mtc<wbr>Conf<wbr>Quality<wbr>Grade<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">mtc<wbr>Conf<wbr>Quality<wbr>Grade<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="mtcconfrolekey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> mtc<wbr>Conf<wbr>Role<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">mtc<wbr>Conf<wbr>Role<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="mtcconfsecuritykey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> mtc<wbr>Conf<wbr>Security<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">mtc<wbr>Conf<wbr>Security<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="mtcconfstatekey" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> mtc<wbr>Conf<wbr>State<wbr>Key</h3> <div class="tsd-signature tsd-kind-icon">mtc<wbr>Conf<wbr>State<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="nickname" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> nick<wbr>Name</h3> <div class="tsd-signature tsd-kind-icon">nick<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="regionid" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> region<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">region<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> </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/_interface_guest_guestconstants_.html">&quot;interface/guest/<wbr>Guest<wbr>Constants&quot;</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-enum tsd-parent-kind-module tsd-is-external"> <a href="../enums/_interface_guest_guestconstants_.guestcallstatechangetype.html" class="tsd-kind-icon">Guest<wbr>Call<wbr>State<wbr>Change<wbr>Type</a> </li> <li class=" tsd-kind-enum tsd-parent-kind-module tsd-is-external"> <a href="../enums/_interface_guest_guestconstants_.guestclientstate.html" class="tsd-kind-icon">Guest<wbr>Client<wbr>State</a> </li> <li class=" tsd-kind-enum tsd-parent-kind-module tsd-is-external"> <a href="../enums/_interface_guest_guestconstants_.guestpicturesize.html" class="tsd-kind-icon">Guest<wbr>Picture<wbr>Size</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="_interface_guest_guestconstants_.groupinfo.html" class="tsd-kind-icon">Group<wbr>Info</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html" class="tsd-kind-icon">GuestCDProps</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#accountname" class="tsd-kind-icon">account<wbr>Name</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#accountpwd" class="tsd-kind-icon">account<wbr>Pwd</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#appkey" class="tsd-kind-icon">app<wbr>Key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#cdtype" class="tsd-kind-icon">cd<wbr>Type</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#jmdstype" class="tsd-kind-icon">jmds<wbr>Type</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#mediatype" class="tsd-kind-icon">media<wbr>Type</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfcapacitykey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>Capacity<wbr>Key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfcompositemodekey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>Composite<wbr>Mode<wbr>Key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfpasswordkey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>Password<wbr>Key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfqualitygradekey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>Quality<wbr>Grade<wbr>Key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfrolekey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>Role<wbr>Key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfsecuritykey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>Security<wbr>Key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#mtcconfstatekey" class="tsd-kind-icon">mtc<wbr>Conf<wbr>State<wbr>Key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#nickname" class="tsd-kind-icon">nick<wbr>Name</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestconstants_.guestcdprops.html#regionid" class="tsd-kind-icon">region<wbr>Id</a> </li> </ul> </li> </ul> <ul class="after-current"> </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>