zego-express-engine-reactnative
Version:
React Native Zego Express Video for Android & iOS
450 lines • 21.9 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ZegoPublishStreamQuality | 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_.zegopublishstreamquality.html">ZegoPublishStreamQuality</a>
</li>
</ul>
<h1>Interface ZegoPublishStreamQuality</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>Published stream quality information.</p>
</div>
<p>Audio and video parameters and network quality, etc.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ZegoPublishStreamQuality</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="_zegoexpressdefines_.zegopublishstreamquality.html#audiocapturefps" class="tsd-kind-icon">audio<wbr>CaptureFPS</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#audiokbps" class="tsd-kind-icon">audioKBPS</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#audiosendbytes" class="tsd-kind-icon">audio<wbr>Send<wbr>Bytes</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#audiosendfps" class="tsd-kind-icon">audio<wbr>SendFPS</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#ishardwareencode" class="tsd-kind-icon">is<wbr>Hardware<wbr>Encode</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#level" class="tsd-kind-icon">level</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#packetlostrate" class="tsd-kind-icon">packet<wbr>Lost<wbr>Rate</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#rtt" class="tsd-kind-icon">rtt</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#totalsendbytes" class="tsd-kind-icon">total<wbr>Send<wbr>Bytes</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#videocapturefps" class="tsd-kind-icon">video<wbr>CaptureFPS</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#videocodecid" class="tsd-kind-icon">video<wbr>CodecID</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#videoencodefps" class="tsd-kind-icon">video<wbr>EncodeFPS</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#videokbps" class="tsd-kind-icon">videoKBPS</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#videosendbytes" class="tsd-kind-icon">video<wbr>Send<wbr>Bytes</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_zegoexpressdefines_.zegopublishstreamquality.html#videosendfps" class="tsd-kind-icon">video<wbr>SendFPS</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="audiocapturefps" class="tsd-anchor"></a>
<h3>audio<wbr>CaptureFPS</h3>
<div class="tsd-signature tsd-kind-icon">audio<wbr>CaptureFPS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1220</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Audio capture frame rate. The unit of frame rate is f/s</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="audiokbps" class="tsd-anchor"></a>
<h3>audioKBPS</h3>
<div class="tsd-signature tsd-kind-icon">audioKBPS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1226</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Audio bit rate in kbps</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="audiosendbytes" class="tsd-anchor"></a>
<h3>audio<wbr>Send<wbr>Bytes</h3>
<div class="tsd-signature tsd-kind-icon">audio<wbr>Send<wbr>Bytes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1247</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Number of audio bytes sent</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="audiosendfps" class="tsd-anchor"></a>
<h3>audio<wbr>SendFPS</h3>
<div class="tsd-signature tsd-kind-icon">audio<wbr>SendFPS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1223</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Audio transmission frame rate. The unit of frame rate is f/s</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="ishardwareencode" class="tsd-anchor"></a>
<h3>is<wbr>Hardware<wbr>Encode</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Hardware<wbr>Encode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1238</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Whether to enable hardware encoding</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="level" class="tsd-anchor"></a>
<h3>level</h3>
<div class="tsd-signature tsd-kind-icon">level<span class="tsd-signature-symbol">:</span> <a href="../enums/_zegoexpressdefines_.zegostreamqualitylevel.html" class="tsd-signature-type">ZegoStreamQualityLevel</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1235</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Published stream quality level</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="packetlostrate" class="tsd-anchor"></a>
<h3>packet<wbr>Lost<wbr>Rate</h3>
<div class="tsd-signature tsd-kind-icon">packet<wbr>Lost<wbr>Rate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1232</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Packet loss rate, in percentage, 0.0 ~ 1.0</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="rtt" class="tsd-anchor"></a>
<h3>rtt</h3>
<div class="tsd-signature tsd-kind-icon">rtt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1229</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Local to server delay, in milliseconds</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="totalsendbytes" class="tsd-anchor"></a>
<h3>total<wbr>Send<wbr>Bytes</h3>
<div class="tsd-signature tsd-kind-icon">total<wbr>Send<wbr>Bytes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1244</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Total number of bytes sent, including audio, video, SEI</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="videocapturefps" class="tsd-anchor"></a>
<h3>video<wbr>CaptureFPS</h3>
<div class="tsd-signature tsd-kind-icon">video<wbr>CaptureFPS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1208</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Video capture frame rate. The unit of frame rate is f/s</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="videocodecid" class="tsd-anchor"></a>
<h3>video<wbr>CodecID</h3>
<div class="tsd-signature tsd-kind-icon">video<wbr>CodecID<span class="tsd-signature-symbol">:</span> <a href="../enums/_zegoexpressdefines_.zegovideocodecid.html" class="tsd-signature-type">ZegoVideoCodecID</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1241</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Video codec ID (Available since 1.17.0)</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="videoencodefps" class="tsd-anchor"></a>
<h3>video<wbr>EncodeFPS</h3>
<div class="tsd-signature tsd-kind-icon">video<wbr>EncodeFPS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1211</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Video encoding frame rate. The unit of frame rate is f/s</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="videokbps" class="tsd-anchor"></a>
<h3>videoKBPS</h3>
<div class="tsd-signature tsd-kind-icon">videoKBPS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1217</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Video bit rate in kbps</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="videosendbytes" class="tsd-anchor"></a>
<h3>video<wbr>Send<wbr>Bytes</h3>
<div class="tsd-signature tsd-kind-icon">video<wbr>Send<wbr>Bytes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1250</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Number of video bytes sent</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="videosendfps" class="tsd-anchor"></a>
<h3>video<wbr>SendFPS</h3>
<div class="tsd-signature tsd-kind-icon">video<wbr>SendFPS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1214</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Video transmission frame rate. The unit of frame rate is f/s</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-interface tsd-parent-kind-module tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html" class="tsd-kind-icon">Zego<wbr>Publish<wbr>Stream<wbr>Quality</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#audiocapturefps" class="tsd-kind-icon">audio<wbr>CaptureFPS</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#audiokbps" class="tsd-kind-icon">audioKBPS</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#audiosendbytes" class="tsd-kind-icon">audio<wbr>Send<wbr>Bytes</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#audiosendfps" class="tsd-kind-icon">audio<wbr>SendFPS</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#ishardwareencode" class="tsd-kind-icon">is<wbr>Hardware<wbr>Encode</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#level" class="tsd-kind-icon">level</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#packetlostrate" class="tsd-kind-icon">packet<wbr>Lost<wbr>Rate</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#rtt" class="tsd-kind-icon">rtt</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#totalsendbytes" class="tsd-kind-icon">total<wbr>Send<wbr>Bytes</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#videocapturefps" class="tsd-kind-icon">video<wbr>CaptureFPS</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#videocodecid" class="tsd-kind-icon">video<wbr>CodecID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#videoencodefps" class="tsd-kind-icon">video<wbr>EncodeFPS</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#videokbps" class="tsd-kind-icon">videoKBPS</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#videosendbytes" class="tsd-kind-icon">video<wbr>Send<wbr>Bytes</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_zegoexpressdefines_.zegopublishstreamquality.html#videosendfps" class="tsd-kind-icon">video<wbr>SendFPS</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>