zego-express-engine-reactnative
Version:
React Native Zego Express Video for Android & iOS
276 lines • 12.8 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ZegoPlayerConfig | 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_.zegoplayerconfig.html">ZegoPlayerConfig</a>
</li>
</ul>
<h1>Class ZegoPlayerConfig</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>Advanced player configuration.</p>
</div>
<p>Configure stream resource mode, CDN configuration and other advanced configurations.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ZegoPlayerConfig</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_.zegoplayerconfig.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_.zegoplayerconfig.html#cdnconfig" class="tsd-kind-icon">cdn<wbr>Config</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegoplayerconfig.html#resourcemode" class="tsd-kind-icon">resource<wbr>Mode</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegoplayerconfig.html#roomid" class="tsd-kind-icon">roomID</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegoplayerconfig.html#videocodecid" class="tsd-kind-icon">video<wbr>CodecID</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>Player<wbr>Config<span class="tsd-signature-symbol">(</span>cdnConfig<span class="tsd-signature-symbol">?: </span><a href="_zegoexpressdefines_.zegocdnconfig.html" class="tsd-signature-type">ZegoCDNConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_zegoexpressdefines_.zegoplayerconfig.html" class="tsd-signature-type">ZegoPlayerConfig</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1312</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cdnConfig: <a href="_zegoexpressdefines_.zegocdnconfig.html" class="tsd-signature-type">ZegoCDNConfig</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_zegoexpressdefines_.zegoplayerconfig.html" class="tsd-signature-type">ZegoPlayerConfig</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="cdnconfig" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> cdn<wbr>Config</h3>
<div class="tsd-signature tsd-kind-icon">cdn<wbr>Config<span class="tsd-signature-symbol">:</span> <a href="_zegoexpressdefines_.zegocdnconfig.html" class="tsd-signature-type">ZegoCDNConfig</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1306</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The CDN configuration for playing stream. If set, the stream is play according to the URL instead of the streamID. After that, the streamID is only used as the ID of SDK internal callback.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="resourcemode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> resource<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">resource<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/_zegoexpressdefines_.zegostreamresourcemode.html" class="tsd-signature-type">ZegoStreamResourceMode</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1303</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Stream resource mode.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="roomid" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> roomID</h3>
<div class="tsd-signature tsd-kind-icon">roomID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1309</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Room ID. It only needs to be filled in the multi-room mode, which indicates which room this stream needs to be bound to. This parameter is ignored in single room mode.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="videocodecid" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> video<wbr>CodecID</h3>
<div class="tsd-signature tsd-kind-icon">video<wbr>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:1312</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The video encoding type of the stream, please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored.</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_.zegoplayerconfig.html" class="tsd-kind-icon">Zego<wbr>Player<wbr>Config</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegoplayerconfig.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegoplayerconfig.html#cdnconfig" class="tsd-kind-icon">cdn<wbr>Config</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegoplayerconfig.html#resourcemode" class="tsd-kind-icon">resource<wbr>Mode</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegoplayerconfig.html#roomid" class="tsd-kind-icon">roomID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegoplayerconfig.html#videocodecid" class="tsd-kind-icon">video<wbr>CodecID</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>