@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>RTCStream | 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/_webrtc_rtcstream_.html">"webrtc/RTCStream"</a> </li> <li> <a href="_webrtc_rtcstream_.rtcstream.html">RTCStream</a> </li> </ul> <h1>Class RTCStream</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> <a href="_eventtarget_.eventtarget.html" class="tsd-signature-type">EventTarget</a> <ul class="tsd-hierarchy"> <li> <span class="target">RTCStream</span> </li> </ul> </li> </ul> </section> <section class="tsd-panel"> <h3>Implements</h3> <ul class="tsd-hierarchy"> <li><a href="../interfaces/_interface_stream_stream_.stream.html" class="tsd-signature-type">Stream</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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_audiosource" class="tsd-kind-icon">_audio<wbr>Source</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_canvasdom" class="tsd-kind-icon">_canvasDOM</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_ctx" class="tsd-kind-icon">_ctx</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_domuniqueid" class="tsd-kind-icon">_dom<wbr>Unique<wbr>Id</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_options" class="tsd-kind-icon">_options</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_state" class="tsd-kind-icon">_state</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_stream" class="tsd-kind-icon">_stream</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_videodom" class="tsd-kind-icon">_videoDOM</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_videosource" class="tsd-kind-icon">_video<wbr>Source</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_wrapperdomid" class="tsd-kind-icon">_wrapperDOMId</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#listenermap" class="tsd-kind-icon">listener<wbr>Map</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#supported_constraints" class="tsd-kind-icon">SUPPORTED_<wbr>CONSTRAINTS</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#reporter" class="tsd-kind-icon">reporter</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#audiosource" class="tsd-kind-icon">audio<wbr>Source</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#state" class="tsd-kind-icon">state</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#videosource" class="tsd-kind-icon">video<wbr>Source</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_canvasdominit" class="tsd-kind-icon">_canvasDOMInit</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_optionshandle" class="tsd-kind-icon">_options<wbr>Handle</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_streaminit" class="tsd-kind-icon">_stream<wbr>Init</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#_videodominit" class="tsd-kind-icon">_videoDOMInit</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#addeventlistener" class="tsd-kind-icon">add<wbr>Event<wbr>Listener</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#addeventlisteners" class="tsd-kind-icon">add<wbr>Event<wbr>Listeners</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#clearlistener" class="tsd-kind-icon">clear<wbr>Listener</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#disableaudio" class="tsd-kind-icon">disable<wbr>Audio</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#disablevideo" class="tsd-kind-icon">disable<wbr>Video</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#dispatchevent" class="tsd-kind-icon">dispatch<wbr>Event</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#dispatcheventlite" class="tsd-kind-icon">dispatch<wbr>Event<wbr>Lite</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#enableaudio" class="tsd-kind-icon">enable<wbr>Audio</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#enablevideo" class="tsd-kind-icon">enable<wbr>Video</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#haslistener" class="tsd-kind-icon">has<wbr>Listener</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#removeeventlistener" class="tsd-kind-icon">remove<wbr>Event<wbr>Listener</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#setaudiooutput" class="tsd-kind-icon">set<wbr>Audio<wbr>Output</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#snapshot" class="tsd-kind-icon">snapshot</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#start" class="tsd-kind-icon">start</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#stop" class="tsd-kind-icon">stop</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#updateoptions" class="tsd-kind-icon">update<wbr>Options</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Object literals</h3> <ul class="tsd-index-list"> <li class="tsd-kind-object-literal tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#default_event_listener_options" class="tsd-kind-icon">DEFAULT_<wbr>EVENT_<wbr>LISTENER_<wbr>OPTIONS</a></li> <li class="tsd-kind-object-literal tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="_webrtc_rtcstream_.rtcstream.html#default_stream_options" class="tsd-kind-icon">DEFAULT_<wbr>STREAM_<wbr>OPTIONS</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"> <li class="tsd-signature tsd-kind-icon">new RTCStream<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interface_stream_streamoptions_.streamoptions.html" class="tsd-signature-type">StreamOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_webrtc_rtcstream_.rtcstream.html" class="tsd-signature-type">RTCStream</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_eventtarget_.eventtarget.html">EventTarget</a>.<a href="_eventtarget_.eventtarget.html#constructor">constructor</a></p> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>options: <a href="../interfaces/_interface_stream_streamoptions_.streamoptions.html" class="tsd-signature-type">StreamOptions</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_webrtc_rtcstream_.rtcstream.html" class="tsd-signature-type">RTCStream</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="_audiosource" class="tsd-anchor"></a> <h3>_audio<wbr>Source</h3> <div class="tsd-signature tsd-kind-icon">_audio<wbr>Source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MediaStreamTrack</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="_canvasdom" class="tsd-anchor"></a> <h3>_canvasDOM</h3> <div class="tsd-signature tsd-kind-icon">_canvasDOM<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLCanvasElement</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="_ctx" class="tsd-anchor"></a> <h3>_ctx</h3> <div class="tsd-signature tsd-kind-icon">_ctx<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CanvasRenderingContext2D</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="_domuniqueid" class="tsd-anchor"></a> <h3>_dom<wbr>Unique<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">_dom<wbr>Unique<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>创建的 video DOM元素的id</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="_options" class="tsd-anchor"></a> <h3>_options</h3> <div class="tsd-signature tsd-kind-icon">_options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_interface_stream_streamoptions_.streamoptions.html" class="tsd-signature-type">StreamOptions</a></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="_state" class="tsd-anchor"></a> <h3>_state</h3> <div class="tsd-signature tsd-kind-icon">_state<span class="tsd-signature-symbol">:</span> <a href="../enums/_interface_stream_streamconatants_.streamstate.html" class="tsd-signature-type">StreamState</a></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="_stream" class="tsd-anchor"></a> <h3>_stream</h3> <div class="tsd-signature tsd-kind-icon">_stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MediaStream</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="_videodom" class="tsd-anchor"></a> <h3>_videoDOM</h3> <div class="tsd-signature tsd-kind-icon">_videoDOM<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLVideoElement</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="_videosource" class="tsd-anchor"></a> <h3>_video<wbr>Source</h3> <div class="tsd-signature tsd-kind-icon">_video<wbr>Source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MediaStreamTrack</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="_wrapperdomid" class="tsd-anchor"></a> <h3>_wrapperDOMId</h3> <div class="tsd-signature tsd-kind-icon">_wrapperDOMId<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a name="listenermap" class="tsd-anchor"></a> <h3>listener<wbr>Map</h3> <div class="tsd-signature tsd-kind-icon">listener<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_eventtarget_.eventtarget.html">EventTarget</a>.<a href="_eventtarget_.eventtarget.html#listenermap">listenerMap</a></p> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../modules/_eventtarget_.html#eventlistenertype" class="tsd-signature-type">EventListenerType</a><span class="tsd-signature-symbol">></span></h5> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a name="supported_constraints" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> SUPPORTED_<wbr>CONSTRAINTS</h3> <div class="tsd-signature tsd-kind-icon">SUPPORTED_<wbr>CONSTRAINTS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">MediaTrackSupportedConstraints</span><span class="tsd-signature-symbol"> = isBrowser ? navigator.mediaDevices.getSupportedConstraints() : null</span></div> <aside class="tsd-sources"> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static tsd-is-external"> <a name="reporter" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> reporter</h3> <div class="tsd-signature tsd-kind-icon">reporter<span class="tsd-signature-symbol">:</span> <a href="_reporter_reporter_.reporter.html" class="tsd-signature-type">Reporter</a><span class="tsd-signature-symbol"> = new Reporter('RTCStream')</span></div> <aside class="tsd-sources"> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"> <a name="audiosource" class="tsd-anchor"></a> <h3>audio<wbr>Source</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> audioSource<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MediaStreamTrack</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MediaStreamTrack</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-external"> <a name="state" class="tsd-anchor"></a> <h3>state</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> state<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/_interface_stream_streamconatants_.streamstate.html" class="tsd-signature-type">StreamState</a></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> state<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../enums/_interface_stream_streamconatants_.streamstate.html" class="tsd-signature-type">StreamState</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-returns-title">Returns <a href="../enums/_interface_stream_streamconatants_.streamstate.html" class="tsd-signature-type">StreamState</a></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>state: <a href="../enums/_interface_stream_streamconatants_.streamstate.html" class="tsd-signature-type">StreamState</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-get-signature tsd-parent-kind-class tsd-is-external"> <a name="videosource" class="tsd-anchor"></a> <h3>video<wbr>Source</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> videoSource<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MediaStreamTrack</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MediaStreamTrack</span></h4> </li> </ul> </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-class tsd-is-external"> <a name="_canvasdominit" class="tsd-anchor"></a> <h3>_canvasDOMInit</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">_canvasDOMInit<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLCanvasElement</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLCanvasElement</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="_optionshandle" class="tsd-anchor"></a> <h3>_options<wbr>Handle</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">_options<wbr>Handle<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_interface_stream_streamoptions_.streamoptions.html" class="tsd-signature-type">StreamOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_interface_stream_streamoptions_.streamoptions.html" class="tsd-signature-type">StreamOptions</a></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><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/_interface_stream_streamoptions_.streamoptions.html" class="tsd-signature-type">StreamOptions</a><span class="tsd-signature-symbol"> = {id: ''}</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/_interface_stream_streamoptions_.streamoptions.html" class="tsd-signature-type">StreamOptions</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="_streaminit" class="tsd-anchor"></a> <h3>_stream<wbr>Init</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">_stream<wbr>Init<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">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-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-class tsd-is-external"> <a name="_videodominit" class="tsd-anchor"></a> <h3>_videoDOMInit</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">_videoDOMInit<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLVideoElement</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLVideoElement</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a name="addeventlistener" class="tsd-anchor"></a> <h3>add<wbr>Event<wbr>Listener</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <li class="tsd-signature tsd-kind-icon">add<wbr>Event<wbr>Listener<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../modules/_eventtarget_.html#eventtargettype" class="tsd-signature-type">EventTargetType</a>, func<span class="tsd-signature-symbol">: </span><a href="../modules/_eventtarget_.html#eventlistenertype" class="tsd-signature-type">EventListenerType</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_eventtarget_.eventlisteneroptions.html" class="tsd-signature-type">EventListenerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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"> <p>Inherited from <a href="_eventtarget_.eventtarget.html">EventTarget</a>.<a href="_eventtarget_.eventtarget.html#addeventlistener">addEventListener</a></p> </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>type: <a href="../modules/_eventtarget_.html#eventtargettype" class="tsd-signature-type">EventTargetType</a></h5> <div class="tsd-comment tsd-typography"> <p>要监听的事件类型</p> </div> </li> <li> <h5>func: <a href="../modules/_eventtarget_.html#eventlistenertype" class="tsd-signature-type">EventListenerType</a></h5> <div class="tsd-comment tsd-typography"> <p>事件监听回调</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_eventtarget_.eventlisteneroptions.html" class="tsd-signature-type">EventListenerOptions</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <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></h4> <p>若添加成功则返回一个函数, 用于移除事件监听</p> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal"> <li class="tsd-signature tsd-kind-icon"><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"> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a name="addeventlisteners" class="tsd-anchor"></a> <h3>add<wbr>Event<wbr>Listeners</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <li class="tsd-signature tsd-kind-icon">add<wbr>Event<wbr>Listeners<span class="tsd-signature-symbol">(</span>types<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../modules/_eventtarget_.html#eventtargettype" class="tsd-signature-type">EventTargetType</a><span class="tsd-signature-symbol">></span>, func<span class="tsd-signature-symbol">: </span><a href="../modules/_eventtarget_.html#eventlistenertype" class="tsd-signature-type">EventListenerType</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_eventtarget_.eventlisteneroptions.html" class="tsd-signature-type">EventListenerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">(Anonymous function)</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_eventtarget_.eventtarget.html">EventTarget</a>.<a href="_eventtarget_.eventtarget.html#addeventlisteners">addEventListeners</a></p> </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>types: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../modules/_eventtarget_.html#eventtargettype" class="tsd-signature-type">EventTargetType</a><span class="tsd-signature-symbol">></span></h5> <div class="tsd-comment tsd-typography"> <p>要监听的事件类型</p> </div> </li> <li> <h5>func: <a href="../modules/_eventtarget_.html#eventlistenertype" class="tsd-signature-type">EventListenerType</a></h5> <div class="tsd-comment tsd-typography"> <p>事件监听回调</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_eventtarget_.eventlisteneroptions.html" class="tsd-signature-type">EventListenerOptions</a></h5> <div class="tsd-comment tsd-typography"> <p>设置监听器参数</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">(Anonymous function)</span></h4> <p>若添加成功则返回一个函数, 用于移除事件监听</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a name="clearlistener" class="tsd-anchor"></a> <h3>clear<wbr>Listener</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <li class="tsd-signature tsd-kind-icon">clear<wbr>Listener<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"> <p>Inherited from <a href="_eventtarget_.eventtarget.html">EventTarget</a>.<a href="_eventtarget_.eventtarget.html#clearlistener">clearListener</a></p> </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-class tsd-is-external"> <a name="disableaudio" class="tsd-anchor"></a> <h3>disable<wbr>Audio</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">disable<wbr>Audio<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"> <p>Implementation of <a href="../interfaces/_interface_stream_stream_.stream.html">Stream</a>.<a href="../interfaces/_interface_stream_stream_.stream.html#disableaudio">disableAudio</a></p> </aside> <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-class tsd-is-external"> <a name="disablevideo" class="tsd-anchor"></a> <h3>disable<wbr>Video</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">disable<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><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"> <p>Implementation of <a href="../interfaces/_interface_stream_stream_.stream.html">Stream</a>.<a href="../interfaces/_interface_stream_stream_.stream.html#disablevideo">disableVideo</a></p> </aside> <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-class tsd-is-inherited tsd-is-external"> <a name="dispatchevent" class="tsd-anchor"></a> <h3>dispatch<wbr>Event</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <li class="tsd-signature tsd-kind-icon">dispatch<wbr>Event<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="_eventtarget_.event.html" class="tsd-signature-type">Event</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_eventtarget_.eventtarget.html">EventTarget</a>.<a href="_eventtarget_.eventtarget.html#dispatchevent">dispatchEvent</a></p> </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>event: <a href="_eventtarget_.event.html" class="tsd-signature-type">Event</a></h5> <div class="tsd-comment tsd-typography"> <p>分发的事件对象</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p>事件是否发送成功</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a name="dispatcheventlite" class="tsd-anchor"></a> <h3>dispatch<wbr>Event<wbr>Lite</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <li class="tsd-signature tsd-kind-icon">dispatch<wbr>Event<wbr>Lite<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../modules/_eventtarget_.html#eventtargettype" class="tsd-signature-type">EventTargetType</a>, message<span class="tsd-signature-symbol">?: </span><a href="../modules/_eventtarget_.html#eventtargetdata" class="tsd-signature-type">EventTargetData</a>, error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</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"> <p>Inherited from <a href="_eventtarget_.eventtarget.html">EventTarget</a>.<a href="_eventtarget_.eventtarget.html#dispatcheventlite">dispatchEventLite</a></p> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>type: <a href="../modules/_eventtarget_.html#eventtargettype" class="tsd-signature-type">EventTargetType</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> message: <a href="../modules/_eventtarget_.html#eventtargetdata" class="tsd-signature-type">EventTargetData</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</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-class tsd-is-external"> <a name="enableaudio" class="tsd-anchor"></a> <h3>enable<wbr>Audio</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">enable<wbr>Audio<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"> <p>Implementation of <a href="../interfaces/_interface_stream_stream_.stream.html">Stream</a>.<a href="../interfaces/_interface_stream_stream_.stream.html#enableaudio">enableAudio</a></p> </aside> <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-class tsd-is-external"> <a name="enablevideo" class="tsd-anchor"></a> <h3>enable<wbr>Video</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">enable<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><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"> <p>Implementation of <a href="../interfaces/_interface_stream_stream_.stream.html">Stream</a>.<a href="../interfaces/_interface_stream_stream_.stream.html#enablevideo">enableVideo</a></p> </aside> <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-class tsd-is-inherited tsd-is-external"> <a name="haslistener" class="tsd-anchor"></a> <h3>has<wbr>Listener</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <li class="tsd-signature tsd-kind-icon">has<wbr>Listener<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../modules/_eventtarget_.html#eventtargettype" class="tsd-signature-type">EventTargetType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_eventtarget_.eventtarget.html">EventTarget</a>.<a href="_eventtarget_.eventtarget.html#haslistener">hasListener</a></p> </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>type: <a href="../modules/_eventtarget_.html#eventtargettype" class="tsd-signature-type">EventTargetType</a></h5> <div class="tsd-comment tsd-typography"> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a name="removeeventlistener" class="tsd-anchor"></a> <h3>remove<wbr>Event<wbr>Listener</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <li class="tsd-signature tsd-kind-icon">remove<wbr>Event<wbr>Listener<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../modules/_eventtarget_.html#eventtargettype" class="tsd-signature-type">EventTargetType</a>, func<span class="tsd-signature-symbol">: </span><a href="../modules/_eventtarget_.html#eventlistenertype" class="tsd-signature-type">EventListenerType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_eventtarget_.eventtarget.html">EventTarget</a>.<a href="_eventtarget_.eventtarget.html#removeeventlistener">removeEventListener</a></p> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>移除事件监听器, 要提供与调用<a href="_webrtc_rtcstream_.rtcstream.html#addeventlistener">addEventListener</a>或<a href="_webrtc_rtcstream_.rtcstream.html#addeventlisteners">addEventListeners</a>时相同的参数</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>type: <a href="../modules/_eventtarget_.html#eventtargettype" class="tsd-signature-type">EventTargetType</a></h5> <div class="tsd-comment tsd-typography"> <p>要移除的事件监听器类型</p> </div> </li> <li> <h5>func: <a href="../modules/_eventtarget_.html#eventlistenertype" class="tsd-signature-type">EventListenerType</a></h5> <div class="tsd-comment tsd-typography"> <p>要移除的事件监听器</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p>返回true表示有该fun监听器并且移除成功</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="setaudiooutput" class="tsd-anchor"></a> <h3>set<wbr>Audio<wbr>Output</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">set<wbr>Audio<wbr>Output<span class="tsd-signature-symbol">(</span>deviceId<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> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>deviceId: <span class="tsd-signature-type">string</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-class tsd-is-external"> <a name="snapshot" class="tsd-anchor"></a> <h3>snapshot</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">snapshot<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> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-sym