AudioChannelSplitter
Splits an audio stream into component channels so that each can be processed independently.
| Memory category | Internal |
|---|
Member index 5
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.

History 9
- 675 Change Tags of AudioChannelSplitter from [NotBrowsable] to []
- 674 Change Tags of AudioChannelSplitter from [] to [NotBrowsable]
- 667 Change Tags of AudioChannelSplitter from [NotBrowsable] to []
- 662 Add GetOutputPins
- 662 Add GetInputPins
- 660 Add WiringChanged
- 660 Add GetConnectedWires
- 660 Add Layout
- 660 Add AudioChannelSplitter
Members 5
GetConnectedWires
| Parameters (1) | ||
|---|---|---|
| pin | string | |
| Returns (1) | ||
| Instances | ||
Returns an array of Wires that are connected to the specified pin. For AudioChannelSplitter, this can be one "Input" pin or a number of output pins - see AudioChannelSplitter.GetInputPins for a full list.
| Thread safety | Unsafe |
|---|
History 1
- 660 Add GetConnectedWires
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 AudioChannelSplitter, this is Input only.
| Thread safety | Unsafe |
|---|
History 1
- 662 Add GetInputPins
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 AudioChannelSplitter, these are:
"Output""Left""Right""Center""SurroundLeft""SurroundRight""BackLeft""BackRight""Sub""TopLeft""TopRight""TopBackLeft""TopBackRight"
| Thread safety | Unsafe |
|---|
History 1
- 662 Add GetOutputPins
Layout
| Type | Default | |
|---|---|---|
| AudioChannelLayout | Stereo | |
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 safety | ReadSafe |
|---|---|
| Category | State |
| Loaded/Saved | true |
WiringChanged
| Parameters (4) | |
|---|---|
| connected | bool |
| 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 AudioChannelSplitter and to some other wirable instance.
| Thread safety | Unsafe |
|---|
History 1
- 660 Add WiringChanged