@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>WeChatLocalCameraContext | 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/_we_chat_wechatdef_.html">"we-chat/WeChatDef"</a> </li> <li> <a href="_we_chat_wechatdef_.wechatlocalcameracontext.html">WeChatLocalCameraContext</a> </li> </ul> <h1>Interface WeChatLocalCameraContext</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">WeChatLocalCameraContext</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_.wechatlocalcameracontext.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_.wechatlocalcameracontext.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_.wechatlocalcameracontext.html#oninitdone" class="tsd-kind-icon">on<wbr>Init<wbr>Done</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalcameracontext.html#onscancode" class="tsd-kind-icon">on<wbr>Scan<wbr>Code</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalcameracontext.html#onstop" class="tsd-kind-icon">on<wbr>Stop</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalcameracontext.html#setzoom" class="tsd-kind-icon">set<wbr>Zoom</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalcameracontext.html#startrecord" class="tsd-kind-icon">start<wbr>Record</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalcameracontext.html#stoprecord" class="tsd-kind-icon">stop<wbr>Record</a></li> <li class="tsd-kind-method tsd-parent-kind-interface tsd-is-external"><a href="_we_chat_wechatdef_.wechatlocalcameracontext.html#takephoto" class="tsd-kind-icon">take<wbr>Photo</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><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">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: <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">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="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="oninitdone" class="tsd-anchor"></a> <h3>on<wbr>Init<wbr>Done</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">on<wbr>Init<wbr>Done<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="onscancode" class="tsd-anchor"></a> <h3>on<wbr>Scan<wbr>Code</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">on<wbr>Scan<wbr>Code<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="onstop" class="tsd-anchor"></a> <h3>on<wbr>Stop</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">on<wbr>Stop<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="setzoom" class="tsd-anchor"></a> <h3>set<wbr>Zoom</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">set<wbr>Zoom<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SetZoomOption</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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: <span class="tsd-signature-type">SetZoomOption</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a name="startrecord" class="tsd-anchor"></a> <h3>start<wbr>Record</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">start<wbr>Record<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CameraContextStartRecordOption</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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: <span class="tsd-signature-type">CameraContextStartRecordOption</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a name="stoprecord" class="tsd-anchor"></a> <h3>stop<wbr>Record</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">stop<wbr>Record<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CameraContextStopRecordOption</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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: <span class="tsd-signature-type">CameraContextStopRecordOption</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a name="takephoto" class="tsd-anchor"></a> <h3>take<wbr>Photo</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <li class="tsd-signature tsd-kind-icon">take<wbr>Photo<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TakePhotoOption</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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: <span class="tsd-signature-type">TakePhotoOption</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</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> </ul> <ul class="current"> <li class="current 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> <ul> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalcameracontext.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_.wechatlocalcameracontext.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_.wechatlocalcameracontext.html#oninitdone" class="tsd-kind-icon">on<wbr>Init<wbr>Done</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalcameracontext.html#onscancode" class="tsd-kind-icon">on<wbr>Scan<wbr>Code</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalcameracontext.html#onstop" class="tsd-kind-icon">on<wbr>Stop</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalcameracontext.html#setzoom" class="tsd-kind-icon">set<wbr>Zoom</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalcameracontext.html#startrecord" class="tsd-kind-icon">start<wbr>Record</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalcameracontext.html#stoprecord" class="tsd-kind-icon">stop<wbr>Record</a> </li> <li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-external"> <a href="_we_chat_wechatdef_.wechatlocalcameracontext.html#takephoto" class="tsd-kind-icon">take<wbr>Photo</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_.wechatlocalcameraoptions.html" class="tsd-kind-icon">We<wbr>Chat<wbr>Local<wbr>Camera<wbr>Options</a> </li> <li class=" 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> </li> <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>