zego-express-engine-reactnative
Version:
React Native Zego Express Video for Android & iOS
392 lines • 21.5 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ZegoMediaPlayerListener | 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/_zegoexpresseventhandler_.html">"ZegoExpressEventHandler"</a>
</li>
<li>
<a href="_zegoexpresseventhandler_.zegomediaplayerlistener.html">ZegoMediaPlayerListener</a>
</li>
</ul>
<h1>Interface ZegoMediaPlayerListener</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ZegoMediaPlayerListener</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpresseventhandler_.zegomediaplayerlistener.html#mediaplayernetworkevent" class="tsd-kind-icon">media<wbr>Player<wbr>Network<wbr>Event</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpresseventhandler_.zegomediaplayerlistener.html#mediaplayerplayingprogress" class="tsd-kind-icon">media<wbr>Player<wbr>Playing<wbr>Progress</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpresseventhandler_.zegomediaplayerlistener.html#mediaplayerrenderingprogress" class="tsd-kind-icon">media<wbr>Player<wbr>Rendering<wbr>Progress</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpresseventhandler_.zegomediaplayerlistener.html#mediaplayerstateupdate" class="tsd-kind-icon">media<wbr>Player<wbr>State<wbr>Update</a></li>
</ul>
</section>
</div>
</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-interface tsd-is-external">
<a name="mediaplayernetworkevent" class="tsd-anchor"></a>
<h3>media<wbr>Player<wbr>Network<wbr>Event</h3>
<div class="tsd-signature tsd-kind-icon">media<wbr>Player<wbr>Network<wbr>Event<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>mediaPlayer<span class="tsd-signature-symbol">: </span><a href="../classes/_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a>, networkEvent<span class="tsd-signature-symbol">: </span><a href="../enums/_zegoexpressdefines_.zegomediaplayernetworkevent.html" class="tsd-signature-type">ZegoMediaPlayerNetworkEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEventHandler.ts:731</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The callback triggered when the network status of the media player changes.</p>
</div>
<p>Available since: 1.3.4
Description: The callback triggered when the network status of the media player changes.
Trigger: When the media player is playing network resources, this callback will be triggered when the status change of the cached data.
Restrictions: The callback will only be triggered when the network resource is played.
Related APIs: [setNetWorkBufferThreshold].</p>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd><p>Callback player object.</p>
</dd>
<dt>param</dt>
<dd><p>Network status event.</p>
</dd>
</dl>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>mediaPlayer<span class="tsd-signature-symbol">: </span><a href="../classes/_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a>, networkEvent<span class="tsd-signature-symbol">: </span><a href="../enums/_zegoexpressdefines_.zegomediaplayernetworkevent.html" class="tsd-signature-type">ZegoMediaPlayerNetworkEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mediaPlayer: <a href="../classes/_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a></h5>
</li>
<li>
<h5>networkEvent: <a href="../enums/_zegoexpressdefines_.zegomediaplayernetworkevent.html" class="tsd-signature-type">ZegoMediaPlayerNetworkEvent</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="mediaplayerplayingprogress" class="tsd-anchor"></a>
<h3>media<wbr>Player<wbr>Playing<wbr>Progress</h3>
<div class="tsd-signature tsd-kind-icon">media<wbr>Player<wbr>Playing<wbr>Progress<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>mediaPlayer<span class="tsd-signature-symbol">: </span><a href="../classes/_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a>, millisecond<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEventHandler.ts:747</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The callback to report the current playback progress of the media player.</p>
</div>
<p>Available since: 1.3.4
Description: The callback triggered when the network status of the media player changes. Set the callback interval by calling [setProgressInterval]. When the callback interval is set to 0, the callback is stopped. The default callback interval is 1 second.
Trigger: When the media player is playing network resources, this callback will be triggered when the status change of the cached data.
Restrictions: None.
Related APIs: [setProgressInterval].</p>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd><p>Callback player object.</p>
</dd>
<dt>param</dt>
<dd><p>Progress in milliseconds.</p>
</dd>
</dl>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>mediaPlayer<span class="tsd-signature-symbol">: </span><a href="../classes/_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a>, millisecond<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mediaPlayer: <a href="../classes/_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a></h5>
</li>
<li>
<h5>millisecond: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="mediaplayerrenderingprogress" class="tsd-anchor"></a>
<h3>media<wbr>Player<wbr>Rendering<wbr>Progress</h3>
<div class="tsd-signature tsd-kind-icon">media<wbr>Player<wbr>Rendering<wbr>Progress<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>mediaPlayer<span class="tsd-signature-symbol">: </span><a href="../classes/_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a>, millisecond<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEventHandler.ts:760</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The callback to report the current rendering progress of the media player.</p>
</div>
<p>Available since: 3.8.0
Description: The callback to report the current rendering progress of the media player. Set the callback interval by calling [setProgressInterval]. When the callback interval is set to 0, the callback is stopped. The default callback interval is 1 second.
Trigger: This callback will be triggered when the media player starts playing resources.
Restrictions: None.
Related APIs: [setProgressInterval].</p>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd><p>Callback player object.</p>
</dd>
<dt>param</dt>
<dd><p>Progress in milliseconds.</p>
</dd>
</dl>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>mediaPlayer<span class="tsd-signature-symbol">: </span><a href="../classes/_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a>, millisecond<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mediaPlayer: <a href="../classes/_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a></h5>
</li>
<li>
<h5>millisecond: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="mediaplayerstateupdate" class="tsd-anchor"></a>
<h3>media<wbr>Player<wbr>State<wbr>Update</h3>
<div class="tsd-signature tsd-kind-icon">media<wbr>Player<wbr>State<wbr>Update<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>mediaPlayer<span class="tsd-signature-symbol">: </span><a href="../classes/_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a>, state<span class="tsd-signature-symbol">: </span><a href="../enums/_zegoexpressdefines_.zegomediaplayerstate.html" class="tsd-signature-type">ZegoMediaPlayerState</a>, errorCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEventHandler.ts:714</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>MediaPlayer playback status callback.</p>
</div>
<p>Available since: 1.3.4
Description: MediaPlayer playback status callback.
Trigger: The callback triggered when the state of the media player changes.
Restrictions: None.</p>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd><p>Callback player object.</p>
</dd>
<dt>param</dt>
<dd><p>Media player status.</p>
</dd>
<dt>param</dt>
<dd><p>Error code, please refer to the error codes document <a href="https://docs.zegocloud.com/en/5548.html">https://docs.zegocloud.com/en/5548.html</a> for details.</p>
</dd>
</dl>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>mediaPlayer<span class="tsd-signature-symbol">: </span><a href="../classes/_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a>, state<span class="tsd-signature-symbol">: </span><a href="../enums/_zegoexpressdefines_.zegomediaplayerstate.html" class="tsd-signature-type">ZegoMediaPlayerState</a>, errorCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mediaPlayer: <a href="../classes/_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a></h5>
</li>
<li>
<h5>state: <a href="../enums/_zegoexpressdefines_.zegomediaplayerstate.html" class="tsd-signature-type">ZegoMediaPlayerState</a></h5>
</li>
<li>
<h5>errorCode: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</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=" 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="current 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">
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_zegoexpresseventhandler_.zegoaudioeffectplayerlistener.html" class="tsd-kind-icon">Zego<wbr>Audio<wbr>Effect<wbr>Player<wbr>Listener</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_zegoexpresseventhandler_.zegoeventlistener.html" class="tsd-kind-icon">Zego<wbr>Event<wbr>Listener</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_zegoexpresseventhandler_.zegomediaplayerlistener.html" class="tsd-kind-icon">Zego<wbr>Media<wbr>Player<wbr>Listener</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpresseventhandler_.zegomediaplayerlistener.html#mediaplayernetworkevent" class="tsd-kind-icon">media<wbr>Player<wbr>Network<wbr>Event</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpresseventhandler_.zegomediaplayerlistener.html#mediaplayerplayingprogress" class="tsd-kind-icon">media<wbr>Player<wbr>Playing<wbr>Progress</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpresseventhandler_.zegomediaplayerlistener.html#mediaplayerrenderingprogress" class="tsd-kind-icon">media<wbr>Player<wbr>Rendering<wbr>Progress</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpresseventhandler_.zegomediaplayerlistener.html#mediaplayerstateupdate" class="tsd-kind-icon">media<wbr>Player<wbr>State<wbr>Update</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>