Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioChannelSplitter

Splits an audio stream into component channels so that each can be processed independently.

Memory categoryInternal

Member index 5

HistoryMember
660Layout: AudioChannelLayout
660GetConnectedWires(pin: string): Instances
662GetInputPins(): Array
662GetOutputPins(): Array
660WiringChanged(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
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: 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()
657StyledPropertiesChanged()
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

AudioChannelSplitter splits an audio stream into component channels so that each can be processed independently. It provides one Input pin, one combined Output pin, as well as the following secondary output pins, all of which can be connected to/from by Wires: Left, Right, Center, SurroundLeft, SurroundRight, Sub, BackLeft, BackRight, TopLeft, TopRight, TopBackLeft, and TopBackRight.

Diagram showing position of all potential channels.

History 7

Members 5

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances

Returns an array of Wires that are connected to the specified pin.

Thread safetyUnsafe

History 1

GetInputPins

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

Returns a table containing one string, "Input", indicating the input pin available for Wire.TargetName.

Thread safetyUnsafe

History 1

GetOutputPins

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

Returns a table of strings indicating which output pins are available for Wire.SourceName:

  • "Output"
  • "Left"
  • "Right"
  • "Center"
  • "SurroundLeft"
  • "SurroundRight"
  • "BackLeft"
  • "BackRight"
  • "Sub"
  • "TopLeft"
  • "TopRight"
  • "TopBackLeft"
  • "TopBackRight"
Thread safetyUnsafe

History 1

Layout

TypeDefault
AudioChannelLayoutStereo

Controls the input channel layout to be split from. When changed, all audio streams prior to this channel splitter's input may need to be up-mixed (widened to at least as many channels as the input requires).

The Output pin produces a copy of the stream wired to Input but, depending on the value of AudioChannelSplitter.Layout:

  • For Mono, the Center pin produces an audio stream.
  • For Stereo, the Left and Right pins produce audio streams.
  • For Quad, the Left, Right, BackLeft, and BackRight pins produce audio streams.
  • Surround_5 is the same as Quad, plus Center produces an audio stream.
  • Surround_5_1 is the same as Surround_5, plus Sub produces an audio stream.
  • Surround_7_1 is the same as Surround_5_1, plus SurroundLeft and SurroundRight produce audio streams.
  • For Surround_7_1_4, all secondary output pins produce audio streams.
Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 1

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 AudioChannelSplitter and to some other wirable instance.

Thread safetyUnsafe

History 1

Settings