<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>VoiceDecorator | react-native-agora</title>
<meta name="description" content="">
<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.js" 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">react-native-agora</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="voicedecorator.html">VoiceDecorator</a>
</li>
</ul>
<h1>Interface VoiceDecorator</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>VoiceDecorator is decorate local audio voice</p>
</div>
<dl class="tsd-comment-tags">
<dt>property</dt>
<dd><p>type: string | the range values ['changer' | 'reverbPreset'] This property is the identifier for audio voice decorator</p>
</dd>
<dt>property</dt>
<dd><p>value: number | the value for voice parameter option.
type 'reverbPreset' range values: [0 is "off", 1 is "popular", 2 is "rnb", 3 is "rock", 4 is "hiphop", 5 is "vocal concert", 6 is "KTV", 7 is "studio"]
type 'changer' range values: [0 is "off", 1 is "old man", 2 is "baby boy", 3 is "baby girl", 4 is "zhubajie", 5 is "ethereal", 6 is "hulk"]</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">VoiceDecorator</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 ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="voicedecorator.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="voicedecorator.html#value" class="tsd-kind-icon">value</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L54">types.ts:54</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="value" class="tsd-anchor"></a>
<h3>value</h3>
<div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/syanbo/react-native-agora/blob/f8359f2/src/types.ts#L55">types.ts:55</a></li>
</ul>
</aside>
</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>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="../classes/agoraview.html" class="tsd-kind-icon">Agora<wbr>View</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/rtcengine.html" class="tsd-kind-icon">Rtc<wbr>Engine</a>
</li>
<li class=" tsd-kind-interface">
<a href="agoraviewprops.html" class="tsd-kind-icon">Agora<wbr>View<wbr>Props</a>
</li>
<li class=" tsd-kind-interface">
<a href="audioframeoption.html" class="tsd-kind-icon">Audio<wbr>Frame<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="audiomixingoption.html" class="tsd-kind-icon">Audio<wbr>Mixing<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="audiorecordingoption.html" class="tsd-kind-icon">Audio<wbr>Recording<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="backgroundimage.html" class="tsd-kind-icon">Background<wbr>Image</a>
</li>
<li class=" tsd-kind-interface">
<a href="beautyoption.html" class="tsd-kind-icon">Beauty<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="cameracapturerconfiguration.html" class="tsd-kind-icon">Camera<wbr>Capturer<wbr>Configuration</a>
</li>
<li class=" tsd-kind-interface">
<a href="color.html" class="tsd-kind-icon">Color</a>
</li>
<li class=" tsd-kind-interface">
<a href="datastreamoption.html" class="tsd-kind-icon">Data<wbr>Stream<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="defaultvideostreamoption.html" class="tsd-kind-icon">Default<wbr>Video<wbr>Stream<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="imageoption.html" class="tsd-kind-icon">Image<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="injectstreamoption.html" class="tsd-kind-icon">Inject<wbr>Stream<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="lastmileprobeconfig.html" class="tsd-kind-icon">Lastmile<wbr>Probe<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="livetranscodingoption.html" class="tsd-kind-icon">Live<wbr>Transcoding<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="mixedaudioframeoption.html" class="tsd-kind-icon">Mixed<wbr>Audio<wbr>Frame<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="option.html" class="tsd-kind-icon">Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="playeffectoption.html" class="tsd-kind-icon">Play<wbr>Effect<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="positionoption.html" class="tsd-kind-icon">Position<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="publishstreamoption.html" class="tsd-kind-icon">Publish<wbr>Stream<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="publisherconfig.html" class="tsd-kind-icon">Publisher<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="rect.html" class="tsd-kind-icon">Rect</a>
</li>
<li class=" tsd-kind-interface">
<a href="removeinjectstreamoption.html" class="tsd-kind-icon">Remove<wbr>Inject<wbr>Stream<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="removepublishstreamoption.html" class="tsd-kind-icon">Remove<wbr>Publish<wbr>Stream<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="size.html" class="tsd-kind-icon">Size</a>
</li>
<li class=" tsd-kind-interface">
<a href="transcodinguser.html" class="tsd-kind-icon">Transcoding<wbr>User</a>
</li>
<li class=" tsd-kind-interface">
<a href="videoencoderconfig.html" class="tsd-kind-icon">Video<wbr>Encoder<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="videooption.html" class="tsd-kind-icon">Video<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="videostreamoption.html" class="tsd-kind-icon">Video<wbr>Stream<wbr>Option</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="voicedecorator.html" class="tsd-kind-icon">Voice<wbr>Decorator</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="voicedecorator.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="voicedecorator.html#value" class="tsd-kind-icon">value</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../globals.html#callback" class="tsd-kind-icon">Callback</a>
</li>
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
<a href="../globals.html#nullable" class="tsd-kind-icon">Nullable</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#number" class="tsd-kind-icon">Number</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#string" class="tsd-kind-icon">String</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../globals.html#agora" class="tsd-kind-icon">Agora</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../globals.html#agoraeventemitter" class="tsd-kind-icon">Agora<wbr>Event<wbr>Emitter</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="../globals.html#rctagoraview" class="tsd-kind-icon">RCTAgora<wbr>View</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>