UNPKG

@jp-web/ts-sdk

Version:

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

243 lines 11.4 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>GuestCallParam | 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_guestcallparam_.html">&quot;interface/guest/GuestCallParam&quot;</a> </li> <li> <a href="_interface_guest_guestcallparam_.guestcallparam.html">GuestCallParam</a> </li> </ul> <h1>Interface GuestCallParam</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>呼叫时的可选参数</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">GuestCallParam</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-private tsd-is-external"><a href="_interface_guest_guestcallparam_.guestcallparam.html#agentuserid" class="tsd-kind-icon">agent<wbr>User<wbr>Id</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestcallparam_.guestcallparam.html#displayname" class="tsd-kind-icon">display<wbr>Name</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestcallparam_.guestcallparam.html#extraparam" class="tsd-kind-icon">extra<wbr>Param</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestcallparam_.guestcallparam.html#securitytype" class="tsd-kind-icon">security<wbr>Type</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestcallparam_.guestcallparam.html#svcresolution" class="tsd-kind-icon">svc<wbr>Resolution</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_guest_guestcallparam_.guestcallparam.html#wholeratio" class="tsd-kind-icon">whole<wbr>Ratio</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-private tsd-is-external"> <a name="agentuserid" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagPrivate">Private</span> agent<wbr>User<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">agent<wbr>User<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>点对点呼叫时指定的坐席userId</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="displayname" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> display<wbr>Name</h3> <div class="tsd-signature tsd-kind-icon">display<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>昵称,显示用户名,支持中文</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="extraparam" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> extra<wbr>Param</h3> <div class="tsd-signature tsd-kind-icon">extra<wbr>Param<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>附带消息</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="securitytype" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> security<wbr>Type</h3> <div class="tsd-signature tsd-kind-icon">security<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="../enums/_interface_guest_guestcallparam_.guestsecuritytype.html" class="tsd-signature-type">GuestSecurityType</a></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>加密方式</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="svcresolution" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> svc<wbr>Resolution</h3> <div class="tsd-signature tsd-kind-icon">svc<wbr>Resolution<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>SVC层分辨率</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="wholeratio" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> whole<wbr>Ratio</h3> <div class="tsd-signature tsd-kind-icon">whole<wbr>Ratio<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>全局宽高比,影响视频的长宽比</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/_interface_guest_guestcallparam_.html">&quot;interface/guest/<wbr>Guest<wbr>Call<wbr>Param&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_guestcallparam_.guestsecuritytype.html" class="tsd-kind-icon">Guest<wbr>Security<wbr>Type</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="_interface_guest_guestcallparam_.guestcallparam.html" class="tsd-kind-icon">Guest<wbr>Call<wbr>Param</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-private tsd-is-external"> <a href="_interface_guest_guestcallparam_.guestcallparam.html#agentuserid" class="tsd-kind-icon">agent<wbr>User<wbr>Id</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestcallparam_.guestcallparam.html#displayname" class="tsd-kind-icon">display<wbr>Name</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestcallparam_.guestcallparam.html#extraparam" class="tsd-kind-icon">extra<wbr>Param</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestcallparam_.guestcallparam.html#securitytype" class="tsd-kind-icon">security<wbr>Type</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestcallparam_.guestcallparam.html#svcresolution" class="tsd-kind-icon">svc<wbr>Resolution</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_guest_guestcallparam_.guestcallparam.html#wholeratio" class="tsd-kind-icon">whole<wbr>Ratio</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>