rules

.cursor/rules/roblox/reference/engine/classes/AudioChannelMixer.yaml

@@ -0,0 +1,173 @@
+# This file is automatically generated. Please don't edit it manually.
+# To submit a bug report on the content, see
+# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
+
+name: AudioChannelMixer
+type: class
+memory_category: Internal
+summary: |
+  Combines multiple audio streams into a single, multichannel audio stream.
+description: |
+  `Class.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 `Class.Wire|Wires`: **Left**, **Right**, **Center**,
+  **SurroundLeft**, **SurroundRight**, **Sub**, **BackLeft**, **BackRight**,
+  **TopLeft**, **TopRight**, **TopBackLeft**, and **TopBackRight**.
+
+  <img src="/assets/engine-api/enums/AudioChannelLayout/Surround_7_1_4.jpg" width="810" alt="Diagram showing position of all potential channels." />
+code_samples:
+  - audio-wiring---splitting-mixing
+inherits:
+  - Instance
+descendants: []
+tags: []
+deprecation_message: ''
+properties:
+  - name: AudioChannelMixer.Layout
+    summary: |
+      Controls the output channel layout to be mixed to.
+    description: |
+      Controls the output channel layout to be mixed to. The **Input** pin of
+      `Class.AudioChannelMixer` is always forwarded "as-is" to **Output**, but
+      depending on the value of `Layout`:
+
+      - For `Enum.AudioChannelLayout.Mono|Mono`, the **Center** pin consumes
+        audio streams.
+      - For `Enum.AudioChannelLayout.Stereo|Stereo`, the **Left** and **Right**
+        pins consume audio streams.
+      - For `Enum.AudioChannelLayout.Quad|Quad`, the **Left**, **Right**,
+        **BackLeft**, and **BackRight** pins consume audio streams.
+      - `Enum.AudioChannelLayout.Surround_5|Surround_5` is the same as `Quad`,
+        plus **Center** consumes an audio stream.
+      - `Enum.AudioChannelLayout.Surround_5_1|Surround_5_1` is the same as
+        `Surround_5`, plus **Sub** consumes an audio stream.
+      - `Enum.AudioChannelLayout.Surround_7_1|Surround_7_1` is the same as
+        `Surround_5_1`, plus **SurroundLeft** and **SurroundRight** consume
+        audio streams.
+      - For `Enum.AudioChannelLayout.Surround_7_1_4|Surround_7_1_4`, all
+        secondary input pins consume audio streams.
+    code_samples: []
+    type: AudioChannelLayout
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: State
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Audio
+methods:
+  - name: AudioChannelMixer:GetConnectedWires
+    summary: |
+      Returns an array of `Class.Wire|Wires` that are connected to the specified
+      pin.
+    description: |
+      Returns an array of `Class.Wire|Wires` that are connected to the specified
+      pin.
+    code_samples: []
+    parameters:
+      - name: pin
+        type: string
+        default:
+        summary: ''
+    returns:
+      - type: Instances
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - Audio
+  - name: AudioChannelMixer:GetInputPins
+    summary: |
+      Returns the input pins that can be selected by `Class.Wire.TargetName`.
+    description: |
+      Returns a table of strings indicating which input pins are available for
+      `Class.Wire.TargetName`:
+
+      - `"Input"`
+      - `"Left"`
+      - `"Right"`
+      - `"Center"`
+      - `"SurroundLeft"`
+      - `"SurroundRight"`
+      - `"BackLeft"`
+      - `"BackRight"`
+      - `"Sub"`
+      - `"TopLeft"`
+      - `"TopRight"`
+      - `"TopBackLeft"`
+      - `"TopBackRight"`
+    code_samples: []
+    parameters: []
+    returns:
+      - type: Array
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - Audio
+  - name: AudioChannelMixer:GetOutputPins
+    summary: |
+      Returns the output pin available for `Class.Wire.SourceName`.
+    description: |
+      Returns a table containing one string, `"Output"`, indicating the output
+      pin available for `Class.Wire.SourceName`.
+    code_samples: []
+    parameters: []
+    returns:
+      - type: Array
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - Audio
+events:
+  - name: AudioChannelMixer.WiringChanged
+    summary: |
+      Fires when another instance is connected to or disconnected from the
+      `Class.AudioChannelMixer` via a `Class.Wire`.
+    description: |
+      Event that fires after a `Class.Wire` becomes connected or disconnected,
+      and that `Class.Wire` is now or was previously connected to a pin on the
+      `Class.AudioChannelMixer` and to some other wirable instance.
+    code_samples: []
+    parameters:
+      - name: connected
+        type: boolean
+        default:
+        summary: |
+          Whether the instance got connected or disconnected.
+      - name: pin
+        type: string
+        default:
+        summary: |
+          The pin on the `Class.AudioChannelMixer` that the `Class.Wire`
+          targets.
+      - name: wire
+        type: Wire
+        default:
+        summary: |
+          The `Class.Wire` between the `Class.AudioChannelMixer` and the other
+          instance.
+      - name: instance
+        type: Instance
+        default:
+        summary: |
+          The other instance that is or was connected through the `Class.Wire`.
+    tags: []
+    deprecation_message: ''
+    security: None
+    capabilities:
+      - Audio
+callbacks: []