UNPKG

zego-express-engine-reactnative

Version:

React Native Zego Express Video for Android & iOS

422 lines 20.1 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ZegoStreamEvent | 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_.zegostreamevent.html">ZegoStreamEvent</a> </li> </ul> <h1>Enumeration ZegoStreamEvent</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>Publish or play stream event</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_.zegostreamevent.html#playend" class="tsd-kind-icon">Play<wbr>End</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegostreamevent.html#playfail" class="tsd-kind-icon">Play<wbr>Fail</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegostreamevent.html#playstart" class="tsd-kind-icon">Play<wbr>Start</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegostreamevent.html#playsuccess" class="tsd-kind-icon">Play<wbr>Success</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegostreamevent.html#publishend" class="tsd-kind-icon">Publish<wbr>End</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegostreamevent.html#publishfail" class="tsd-kind-icon">Publish<wbr>Fail</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegostreamevent.html#publishstart" class="tsd-kind-icon">Publish<wbr>Start</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegostreamevent.html#publishsuccess" class="tsd-kind-icon">Publish<wbr>Success</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegostreamevent.html#retryplayfail" class="tsd-kind-icon">Retry<wbr>Play<wbr>Fail</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegostreamevent.html#retryplaystart" class="tsd-kind-icon">Retry<wbr>Play<wbr>Start</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegostreamevent.html#retryplaysuccess" class="tsd-kind-icon">Retry<wbr>Play<wbr>Success</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegostreamevent.html#retrypublishfail" class="tsd-kind-icon">Retry<wbr>Publish<wbr>Fail</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegostreamevent.html#retrypublishstart" class="tsd-kind-icon">Retry<wbr>Publish<wbr>Start</a></li> <li class="tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"><a href="_zegoexpressdefines_.zegostreamevent.html#retrypublishsuccess" class="tsd-kind-icon">Retry<wbr>Publish<wbr>Success</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="playend" class="tsd-anchor"></a> <h3>Play<wbr>End</h3> <div class="tsd-signature tsd-kind-icon">Play<wbr>End<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 206</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:722</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>End of playing stream</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="playfail" class="tsd-anchor"></a> <h3>Play<wbr>Fail</h3> <div class="tsd-signature tsd-kind-icon">Play<wbr>Fail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 202</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:714</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Failed to play stream for the first time</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="playstart" class="tsd-anchor"></a> <h3>Play<wbr>Start</h3> <div class="tsd-signature tsd-kind-icon">Play<wbr>Start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 200</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:710</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Start playing stream</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="playsuccess" class="tsd-anchor"></a> <h3>Play<wbr>Success</h3> <div class="tsd-signature tsd-kind-icon">Play<wbr>Success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 201</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:712</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The first play stream was successful</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="publishend" class="tsd-anchor"></a> <h3>Publish<wbr>End</h3> <div class="tsd-signature tsd-kind-icon">Publish<wbr>End<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 106</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:708</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>End of publishing stream</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="publishfail" class="tsd-anchor"></a> <h3>Publish<wbr>Fail</h3> <div class="tsd-signature tsd-kind-icon">Publish<wbr>Fail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 102</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:700</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Failed to publish stream for the first time</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="publishstart" class="tsd-anchor"></a> <h3>Publish<wbr>Start</h3> <div class="tsd-signature tsd-kind-icon">Publish<wbr>Start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 100</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:696</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Start publishing stream</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="publishsuccess" class="tsd-anchor"></a> <h3>Publish<wbr>Success</h3> <div class="tsd-signature tsd-kind-icon">Publish<wbr>Success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 101</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:698</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The first publish stream was successful</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="retryplayfail" class="tsd-anchor"></a> <h3>Retry<wbr>Play<wbr>Fail</h3> <div class="tsd-signature tsd-kind-icon">Retry<wbr>Play<wbr>Fail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 205</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:720</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Failed to retry playing stream</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="retryplaystart" class="tsd-anchor"></a> <h3>Retry<wbr>Play<wbr>Start</h3> <div class="tsd-signature tsd-kind-icon">Retry<wbr>Play<wbr>Start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 203</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:716</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Start retrying playing stream</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="retryplaysuccess" class="tsd-anchor"></a> <h3>Retry<wbr>Play<wbr>Success</h3> <div class="tsd-signature tsd-kind-icon">Retry<wbr>Play<wbr>Success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 204</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:718</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Retry playing stream successfully</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="retrypublishfail" class="tsd-anchor"></a> <h3>Retry<wbr>Publish<wbr>Fail</h3> <div class="tsd-signature tsd-kind-icon">Retry<wbr>Publish<wbr>Fail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 105</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:706</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Failed to retry publishing stream</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="retrypublishstart" class="tsd-anchor"></a> <h3>Retry<wbr>Publish<wbr>Start</h3> <div class="tsd-signature tsd-kind-icon">Retry<wbr>Publish<wbr>Start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 103</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:702</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Start retrying publishing stream</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a name="retrypublishsuccess" class="tsd-anchor"></a> <h3>Retry<wbr>Publish<wbr>Success</h3> <div class="tsd-signature tsd-kind-icon">Retry<wbr>Publish<wbr>Success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = 104</span></div> <aside class="tsd-sources"> <ul> <li>Defined in ZegoExpressDefines.ts:704</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Retry publishing stream successfully</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_.zegostreamevent.html" class="tsd-kind-icon">Zego<wbr>Stream<wbr>Event</a> <ul> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#playend" class="tsd-kind-icon">Play<wbr>End</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#playfail" class="tsd-kind-icon">Play<wbr>Fail</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#playstart" class="tsd-kind-icon">Play<wbr>Start</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#playsuccess" class="tsd-kind-icon">Play<wbr>Success</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#publishend" class="tsd-kind-icon">Publish<wbr>End</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#publishfail" class="tsd-kind-icon">Publish<wbr>Fail</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#publishstart" class="tsd-kind-icon">Publish<wbr>Start</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#publishsuccess" class="tsd-kind-icon">Publish<wbr>Success</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#retryplayfail" class="tsd-kind-icon">Retry<wbr>Play<wbr>Fail</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#retryplaystart" class="tsd-kind-icon">Retry<wbr>Play<wbr>Start</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#retryplaysuccess" class="tsd-kind-icon">Retry<wbr>Play<wbr>Success</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#retrypublishfail" class="tsd-kind-icon">Retry<wbr>Publish<wbr>Fail</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#retrypublishstart" class="tsd-kind-icon">Retry<wbr>Publish<wbr>Start</a> </li> <li class=" tsd-kind-enum-member tsd-parent-kind-enum tsd-is-external"> <a href="_zegoexpressdefines_.zegostreamevent.html#retrypublishsuccess" class="tsd-kind-icon">Retry<wbr>Publish<wbr>Success</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>