@jp-web/ts-sdk
Version:
视频客服，视频会议Web端及微信小程序端SDK
720 lines • 45.9 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Conference | wechat-conference-sdk</title>
<meta name="description" content="Documentation for wechat-conference-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">wechat-conference-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_conference_conference_.html">"interface/conference/Conference"</a>
</li>
<li>
<a href="_interface_conference_conference_.conference.html">Conference</a>
</li>
</ul>
<h1>Interface Conference</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">Conference</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/_webrtc_conference_rtcconference_.rtcconference.html" class="tsd-signature-type">RTCConference</a></li>
<li><a href="../classes/_we_chat_conference_wechatconference_.wechatconference.html" class="tsd-signature-type">WeChatConference</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 tsd-is-external">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#disableaudiooutput" class="tsd-kind-icon">disable<wbr>Audio<wbr>Output</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#disableuploadaudiostream" class="tsd-kind-icon">disable<wbr>Upload<wbr>Audio<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#disableuploadvideostream" class="tsd-kind-icon">disable<wbr>Upload<wbr>Video<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#enableaudiooutput" class="tsd-kind-icon">enable<wbr>Audio<wbr>Output</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#enableuploadaudiostream" class="tsd-kind-icon">enable<wbr>Upload<wbr>Audio<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#enableuploadvideostream" class="tsd-kind-icon">enable<wbr>Upload<wbr>Video<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#join" class="tsd-kind-icon">join</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#leave" class="tsd-kind-icon">leave</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#login" class="tsd-kind-icon">login</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#query" class="tsd-kind-icon">query</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#requestvideo" class="tsd-kind-icon">request<wbr>Video</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#sendmessage" class="tsd-kind-icon">send<wbr>Message</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#setaudioroute" class="tsd-kind-icon">set<wbr>Audio<wbr>Route</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#start" class="tsd-kind-icon">start</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#startcameravideo" class="tsd-kind-icon">start<wbr>Camera<wbr>Video</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#startvideo" class="tsd-kind-icon">start<wbr>Video</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#stop" class="tsd-kind-icon">stop</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_interface_conference_conference_.conference.html#switchcamera" class="tsd-kind-icon">switch<wbr>Camera</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">destroy<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>销毁实例</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a name="disableaudiooutput" class="tsd-anchor"></a>
<h3>disable<wbr>Audio<wbr>Output</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">disable<wbr>Audio<wbr>Output<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><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>取消订阅会议音频流</p>
</div>
</div>
<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-method tsd-parent-kind-interface tsd-is-external">
<a name="disableuploadaudiostream" class="tsd-anchor"></a>
<h3>disable<wbr>Upload<wbr>Audio<wbr>Stream</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">disable<wbr>Upload<wbr>Audio<wbr>Stream<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><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>关闭发送本地音频流，会议中的成员会收到<a href="../enums/_interface_conference_conferenceeventtype_.conferenceeventtype.html#conference_participant_update">ConferenceEventType.CONFERENCE_PARTICIPANT_UPDATE</a>回调
当前的状态@see JCConferenceInfo 对象的接口 getUploadAudio()</p>
</div>
</div>
<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-method tsd-parent-kind-interface tsd-is-external">
<a name="disableuploadvideostream" class="tsd-anchor"></a>
<h3>disable<wbr>Upload<wbr>Video<wbr>Stream</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">disable<wbr>Upload<wbr>Video<wbr>Stream<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><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>关闭发送本地视频流，会议中的成员会收到<a href="../enums/_interface_conference_conferenceeventtype_.conferenceeventtype.html#conference_participant_update">ConferenceEventType.CONFERENCE_PARTICIPANT_UPDATE</a>回调
当前的状态@see JCConferenceInfo 对象的接口 getUploadVideo()</p>
</div>
</div>
<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-method tsd-parent-kind-interface tsd-is-external">
<a name="enableaudiooutput" class="tsd-anchor"></a>
<h3>enable<wbr>Audio<wbr>Output</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">enable<wbr>Audio<wbr>Output<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><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>订阅会议音频流，关闭订阅将无法听到会议中其他成员的声音</p>
</div>
</div>
<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-method tsd-parent-kind-interface tsd-is-external">
<a name="enableuploadaudiostream" class="tsd-anchor"></a>
<h3>enable<wbr>Upload<wbr>Audio<wbr>Stream</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">enable<wbr>Upload<wbr>Audio<wbr>Stream<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><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>开启发送本地音频流，会议中的成员会收到<a href="../enums/_interface_conference_conferenceeventtype_.conferenceeventtype.html#conference_participant_update">ConferenceEventType.CONFERENCE_PARTICIPANT_UPDATE</a>回调
当前的状态@see JCConferenceInfo 对象的接口 getUploadAudio()</p>
</div>
</div>
<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-method tsd-parent-kind-interface tsd-is-external">
<a name="enableuploadvideostream" class="tsd-anchor"></a>
<h3>enable<wbr>Upload<wbr>Video<wbr>Stream</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">enable<wbr>Upload<wbr>Video<wbr>Stream<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><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>开启发送本地视频流，会议中的成员会收到<a href="../enums/_interface_conference_conferenceeventtype_.conferenceeventtype.html#conference_participant_update">ConferenceEventType.CONFERENCE_PARTICIPANT_UPDATE</a>回调
当前的状态@see JCConferenceInfo 对象的接口 getUploadVideo()</p>
</div>
</div>
<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-method tsd-parent-kind-interface tsd-is-external">
<a name="join" class="tsd-anchor"></a>
<h3>join</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">join<span class="tsd-signature-symbol">(</span>confNumber<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, video<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, joinParam<span class="tsd-signature-symbol">: </span><a href="_interface_conference_conferencejoinparam_.conferencejoinparam.html" class="tsd-signature-type">ConferenceJoinParam</a><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>加入一个会议，结果回调由<a href="../enums/_interface_conference_conferenceeventtype_.conferenceeventtype.html#conference_join">ConferenceEventType.CONFERENCE_JOIN</a>上报</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>confNumber: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>传 "0" 由服务器生成10位的会议号，可传字母或数字作为自定义会议号</p>
</div>
</li>
<li>
<h5>video: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>传递 true 即可. <strong>目前强制为视频会议, 语音会议暂不可用</strong></p>
</div>
</li>
<li>
<h5>joinParam: <a href="_interface_conference_conferencejoinparam_.conferencejoinparam.html" class="tsd-signature-type">ConferenceJoinParam</a></h5>
<div class="tsd-comment tsd-typography">
<p>加入会议额外参数</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-method tsd-parent-kind-interface tsd-is-external">
<a name="leave" class="tsd-anchor"></a>
<h3>leave</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">leave<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><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>离开会议，结果回调由<a href="../enums/_interface_conference_conferenceeventtype_.conferenceeventtype.html#conference_leave">ConferenceEventType.CONFERENCE_LEAVE</a>上报</p>
</div>
</div>
<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-method tsd-parent-kind-interface tsd-is-external">
<a name="login" class="tsd-anchor"></a>
<h3>login</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">login<span class="tsd-signature-symbol">(</span>confProps<span class="tsd-signature-symbol">: </span><a href="_interface_conference_conferenceconstants_.conferencecdprops.html" class="tsd-signature-type">ConferenceCDProps</a><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>创建CD并登录</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>confProps: <a href="_interface_conference_conferenceconstants_.conferencecdprops.html" class="tsd-signature-type">ConferenceCDProps</a></h5>
</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-method tsd-parent-kind-interface tsd-is-external">
<a name="query" class="tsd-anchor"></a>
<h3>query</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">query<span class="tsd-signature-symbol">(</span>channelId<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>根据 channelId(房间号) 查询会议是否存在</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>channelId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
</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-method tsd-parent-kind-interface tsd-is-external">
<a name="requestvideo" class="tsd-anchor"></a>
<h3>request<wbr>Video</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">request<wbr>Video<span class="tsd-signature-symbol">(</span>participant<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pictureSize<span class="tsd-signature-symbol">: </span><a href="../enums/_interface_conference_conferenceconstants_.conferencepicturesize.html" class="tsd-signature-type">ConferencePictureSize</a><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>请求用户的视频流
当 pictureSize 为 PictureSizeNone 标识关闭请求</p>
</div>
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p>ConferencePictureSize</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>participant: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>用户对象</p>
</div>
</li>
<li>
<h5>pictureSize: <a href="../enums/_interface_conference_conferenceconstants_.conferencepicturesize.html" class="tsd-signature-type">ConferencePictureSize</a></h5>
<div class="tsd-comment tsd-typography">
<p>视频请求尺寸类型</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-method tsd-parent-kind-interface tsd-is-external">
<a name="sendmessage" class="tsd-anchor"></a>
<h3>send<wbr>Message</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">send<wbr>Message<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, content<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Object</span>, toUserId<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>发送消息，其他成员会收到<a href="../enums/_interface_conference_conferenceeventtype_.conferenceeventtype.html#message_receive">ConferenceEventType.MESSAGE_RECEIVE</a>回调,
如未指定toUserId, 则该消息将会广播给所有成员</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>消息类型</p>
</div>
</li>
<li>
<h5>content: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Object</span></h5>
<div class="tsd-comment tsd-typography">
<p>消息内容. 当 toUserId 不为 null 时，content 不能大于 4k</p>
</div>
</li>
<li>
<h5>toUserId: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>接收者id，null则发给所有会议人员</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-method tsd-parent-kind-interface tsd-is-external">
<a name="setaudioroute" class="tsd-anchor"></a>
<h3>set<wbr>Audio<wbr>Route</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">set<wbr>Audio<wbr>Route<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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>设置音频路由, 听筒或扬声器等</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span></h5>
</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-method tsd-parent-kind-interface tsd-is-external">
<a name="start" class="tsd-anchor"></a>
<h3>start</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>confNumber<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, video<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, joinParam<span class="tsd-signature-symbol">: </span><a href="_interface_conference_conferencejoinparam_.conferencejoinparam.html" class="tsd-signature-type">ConferenceJoinParam</a><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>创建并加入一个会议，结果回调由<a href="../enums/_interface_conference_conferenceeventtype_.conferenceeventtype.html#conference_join">ConferenceEventType.CONFERENCE_JOIN</a>上报</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>confNumber: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>传 "0" 由服务器生成10位的会议号，可传字母或数字作为自定义会议号</p>
</div>
</li>
<li>
<h5>video: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>true 视频会议，false 语音会议. 传递 true 即可. <strong>目前强制为视频会议, 语音会议暂不可用</strong></p>
</div>
</li>
<li>
<h5>joinParam: <a href="_interface_conference_conferencejoinparam_.conferencejoinparam.html" class="tsd-signature-type">ConferenceJoinParam</a></h5>
<div class="tsd-comment tsd-typography">
<p>加入会议的额外参数</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-method tsd-parent-kind-interface tsd-is-external">
<a name="startcameravideo" class="tsd-anchor"></a>
<h3>start<wbr>Camera<wbr>Video</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">start<wbr>Camera<wbr>Video<span class="tsd-signature-symbol">(</span>renderType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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="_interface_stream_stream_.stream.html" class="tsd-signature-type">Stream</a><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>获得视频预览对象，通过此对象能获得本地摄像头画面用于UI显示</p>
</div>
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p>RenderType</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>renderType: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>渲染模式</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_interface_stream_stream_.stream.html" class="tsd-signature-type">Stream</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a name="startvideo" class="tsd-anchor"></a>
<h3>start<wbr>Video</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">start<wbr>Video<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="_interface_stream_stream_.stream.html" class="tsd-signature-type">Stream</a><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>获得视频对象，通过此对象能获得远端画面用于UI显示</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_interface_stream_stream_.stream.html" class="tsd-signature-type">Stream</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a name="stop" class="tsd-anchor"></a>
<h3>stop</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">stop<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><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>结束会议，主持人才能调用该接口结束会议，结果回调由<a href="../enums/_interface_conference_conferenceeventtype_.conferenceeventtype.html#conference_leave">ConferenceEventType.CONFERENCE_LEAVE</a>上报</p>
</div>
</div>
<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-method tsd-parent-kind-interface tsd-is-external">
<a name="switchcamera" class="tsd-anchor"></a>
<h3>switch<wbr>Camera</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<li class="tsd-signature tsd-kind-icon">switch<wbr>Camera<span class="tsd-signature-symbol">(</span>constraints<span class="tsd-signature-symbol">: </span><a href="_interface_stream_streamoptions_.streamcameraconstraints.html" class="tsd-signature-type">StreamCameraConstraints</a><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="_interface_stream_stream_.stream.html" class="tsd-signature-type">Stream</a><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>切换摄像头</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>constraints: <a href="_interface_stream_streamoptions_.streamcameraconstraints.html" class="tsd-signature-type">StreamCameraConstraints</a></h5>
<div class="tsd-comment tsd-typography">
<p>指定的摄像头约束</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_interface_stream_stream_.stream.html" class="tsd-signature-type">Stream</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</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_conference_conference_.html">"interface/conference/<wbr>Conference"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_interface_conference_conference_.conference.html" class="tsd-kind-icon">Conference</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#disableaudiooutput" class="tsd-kind-icon">disable<wbr>Audio<wbr>Output</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#disableuploadaudiostream" class="tsd-kind-icon">disable<wbr>Upload<wbr>Audio<wbr>Stream</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#disableuploadvideostream" class="tsd-kind-icon">disable<wbr>Upload<wbr>Video<wbr>Stream</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#enableaudiooutput" class="tsd-kind-icon">enable<wbr>Audio<wbr>Output</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#enableuploadaudiostream" class="tsd-kind-icon">enable<wbr>Upload<wbr>Audio<wbr>Stream</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#enableuploadvideostream" class="tsd-kind-icon">enable<wbr>Upload<wbr>Video<wbr>Stream</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#join" class="tsd-kind-icon">join</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#leave" class="tsd-kind-icon">leave</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#login" class="tsd-kind-icon">login</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#query" class="tsd-kind-icon">query</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#requestvideo" class="tsd-kind-icon">request<wbr>Video</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#sendmessage" class="tsd-kind-icon">send<wbr>Message</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#setaudioroute" class="tsd-kind-icon">set<wbr>Audio<wbr>Route</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#start" class="tsd-kind-icon">start</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#startcameravideo" class="tsd-kind-icon">start<wbr>Camera<wbr>Video</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#startvideo" class="tsd-kind-icon">start<wbr>Video</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#stop" class="tsd-kind-icon">stop</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external">
<a href="_interface_conference_conference_.conference.html#switchcamera" class="tsd-kind-icon">switch<wbr>Camera</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>