Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioFlanger

Imparts a whooshing or sweeping sound on audio streams.

Member index 6

HistoryMember
628Bypass: bool
592Depth: float
592Mix: float
592Rate: float
648GetConnectedWires(pin: string): Instances
652WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

AudioFlanger imparts a whooshing or sweeping sound on audio streams by overlaying a delayed copy of the input stream and modulating the pitch of the copy. It provides one Input pin and one Output pin which can be connected to/from by Wires.

History 16

Members 6

Bypass

TypeDefault
boolfalse

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

History 1

Depth

TypeDefault
float0.449999988

Controls how strong the pitch modulation of the flanger is. Ranges from 0 to 1 which determines the maximum delay time of the modulated signal. A value of 1 corresponds to 10 milliseconds of maximum delay; beyond this, the modulated signal would begin to sound more like an echo than a flange.

History 2

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances

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

History 5

Mix

TypeDefault
float0.850000024

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

History 2

Rate

TypeDefault
float5

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

History 2

WiringChanged

Parameters (4)
connectedbool
pinstring
wireWire
instanceInstance

History 1

Settings