zego-express-engine-reactnative
Version:
React Native Zego Express Video for Android & iOS
315 lines • 14.3 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ZegoMixerTask | 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_.zegomixertask.html">ZegoMixerTask</a>
</li>
</ul>
<h1>Class ZegoMixerTask</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>Mix stream task object.</p>
</div>
<p>This class is the configuration class of the stream mixing task. When a stream mixing task is requested to the ZEGO RTC server, the configuration of the stream mixing task is required.
This class describes the detailed configuration information of this stream mixing task.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ZegoMixerTask</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegomixertask.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-external">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegomixertask.html#audioconfig" class="tsd-kind-icon">audio<wbr>Config</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegomixertask.html#enablesoundlevel" class="tsd-kind-icon">enable<wbr>Sound<wbr>Level</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegomixertask.html#inputlist" class="tsd-kind-icon">input<wbr>List</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegomixertask.html#outputlist" class="tsd-kind-icon">output<wbr>List</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegomixertask.html#taskid" class="tsd-kind-icon">taskID</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressdefines_.zegomixertask.html#videoconfig" class="tsd-kind-icon">video<wbr>Config</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">new <wbr>Zego<wbr>Mixer<wbr>Task<span class="tsd-signature-symbol">(</span>taskID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_zegoexpressdefines_.zegomixertask.html" class="tsd-signature-type">ZegoMixerTask</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1565</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>taskID: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_zegoexpressdefines_.zegomixertask.html" class="tsd-signature-type">ZegoMixerTask</a></h4>
</li>
</ul>
</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-class tsd-is-external">
<a name="audioconfig" class="tsd-anchor"></a>
<h3>audio<wbr>Config</h3>
<div class="tsd-signature tsd-kind-icon">audio<wbr>Config<span class="tsd-signature-symbol">:</span> <a href="_zegoexpressdefines_.zegomixeraudioconfig.html" class="tsd-signature-type">ZegoMixerAudioConfig</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1562</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The audio config of the task</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="enablesoundlevel" class="tsd-anchor"></a>
<h3>enable<wbr>Sound<wbr>Level</h3>
<div class="tsd-signature tsd-kind-icon">enable<wbr>Sound<wbr>Level<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1565</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enable or disable sound level callback for the task. If enabled, then the remote player can get the soundLevel of every stream in the inputlist by [onMixerSoundLevelUpdate] callback.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="inputlist" class="tsd-anchor"></a>
<h3>input<wbr>List</h3>
<div class="tsd-signature tsd-kind-icon">input<wbr>List<span class="tsd-signature-symbol">:</span> <a href="_zegoexpressdefines_.zegomixerinput.html" class="tsd-signature-type">ZegoMixerInput</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1553</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The input list of the task</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="outputlist" class="tsd-anchor"></a>
<h3>output<wbr>List</h3>
<div class="tsd-signature tsd-kind-icon">output<wbr>List<span class="tsd-signature-symbol">:</span> <a href="_zegoexpressdefines_.zegomixeroutput.html" class="tsd-signature-type">ZegoMixerOutput</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1556</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The output list of the task</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="taskid" class="tsd-anchor"></a>
<h3>taskID</h3>
<div class="tsd-signature tsd-kind-icon">taskID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1550</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The task ID of the task</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="videoconfig" class="tsd-anchor"></a>
<h3>video<wbr>Config</h3>
<div class="tsd-signature tsd-kind-icon">video<wbr>Config<span class="tsd-signature-symbol">:</span> <a href="_zegoexpressdefines_.zegomixervideoconfig.html" class="tsd-signature-type">ZegoMixerVideoConfig</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressDefines.ts:1559</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The video config of the task</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-class tsd-parent-kind-module tsd-is-external">
<a href="_zegoexpressdefines_.zegomixertask.html" class="tsd-kind-icon">Zego<wbr>Mixer<wbr>Task</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegomixertask.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegomixertask.html#audioconfig" class="tsd-kind-icon">audio<wbr>Config</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegomixertask.html#enablesoundlevel" class="tsd-kind-icon">enable<wbr>Sound<wbr>Level</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegomixertask.html#inputlist" class="tsd-kind-icon">input<wbr>List</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegomixertask.html#outputlist" class="tsd-kind-icon">output<wbr>List</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegomixertask.html#taskid" class="tsd-kind-icon">taskID</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a href="_zegoexpressdefines_.zegomixertask.html#videoconfig" class="tsd-kind-icon">video<wbr>Config</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>