zego-express-engine-reactnative
Version:
React Native Zego Express Video for Android & iOS
541 lines • 365 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ZegoExpressEngine | 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/_zegoexpressengine_.html">"ZegoExpressEngine"</a>
</li>
<li>
<a href="_zegoexpressengine_.zegoexpressengine.html">ZegoExpressEngine</a>
</li>
</ul>
<h1>Class ZegoExpressEngine</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">ZegoExpressEngine</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>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#addpublishcdnurl" class="tsd-kind-icon">add<wbr>Publish<wbr>Cdn<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#callexperimentalapi" class="tsd-kind-icon">call<wbr>ExperimentalAPI</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#createaudioeffectplayer" class="tsd-kind-icon">create<wbr>Audio<wbr>Effect<wbr>Player</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#createmediaplayer" class="tsd-kind-icon">create<wbr>Media<wbr>Player</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#destroyaudioeffectplayer" class="tsd-kind-icon">destroy<wbr>Audio<wbr>Effect<wbr>Player</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#destroymediaplayer" class="tsd-kind-icon">destroy<wbr>Media<wbr>Player</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enableaec" class="tsd-kind-icon">enableAEC</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enableagc" class="tsd-kind-icon">enableAGC</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enableans" class="tsd-kind-icon">enableANS</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enablealphachannelvideoencoder" class="tsd-kind-icon">enable<wbr>Alpha<wbr>Channel<wbr>Video<wbr>Encoder</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enableaudiocapturedevice" class="tsd-kind-icon">enable<wbr>Audio<wbr>Capture<wbr>Device</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enablebeautify" class="tsd-kind-icon">enable<wbr>Beautify</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enablecamera" class="tsd-kind-icon">enable<wbr>Camera</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enablecustomaudioio" class="tsd-kind-icon">enable<wbr>Custom<wbr>AudioIO</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enablecustomvideoprocessing" class="tsd-kind-icon">enable<wbr>Custom<wbr>Video<wbr>Processing</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enableeffectsbeauty" class="tsd-kind-icon">enable<wbr>Effects<wbr>Beauty</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enableh265encodefallback" class="tsd-kind-icon">enable<wbr>H265<wbr>Encode<wbr>Fallback</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enablehardwaredecoder" class="tsd-kind-icon">enable<wbr>Hardware<wbr>Decoder</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enablehardwareencoder" class="tsd-kind-icon">enable<wbr>Hardware<wbr>Encoder</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enableheadphoneaec" class="tsd-kind-icon">enable<wbr>HeadphoneAEC</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enableheadphonemonitor" class="tsd-kind-icon">enable<wbr>Headphone<wbr>Monitor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enablepublishdirecttocdn" class="tsd-kind-icon">enable<wbr>Publish<wbr>Direct<wbr>ToCDN</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#enablevideoobjectsegmentation" class="tsd-kind-icon">enable<wbr>Video<wbr>Object<wbr>Segmentation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#getaudioconfig" class="tsd-kind-icon">get<wbr>Audio<wbr>Config</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#getaudioroutetype" class="tsd-kind-icon">get<wbr>Audio<wbr>Route<wbr>Type</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#getnetworktimeinfo" class="tsd-kind-icon">get<wbr>Network<wbr>Time<wbr>Info</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#getvideoconfig" class="tsd-kind-icon">get<wbr>Video<wbr>Config</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#ismicrophonemuted" class="tsd-kind-icon">is<wbr>Microphone<wbr>Muted</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#isspeakermuted" class="tsd-kind-icon">is<wbr>Speaker<wbr>Muted</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#isvideodecodersupported" class="tsd-kind-icon">is<wbr>Video<wbr>Decoder<wbr>Supported</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#isvideoencodersupported" class="tsd-kind-icon">is<wbr>Video<wbr>Encoder<wbr>Supported</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#loginroom" class="tsd-kind-icon">login<wbr>Room</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#logoutroom" class="tsd-kind-icon">logout<wbr>Room</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#muteallplaystreamaudio" class="tsd-kind-icon">mute<wbr>All<wbr>Play<wbr>Stream<wbr>Audio</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#muteallplaystreamvideo" class="tsd-kind-icon">mute<wbr>All<wbr>Play<wbr>Stream<wbr>Video</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#mutemicrophone" class="tsd-kind-icon">mute<wbr>Microphone</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#muteplaystreamaudio" class="tsd-kind-icon">mute<wbr>Play<wbr>Stream<wbr>Audio</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#muteplaystreamvideo" class="tsd-kind-icon">mute<wbr>Play<wbr>Stream<wbr>Video</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#mutepublishstreamaudio" class="tsd-kind-icon">mute<wbr>Publish<wbr>Stream<wbr>Audio</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#mutepublishstreamvideo" class="tsd-kind-icon">mute<wbr>Publish<wbr>Stream<wbr>Video</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#mutespeaker" class="tsd-kind-icon">mute<wbr>Speaker</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#off" class="tsd-kind-icon">off</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#on" class="tsd-kind-icon">on</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#removepublishcdnurl" class="tsd-kind-icon">remove<wbr>Publish<wbr>Cdn<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#renewtoken" class="tsd-kind-icon">renew<wbr>Token</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#sendbarragemessage" class="tsd-kind-icon">send<wbr>Barrage<wbr>Message</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#sendbroadcastmessage" class="tsd-kind-icon">send<wbr>Broadcast<wbr>Message</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#sendcustomcommand" class="tsd-kind-icon">send<wbr>Custom<wbr>Command</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#sendsei" class="tsd-kind-icon">sendSEI</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setaecmode" class="tsd-kind-icon">setAECMode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setansmode" class="tsd-kind-icon">setANSMode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setallplaystreamvolume" class="tsd-kind-icon">set<wbr>All<wbr>Play<wbr>Stream<wbr>Volume</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setapporientation" class="tsd-kind-icon">set<wbr>App<wbr>Orientation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setaudioconfig" class="tsd-kind-icon">set<wbr>Audio<wbr>Config</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setaudioequalizergain" class="tsd-kind-icon">set<wbr>Audio<wbr>Equalizer<wbr>Gain</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setaudioroutetospeaker" class="tsd-kind-icon">set<wbr>Audio<wbr>Route<wbr>ToSpeaker</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setaudiosource" class="tsd-kind-icon">set<wbr>Audio<wbr>Source</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setbeautifyoption" class="tsd-kind-icon">set<wbr>Beautify<wbr>Option</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setcapturevolume" class="tsd-kind-icon">set<wbr>Capture<wbr>Volume</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#seteffectsbeautyparam" class="tsd-kind-icon">set<wbr>Effects<wbr>Beauty<wbr>Param</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setelectroniceffects" class="tsd-kind-icon">set<wbr>Electronic<wbr>Effects</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setplaystreamvideotype" class="tsd-kind-icon">set<wbr>Play<wbr>Stream<wbr>Video<wbr>Type</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setplayvolume" class="tsd-kind-icon">set<wbr>Play<wbr>Volume</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setreverbadvancedparam" class="tsd-kind-icon">set<wbr>Reverb<wbr>Advanced<wbr>Param</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setreverbechoparam" class="tsd-kind-icon">set<wbr>Reverb<wbr>Echo<wbr>Param</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setreverbpreset" class="tsd-kind-icon">set<wbr>Reverb<wbr>Preset</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setroomextrainfo" class="tsd-kind-icon">set<wbr>Room<wbr>Extra<wbr>Info</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setstreamextrainfo" class="tsd-kind-icon">set<wbr>Stream<wbr>Extra<wbr>Info</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setvideoconfig" class="tsd-kind-icon">set<wbr>Video<wbr>Config</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setvideomirrormode" class="tsd-kind-icon">set<wbr>Video<wbr>Mirror<wbr>Mode</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setvideosource" class="tsd-kind-icon">set<wbr>Video<wbr>Source</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setvoicechangerparam" class="tsd-kind-icon">set<wbr>Voice<wbr>Changer<wbr>Param</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setvoicechangerpreset" class="tsd-kind-icon">set<wbr>Voice<wbr>Changer<wbr>Preset</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#starteffectsenv" class="tsd-kind-icon">start<wbr>Effects<wbr>Env</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#startmixertask" class="tsd-kind-icon">start<wbr>Mixer<wbr>Task</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#startnetworkspeedtest" class="tsd-kind-icon">start<wbr>Network<wbr>Speed<wbr>Test</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#startplayingstream" class="tsd-kind-icon">start<wbr>Playing<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#startpreview" class="tsd-kind-icon">start<wbr>Preview</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#startpublishingstream" class="tsd-kind-icon">start<wbr>Publishing<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#startrecordingcaptureddata" class="tsd-kind-icon">start<wbr>Recording<wbr>Captured<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#startscreencapture" class="tsd-kind-icon">start<wbr>Screen<wbr>Capture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#startscreencaptureinapp" class="tsd-kind-icon">start<wbr>Screen<wbr>Capture<wbr>InApp</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#startsoundlevelmonitor" class="tsd-kind-icon">start<wbr>Sound<wbr>Level<wbr>Monitor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#stopeffectsenv" class="tsd-kind-icon">stop<wbr>Effects<wbr>Env</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#stopmixertask" class="tsd-kind-icon">stop<wbr>Mixer<wbr>Task</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#stopnetworkspeedtest" class="tsd-kind-icon">stop<wbr>Network<wbr>Speed<wbr>Test</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#stopplayingstream" class="tsd-kind-icon">stop<wbr>Playing<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#stoppreview" class="tsd-kind-icon">stop<wbr>Preview</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#stoppublishingstream" class="tsd-kind-icon">stop<wbr>Publishing<wbr>Stream</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#stoprecordingcaptureddata" class="tsd-kind-icon">stop<wbr>Recording<wbr>Captured<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#stopscreencapture" class="tsd-kind-icon">stop<wbr>Screen<wbr>Capture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#stopsoundlevelmonitor" class="tsd-kind-icon">stop<wbr>Sound<wbr>Level<wbr>Monitor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#switchroom" class="tsd-kind-icon">switch<wbr>Room</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#takeplaystreamsnapshot" class="tsd-kind-icon">take<wbr>Play<wbr>Stream<wbr>Snapshot</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#takepublishstreamsnapshot" class="tsd-kind-icon">take<wbr>Publish<wbr>Stream<wbr>Snapshot</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#updatescreencaptureconfig" class="tsd-kind-icon">update<wbr>Screen<wbr>Capture<wbr>Config</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#uploadlog" class="tsd-kind-icon">upload<wbr>Log</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#usefrontcamera" class="tsd-kind-icon">use<wbr>Front<wbr>Camera</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#createengine" class="tsd-kind-icon">create<wbr>Engine</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#createenginewithprofile" class="tsd-kind-icon">create<wbr>Engine<wbr>With<wbr>Profile</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#destroyengine" class="tsd-kind-icon">destroy<wbr>Engine</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#getversion" class="tsd-kind-icon">get<wbr>Version</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#instance" class="tsd-kind-icon">instance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setengineconfig" class="tsd-kind-icon">set<wbr>Engine<wbr>Config</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static tsd-is-external"><a href="_zegoexpressengine_.zegoexpressengine.html#setroommode" class="tsd-kind-icon">set<wbr>Room<wbr>Mode</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="addpublishcdnurl" class="tsd-anchor"></a>
<h3>add<wbr>Publish<wbr>Cdn<wbr>Url</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">add<wbr>Publish<wbr>Cdn<wbr>Url<span class="tsd-signature-symbol">(</span>streamID<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, targetURL<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_zegoexpressdefines_.zegopublisherupdatecdnurlresult.html" class="tsd-signature-type">ZegoPublisherUpdateCdnUrlResult</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEngine.ts:581</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds a target CDN URL to which the stream will be relayed from ZEGO RTC server.</p>
</div>
<p>Available since: 1.1.0
Description: Forward audio and video streams from ZEGO RTC servers to custom CDN content distribution networks with high latency but support for high concurrent pull streams.
Use cases: 1. It is often used in large-scale live broadcast scenes that do not have particularly high requirements for delay. 2. Since ZEGO RTC server itself can be configured to support CDN(content distribution networks), this function is mainly used by developers who have CDN content distribution services themselves. 3. This function supports dynamic relay to the CDN content distribution network, so developers can use this function as a disaster recovery solution for CDN content distribution services.
When to call: After calling the [createEngine] function to create the engine.
Restrictions: When the [enablePublishDirectToCDN] function is set to true to publish the stream straight to the CDN, then calling this function will have no effect.
Caution: Removing URLs retweeted to CDN requires calling [removePublishCdnUrl], calling [stopPublishingStream] will not remove URLs publish to CDN.
Related APIs: Remove URLs that are re-pushed to the CDN [removePublishCdnUrl].</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>streamID: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Stream ID.</p>
</div>
</li>
<li>
<h5>targetURL: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>CDN relay address, supported address format is rtmp, rtmps.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_zegoexpressdefines_.zegopublisherupdatecdnurlresult.html" class="tsd-signature-type">ZegoPublisherUpdateCdnUrlResult</a><span class="tsd-signature-symbol">></span></h4>
<p>The execution result of update the relay CDN operation.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="callexperimentalapi" class="tsd-anchor"></a>
<h3>call<wbr>ExperimentalAPI</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">call<wbr>ExperimentalAPI<span class="tsd-signature-symbol">(</span>params<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEngine.ts:109</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Call the experimental API.</p>
</div>
<p>Available since: 2.7.0
Description: ZEGO provides some technical previews or special customization functions in RTC business through this API. If you need to get the use of the function or the details, please consult ZEGO technical support.
When to call: After [createEngine].</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>params: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Parameters in the format of a JSON string, please consult ZEGO technical support for details.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
<p>Returns an argument in the format of a JSON string, please consult ZEGO technical support for details.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="createaudioeffectplayer" class="tsd-anchor"></a>
<h3>create<wbr>Audio<wbr>Effect<wbr>Player</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">create<wbr>Audio<wbr>Effect<wbr>Player<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_zegoexpressdefines_.zegoaudioeffectplayer.html" class="tsd-signature-type">ZegoAudioEffectPlayer</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEngine.ts:1655</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a audio effect player instance.</p>
</div>
<p>Available since: 1.16.0
Description: Creates a audio effect player instance.
Use cases: When you need to play short sound effects, such as applause, cheers, etc., you can use audioEffectPlayer to achieve.
When to call: It can be called after [createEngine].
Restrictions: Currently, a maximum of 1 instances can be created, after which it will return null.
Related APIs: [destroyAudioEffectPlayer].</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_zegoexpressdefines_.zegoaudioeffectplayer.html" class="tsd-signature-type">ZegoAudioEffectPlayer</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h4>
<p>audio effect player instance, null will be returned when the maximum number is exceeded.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="createmediaplayer" class="tsd-anchor"></a>
<h3>create<wbr>Media<wbr>Player</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">create<wbr>Media<wbr>Player<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEngine.ts:1626</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a media player instance.</p>
</div>
<p>Available since: 2.1.0
Description: Creates a media player instance.
Use case: It is often used to play media resource scenes, For example, play video files, push the video of media resources in combination with custom video acquisition, and the remote end can pull the stream for viewing.
When to call: It can be called after the SDK by [createEngine] has been initialized.
Restrictions: Currently, a maximum of 4 instances can be created, after which it will return null.
Caution: The more instances of a media player, the greater the performance overhead on the device.
Related APIs: User can call [destroyMediaPlayer] function to destroy a media player instance.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h4>
<p>Media player instance, null will be returned when the maximum number is exceeded.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="destroyaudioeffectplayer" class="tsd-anchor"></a>
<h3>destroy<wbr>Audio<wbr>Effect<wbr>Player</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">destroy<wbr>Audio<wbr>Effect<wbr>Player<span class="tsd-signature-symbol">(</span>audioEffectPlayer<span class="tsd-signature-symbol">: </span><a href="_zegoexpressdefines_.zegoaudioeffectplayer.html" class="tsd-signature-type">ZegoAudioEffectPlayer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEngine.ts:1670</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Destroys a audio effect player instance.</p>
</div>
<p>Available since: 1.16.0
Description: Destroys the specified audio effect player instance.
When to call: It can be called after [createAudioEffectPlayer].
Restrictions: None.
Related APIs: [createAudioEffectPlayer].</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>audioEffectPlayer: <a href="_zegoexpressdefines_.zegoaudioeffectplayer.html" class="tsd-signature-type">ZegoAudioEffectPlayer</a></h5>
<div class="tsd-comment tsd-typography">
<p>The audio effect player instance object to be destroyed.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="destroymediaplayer" class="tsd-anchor"></a>
<h3>destroy<wbr>Media<wbr>Player</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">destroy<wbr>Media<wbr>Player<span class="tsd-signature-symbol">(</span>mediaPlayer<span class="tsd-signature-symbol">: </span><a href="_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEngine.ts:1639</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Destroys a media player instance.</p>
</div>
<p>Available since: 2.1.0
Description: Destroys a media player instance.
Related APIs: User can call [createMediaPlayer] function to create a media player instance.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mediaPlayer: <a href="_zegoexpressdefines_.zegomediaplayer.html" class="tsd-signature-type">ZegoMediaPlayer</a></h5>
<div class="tsd-comment tsd-typography">
<p>The media player instance object to be destroyed.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="enableaec" class="tsd-anchor"></a>
<h3>enableAEC</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">enableAEC<span class="tsd-signature-symbol">(</span>enable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEngine.ts:1248</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Whether to enable acoustic echo cancellation (AEC).</p>
</div>
<p>Available since: 1.1.0
Description: Turning on echo cancellation, the SDK filters the collected audio data to reduce the echo component in the audio.
Use case: When you need to reduce the echo to improve the call quality and user experience, you can turn on this feature.
When to call: It needs to be called after [createEngine], before [startPublishingStream], [startPlayingStream], [startPreview], [createMediaPlayer], [createAudioEffectPlayer] and [createRealTimeSequentialDataManager].
Caution: The AEC function only supports the processing of sounds playbacked through the SDK, such as sounds played by the playing stream, media player, audio effect player, etc. Before this function is called, the SDK automatically determines whether to use AEC. Once this function is called, the SDK does not automatically determine whether to use AEC.
Restrictions: None.
Related APIs: Developers can use [enableHeadphoneAEC] to set whether to enable AEC when using headphones, and use [setAECMode] to set the echo cancellation mode.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>enable: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>Whether to enable echo cancellation, true: enable, false: disable</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="enableagc" class="tsd-anchor"></a>
<h3>enableAGC</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">enableAGC<span class="tsd-signature-symbol">(</span>enable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEngine.ts:1299</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enables or disables automatic gain control (AGC).</p>
</div>
<p>Available since: 1.1.0
Description: After turning on this function, the SDK can automatically adjust the microphone volume to adapt to near and far sound pickups and keep the volume stable.
Use case: When you need to ensure volume stability to improve call quality and user experience, you can turn on this feature.
When to call: It needs to be called after [createEngine] and before [startPublishingStream], [startPlayingStream], [startPreview], [createMediaPlayer], [createAudioEffectPlayer] and [createRealTimeSequentialDataManager]. Note that the Mac needs to be called after [startPreview] and before [startPublishingStream].
Caution: Before this function is called, the SDK automatically determines whether to use AGC. Once this function is called, the SDK does not automatically determine whether to use AGC.
Restrictions: None.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>enable: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>Whether to enable automatic gain control, true: enable, false: disable</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="enableans" class="tsd-anchor"></a>
<h3>enableANS</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">enableANS<span class="tsd-signature-symbol">(</span>enable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEngine.ts:1316</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enables or disables active noise suppression (ANS, aka ANC).</p>
</div>
<p>Available since: 1.1.0
Description: Enable the noise suppression can reduce the noise in the audio data and make the human voice clearer.
Use case: When you need to suppress noise to improve call quality and user experience, you can turn on this feature.
When to call: It needs to be called after [createEngine], before [startPublishingStream], [startPlayingStream], [startPreview], [createMediaPlayer], [createAudioEffectPlayer] and [createRealTimeSequentialDataManager].
Related APIs: This function has a better suppression effect on continuous noise (such as the sound of rain, white noise). If you need to turn on transient noise suppression, please use [enableTransientANS]. And the noise suppression mode can be set by [setANSMode].
Caution: Before this function is called, the SDK automatically determines whether to use ANS. Once this function is called, the SDK does not automatically determine whether to use ANS.
Restrictions: None.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>enable: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>Whether to enable noise suppression, true: enable, false: disable</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
<a name="enablealphachannelvideoencoder" class="tsd-anchor"></a>
<h3>enable<wbr>Alpha<wbr>Channel<wbr>Video<wbr>Encoder</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">enable<wbr>Alpha<wbr>Channel<wbr>Video<wbr>Encoder<span class="tsd-signature-symbol">(</span>enable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, alphaLayout<span class="tsd-signature-symbol">: </span><a href="../enums/_zegoexpressdefines_.zegoalphalayouttype.html" class="tsd-signature-type">ZegoAlphaLayoutType</a>, channel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/_zegoexpressdefines_.zegopublishchannel.html" class="tsd-signature-type">ZegoPublishChannel</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in ZegoExpressEngine.ts:783</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enable video encoder alpha channel support.</p>
</div>
<p>Available since: 3.4.0
Description: Enable the alpha channel support of the video encoder on the stream publishing end, and encode the split video body for streaming.
Use cases: Scenes where the object in the video needs to be separated from the background, such as mixed reality, multi-person interaction scenes, and so on.
When to