zego-express-engine-reactnative
Version:
React Native Zego Express Video for Android & iOS
327 lines • 16.3 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ZegoRoomStateChangedReason | 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_.zegoroomstatechangedreason.html">ZegoRoomStateChangedReason</a>
</li>
</ul>
<h1>Enumeration ZegoRoomStateChangedReason</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 state change reason.</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_.zegoroomstatechangedreason.html#kickout" class="tsd-kind-icon">Kick<wbr>Out</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#loginfailed" class="tsd-kind-icon">Login<wbr>Failed</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#logined" class="tsd-kind-icon">Logined</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#logining" class="tsd-kind-icon">Logining</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#logout" class="tsd-kind-icon">Logout</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#logoutfailed" class="tsd-kind-icon">Logout<wbr>Failed</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#reconnectfailed" class="tsd-kind-icon">Reconnect<wbr>Failed</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#reconnected" class="tsd-kind-icon">Reconnected</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#reconnecting" class="tsd-kind-icon">Reconnecting</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="kickout" class="tsd-anchor"></a>
<h3>Kick<wbr>Out</h3>
<div class="tsd-signature tsd-kind-icon">Kick<wbr>Out<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 6</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:70</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Kicked out of the room by the server. For example, if you log in to the room with the same user name in other places, and the local end is kicked out of the room, it will enter this state.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="loginfailed" class="tsd-anchor"></a>
<h3>Login<wbr>Failed</h3>
<div class="tsd-signature tsd-kind-icon">Login<wbr>Failed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:62</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Failed to log in to the room. When the login or switch room fails, it will enter this state, indicating that the login or switch room has failed, for example, AppID or Token is incorrect, etc.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="logined" class="tsd-anchor"></a>
<h3>Logined</h3>
<div class="tsd-signature tsd-kind-icon">Logined<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 1</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:60</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Log in to the room successfully. When the room is successfully logged in or switched, it will enter this state, indicating that the login to the room has been successful, and users can normally receive callback notifications of other users in the room and all stream information additions and deletions.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="logining" class="tsd-anchor"></a>
<h3>Logining</h3>
<div class="tsd-signature tsd-kind-icon">Logining<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 0</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:58</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Logging in to the room. When calling [loginRoom] to log in to the room or [switchRoom] to switch to the target room, it will enter this state, indicating that it is requesting to connect to the server. The application interface is usually displayed through this state.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="logout" class="tsd-anchor"></a>
<h3>Logout</h3>
<div class="tsd-signature tsd-kind-icon">Logout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 7</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:72</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Logout of the room is successful. It is in this state by default before logging into the room. When calling [logoutRoom] to log out of the room successfully or [switchRoom] to log out of the current room successfully, it will enter this state.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="logoutfailed" class="tsd-anchor"></a>
<h3>Logout<wbr>Failed</h3>
<div class="tsd-signature tsd-kind-icon">Logout<wbr>Failed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 8</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:74</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Failed to log out of the room. Enter this state when calling [logoutRoom] fails to log out of the room or [switchRoom] fails to log out of the current room internally.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="reconnectfailed" class="tsd-anchor"></a>
<h3>Reconnect<wbr>Failed</h3>
<div class="tsd-signature tsd-kind-icon">Reconnect<wbr>Failed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 5</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:68</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The room fails to reconnect. If there is an interruption due to poor network quality, the SDK will retry internally, and enter this state after the reconnection fails.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="reconnected" class="tsd-anchor"></a>
<h3>Reconnected</h3>
<div class="tsd-signature tsd-kind-icon">Reconnected<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 4</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:66</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The room is successfully reconnected. If there is an interruption due to poor network quality, the SDK will retry internally, and enter this state after successful reconnection.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a name="reconnecting" class="tsd-anchor"></a>
<h3>Reconnecting</h3>
<div class="tsd-signature tsd-kind-icon">Reconnecting<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 3</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:64</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The room connection is temporarily interrupted. If the interruption occurs due to poor network quality, the SDK will retry internally.</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_.zegoroomstatechangedreason.html" class="tsd-kind-icon">Zego<wbr>Room<wbr>State<wbr>Changed<wbr>Reason</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#kickout" class="tsd-kind-icon">Kick<wbr>Out</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#loginfailed" class="tsd-kind-icon">Login<wbr>Failed</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#logined" class="tsd-kind-icon">Logined</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#logining" class="tsd-kind-icon">Logining</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#logout" class="tsd-kind-icon">Logout</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#logoutfailed" class="tsd-kind-icon">Logout<wbr>Failed</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#reconnectfailed" class="tsd-kind-icon">Reconnect<wbr>Failed</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#reconnected" class="tsd-kind-icon">Reconnected</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external">
<a href="_zegoexpressdefines_.zegoroomstatechangedreason.html#reconnecting" class="tsd-kind-icon">Reconnecting</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>