zego-express-engine-reactnative
Version:
React Native Zego Express Video for Android & iOS
359 lines • 18.7 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ZegoVideoConfig | 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">"ZegoExpressDefines"</a>
</li>
<li>
<a href="_zegoexpressdefines_.zegovideoconfig.html">ZegoVideoConfig</a>
</li>
</ul>
<h1>Class ZegoVideoConfig</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>Video config.</p>
</div>
<p>Configure parameters used for publishing stream, such as bitrate, frame rate, and resolution.
Developers should note that the width and height resolution of the mobile and desktop are opposite. For example, 360p, the resolution of the mobile is 360x640, and the desktop is 640x360.
When using external capture, the capture and encoding resolution of RTC cannot be set to 0*0, otherwise, there will be no video data in the publishing stream in the entire engine life cycle.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ZegoVideoConfig</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_.zegovideoconfig.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_.zegovideoconfig.html#bitrate" class="tsd-kind-icon">bitrate</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegovideoconfig.html#captureheight" class="tsd-kind-icon">capture<wbr>Height</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegovideoconfig.html#capturewidth" class="tsd-kind-icon">capture<wbr>Width</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegovideoconfig.html#codecid" class="tsd-kind-icon">codecID</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegovideoconfig.html#encodeheight" class="tsd-kind-icon">encode<wbr>Height</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegovideoconfig.html#encodewidth" class="tsd-kind-icon">encode<wbr>Width</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegovideoconfig.html#fps" class="tsd-kind-icon">fps</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegovideoconfig.html#keyframeinterval" class="tsd-kind-icon">key<wbr>Frame<wbr>Interval</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>Video<wbr>Config<span class="tsd-signature-symbol">(</span>preset<span class="tsd-signature-symbol">?: </span><a href="../enums/_zegoexpressdefines_.zegovideoconfigpreset.html" class="tsd-signature-type">ZegoVideoConfigPreset</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_zegoexpressdefines_.zegovideoconfig.html" class="tsd-signature-type">ZegoVideoConfig</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:928</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create video configuration with preset enumeration values</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> preset: <a href="../enums/_zegoexpressdefines_.zegovideoconfigpreset.html" class="tsd-signature-type">ZegoVideoConfigPreset</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_zegoexpressdefines_.zegovideoconfig.html" class="tsd-signature-type">ZegoVideoConfig</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="bitrate" class="tsd-anchor"></a>
<h3>bitrate</h3>
<div class="tsd-signature tsd-kind-icon">bitrate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:922</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Bit rate in kbps. The settings before and after publishing stream can be effective</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="captureheight" class="tsd-anchor"></a>
<h3>capture<wbr>Height</h3>
<div class="tsd-signature tsd-kind-icon">capture<wbr>Height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:910</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Capture resolution height, control the height of camera image acquisition. SDK requires this member to be set to an even number. Only the camera is not started and the custom video capture is not used, the setting is effective. For performance reasons, the SDK scales the video frame to the encoding resolution after capturing from camera and before rendering to the preview view. Therefore, the resolution of the preview image is the encoding resolution. If you need the resolution of the preview image to be this value, Please call [setCapturePipelineScaleMode] first to change the capture pipeline scale mode to [Post]</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="capturewidth" class="tsd-anchor"></a>
<h3>capture<wbr>Width</h3>
<div class="tsd-signature tsd-kind-icon">capture<wbr>Width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:907</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Capture resolution width, control the width of camera image acquisition. SDK requires this member to be set to an even number. Only the camera is not started and the custom video capture is not used, the setting is effective. For performance reasons, the SDK scales the video frame to the encoding resolution after capturing from camera and before rendering to the preview view. Therefore, the resolution of the preview image is the encoding resolution. If you need the resolution of the preview image to be this value, Please call [setCapturePipelineScaleMode] first to change the capture pipeline scale mode to [Post]</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="codecid" class="tsd-anchor"></a>
<h3>codecID</h3>
<div class="tsd-signature tsd-kind-icon">codecID<span class="tsd-signature-symbol">:</span> <a href="../enums/_zegoexpressdefines_.zegovideocodecid.html" class="tsd-signature-type">ZegoVideoCodecID</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:925</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The codec id to be used, the default value is [default]. Settings only take effect before publishing stream</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="encodeheight" class="tsd-anchor"></a>
<h3>encode<wbr>Height</h3>
<div class="tsd-signature tsd-kind-icon">encode<wbr>Height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:916</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Encode resolution height, control the image height of the encoder when publishing stream. SDK requires this member to be set to an even number. The settings before and after publishing stream can be effective</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="encodewidth" class="tsd-anchor"></a>
<h3>encode<wbr>Width</h3>
<div class="tsd-signature tsd-kind-icon">encode<wbr>Width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:913</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Encode resolution width, control the image width of the encoder when publishing stream. SDK requires this member to be set to an even number. The settings before and after publishing stream can be effective</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="fps" class="tsd-anchor"></a>
<h3>fps</h3>
<div class="tsd-signature tsd-kind-icon">fps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:919</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Frame rate, control the frame rate of the camera and the frame rate of the encoder. Only the camera is not started, the setting is effective. Publishing stream set to 60 fps, playing stream to take effect need contact technical support</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="keyframeinterval" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> key<wbr>Frame<wbr>Interval</h3>
<div class="tsd-signature tsd-kind-icon">key<wbr>Frame<wbr>Interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:928</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Video keyframe interval, in seconds. Required: No. Default value: 2 seconds. Value range: [2, 5]. Caution: The setting is only valid before pushing.</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">"index"</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">"<wbr>Zego<wbr>Express<wbr>Defines"</a>
</li>
<li class=" tsd-kind-module tsd-is-external">
<a href="../modules/_zegoexpressengine_.html">"<wbr>Zego<wbr>Express<wbr>Engine"</a>
</li>
<li class=" tsd-kind-module tsd-is-external">
<a href="../modules/_zegoexpresseventhandler_.html">"<wbr>Zego<wbr>Express<wbr>Event<wbr>Handler"</a>
</li>
<li class=" tsd-kind-module tsd-is-external">
<a href="../modules/_zegorenderview_.html">"<wbr>Zego<wbr>Render<wbr>View"</a>
</li>
<li class=" tsd-kind-module tsd-is-external">
<a href="../modules/_impl_zegoexpressengineimpl_.html">"impl/<wbr>Zego<wbr>Express<wbr>Engine<wbr>Impl"</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_.zegovideoconfig.html" class="tsd-kind-icon">Zego<wbr>Video<wbr>Config</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegovideoconfig.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegovideoconfig.html#bitrate" class="tsd-kind-icon">bitrate</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegovideoconfig.html#captureheight" class="tsd-kind-icon">capture<wbr>Height</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegovideoconfig.html#capturewidth" class="tsd-kind-icon">capture<wbr>Width</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegovideoconfig.html#codecid" class="tsd-kind-icon">codecID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegovideoconfig.html#encodeheight" class="tsd-kind-icon">encode<wbr>Height</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegovideoconfig.html#encodewidth" class="tsd-kind-icon">encode<wbr>Width</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegovideoconfig.html#fps" class="tsd-kind-icon">fps</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegovideoconfig.html#keyframeinterval" class="tsd-kind-icon">key<wbr>Frame<wbr>Interval</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>