AudioEffectDelay — C# API

Adds a delay audio effect to an audio bus. Emulates an echo by playing the input audio back after a period of time.

class AudioEffectDelayReckfellSharpInherits AudioEffect

Adds a delay audio effect to an audio bus. Emulates an echo by playing the input audio back after a period of time.

A "delay" effect plays the input audio signal back after a period of time. Each repetition is called a "delay tap" or simply "tap". Delay taps may be played back multiple times to create the sound of a repeating, decaying echo. Delay effects range from a subtle echo to a pronounced blending of previous sounds with new sounds. See also AudioEffectReverb for a blurry, continuous echo.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AudioEffectDelayConstructor

# AudioEffectDelay

C#
public AudioEffectDelay();

Properties13

DryProperty

# Dry

C#
public float Dry { get; set; }

The volume ratio of the original audio. Value can range from 0 to 1.

FeedbackActiveProperty

# FeedbackActive

C#
public bool FeedbackActive { get; set; }

If true, feedback is enabled, repeating taps after they are played.

FeedbackDelayMsProperty

# FeedbackDelayMs

C#
public float FeedbackDelayMs { get; set; }

Feedback delay time in milliseconds. Value can range from 0 to 1500.

FeedbackLevelDbProperty

# FeedbackLevelDb

C#
public float FeedbackLevelDb { get; set; }

Gain for feedback, in dB. Value can range from -60 to 0.

FeedbackLowpassProperty

# FeedbackLowpass

C#
public float FeedbackLowpass { get; set; }

Low-pass filter for feedback, in Hz. Frequencies above this value are filtered out. Value can range from 1 to 16000.

Tap1ActiveProperty

# Tap1Active

C#
public bool Tap1Active { get; set; }

If true, the first tap will be enabled.

Tap1DelayMsProperty

# Tap1DelayMs

C#
public float Tap1DelayMs { get; set; }

First tap delay time in milliseconds, compared to the original audio. Value can range from 0 to 1500.

Tap1LevelDbProperty

# Tap1LevelDb

C#
public float Tap1LevelDb { get; set; }

Gain for the first tap, in dB. Value can range from -60 to 0.

Tap1PanProperty

# Tap1Pan

C#
public float Tap1Pan { get; set; }

Pan position for the first tap. Negative values pan the sound to the left, positive pan to the right. Value can range from -1 to 1.

Tap2ActiveProperty

# Tap2Active

C#
public bool Tap2Active { get; set; }

If true, the second tap will be enabled.

Tap2DelayMsProperty

# Tap2DelayMs

C#
public float Tap2DelayMs { get; set; }

Second tap delay time in milliseconds, compared to the original audio. Value can range from 0 to 1500.

Tap2LevelDbProperty

# Tap2LevelDb

C#
public float Tap2LevelDb { get; set; }

Gain for the second tap, in dB. Value can range from -60 to 0.

Tap2PanProperty

# Tap2Pan

C#
public float Tap2Pan { get; set; }

Pan position for the second tap. Negative values pan the sound to the left, positive pan to the right. Value can range from -1 to 1.

Methods26

GetDryfloat

# GetDry

C#
public float GetDry();

Returns float

GetFeedbackDelayMsfloat

# GetFeedbackDelayMs

C#
public float GetFeedbackDelayMs();

Returns float

GetFeedbackLevelDbfloat

# GetFeedbackLevelDb

C#
public float GetFeedbackLevelDb();

Returns float

GetFeedbackLowpassfloat

# GetFeedbackLowpass

C#
public float GetFeedbackLowpass();

Returns float

GetTap1DelayMsfloat

# GetTap1DelayMs

C#
public float GetTap1DelayMs();

Returns float

GetTap1LevelDbfloat

# GetTap1LevelDb

C#
public float GetTap1LevelDb();

Returns float

GetTap1Panfloat

# GetTap1Pan

C#
public float GetTap1Pan();

Returns float

GetTap2DelayMsfloat

# GetTap2DelayMs

C#
public float GetTap2DelayMs();

Returns float

GetTap2LevelDbfloat

# GetTap2LevelDb

C#
public float GetTap2LevelDb();

Returns float

GetTap2Panfloat

# GetTap2Pan

C#
public float GetTap2Pan();

Returns float

IsFeedbackActivebool

# IsFeedbackActive

C#
public bool IsFeedbackActive();

Returns bool

IsTap1Activebool

# IsTap1Active

C#
public bool IsTap1Active();

Returns bool

IsTap2Activebool

# IsTap2Active

C#
public bool IsTap2Active();

Returns bool

SetDryvoid

# SetDry

C#
public void SetDry(float amount);

Parameters
Name	Type	Default
`amount`	`float`	—

SetFeedbackActivevoid

# SetFeedbackActive

C#
public void SetFeedbackActive(bool amount);

Parameters
Name	Type	Default
`amount`	`bool`	—

SetFeedbackDelayMsvoid

# SetFeedbackDelayMs

C#
public void SetFeedbackDelayMs(float amount);

Parameters
Name	Type	Default
`amount`	`float`	—

SetFeedbackLevelDbvoid

# SetFeedbackLevelDb

C#
public void SetFeedbackLevelDb(float amount);

Parameters
Name	Type	Default
`amount`	`float`	—

SetFeedbackLowpassvoid

# SetFeedbackLowpass

C#
public void SetFeedbackLowpass(float amount);

Parameters
Name	Type	Default
`amount`	`float`	—

SetTap1Activevoid

# SetTap1Active

C#
public void SetTap1Active(bool amount);

Parameters
Name	Type	Default
`amount`	`bool`	—

SetTap1DelayMsvoid

# SetTap1DelayMs

C#
public void SetTap1DelayMs(float amount);

Parameters
Name	Type	Default
`amount`	`float`	—

SetTap1LevelDbvoid

# SetTap1LevelDb

C#
public void SetTap1LevelDb(float amount);

Parameters
Name	Type	Default
`amount`	`float`	—

SetTap1Panvoid

# SetTap1Pan

C#
public void SetTap1Pan(float amount);

Parameters
Name	Type	Default
`amount`	`float`	—

SetTap2Activevoid

# SetTap2Active

C#
public void SetTap2Active(bool amount);

Parameters
Name	Type	Default
`amount`	`bool`	—

SetTap2DelayMsvoid

# SetTap2DelayMs

C#
public void SetTap2DelayMs(float amount);

Parameters
Name	Type	Default
`amount`	`float`	—

SetTap2LevelDbvoid

# SetTap2LevelDb

C#
public void SetTap2LevelDb(float amount);

Parameters
Name	Type	Default
`amount`	`float`	—

SetTap2Panvoid

# SetTap2Pan

C#
public void SetTap2Pan(float amount);

Parameters
Name	Type	Default
`amount`	`float`	—