rojo/.cursor/rules/roblox/reference/engine/classes/AudioEqualizer.yaml

# 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: AudioEqualizer
type: class
memory_category: Internal
summary: |
  Adjusts the frequency content of audio streams.
description: |
  `Class.AudioEqualizer` adjusts the frequency content of audio streams. It
  provides one **Input** pin and one **Output** pin which can be connected
  to/from by `Class.Wire|Wires`. `Class.AudioEqualizer` has 3 frequency bands
  whose gain values can be controlled, and the crossover points between bands
  can be moved.
code_samples:
  - audio-wiring---listener-equalization
inherits:
  - Instance
descendants: []
tags: []
deprecation_message: ''
properties:
  - name: AudioEqualizer.Bypass
    summary: |
      Whether audio streams are passed-through unaffected by this effect.
    description: |
      If `true`, audio streams are passed-through unaffected by this effect.
    code_samples: []
    type: boolean
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: State
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Audio
  - name: AudioEqualizer.Editor
    summary: ''
    description: ''
    code_samples: []
    type: boolean
    tags:
      - NotReplicated
    deprecation_message: ''
    security:
      read: RobloxScriptSecurity
      write: RobloxScriptSecurity
    thread_safety: ReadSafe
    category: State Editing
    serialization:
      can_load: true
      can_save: false
    capabilities:
      - Audio
  - name: AudioEqualizer.HighGain
    summary: |
      Gain value to be applied to the frequency content of the highest band in
      the equalizer.
    description: |
      Gain value, in decibels, to be applied to the frequency content of the
      highest band in the equalizer. Ranges from -80 to 10.
    code_samples: []
    type: float
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: State
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Audio
  - name: AudioEqualizer.LowGain
    summary: |
      Gain value to be applied to the frequency content of the lowest band in
      the equalizer.
    description: |
      Gain value, in decibels, to be applied to the frequency content of the
      lowest band in the equalizer. Ranges from -80 to 10.
    code_samples: []
    type: float
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: State
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Audio
  - name: AudioEqualizer.MidGain
    summary: |
      Gain value to be applied to the frequency content of the middle band in
      the equalizer.
    description: |
      Gain value, in decibels, to be applied to the frequency content of the
      middle band in the equalizer. Ranges from -80 to 10.
    code_samples: []
    type: float
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: State
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Audio
  - name: AudioEqualizer.MidRange
    summary: |
      The frequency range of the band influenced by
      `Class.AudioEqualizer.MidGain|MidGain`.
    description: |
      The frequency range in hertz of the band influenced by
      `Class.AudioEqualizer.MidGain|MidGain`. The lower value of the range
      determines the crossover frequency between the low and mid bands. The
      higher value of the range determines the crossover frequency between the
      mid and high bands. Both crossover frequencies range from 200 to 20,000.
    code_samples: []
    type: NumberRange
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: State
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Audio
methods:
  - name: AudioEqualizer: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. `Class.AudioEqualizer` has one "Input" pin and one "Output" 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: AudioEqualizer:GetInputPins
    summary: ''
    description: ''
    code_samples: []
    parameters: []
    returns:
      - type: Array
        summary: ''
    tags: []
    deprecation_message: ''
    security: None
    thread_safety: Unsafe
    capabilities:
      - Audio
  - name: AudioEqualizer:GetOutputPins
    summary: ''
    description: ''
    code_samples: []
    parameters: []
    returns:
      - type: Array
        summary: ''
    tags: []
    deprecation_message: ''
    security: None
    thread_safety: Unsafe
    capabilities:
      - Audio
events:
  - name: AudioEqualizer.WiringChanged
    summary: |
      Fires when another instance is connected to or disconnected from the
      `Class.AudioEqualizer` 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.AudioEqualizer` 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.AudioEqualizer` that the `Class.Wire` targets.
      - name: wire
        type: Wire
        default:
        summary: |
          The `Class.Wire` between the `Class.AudioEqualizer` 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: []