@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>WeChatLocalStreamContext | 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/_we_chat_wechatdef_.html">"we-chat/WeChatDef"</a> </li> <li> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html">WeChatLocalStreamContext</a> </li> </ul> <h1>Interface WeChatLocalStreamContext</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>定义<code><local-stream></code>组件</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">WeChatLocalStreamContext</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>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#_propertyobserver" class="tsd-kind-icon">_property<wbr>Observer</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#onbgmcomplete" class="tsd-kind-icon">onBGMComplete</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#onbgmprocess" class="tsd-kind-icon">onBGMProcess</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#onbgmstart" class="tsd-kind-icon">onBGMStart</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#onerror" class="tsd-kind-icon">on<wbr>Error</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#onnetstatechange" class="tsd-kind-icon">on<wbr>Net<wbr>State<wbr>Change</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#onstatechange" class="tsd-kind-icon">on<wbr>State<wbr>Change</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#pause" class="tsd-kind-icon">pause</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#pausebgm" class="tsd-kind-icon">pauseBGM</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#playbgm" class="tsd-kind-icon">playBGM</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#resume" class="tsd-kind-icon">resume</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#resumebgm" class="tsd-kind-icon">resumeBGM</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#setbgmvolume" class="tsd-kind-icon">setBGMVolume</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#setmicvolume" class="tsd-kind-icon">setMICVolume</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#snapshot" class="tsd-kind-icon">snapshot</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#start" class="tsd-kind-icon">start</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#startpreview" class="tsd-kind-icon">start<wbr>Preview</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#stop" class="tsd-kind-icon">stop</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#stopbgm" class="tsd-kind-icon">stopBGM</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#stoppreview" class="tsd-kind-icon">stop<wbr>Preview</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalstreamcontext.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="_propertyobserver" class="tsd-anchor"></a> <h3>_property<wbr>Observer</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">_property<wbr>Observer<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../classes/_we_chat_wechatlocalstream_.wechatlocalstream.html" class="tsd-signature-type">WeChatLocalStream</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">void</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>data: <a href="../classes/_we_chat_wechatlocalstream_.wechatlocalstream.html" class="tsd-signature-type">WeChatLocalStream</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">void</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="onbgmcomplete" class="tsd-anchor"></a> <h3>onBGMComplete</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">onBGMComplete<span class="tsd-signature-symbol">(</span>event<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>event: <span class="tsd-signature-type">any</span></h5> </li> </ul> <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="onbgmprocess" class="tsd-anchor"></a> <h3>onBGMProcess</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">onBGMProcess<span class="tsd-signature-symbol">(</span>event<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>event: <span class="tsd-signature-type">any</span></h5> </li> </ul> <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="onbgmstart" class="tsd-anchor"></a> <h3>onBGMStart</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">onBGMStart<span class="tsd-signature-symbol">(</span>event<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>event: <span class="tsd-signature-type">any</span></h5> </li> </ul> <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="onerror" class="tsd-anchor"></a> <h3>on<wbr>Error</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">on<wbr>Error<span class="tsd-signature-symbol">(</span>event<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>event: <span class="tsd-signature-type">any</span></h5> </li> </ul> <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="onnetstatechange" class="tsd-anchor"></a> <h3>on<wbr>Net<wbr>State<wbr>Change</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">on<wbr>Net<wbr>State<wbr>Change<span class="tsd-signature-symbol">(</span>event<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>event: <span class="tsd-signature-type">any</span></h5> </li> </ul> <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="onstatechange" class="tsd-anchor"></a> <h3>on<wbr>State<wbr>Change</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">on<wbr>State<wbr>Change<span class="tsd-signature-symbol">(</span>event<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>event: <span class="tsd-signature-type">any</span></h5> </li> </ul> <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="pause" class="tsd-anchor"></a> <h3>pause</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">pause<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a><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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a></h5> </li> </ul> <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="pausebgm" class="tsd-anchor"></a> <h3>pauseBGM</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">pauseBGM<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a><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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a></h5> </li> </ul> <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="playbgm" class="tsd-anchor"></a> <h3>playBGM</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">playBGM<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a><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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>url: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>options: <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a></h5> </li> </ul> <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="resume" class="tsd-anchor"></a> <h3>resume</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">resume<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a><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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a></h5> </li> </ul> <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="resumebgm" class="tsd-anchor"></a> <h3>resumeBGM</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">resumeBGM<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a><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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a></h5> </li> </ul> <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="setbgmvolume" class="tsd-anchor"></a> <h3>setBGMVolume</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">setBGMVolume<span class="tsd-signature-symbol">(</span>volume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">: </span><a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a><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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>volume: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>options: <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a></h5> </li> </ul> <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="setmicvolume" class="tsd-anchor"></a> <h3>setMICVolume</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">setMICVolume<span class="tsd-signature-symbol">(</span>volume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">: </span><a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a><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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>volume: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>options: <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a></h5> </li> </ul> <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="snapshot" class="tsd-anchor"></a> <h3>snapshot</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">snapshot<span class="tsd-signature-symbol">(</span>quality<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"raw"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"compressed"</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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>quality: <span class="tsd-signature-type">"raw"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"compressed"</span></h5> </li> </ul> <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="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>options<span class="tsd-signature-symbol">: </span><a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a><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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a></h5> </li> </ul> <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="startpreview" class="tsd-anchor"></a> <h3>start<wbr>Preview</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">start<wbr>Preview<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a><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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a></h5> </li> </ul> <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="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>options<span class="tsd-signature-symbol">: </span><a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a><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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a></h5> </li> </ul> <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="stopbgm" class="tsd-anchor"></a> <h3>stopBGM</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">stopBGM<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a><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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a></h5> </li> </ul> <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="stoppreview" class="tsd-anchor"></a> <h3>stop<wbr>Preview</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">stop<wbr>Preview<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a><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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a></h5> </li> </ul> <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="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>options<span class="tsd-signature-symbol">: </span><a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a><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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-signature-type">BaseOptions</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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/_we_chat_wechatdef_.html">"we-<wbr>chat/<wbr>WeChat<wbr>Def"</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/_we_chat_wechatdef_.wechatlocalcameraeventtype.html" class="tsd-kind-icon">We<wbr>Chat<wbr>Local<wbr>Camera<wbr>Event<wbr>Type</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter tsd-is-external tsd-is-not-exported"> <a href="_we_chat_wechatdef_.baseoptions.html" class="tsd-kind-icon">Base<wbr>Options</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalcameracontext.html" class="tsd-kind-icon">We<wbr>Chat<wbr>Local<wbr>Camera<wbr>Context</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalcameraoptions.html" class="tsd-kind-icon">We<wbr>Chat<wbr>Local<wbr>Camera<wbr>Options</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html" class="tsd-kind-icon">We<wbr>Chat<wbr>Local<wbr>Stream<wbr>Context</a> <ul> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#_propertyobserver" class="tsd-kind-icon">_property<wbr>Observer</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#onbgmcomplete" class="tsd-kind-icon">onBGMComplete</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#onbgmprocess" class="tsd-kind-icon">onBGMProcess</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#onbgmstart" class="tsd-kind-icon">onBGMStart</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#onerror" class="tsd-kind-icon">on<wbr>Error</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#onnetstatechange" class="tsd-kind-icon">on<wbr>Net<wbr>State<wbr>Change</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#onstatechange" class="tsd-kind-icon">on<wbr>State<wbr>Change</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#pause" class="tsd-kind-icon">pause</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#pausebgm" class="tsd-kind-icon">pauseBGM</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#playbgm" class="tsd-kind-icon">playBGM</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#resume" class="tsd-kind-icon">resume</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#resumebgm" class="tsd-kind-icon">resumeBGM</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#setbgmvolume" class="tsd-kind-icon">setBGMVolume</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#setmicvolume" class="tsd-kind-icon">setMICVolume</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#snapshot" class="tsd-kind-icon">snapshot</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#start" class="tsd-kind-icon">start</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#startpreview" class="tsd-kind-icon">start<wbr>Preview</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#stop" class="tsd-kind-icon">stop</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#stopbgm" class="tsd-kind-icon">stopBGM</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#stoppreview" class="tsd-kind-icon">stop<wbr>Preview</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamcontext.html#switchcamera" class="tsd-kind-icon">switch<wbr>Camera</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalstreamoptions.html" class="tsd-kind-icon">We<wbr>Chat<wbr>Local<wbr>Stream<wbr>Options</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="_we_chat_wechatdef_.wechatremotestreamcontext.html" class="tsd-kind-icon">We<wbr>Chat<wbr>Remote<wbr>Stream<wbr>Context</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="_we_chat_wechatdef_.wechatremotestreamoptions.html" class="tsd-kind-icon">We<wbr>Chat<wbr>Remote<wbr>Stream<wbr>Options</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-external tsd-is-not-exported"> <a href="../modules/_we_chat_wechatdef_.html#cameracontextstartrecordoption" class="tsd-kind-icon">Camera<wbr>Context<wbr>Start<wbr>Record<wbr>Option</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-external tsd-is-not-exported"> <a href="../modules/_we_chat_wechatdef_.html#cameracontextstoprecordoption" class="tsd-kind-icon">Camera<wbr>Context<wbr>Stop<wbr>Record<wbr>Option</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-external tsd-is-not-exported"> <a href="../modules/_we_chat_wechatdef_.html#setzoomoption" class="tsd-kind-icon">Set<wbr>Zoom<wbr>Option</a> </li> <li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-external tsd-is-not-exported"> <a href="../modules/_we_chat_wechatdef_.html#takephotooption" class="tsd-kind-icon">Take<wbr>Photo<wbr>Option</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>