AudioEffectChorus
Adds a chorus audio effect to an audio bus. Gives the impression of multiple audio sources.
Adds a chorus audio effect to an audio bus. Gives the impression of multiple audio sources.
A "chorus" effect creates multiple copies of the original audio (called "voices") with variations in pitch, and layers on top of the original, giving the impression that the sound comes from multiple sources. This creates spectral and spatial movement.
Each voice is played a short period of time after the original audio, controlled by delay. An internal low-frequency oscillator (LFO) controls their pitch, and depth controls the LFO's maximum amount.
In the real world, this kind of effect is found in pianos, choirs, and instrument ensembles.
This effect can also be used to widen mono audio and make digital sounds have a more natural or analog quality.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
AudioEffectChorusConstructor
public AudioEffectChorus();Properties3
DryProperty
public float Dry { get; set; }The volume ratio of the original audio. Value can range from 0 to 1.
VoiceCountProperty
public int VoiceCount { get; set; }The number of voices in the effect. Value can range from 1 to 4.
WetProperty
public float Wet { get; set; }The volume ratio of all voices. Value can range from 0 to 1.
Methods18
GetDryfloat
public float GetDry();floatGetVoiceCountint
public int GetVoiceCount();intGetVoiceCutoffHzfloat
public float GetVoiceCutoffHz(int voiceIdx);Returns the frequency threshold of a given voice_idx's low-pass filter in Hz. Frequencies above this value are removed from the voice.
| Name | Type | Default |
|---|---|---|
voiceIdx | int | — |
floatGetVoiceDelayMsfloat
public float GetVoiceDelayMs(int voiceIdx);Returns the delay of a given voice_idx in milliseconds, compared to the original audio.
| Name | Type | Default |
|---|---|---|
voiceIdx | int | — |
floatGetVoiceDepthMsfloat
public float GetVoiceDepthMs(int voiceIdx);Returns the depth of a given voice_idx's low-frequency oscillator in milliseconds.
| Name | Type | Default |
|---|---|---|
voiceIdx | int | — |
floatGetVoiceLevelDbfloat
public float GetVoiceLevelDb(int voiceIdx);Returns the gain of a given voice_idx in dB.
| Name | Type | Default |
|---|---|---|
voiceIdx | int | — |
floatGetVoicePanfloat
public float GetVoicePan(int voiceIdx);Returns the pan position of a given voice_idx. Negative values mean the left channel, positive mean the right.
| Name | Type | Default |
|---|---|---|
voiceIdx | int | — |
floatGetVoiceRateHzfloat
public float GetVoiceRateHz(int voiceIdx);Returns the rate of a given voice_idx's low-frequency oscillator in Hz.
| Name | Type | Default |
|---|---|---|
voiceIdx | int | — |
floatGetWetfloat
public float GetWet();floatSetDryvoid
public void SetDry(float amount);| Name | Type | Default |
|---|---|---|
amount | float | — |
SetVoiceCountvoid
public void SetVoiceCount(int voices);| Name | Type | Default |
|---|---|---|
voices | int | — |
SetVoiceCutoffHzvoid
public void SetVoiceCutoffHz(int voiceIdx, float cutoffHz);Sets the frequency threshold of a given voice_idx's low-pass filter in Hz. Frequencies above cutoff_hz are removed from voice_idx. Value can range from 1 to 20500.
| Name | Type | Default |
|---|---|---|
voiceIdx | int | — |
cutoffHz | float | — |
SetVoiceDelayMsvoid
public void SetVoiceDelayMs(int voiceIdx, float delayMs);Sets the delay of a given voice_idx in milliseconds, compared to the original audio. Value can range from 0 to 50.
| Name | Type | Default |
|---|---|---|
voiceIdx | int | — |
delayMs | float | — |
SetVoiceDepthMsvoid
public void SetVoiceDepthMs(int voiceIdx, float depthMs);Sets the depth of a given voice_idx's low-frequency oscillator in milliseconds. Value can range from 0 to 20.
| Name | Type | Default |
|---|---|---|
voiceIdx | int | — |
depthMs | float | — |
SetVoiceLevelDbvoid
public void SetVoiceLevelDb(int voiceIdx, float levelDb);Sets the gain of a given voice_idx in dB. Value can range from -60 to 24.
| Name | Type | Default |
|---|---|---|
voiceIdx | int | — |
levelDb | float | — |
SetVoicePanvoid
public void SetVoicePan(int voiceIdx, float pan);Sets the pan position of a given voice_idx. Negative values pan the sound to the left, positive pan to the right. Value can range from -1 to 1.
| Name | Type | Default |
|---|---|---|
voiceIdx | int | — |
pan | float | — |
SetVoiceRateHzvoid
public void SetVoiceRateHz(int voiceIdx, float rateHz);Sets the rate of a given voice_idx's low-frequency oscillator in Hz. Value can range from 0.1 to 20.
| Name | Type | Default |
|---|---|---|
voiceIdx | int | — |
rateHz | float | — |
SetWetvoid
public void SetWet(float amount);| Name | Type | Default |
|---|---|---|
amount | float | — |