zego-express-engine-reactnative
Version:
React Native Zego Express Video for Android & iOS
365 lines • 19 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ZegoScenario | 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_.zegoscenario.html">ZegoScenario</a>
</li>
</ul>
<h1>Enumeration ZegoScenario</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>Room scenario.</p>
</div>
</div>
</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>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoscenario.html#broadcast" class="tsd-kind-icon">Broadcast</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoscenario.html#communication" class="tsd-kind-icon">Communication</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoscenario.html#default" class="tsd-kind-icon">Default</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoscenario.html#general" class="tsd-kind-icon">General</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoscenario.html#highqualitychatroom" class="tsd-kind-icon">High<wbr>Quality<wbr>Chatroom</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoscenario.html#highqualityvideocall" class="tsd-kind-icon">High<wbr>Quality<wbr>Video<wbr>Call</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoscenario.html#karaoke" class="tsd-kind-icon">Karaoke</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoscenario.html#live" class="tsd-kind-icon">Live</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoscenario.html#standardchatroom" class="tsd-kind-icon">Standard<wbr>Chatroom</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoscenario.html#standardvideocall" class="tsd-kind-icon">Standard<wbr>Video<wbr>Call</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoscenario.html#standardvoicecall" class="tsd-kind-icon">Standard<wbr>Voice<wbr>Call</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="broadcast" class="tsd-anchor"></a>
<h3>Broadcast</h3>
<div class="tsd-signature tsd-kind-icon">Broadcast<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 8</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:22</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Available since: 3.0.0. Description: Live broadcast scenario, it is suitable for one-to-many live broadcast scenarios such as shows, games, e-commerce, and large educational classes. The audio and video quality, fluency, and compatibility have been optimized. Note: Even in live broadcast scenarios, the SDK has no business "roles" (such as anchors and viewers), and all users in the room can publish and play streams.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="communication" class="tsd-anchor"></a>
<h3>Communication</h3>
<div class="tsd-signature tsd-kind-icon">Communication<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 1</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:8</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>[Deprecated] Legacy communication scenario, this scenario has been deprecated since version 3.0.0, and it is not recommended to use, please migrate to other new scenario as soon as possible.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="default" class="tsd-anchor"></a>
<h3>Default</h3>
<div class="tsd-signature tsd-kind-icon">Default<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 3</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:12</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Available since: 3.0.0. Description: The default (generic) scenario. If none of the following scenarios conform to your actual application scenario, this default scenario can be used.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="general" class="tsd-anchor"></a>
<h3>General</h3>
<div class="tsd-signature tsd-kind-icon">General<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 0</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:6</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>[Deprecated] Legacy general scenario, this scenario has been deprecated since version 3.0.0, and it is not recommended to use, please migrate to other new scenario as soon as possible.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="highqualitychatroom" class="tsd-anchor"></a>
<h3>High<wbr>Quality<wbr>Chatroom</h3>
<div class="tsd-signature tsd-kind-icon">High<wbr>Quality<wbr>Chatroom<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 7</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:20</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Available since: 3.0.0. Description: High quality chatroom scenario, it is similar to the standard chatroom scenario, but this scenario uses a higher audio bit rate than the standard chatroom scenario by default. It is suitable for multi-person pure voice call scenarios with high requirements on sound quality. Note: On the ExpressVideo SDK, the camera is not enabled by default in this scenario.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="highqualityvideocall" class="tsd-anchor"></a>
<h3>High<wbr>Quality<wbr>Video<wbr>Call</h3>
<div class="tsd-signature tsd-kind-icon">High<wbr>Quality<wbr>Video<wbr>Call<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 5</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:16</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Available since: 3.0.0. Description: High quality video call scenario, it is similar to the standard video call scenario, but this scenario uses a higher video frame rate, bit rate, and resolution (540p) by default, which is suitable for video call scenario with high image quality requirements.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="karaoke" class="tsd-anchor"></a>
<h3>Karaoke</h3>
<div class="tsd-signature tsd-kind-icon">Karaoke<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 9</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:24</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Available since: 3.0.0. Description: Karaoke (KTV) scenario, it is suitable for real-time chorus and online karaoke scenarios, and has optimized delay, sound quality, ear return, echo cancellation, etc., and also ensures accurate alignment and ultra-low delay when multiple people chorus.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="live" class="tsd-anchor"></a>
<h3>Live</h3>
<div class="tsd-signature tsd-kind-icon">Live<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:10</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>[Deprecated] Legacy live broadcast scenario, this scenario has been deprecated since version 3.0.0, and it is not recommended to use, please migrate to other new scenario as soon as possible.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="standardchatroom" class="tsd-anchor"></a>
<h3>Standard<wbr>Chatroom</h3>
<div class="tsd-signature tsd-kind-icon">Standard<wbr>Chatroom<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 6</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:18</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Available since: 3.0.0. Description: Standard chatroom scenario, suitable for multi-person pure voice calls (low data usage). Note: On the ExpressVideo SDK, the camera is not enabled by default in this scenario.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="standardvideocall" class="tsd-anchor"></a>
<h3>Standard<wbr>Video<wbr>Call</h3>
<div class="tsd-signature tsd-kind-icon">Standard<wbr>Video<wbr>Call<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 4</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:14</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Available since: 3.0.0. Description: Standard video call scenario, it is suitable for one-to-one video call scenarios.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="standardvoicecall" class="tsd-anchor"></a>
<h3>Standard<wbr>Voice<wbr>Call</h3>
<div class="tsd-signature tsd-kind-icon">Standard<wbr>Voice<wbr>Call<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 10</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:26</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Available since: 3.3.0. Description: Standard voice call scenario, it is suitable for one-to-one video or voice call scenarios. Note: On the ExpressVideo SDK, the camera is not enabled by default in this scenario.</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-enum tsd-parent-kind-module tsd-is-external">
<a href="_zegoexpressdefines_.zegoscenario.html" class="tsd-kind-icon">Zego<wbr>Scenario</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoscenario.html#broadcast" class="tsd-kind-icon">Broadcast</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoscenario.html#communication" class="tsd-kind-icon">Communication</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoscenario.html#default" class="tsd-kind-icon">Default</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoscenario.html#general" class="tsd-kind-icon">General</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoscenario.html#highqualitychatroom" class="tsd-kind-icon">High<wbr>Quality<wbr>Chatroom</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoscenario.html#highqualityvideocall" class="tsd-kind-icon">High<wbr>Quality<wbr>Video<wbr>Call</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoscenario.html#karaoke" class="tsd-kind-icon">Karaoke</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoscenario.html#live" class="tsd-kind-icon">Live</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoscenario.html#standardchatroom" class="tsd-kind-icon">Standard<wbr>Chatroom</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoscenario.html#standardvideocall" class="tsd-kind-icon">Standard<wbr>Video<wbr>Call</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoscenario.html#standardvoicecall" class="tsd-kind-icon">Standard<wbr>Voice<wbr>Call</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>