Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioChannelMixer

Combines multiple audio streams into a single, multichannel audio stream.

Memory categoryInternal

Member index 5

HistoryMember
731Layout: AudioChannelLayout
660GetConnectedWires(pin: string): Instances
662GetInputPins(): Array
662GetOutputPins(): Array
660WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: 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
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

AudioChannelMixer mixes multiple audio streams into a single, multichannel stream. It provides one combined Input pin, one Output pin, as well as the following secondary input 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 11

Members 5

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances

Returns an array of Wires that are connected to the specified pin. For AudioChannelMixer, this can be one "Output" pin or a number of input pins - see AudioChannelMixer.GetInputPins for a full list.

Thread safetyUnsafe

History 1

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 AudioChannelMixer, these are:

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

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

Thread safetyUnsafe

History 1

Layout

TypeDefault
AudioChannelLayoutStereo

Controls the output channel layout to be mixed to. The Input pin of AudioChannelMixer is always forwarded "as-is" to Output, but depending on the value of Layout:

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

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

Thread safetyUnsafe

History 1

Settings