Table of Contents

Class AudioEffectChorus

Namespace
Godot
Assembly
GodotSharp.dll

Adds a chorus audio effect. The effect applies a filter with voices to duplicate the audio source and manipulate it through the filter.

public class AudioEffectChorus : AudioEffect, IDisposable
Inheritance
AudioEffectChorus
Implements
Inherited Members

Constructors

AudioEffectChorus() 

public AudioEffectChorus()

Properties

Dry

The effect's raw signal.

public float Dry { get; set; }

Property Value

float

VoiceCount

The number of voices in the effect.

public int VoiceCount { get; set; }

Property Value

int

Wet

The effect's processed signal.

public float Wet { get; set; }

Property Value

float

Methods

GetVoiceCutoffHz(int) 

public float GetVoiceCutoffHz(int voiceIdx)

Parameters

voiceIdx int

Returns

float

GetVoiceDelayMs(int) 

public float GetVoiceDelayMs(int voiceIdx)

Parameters

voiceIdx int

Returns

float

GetVoiceDepthMs(int) 

public float GetVoiceDepthMs(int voiceIdx)

Parameters

voiceIdx int

Returns

float

GetVoiceLevelDb(int) 

public float GetVoiceLevelDb(int voiceIdx)

Parameters

voiceIdx int

Returns

float

GetVoicePan(int) 

public float GetVoicePan(int voiceIdx)

Parameters

voiceIdx int

Returns

float

GetVoiceRateHz(int) 

public float GetVoiceRateHz(int voiceIdx)

Parameters

voiceIdx int

Returns

float

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

SetVoiceCutoffHz(int, float) 

public void SetVoiceCutoffHz(int voiceIdx, float cutoffHz)

Parameters

voiceIdx int
cutoffHz float

SetVoiceDelayMs(int, float) 

public void SetVoiceDelayMs(int voiceIdx, float delayMs)

Parameters

voiceIdx int
delayMs float

SetVoiceDepthMs(int, float) 

public void SetVoiceDepthMs(int voiceIdx, float depthMs)

Parameters

voiceIdx int
depthMs float

SetVoiceLevelDb(int, float) 

public void SetVoiceLevelDb(int voiceIdx, float levelDb)

Parameters

voiceIdx int
levelDb float

SetVoicePan(int, float) 

public void SetVoicePan(int voiceIdx, float pan)

Parameters

voiceIdx int
pan float

SetVoiceRateHz(int, float) 

public void SetVoiceRateHz(int voiceIdx, float rateHz)

Parameters

voiceIdx int
rateHz float
Edit this page