UNPKG

zego-express-engine-reactnative

Version:

React Native Zego Express Video for Android & iOS

422 lines 21 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ZegoDeviceExceptionType | 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">&quot;ZegoExpressDefines&quot;</a> </li> <li> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.html">ZegoDeviceExceptionType</a> </li> </ul> <h1>Enumeration ZegoDeviceExceptionType</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>The exception type for the device.</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_.zegodeviceexceptiontype.html#audiosessioncategorychange" class="tsd-kind-icon">Audio<wbr>Session<wbr>Category<wbr>Change</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#audiosessiondeactive" class="tsd-kind-icon">Audio<wbr>Session<wbr>Deactive</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#deviceoccupied" class="tsd-kind-icon">Device<wbr>Occupied</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#deviceunplugged" class="tsd-kind-icon">Device<wbr>Unplugged</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#generic" class="tsd-kind-icon">Generic</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#invalidid" class="tsd-kind-icon">Invalid<wbr>Id</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#magneticcase" class="tsd-kind-icon">Magnetic<wbr>Case</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#mediaserviceswerelost" class="tsd-kind-icon">Media<wbr>Services<wbr>Were<wbr>Lost</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#permissionnotgranted" class="tsd-kind-icon">Permission<wbr>Not<wbr>Granted</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegodeviceexceptiontype.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_.zegodeviceexceptiontype.html#siriisrecording" class="tsd-kind-icon">Siri<wbr>IsRecording</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#soundleveltoolow" class="tsd-kind-icon">Sound<wbr>Level<wbr>Too<wbr>Low</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#unknown" class="tsd-kind-icon">Unknown</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#zerocapturefps" class="tsd-kind-icon">Zero<wbr>Capture<wbr>Fps</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="audiosessioncategorychange" class="tsd-anchor"></a> <h3>Audio<wbr>Session<wbr>Category<wbr>Change</h3> <div class="tsd-signature tsd-kind-icon">Audio<wbr>Session<wbr>Category<wbr>Change<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 13</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:490</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Audio session category change (Apple platform only).</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="audiosessiondeactive" class="tsd-anchor"></a> <h3>Audio<wbr>Session<wbr>Deactive</h3> <div class="tsd-signature tsd-kind-icon">Audio<wbr>Session<wbr>Deactive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 12</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:488</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Audio session deactive (Apple platform only).</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="deviceoccupied" class="tsd-anchor"></a> <h3>Device<wbr>Occupied</h3> <div class="tsd-signature tsd-kind-icon">Device<wbr>Occupied<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 5</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:474</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The device is being occupied.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="deviceunplugged" class="tsd-anchor"></a> <h3>Device<wbr>Unplugged</h3> <div class="tsd-signature tsd-kind-icon">Device<wbr>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:476</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The device is unplugged (not plugged in).</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="generic" class="tsd-anchor"></a> <h3>Generic</h3> <div class="tsd-signature tsd-kind-icon">Generic<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 1</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:466</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Generic device exception.</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>Invalid<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">Invalid<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 2</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:468</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Invalid device ID exception.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="magneticcase" class="tsd-anchor"></a> <h3>Magnetic<wbr>Case</h3> <div class="tsd-signature tsd-kind-icon">Magnetic<wbr>Case<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 11</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:486</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The device is being occupied, and maybe cause by iPad magnetic case (Apple platform only).</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="mediaserviceswerelost" class="tsd-anchor"></a> <h3>Media<wbr>Services<wbr>Were<wbr>Lost</h3> <div class="tsd-signature tsd-kind-icon">Media<wbr>Services<wbr>Were<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:480</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The system media service is unavailable, e.g. when the iOS system detects that the current pressure is huge (such as playing a lot of animation), it is possible to disable all media related services (Apple platform only).</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="permissionnotgranted" class="tsd-anchor"></a> <h3>Permission<wbr>Not<wbr>Granted</h3> <div class="tsd-signature tsd-kind-icon">Permission<wbr>Not<wbr>Granted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 3</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:470</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Device permission is not granted.</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:478</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The device requires the system to restart before it can work (Windows platform only).</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="siriisrecording" class="tsd-anchor"></a> <h3>Siri<wbr>IsRecording</h3> <div class="tsd-signature tsd-kind-icon">Siri<wbr>IsRecording<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 9</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:482</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The device is being occupied by Siri (Apple platform only).</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="soundleveltoolow" class="tsd-anchor"></a> <h3>Sound<wbr>Level<wbr>Too<wbr>Low</h3> <div class="tsd-signature tsd-kind-icon">Sound<wbr>Level<wbr>Too<wbr>Low<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 10</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:484</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The device captured sound level is too low (Windows platform only).</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="unknown" class="tsd-anchor"></a> <h3>Unknown</h3> <div class="tsd-signature tsd-kind-icon">Unknown<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 0</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:464</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Unknown device exception.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="zerocapturefps" class="tsd-anchor"></a> <h3>Zero<wbr>Capture<wbr>Fps</h3> <div class="tsd-signature tsd-kind-icon">Zero<wbr>Capture<wbr>Fps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 4</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:472</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The capture frame rate of the device 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">&quot;index&quot;</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">&quot;<wbr>Zego<wbr>Express<wbr>Defines&quot;</a> </li> <li class=" tsd-kind-module tsd-is-external"> <a href="../modules/_zegoexpressengine_.html">&quot;<wbr>Zego<wbr>Express<wbr>Engine&quot;</a> </li> <li class=" tsd-kind-module tsd-is-external"> <a href="../modules/_zegoexpresseventhandler_.html">&quot;<wbr>Zego<wbr>Express<wbr>Event<wbr>Handler&quot;</a> </li> <li class=" tsd-kind-module tsd-is-external"> <a href="../modules/_zegorenderview_.html">&quot;<wbr>Zego<wbr>Render<wbr>View&quot;</a> </li> <li class=" tsd-kind-module tsd-is-external"> <a href="../modules/_impl_zegoexpressengineimpl_.html">&quot;impl/<wbr>Zego<wbr>Express<wbr>Engine<wbr>Impl&quot;</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_.zegodeviceexceptiontype.html" class="tsd-kind-icon">Zego<wbr>Device<wbr>Exception<wbr>Type</a> <ul> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#audiosessioncategorychange" class="tsd-kind-icon">Audio<wbr>Session<wbr>Category<wbr>Change</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#audiosessiondeactive" class="tsd-kind-icon">Audio<wbr>Session<wbr>Deactive</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#deviceoccupied" class="tsd-kind-icon">Device<wbr>Occupied</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#deviceunplugged" class="tsd-kind-icon">Device<wbr>Unplugged</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#generic" class="tsd-kind-icon">Generic</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#invalidid" class="tsd-kind-icon">Invalid<wbr>Id</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#magneticcase" class="tsd-kind-icon">Magnetic<wbr>Case</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#mediaserviceswerelost" class="tsd-kind-icon">Media<wbr>Services<wbr>Were<wbr>Lost</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#permissionnotgranted" class="tsd-kind-icon">Permission<wbr>Not<wbr>Granted</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.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_.zegodeviceexceptiontype.html#siriisrecording" class="tsd-kind-icon">Siri<wbr>IsRecording</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#soundleveltoolow" class="tsd-kind-icon">Sound<wbr>Level<wbr>Too<wbr>Low</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#unknown" class="tsd-kind-icon">Unknown</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegodeviceexceptiontype.html#zerocapturefps" class="tsd-kind-icon">Zero<wbr>Capture<wbr>Fps</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>