Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioFlanger

Imparts a whooshing or sweeping sound on audio streams.

Member index 8

HistoryMember
726Bypass: bool
726Depth: float
726Mix: float
726Rate: float
648GetConnectedWires(pin: string): Instances
660GetInputPins(): Array
660GetOutputPins(): Array
652WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: 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
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(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 22

Members 8

Bypass

TypeDefault
bool

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

History 2

Depth

TypeDefault
float

Controls how strong the pitch modulation of the flanger is. Ranges from 0.01 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 3

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

GetInputPins

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 AudioFlanger, this is Input only.

History 1

GetOutputPins

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 AudioFlanger, this is Output only.

History 1

Mix

TypeDefault
float

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

History 3

  • 726 Change Default of Mix from 0.850000024 to
  • 592 Change Category of Mix from Data to State
  • 588 Add Mix

Rate

TypeDefault
float

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

History 3

WiringChanged

Parameters (4)
connectedbool
pinstring
wireWire
instanceInstance

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

History 1

Settings