AudioChorus
CreatorHub

Makes an audio stream sound more voluminous. If applied to a single voice, it may sound like multiple voices.

Memory category	Internal

Member index 8

History		Member
628		Bypass: bool
592		Depth: float
592		Mix: float
592		Rate: float
648		GetConnectedWires(pin: string): Instances
660		GetInputPins(): Array
660		GetOutputPins(): Array
652		WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
67 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
670		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
702		PredictionMode: PredictionMode
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
670		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
680		UniqueId: UniqueId
553		archivable: bool
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(property: string)

Description

AudioChorus makes an audio stream sound more voluminous. It provides one Input pin and one Output pin which can be connected to/from by Wires.

AudioChorus is implemented by duplicating the input stream and modulating the pitch of several delayed copies so that the overall result sounds like a cloud of streams. If applied to a single voice, it may sound like multiple voices.

History 18
Hide member changes

660 Add GetOutputPins
660 Add GetInputPins
652 Add WiringChanged
648 Change ReturnType of GetConnectedWires from Objects to Instances
643 Change Tags of AudioChorus from [NotBrowsable] to []
637 Change ReturnType of GetConnectedWires from Array to Objects
628 Add Bypass
618 Change Security of GetConnectedWires from PluginSecurity to None
607 Change Security of GetConnectedWires from RobloxScriptSecurity to PluginSecurity
597 Change MemoryCategory of AudioChorus from Instances to Internal
593 Add GetConnectedWires
592 Change Category of Rate from Data to State
592 Change Category of Mix from Data to State
592 Change Category of Depth from Data to State
588 Add Rate
588 Add Mix
588 Add Depth
588 Add AudioChorus

Members 8

Bypass
CreatorHub

Type		Default
bool		false

If true, audio streams are passed-through unaffected by this effect.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 1

628 Add Bypass

Depth
CreatorHub

Type		Default
float		0.449999988

Controls how strong the chorus effect is by changing the maximum delay time of the copy streams. Ranges from 0 to 1 which corresponds to 0 to 100 milliseconds of maximum delay.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of Depth from Data to State
588 Add Depth

GetConnectedWires
CreatorHub

Parameters (1)
pin	string
Returns (1)
Instances

Returns an array of Wires that are connected to the specified pin. AudioChorus has one "Input" pin and one "Output" pin.

Thread safety	Unsafe

History 5

648 Change ReturnType of GetConnectedWires from Objects to Instances
637 Change ReturnType of GetConnectedWires from Array to Objects
618 Change Security of GetConnectedWires from PluginSecurity to None
607 Change Security of GetConnectedWires from RobloxScriptSecurity to PluginSecurity
593 Add GetConnectedWires

GetInputPins
CreatorHub

Parameters (0)
No parameters.
Returns (1)
Array

Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.

For AudioChorus, this is Input only.

Thread safety	Unsafe

History 1

660 Add GetInputPins

GetOutputPins
CreatorHub

Parameters (0)
No parameters.
Returns (1)
Array

Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.

For AudioChorus, this is Output only.

Thread safety	Unsafe

History 1

660 Add GetOutputPins

Mix
CreatorHub

Type		Default
float		0.850000024

Controls the balance of plain input stream to modified output stream. Ranges from 0 to 1.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of Mix from Data to State
588 Add Mix

Rate
CreatorHub

Type		Default
float		5

Frequency controlling the rate of pitch modulations, in hertz. Ranges from 0 to 20.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of Rate from Data to State
588 Add Rate

WiringChanged
CreatorHub

Parameters (4)
connected	bool
pin	string
wire	Wire
instance	Instance

Event that fires after a Wire becomes connected or disconnected, and that Wire is now or was previously connected to a pin on the AudioChorus and to some other wirable instance.

Thread safety	Unsafe

History 1

652 Add WiringChanged

Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioChorus
CreatorHub

Member index 8

Description

History 18
Hide member changes

Members 8

Bypass
CreatorHub

History 1

Depth
CreatorHub

History 2

GetConnectedWires
CreatorHub

History 5

GetInputPins
CreatorHub

History 1

GetOutputPins
CreatorHub

History 1

Mix
CreatorHub

History 2

Rate
CreatorHub

History 2

WiringChanged
CreatorHub

History 1

Settings