UNPKG

zego-express-engine-reactnative

Version:

React Native Zego Express Video for Android & iOS

303 lines 14 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ZegoScreenCaptureConfig | zego-express-engine-reactnative</title> <meta name="description" content="Documentation for zego-express-engine-reactnative"> <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">zego-express-engine-reactnative</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="../globals.html">Globals</a> </li> <li> <a href="../modules/_zegoexpressdefines_.html">&quot;ZegoExpressDefines&quot;</a> </li> <li> <a href="_zegoexpressdefines_.zegoscreencaptureconfig.html">ZegoScreenCaptureConfig</a> </li> </ul> <h1>Class ZegoScreenCaptureConfig</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>Screen capture configuration parameters.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">ZegoScreenCaptureConfig</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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegoscreencaptureconfig.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="_zegoexpressdefines_.zegoscreencaptureconfig.html#applicationvolume" class="tsd-kind-icon">application<wbr>Volume</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegoscreencaptureconfig.html#audioparam" class="tsd-kind-icon">audio<wbr>Param</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegoscreencaptureconfig.html#captureaudio" class="tsd-kind-icon">capture<wbr>Audio</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegoscreencaptureconfig.html#capturevideo" class="tsd-kind-icon">capture<wbr>Video</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegoscreencaptureconfig.html#microphonevolume" class="tsd-kind-icon">microphone<wbr>Volume</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-external"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">new <wbr>Zego<wbr>Screen<wbr>Capture<wbr>Config<span class="tsd-signature-symbol">(</span>captureVideo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, captureAudio<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, microphoneVolume<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, applicationVolume<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><a href="_zegoexpressdefines_.zegoscreencaptureconfig.html" class="tsd-signature-type">ZegoScreenCaptureConfig</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:1839</li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>captureVideo: <span class="tsd-signature-type">boolean</span></h5> </li> <li> <h5>captureAudio: <span class="tsd-signature-type">boolean</span></h5> </li> <li> <h5>microphoneVolume: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>applicationVolume: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_zegoexpressdefines_.zegoscreencaptureconfig.html" class="tsd-signature-type">ZegoScreenCaptureConfig</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="applicationvolume" class="tsd-anchor"></a> <h3>application<wbr>Volume</h3> <div class="tsd-signature tsd-kind-icon">application<wbr>Volume<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:1836</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set Application audio volume for ReplayKit. The range is 0 ~ 200. The default is 100. (only for iOS)</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="audioparam" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> audio<wbr>Param</h3> <div class="tsd-signature tsd-kind-icon">audio<wbr>Param<span class="tsd-signature-symbol">:</span> <a href="_zegoexpressdefines_.zegoaudioframeparam.html" class="tsd-signature-type">ZegoAudioFrameParam</a></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:1839</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set the audio capture parameters during screen capture. (only for Android)</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="captureaudio" class="tsd-anchor"></a> <h3>capture<wbr>Audio</h3> <div class="tsd-signature tsd-kind-icon">capture<wbr>Audio<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:1830</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether to capture audio when screen capture. The default is true.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="capturevideo" class="tsd-anchor"></a> <h3>capture<wbr>Video</h3> <div class="tsd-signature tsd-kind-icon">capture<wbr>Video<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:1827</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether to capture video when screen capture. The default is true.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="microphonevolume" class="tsd-anchor"></a> <h3>microphone<wbr>Volume</h3> <div class="tsd-signature tsd-kind-icon">microphone<wbr>Volume<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:1833</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set Microphone audio volume for ReplayKit. The range is 0 ~ 200. The default is 100. (only for iOS)</p> </div> </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="../globals.html"><em>Globals</em></a> </li> <li class="label tsd-is-external"> <span>Internals</span> </li> <li class=" tsd-kind-module"> <a href="../modules/_index_.html">&quot;index&quot;</a> </li> <li class="label tsd-is-external"> <span>Externals</span> </li> <li class="current tsd-kind-module tsd-is-external"> <a href="../modules/_zegoexpressdefines_.html">&quot;<wbr>Zego<wbr>Express<wbr>Defines&quot;</a> </li> <li class=" tsd-kind-module tsd-is-external"> <a href="../modules/_zegoexpressengine_.html">&quot;<wbr>Zego<wbr>Express<wbr>Engine&quot;</a> </li> <li class=" tsd-kind-module tsd-is-external"> <a href="../modules/_zegoexpresseventhandler_.html">&quot;<wbr>Zego<wbr>Express<wbr>Event<wbr>Handler&quot;</a> </li> <li class=" tsd-kind-module tsd-is-external"> <a href="../modules/_zegorenderview_.html">&quot;<wbr>Zego<wbr>Render<wbr>View&quot;</a> </li> <li class=" tsd-kind-module tsd-is-external"> <a href="../modules/_impl_zegoexpressengineimpl_.html">&quot;impl/<wbr>Zego<wbr>Express<wbr>Engine<wbr>Impl&quot;</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external"> <a href="_zegoexpressdefines_.zegoscreencaptureconfig.html" class="tsd-kind-icon">Zego<wbr>Screen<wbr>Capture<wbr>Config</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external"> <a href="_zegoexpressdefines_.zegoscreencaptureconfig.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="_zegoexpressdefines_.zegoscreencaptureconfig.html#applicationvolume" class="tsd-kind-icon">application<wbr>Volume</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="_zegoexpressdefines_.zegoscreencaptureconfig.html#audioparam" class="tsd-kind-icon">audio<wbr>Param</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="_zegoexpressdefines_.zegoscreencaptureconfig.html#captureaudio" class="tsd-kind-icon">capture<wbr>Audio</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="_zegoexpressdefines_.zegoscreencaptureconfig.html#capturevideo" class="tsd-kind-icon">capture<wbr>Video</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="_zegoexpressdefines_.zegoscreencaptureconfig.html#microphonevolume" class="tsd-kind-icon">microphone<wbr>Volume</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> </body> </html>