Skip to content
Roblox API Reference

AudioTremolo

Creates a trembling effect on a sound by varying the volume of the sound up and down.
Memory category
Internal
Own members
11
Inherited members
75
Subclasses
0
Siblings
608

Properties30

Inherited fromObject2

Property categoryData

Inherited fromInstance21

Property categoryBehavior

Property categoryData

Property categoryPermissions

Defined byAudioTremolo7

Property categoryState

  • AudioTremolo.Bypass: boolean = false
    Whether audio streams are passed-through unaffected by this effect.
    • Read capabilities: Audio
  • AudioTremolo.Depth: number = 1
    Controls how much the volume will raise and lower.
    • Read capabilities: Audio
  • AudioTremolo.Duty: number = 0.5
    Controls how long the effect will be active during one volume oscillation.
    • Read capabilities: Audio
  • AudioTremolo.Frequency: number = 5
    Sets how often the effect will oscillate the volume.
    • Read capabilities: Audio
  • AudioTremolo.Shape: number = 0
    Controls the shape of the low frequency oscillations.
    • Read capabilities: Audio
  • AudioTremolo.Skew: number = 0
    Time-skews the low frequency oscillations cycle.
    • Read capabilities: Audio
  • AudioTremolo.Square: number = 0
    Flatness of the low frequency oscillations shape.
    • Read capabilities: Audio

Methods45

Inherited fromObject3
  • Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Inherited fromInstance39
Defined byAudioTremolo3
  • AudioTremolo:GetConnectedWires(pin: string): { Instance }
    Returns an array of Wires that are connected to the specified pin.
    • Capabilities: Audio
    Parameters
    ParameterDescription
    pin: string
    An input or output pin on this instance
    Returns
    TypeDescription
    { Instance }
    An array of Wires
  • AudioTremolo:GetInputPins(): { any }
    Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.
    • Capabilities: Audio
    Returns
    TypeDescription
    { any }
    An array of strings representing valid pin names.
  • AudioTremolo:GetOutputPins(): { any }
    Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.
    • Capabilities: Audio
    Returns
    TypeDescription
    { any }
    An array of strings representing valid pin names.

Events11

Inherited fromObject1
Inherited fromInstance9
Defined byAudioTremolo1