zego-express-engine-reactnative
Version:
React Native Zego Express Video for Android & iOS
263 lines • 12.1 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ZegoEngineProfile | 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_.zegoengineprofile.html">ZegoEngineProfile</a>
</li>
</ul>
<h1>Class ZegoEngineProfile</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>Profile for create engine</p>
</div>
<p>Profile for create engine</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ZegoEngineProfile</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_.zegoengineprofile.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_.zegoengineprofile.html#appid" class="tsd-kind-icon">appID</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegoengineprofile.html#appsign" class="tsd-kind-icon">app<wbr>Sign</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegoengineprofile.html#scenario" class="tsd-kind-icon">scenario</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>Engine<wbr>Profile<span class="tsd-signature-symbol">(</span>appID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, appSign<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, scenario<span class="tsd-signature-symbol">: </span><a href="../enums/_zegoexpressdefines_.zegoscenario.html" class="tsd-signature-type">ZegoScenario</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_zegoexpressdefines_.zegoengineprofile.html" class="tsd-signature-type">ZegoEngineProfile</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:854</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>appID: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>appSign: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>scenario: <a href="../enums/_zegoexpressdefines_.zegoscenario.html" class="tsd-signature-type">ZegoScenario</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_zegoexpressdefines_.zegoengineprofile.html" class="tsd-signature-type">ZegoEngineProfile</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="appid" class="tsd-anchor"></a>
<h3>appID</h3>
<div class="tsd-signature tsd-kind-icon">appID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:848</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Application ID issued by ZEGO for developers, please apply from the ZEGO Admin Console <a href="https://console.zegocloud.com">https://console.zegocloud.com</a> The value ranges from 0 to 4294967295.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="appsign" class="tsd-anchor"></a>
<h3>app<wbr>Sign</h3>
<div class="tsd-signature tsd-kind-icon">app<wbr>Sign<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:851</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Application signature for each AppID, please apply from the ZEGO Admin Console. Application signature is a 64 character string. Each character has a range of '0' ~ '9', 'a' ~ 'z'. AppSign 2.17.0 and later allows null or no transmission. If the token is passed empty or not passed, the token must be entered in the [ZegoRoomConfig] parameter for authentication when the [loginRoom] interface is called to login to the room.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="scenario" class="tsd-anchor"></a>
<h3>scenario</h3>
<div class="tsd-signature tsd-kind-icon">scenario<span class="tsd-signature-symbol">:</span> <a href="../enums/_zegoexpressdefines_.zegoscenario.html" class="tsd-signature-type">ZegoScenario</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:854</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The room scenario. the SDK will optimize the audio and video configuration for the specified scenario to achieve the best effect in this scenario. After specifying the scenario, you can call other APIs to adjusting the audio and video configuration. Differences between scenarios and how to choose a suitable scenario, please refer to <a href="https://docs.zegocloud.com/article/14940">https://docs.zegocloud.com/article/14940</a></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_.zegoengineprofile.html" class="tsd-kind-icon">Zego<wbr>Engine<wbr>Profile</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegoengineprofile.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegoengineprofile.html#appid" class="tsd-kind-icon">appID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegoengineprofile.html#appsign" class="tsd-kind-icon">app<wbr>Sign</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegoengineprofile.html#scenario" class="tsd-kind-icon">scenario</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>