zego-express-engine-reactnative
Version:
React Native Zego Express Video for Android & iOS
460 lines • 22.6 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ZegoRemoteDeviceState | 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_.zegoremotedevicestate.html">ZegoRemoteDeviceState</a>
</li>
</ul>
<h1>Enumeration ZegoRemoteDeviceState</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>Remote device status.</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_.zegoremotedevicestate.html#bysystempressure" class="tsd-kind-icon">By<wbr>System<wbr>Pressure</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#disable" class="tsd-kind-icon">Disable</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#genericerror" class="tsd-kind-icon">Generic<wbr>Error</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#inbackground" class="tsd-kind-icon">In<wbr>Background</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#inusebyother" class="tsd-kind-icon">In<wbr>Use<wbr>ByOther</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#interruption" class="tsd-kind-icon">Interruption</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#invalidid" class="tsd-kind-icon">InvalidID</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#multiforegroundapp" class="tsd-kind-icon">Multi<wbr>Foreground<wbr>App</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#mute" class="tsd-kind-icon">Mute</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#noauthorization" class="tsd-kind-icon">No<wbr>Authorization</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#notsupport" class="tsd-kind-icon">Not<wbr>Support</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#open" class="tsd-kind-icon">Open</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#rebootrequired" class="tsd-kind-icon">Reboot<wbr>Required</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#systemmediaserviceslost" class="tsd-kind-icon">System<wbr>Media<wbr>Services<wbr>Lost</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#unplugged" class="tsd-kind-icon">Unplugged</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoremotedevicestate.html#zerofps" class="tsd-kind-icon">ZeroFPS</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="bysystempressure" class="tsd-anchor"></a>
<h3>By<wbr>System<wbr>Pressure</h3>
<div class="tsd-signature tsd-kind-icon">By<wbr>System<wbr>Pressure<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 14</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:524</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The system is under high load pressure and may cause abnormal equipment.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="disable" class="tsd-anchor"></a>
<h3>Disable</h3>
<div class="tsd-signature tsd-kind-icon">Disable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 9</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:514</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The remote user calls [enableCamera] or [enableAudioCaptureDevice] to disable the camera or microphone.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="genericerror" class="tsd-anchor"></a>
<h3>Generic<wbr>Error</h3>
<div class="tsd-signature tsd-kind-icon">Generic<wbr>Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 1</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:498</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>General device error</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="inbackground" class="tsd-anchor"></a>
<h3>In<wbr>Background</h3>
<div class="tsd-signature tsd-kind-icon">In<wbr>Background<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 12</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:520</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>There are multiple apps at the same time in the foreground, such as the iPad app split screen, the system will prohibit all apps from using the camera.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="inusebyother" class="tsd-anchor"></a>
<h3>In<wbr>Use<wbr>ByOther</h3>
<div class="tsd-signature tsd-kind-icon">In<wbr>Use<wbr>ByOther<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 5</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:506</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The device is occupied</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="interruption" class="tsd-anchor"></a>
<h3>Interruption</h3>
<div class="tsd-signature tsd-kind-icon">Interruption<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 11</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:518</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The device is interrupted, such as a phone call interruption, etc.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="invalidid" class="tsd-anchor"></a>
<h3>InvalidID</h3>
<div class="tsd-signature tsd-kind-icon">InvalidID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:500</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Invalid device ID</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="multiforegroundapp" class="tsd-anchor"></a>
<h3>Multi<wbr>Foreground<wbr>App</h3>
<div class="tsd-signature tsd-kind-icon">Multi<wbr>Foreground<wbr>App<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 13</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:522</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CDN server actively disconnected</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="mute" class="tsd-anchor"></a>
<h3>Mute</h3>
<div class="tsd-signature tsd-kind-icon">Mute<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 10</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:516</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The remote user actively calls [muteMicrophone] or [mutePublishStreamAudio] or [mutePublishStreamVideo] to stop publish the audio or video stream.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="noauthorization" class="tsd-anchor"></a>
<h3>No<wbr>Authorization</h3>
<div class="tsd-signature tsd-kind-icon">No<wbr>Authorization<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 3</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:502</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>No permission</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="notsupport" class="tsd-anchor"></a>
<h3>Not<wbr>Support</h3>
<div class="tsd-signature tsd-kind-icon">Not<wbr>Support<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 15</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:526</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The remote device is not supported to publish the device state.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="open" class="tsd-anchor"></a>
<h3>Open</h3>
<div class="tsd-signature tsd-kind-icon">Open<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 0</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:496</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Device on</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="rebootrequired" class="tsd-anchor"></a>
<h3>Reboot<wbr>Required</h3>
<div class="tsd-signature tsd-kind-icon">Reboot<wbr>Required<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 7</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:510</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The system needs to be restarted</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="systemmediaserviceslost" class="tsd-anchor"></a>
<h3>System<wbr>Media<wbr>Services<wbr>Lost</h3>
<div class="tsd-signature tsd-kind-icon">System<wbr>Media<wbr>Services<wbr>Lost<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 8</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:512</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>System media services stop, such as under the iOS platform, when the system detects that the current pressure is huge (such as playing a lot of animation), it is possible to disable all media related services.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="unplugged" class="tsd-anchor"></a>
<h3>Unplugged</h3>
<div class="tsd-signature tsd-kind-icon">Unplugged<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 6</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:508</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The device is not plugged in or unplugged</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="zerofps" class="tsd-anchor"></a>
<h3>ZeroFPS</h3>
<div class="tsd-signature tsd-kind-icon">ZeroFPS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 4</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:504</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Captured frame rate is 0</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_.zegoremotedevicestate.html" class="tsd-kind-icon">Zego<wbr>Remote<wbr>Device<wbr>State</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#bysystempressure" class="tsd-kind-icon">By<wbr>System<wbr>Pressure</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#disable" class="tsd-kind-icon">Disable</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#genericerror" class="tsd-kind-icon">Generic<wbr>Error</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#inbackground" class="tsd-kind-icon">In<wbr>Background</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#inusebyother" class="tsd-kind-icon">In<wbr>Use<wbr>ByOther</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#interruption" class="tsd-kind-icon">Interruption</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#invalidid" class="tsd-kind-icon">InvalidID</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#multiforegroundapp" class="tsd-kind-icon">Multi<wbr>Foreground<wbr>App</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#mute" class="tsd-kind-icon">Mute</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#noauthorization" class="tsd-kind-icon">No<wbr>Authorization</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#notsupport" class="tsd-kind-icon">Not<wbr>Support</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#open" class="tsd-kind-icon">Open</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#rebootrequired" class="tsd-kind-icon">Reboot<wbr>Required</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#systemmediaserviceslost" class="tsd-kind-icon">System<wbr>Media<wbr>Services<wbr>Lost</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#unplugged" class="tsd-kind-icon">Unplugged</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoremotedevicestate.html#zerofps" class="tsd-kind-icon">ZeroFPS</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>