Class
AudioChannelMixer
Combines multiple audio streams into a single, multichannel audio stream.
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.
Properties 1#
LayoutAudioChannelLayout | Controls the output channel layout to be mixed to.ReadSafe |
Layout: AudioChannelLayout#
ReadSafe
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_5is the same asQuad, plus Center consumes an audio stream.Surround_5_1is the same asSurround_5, plus Sub consumes an audio stream.Surround_7_1is the same asSurround_5_1, plus SurroundLeft and SurroundRight consume audio streams.- For
Surround_7_1_4, all secondary input pins consume audio streams.
Methods 3#
| GetConnectedWires | Returns an array of Wires that are connected to the specified
pin. |
| GetInputPins | Gets the list of pins that Wire can use in Wire.TargetName
to connect to this instance via its Wire.TargetInstance property. |
| GetOutputPins | Gets the list of pins that Wire can use in Wire.SourceName
to connect to this instance via its Wire.SourceInstance property. |
GetConnectedWires(pin: string): List<Wire>#
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.
| Name | Type | Default | Description |
|---|---|---|---|
pin | string | An input or output pin on this instance |
Returns
List<Wire>— An array ofWires
GetInputPins(): 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"
Returns
Array— An array of strings representing valid pin names.
GetOutputPins(): 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.
Returns
Array— An array of strings representing valid pin names.
Events 1#
| WiringChanged | Fires when another instance is connected to or disconnected from the
AudioChannelMixer via a Wire. |
WiringChanged(connected: boolean, 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
AudioChannelMixer and to some other wirable instance.
| Name | Type | Default | Description |
|---|---|---|---|
connected | boolean | Whether the instance got connected or disconnected. | |
pin | string | The pin on the AudioChannelMixer that the Wire
targets. | |
wire | Wire | The Wire between the AudioChannelMixer and the other
instance. | |
instance | Instance | The other instance that is or was connected through the Wire. |
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild