GSmGpE6CwX2y9JjB25B8
We use cookies on this site to enhance your user experience
Collapse Sidebar

EqualizerSoundEffect

Show Show deprecated

EqualizerSoundEffect

Show deprecated

The EqualizerSoundEffect allows for control of the volume of various frequency ranges for the Sound or SoundGroup the effect is applied to. This can be used to highlight particular elements of audio or minimize or outright eliminate others.

The EqualizerSoundEffect gives control over three ranges of frequency: Low, Mid, and High, and their specific frequencies are as follows:

  • Low: 0 - 400 Hz
  • Mid: 400 - 4000 Hz
  • High: 4000+ Hz
  • Like all other `SoundEffect`, a EqualizerSoundEffect can be applied either to a `Sound` or `SoundGroup` by being parented to either.

    Properties

    float

    HighGain

    The output volume of frequencies greater than 4000 Hz.

    float

    LowGain

    The output volume of frequencies lower than 400 Hz.

    float

    MidGain

    The output volume of frequencies between 400 and 4000 Hz.

    Inherited from SoundEffect: Show Hide

    bool

    Enabled

    Toggles the effect on and off.

    int

    Priority

    Determines the order the effect will be applied in relation to other effects.

    Inherited from Instance: Show Hide

    bool

    Archivable

    Determines if an Instance can be cloned using /Instance/Clone or saved to file.

    string

    ClassName

    [ReadOnly] [NotReplicated]

    A read-only string representing the class this Instance belongs to

    int

    DataCost

    [ReadOnly] [NotReplicated] [Deprecated]

    The cost of saving the instance using data persistence.

    string

    Name

    A non-unique identifier of the Instance

    Instance

    Parent

    Determines the hierarchical parent of the Instance

    bool

    RobloxLocked

    If true, the Instance and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted

    bool

    archivable

    [Hidden] [NotReplicated] [Deprecated]
    string

    className

    [ReadOnly] [NotReplicated] [Deprecated]

    Functions

    Inherited from Instance: Show Hide

    void

    ClearAllChildren ( )

    This function destroys all of an Instance's children.

    Instance

    Clone ( )

    Create a deep copy of a Roblox instance and descendants where Archivable = true.

    void

    Destroy ( )

    Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.

    Instance

    FindFirstAncestor ( string name )

    Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.

    Instance

    FindFirstAncestorOfClass ( string className )

    Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.

    Instance

    FindFirstAncestorWhichIsA ( string className )

    Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.

    Instance

    FindFirstChild ( string name , bool recursive )

    Returns the first child of the Instance found with the given name.

    Instance

    FindFirstChildOfClass ( string className )

    Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.

    Instance

    FindFirstChildWhichIsA ( string className , bool recursive )

    Returns the first child of the Instance for whom Instance/IsA returns true for the given className.

    Objects

    GetChildren ( )

    Returns an array containing all of the Instance's children.

    string

    GetDebugId ( int scopeLength )

    [NotBrowsable]

    Returns a coded string of the Instances DebugId used internally by Roblox.

    Array

    GetDescendants ( )

    [CustomLuaState]

    Returns an array containing all of the descendants of the instance

    string

    GetFullName ( )

    Returns a string describing the Instance's ancestry.

    RBXScriptSignal

    GetPropertyChangedSignal ( string property )

    Get an event that fires when a given property of an object changes.

    bool

    IsA ( string className )

    [CustomLuaState]

    Returns true if an Instance's class matches or inherits from a given class

    bool

    IsAncestorOf ( Instance descendant )

    Returns true if an Instance is an ancestor of the given descendant.

    bool

    IsDescendantOf ( Instance ancestor )

    Returns true if an Instance is a descendant of the given ancestor.

    void

    Remove ( )

    [Deprecated]

    Sets the object’s Parent to nil, and does the same for all its descendants.

    Instance

    WaitForChild ( string childName , double timeOut )

    [CustomLuaState] [CanYield]

    Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.

    Objects

    children ( )

    [Deprecated]

    Returns an array of the object’s children.

    Instance

    clone ( )

    [Deprecated]
    void

    destroy ( )

    [Deprecated]
    Instance

    findFirstChild ( string name , bool recursive )

    [Deprecated]
    Objects

    getChildren ( )

    [Deprecated]
    bool

    isA ( string className )

    [Deprecated] [CustomLuaState]
    bool

    isDescendantOf ( Instance ancestor )

    [Deprecated]
    void

    remove ( )

    [Deprecated]

    Events

    Inherited from Instance: Show Hide

    RBXScriptSignal

    AncestryChanged ( Instance child , Instance parent )

    Fires when the Instance/Parent property of the object or one of its ancestors is changed.

    RBXScriptSignal

    Changed ( string property )

    Fired immediately after a property of an object changes.

    RBXScriptSignal

    ChildAdded ( Instance child )

    Fires when an object is parented to this Instance.

    RBXScriptSignal

    ChildRemoved ( Instance child )

    Fires when a child is removed from this Instance.

    RBXScriptSignal

    DescendantAdded ( Instance descendant )

    Fires when a descendant is added to the Instance

    RBXScriptSignal

    DescendantRemoving ( Instance descendant )

    Fires immediately before a descendant of the Instance is removed.

    RBXScriptSignal

    childAdded ( Instance child )

    [Deprecated]