Index

Search Results for

    Class AudioFilter

    Inheritance
    BaseObject
    BaseObject
    AudioFilter
    Inherited Members
    BaseObject.type
    BaseObject.valid
    BaseObject.id
    BaseObject.destroy
    BaseObject.getMetaDataKeys
    BaseObject.getSyncedMeta
    BaseObject.hasSyncedMeta
    BaseObject.getSyncedMetaKeys
    BaseObject.refCount
    Module: alt-client
    Package: @altmp/altv-types
    Syntax
    class AudioFilter extends BaseObject

    Constructors

    | Improve this Doc View Source

    AudioFilter(string)

    Declaration
    AudioFilter(filterName: string): AudioFilter
    Parameters
    Type Name Description
    string filterName

    Properties

    | Improve this Doc View Source

    audioCategory

    Declaration
    public get audioCategory(): number
public set audioCategory(audioCategory: string | number): void
    Parameters
    Type Name Description
    string | number audioCategory
    Property Value
    Type Description
    number
    | Improve this Doc View Source

    hash

    Declaration
    public readonly hash: number
    Property Value
    Type Description
    number

    Methods

    | Improve this Doc View Source

    addRotateEffect(number, number)

    Declaration
    public addRotateEffect(fRate: number, priority: number): number
    Parameters
    Type Name Description
    number fRate
    number priority
    Returns
    Type Description
    number
    | Improve this Doc View Source

    addVolumeEffect(number, number, number)

    Declaration
    public addVolumeEffect(fVolume: number, priority: number, channel?: number): number
    Parameters
    Type Name Description
    number fVolume
    number priority
    number channel
    Returns
    Type Description
    number
    | Improve this Doc View Source

    addPeakeqEffect(number, number, number, number, number, number)

    Declaration
    public addPeakeqEffect(lBand: number, fBandwidth: number, fQ: number, fCenter: number, fGain: number, priority: number): number
    Parameters
    Type Name Description
    number lBand
    number fBandwidth
    number fQ
    number fCenter
    number fGain
    number priority
    Returns
    Type Description
    number
    | Improve this Doc View Source

    addDampEffect(number, number, number, number, number, number)

    Declaration
    public addDampEffect(fTarget: number, fQuiet: number, fRate: number, fGain: number, fDelay: number, priority: number): number
    Parameters
    Type Name Description
    number fTarget
    number fQuiet
    number fRate
    number fGain
    number fDelay
    number priority
    Returns
    Type Description
    number
    | Improve this Doc View Source

    addAutowahEffect(number, number, number, number, number, number, number)

    Declaration
    public addAutowahEffect(fDryMix: number, fWetMix: number, fFeedback: number, fRate: number, fRange: number, fFreq: number, priority: number): number
    Parameters
    Type Name Description
    number fDryMix
    number fWetMix
    number fFeedback
    number fRate
    number fRange
    number fFreq
    number priority
    Returns
    Type Description
    number
    | Improve this Doc View Source

    addPhaserEffect(number, number, number, number, number, number, number)

    Declaration
    public addPhaserEffect(fDryMix: number, fWetMix: number, fFeedback: number, fRate: number, fRange: number, fFreq: number, priority: number): number
    Parameters
    Type Name Description
    number fDryMix
    number fWetMix
    number fFeedback
    number fRate
    number fRange
    number fFreq
    number priority
    Returns
    Type Description
    number
    | Improve this Doc View Source

    addChorusEffect(number, number, number, number, number, number, number)

    Declaration
    public addChorusEffect(fDryMix: number, fWetMix: number, fFeedback: number, fMinSweep: number, fMaxSweep: number, fRate: number, priority: number): number
    Parameters
    Type Name Description
    number fDryMix
    number fWetMix
    number fFeedback
    number fMinSweep
    number fMaxSweep
    number fRate
    number priority
    Returns
    Type Description
    number
    | Improve this Doc View Source

    addDistortionEffect(number, number, number, number, number, number)

    Declaration
    public addDistortionEffect(fDrive: number, fDryMix: number, fWetMix: number, fFeedback: number, fVolume: number, priority: number): number
    Parameters
    Type Name Description
    number fDrive
    number fDryMix
    number fWetMix
    number fFeedback
    number fVolume
    number priority
    Returns
    Type Description
    number
    | Improve this Doc View Source

    addCompressor2Effect(number, number, number, number, number, number)

    Declaration
    public addCompressor2Effect(fGain: number, fThreshold: number, fRatio: number, fAttack: number, fRelease: number, priority: number): number
    Parameters
    Type Name Description
    number fGain
    number fThreshold
    number fRatio
    number fAttack
    number fRelease
    number priority
    Returns
    Type Description
    number
    | Improve this Doc View Source

    addBqfEffect(number, number, number, number, number, number, number)

    Declaration
    public addBqfEffect(lFilter: number, fCenter: number, fGain: number, fBandwidth: number, fQ: number, fS: number, priority: number): number
    Parameters
    Type Name Description
    number lFilter
    number fCenter
    number fGain
    number fBandwidth
    number fQ
    number fS
    number priority
    Returns
    Type Description
    number
    | Improve this Doc View Source

    addEcho4Effect(number, number, number, number, number)

    Declaration
    public addEcho4Effect(fDryMix: number, fWetMix: number, fFeedback: number, fDelay: number, priority: number): number
    Parameters
    Type Name Description
    number fDryMix
    number fWetMix
    number fFeedback
    number fDelay
    number priority
    Returns
    Type Description
    number
    | Improve this Doc View Source

    addPitchshiftEffect(number, number, number, number, number)

    Declaration
    public addPitchshiftEffect(fPitchShift: number, fSemitones: number, lFFTsize: number, lOsamp: number, priority: number): number
    Parameters
    Type Name Description
    number fPitchShift
    number fSemitones
    number lFFTsize
    number lOsamp
    number priority
    Returns
    Type Description
    number
    | Improve this Doc View Source

    addFreeverbEffect(number, number, number, number, number, number, number)

    Declaration
    public addFreeverbEffect(fDryMix: number, fWetMix: number, fRoomSize: number, fDamp: number, fWidth: number, lMode: number, priority: number): number
    Parameters
    Type Name Description
    number fDryMix
    number fWetMix
    number fRoomSize
    number fDamp
    number fWidth
    number lMode
    number priority
    Returns
    Type Description
    number
    | Improve this Doc View Source

    removeEffect(number)

    Declaration
    public removeEffect(hfxHandler: number): boolean
    Parameters
    Type Name Description
    number hfxHandler
    Returns
    Type Description
    boolean