Open Asterune
ChorusSoundEffect

ChorusSoundEffect

Mixes delayed, modulated copies of an audio signal.

Creatable
Instance.new("ChorusSoundEffect")
Inherits
SoundEffectInstance
Replication
Standard

Behavior

ChorusSoundEffect mixes delayed, modulated copies of an audio signal.

Summary

Members6
Properties5
  • Depth: number = 0.5parallel read

    The modulation depth of the audio effect.

  • Enabled: boolean = trueparallel read

    Whether this effect processes the audio signal.

  • Mix: number = 0.5parallel read

    The blend between the dry and processed audio signal.

  • Priority: number = 0parallel read

    The relative priority used to order or process this object.

  • Rate: number = 0.5parallel read

    The modulation frequency of the effect.

Methods1

Properties

Depth

ChorusSoundEffect.Depth: number = 0.5

The modulation depth of the audio effect.

Enabled

ChorusSoundEffect.Enabled: boolean = true

Whether this effect processes the audio signal.

Mix

ChorusSoundEffect.Mix: number = 0.5

The blend between the dry and processed audio signal.

Priority

ChorusSoundEffect.Priority: number = 0

The relative priority used to order or process this object.

Rate

ChorusSoundEffect.Rate: number = 0.5

The modulation frequency of the effect.

Methods

GetExecutionGroup

ChorusSoundEffect:GetExecutionGroup(): ExecutionGroup?

Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.

Inherited members

Inherited47

SoundEffect