@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>StreamOptions | webrtc-guest-sdk</title> <meta name="description" content="Documentation for webrtc-guest-sdk"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">webrtc-guest-sdk</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../index.html">Globals</a> </li> <li> <a href="../modules/_interface_stream_streamoptions_.html">"interface/stream/StreamOptions"</a> </li> <li> <a href="_interface_stream_streamoptions_.streamoptions.html">StreamOptions</a> </li> </ul> <h1>Interface StreamOptions</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">StreamOptions</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section tsd-is-external"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stream_streamoptions_.streamoptions.html#audio" class="tsd-kind-icon">audio</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stream_streamoptions_.streamoptions.html#audiosource" class="tsd-kind-icon">audio<wbr>Source</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stream_streamoptions_.streamoptions.html#id" class="tsd-kind-icon">id</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stream_streamoptions_.streamoptions.html#muted" class="tsd-kind-icon">muted</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stream_streamoptions_.streamoptions.html#rendertype" class="tsd-kind-icon">render<wbr>Type</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stream_streamoptions_.streamoptions.html#video" class="tsd-kind-icon">video</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stream_streamoptions_.streamoptions.html#videosource" class="tsd-kind-icon">video<wbr>Source</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="audio" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> audio</h3> <div class="tsd-signature tsd-kind-icon">audio<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>获取音频轨道时指定的约束</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="audiosource" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> 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> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>通过该属性可以指定音频轨道，该属性赋值后会忽略<a href="_interface_stream_streamoptions_.streamoptions.html#audio">StreamOptions.audio</a>属性</p> </div> <p>该属性可用于传输从除 <em>媒体设备</em> 之外的方式获取到的音频轨道</p> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="id" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3> <div class="tsd-signature tsd-kind-icon">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>唯一标识id</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="muted" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> muted</h3> <div class="tsd-signature tsd-kind-icon">muted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>设置 <video> 的muted属性, 是否静音, 对应本地的<a href="_interface_stream_stream_.stream.html">Stream</a>流默认静音, 远端的默认放音</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="rendertype" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> render<wbr>Type</h3> <div class="tsd-signature tsd-kind-icon">render<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="../enums/_interface_stream_streamconatants_.rendertype.html" class="tsd-signature-type">RenderType</a></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>指定画面渲染类型, 可选值有<a href="../enums/_interface_stream_streamconatants_.rendertype.html#contain">RenderType.CONTAIN</a> 和 <a href="../enums/_interface_stream_streamconatants_.rendertype.html#cover">RenderType.COVER</a></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="video" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> video</h3> <div class="tsd-signature tsd-kind-icon">video<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><a href="_interface_stream_streamoptions_.streamcameraconstraints.html" class="tsd-signature-type">StreamCameraConstraints</a></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>获取视频轨道时指定的约束</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="videosource" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> 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> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>通过该属性可以指定视频轨道, 该属性赋值后会忽略<a href="_interface_stream_streamoptions_.streamoptions.html#video">StreamOptions.video</a>属性</p> </div> <p>该属性可用于传输从除 <em>媒体设备</em> 和 <em>屏幕/窗口捕获</em> 之外的方式获取到的视频轨道</p> </div> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../index.html"><em>Globals</em></a> </li> <li class="current tsd-kind-module tsd-is-external"> <a href="../modules/_interface_stream_streamoptions_.html">"interface/stream/<wbr>Stream<wbr>Options"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="_interface_stream_streamoptions_.streamcameraconstraints.html" class="tsd-kind-icon">Stream<wbr>Camera<wbr>Constraints</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="_interface_stream_streamoptions_.streamoptions.html" class="tsd-kind-icon">Stream<wbr>Options</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stream_streamoptions_.streamoptions.html#audio" class="tsd-kind-icon">audio</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stream_streamoptions_.streamoptions.html#audiosource" class="tsd-kind-icon">audio<wbr>Source</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stream_streamoptions_.streamoptions.html#id" class="tsd-kind-icon">id</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stream_streamoptions_.streamoptions.html#muted" class="tsd-kind-icon">muted</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stream_streamoptions_.streamoptions.html#rendertype" class="tsd-kind-icon">render<wbr>Type</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stream_streamoptions_.streamoptions.html#video" class="tsd-kind-icon">video</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stream_streamoptions_.streamoptions.html#videosource" class="tsd-kind-icon">video<wbr>Source</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>