AudioFilter

Hierarchy

• BaseObject
  • AudioFilter

Index

Constructors

• constructor

Properties

• hash
• id
• isRemote
• refCount
• remoteID
• type
• valid

Accessors

• audioCategory

Methods

• addAutowahEffect
• addBqfEffect
• addChorusEffect
• addCompressor2Effect
• addDampEffect
• addDistortionEffect
• addEcho4Effect
• addFreeverbEffect
• addPeakeqEffect
• addPhaserEffect
• addPitchshiftEffect
• addRotateEffect
• addVolumeEffect
• deleteMeta
• destroy
• getMeta
• getMetaDataKeys
• getSyncedMeta
• getSyncedMetaKeys
• hasMeta
• hasSyncedMeta
• removeEffect
• setMeta
• getByID
• getByRemoteID

Constructors

constructor

• new AudioFilter(filterName: string): AudioFilter

• Overrides BaseObject.constructor

Properties

publicreadonlyhash

hash: number

publicreadonlyid

id: number

Inherited from BaseObject.id

publicreadonlyisRemote

isRemote: boolean

Whether this entity was created clientside or serverside. (Clientside = false, Serverside = true).

Inherited from BaseObject.isRemote

publicreadonlyrefCount

refCount: number

Returns the ref count of the entity.

Remarks

It’s only available in debug-mode.

Inherited from BaseObject.refCount

publicreadonlyremoteID

remoteID: number

The serverside id of this entity.

Inherited from BaseObject.remoteID

publicreadonlytype

type: BaseObjectType

Type of the object.

Inherited from BaseObject.type

publicreadonlyvalid

valid: boolean

Object usability.

Returns

False if object is no longer usable.

Inherited from BaseObject.valid

Accessors

publicaudioCategory

• get audioCategory(): number
• set audioCategory(audioCategory: string | number): void

Methods

publicaddAutowahEffect

• addAutowahEffect(fDryMix: number, fWetMix: number, fFeedback: number, fRate: number, fRange: number, fFreq: number, priority: number): number

publicaddBqfEffect

• addBqfEffect(lFilter: number, fCenter: number, fGain: number, fBandwidth: number, fQ: number, fS: number, priority: number): number

publicaddChorusEffect

• addChorusEffect(fDryMix: number, fWetMix: number, fFeedback: number, fMinSweep: number, fMaxSweep: number, fRate: number, priority: number): number

publicaddCompressor2Effect

• addCompressor2Effect(fGain: number, fThreshold: number, fRatio: number, fAttack: number, fRelease: number, priority: number): number

publicaddDampEffect

• addDampEffect(fTarget: number, fQuiet: number, fRate: number, fGain: number, fDelay: number, priority: number): number

publicaddDistortionEffect

• addDistortionEffect(fDrive: number, fDryMix: number, fWetMix: number, fFeedback: number, fVolume: number, priority: number): number

publicaddEcho4Effect

• addEcho4Effect(fDryMix: number, fWetMix: number, fFeedback: number, fDelay: number, priority: number): number

publicaddFreeverbEffect

• addFreeverbEffect(fDryMix: number, fWetMix: number, fRoomSize: number, fDamp: number, fWidth: number, lMode: number, priority: number): number

publicaddPeakeqEffect

• addPeakeqEffect(lBand: number, fBandwidth: number, fQ: number, fCenter: number, fGain: number, priority: number): number

publicaddPhaserEffect

• addPhaserEffect(fDryMix: number, fWetMix: number, fFeedback: number, fRate: number, fRange: number, fFreq: number, priority: number): number

publicaddPitchshiftEffect

• addPitchshiftEffect(fPitchShift: number, fSemitones: number, lFFTsize: number, lOsamp: number, priority: number): number

publicaddRotateEffect

• addRotateEffect(fRate: number, priority: number): number

publicaddVolumeEffect

• addVolumeEffect(fVolume: number, priority: number, channel?: number): number

publicdeleteMeta

• deleteMeta(key: string): void
• deleteMeta<K>(key: K): void

• Inherited from BaseObject.deleteMeta

publicdestroy

• destroy(): void

• Inherited from BaseObject.destroy

  Removes the object from the world.

publicgetMeta

• getMeta<K>(key: Exclude<K, never>): unknown
• getMeta<K>(key: K): undefined | ICustomBaseObjectMeta[K]
• getMeta<V>(key: string): undefined | V

• Inherited from BaseObject.getMeta

  Type parameters

  • K: string

publicgetMetaDataKeys

• getMetaDataKeys(): readonly string[]

• Inherited from BaseObject.getMetaDataKeys

publicgetSyncedMeta

• getSyncedMeta<K>(key: Exclude<K, never>): unknown
• getSyncedMeta<K>(key: K): undefined | ICustomBaseObjectSyncedMeta[K]
• getSyncedMeta<V>(key: string): undefined | V

• Inherited from BaseObject.getSyncedMeta

  Gets a value using the specified key.

  ---

  Type parameters

  • K: string

publicgetSyncedMetaKeys

• getSyncedMetaKeys(): readonly string[]

• Inherited from BaseObject.getSyncedMetaKeys

publichasMeta

• hasMeta(key: string): boolean
• hasMeta<K>(key: K): boolean

• Inherited from BaseObject.hasMeta

publichasSyncedMeta

• hasSyncedMeta(key: string): boolean
• hasSyncedMeta<K>(key: K): boolean

• Inherited from BaseObject.hasSyncedMeta

  Determines whether contains the specified key.

publicremoveEffect

• removeEffect(hfxHandler: number): boolean

publicsetMeta

• setMeta<K>(key: K, value: InterfaceValueByKey<ICustomBaseObjectMeta, K, unknown, void>): void
• setMeta<K>(key: K, value: ICustomBaseObjectMeta[K]): void
• setMeta<V, K>(key: K, value: InterfaceValueByKey<ICustomBaseObjectMeta, K, V, void>): void

• Inherited from BaseObject.setMeta

  Type parameters

  • K: string

publicstaticgetByID

• getByID(type: BaseObjectType, id: number): null | BaseObject

• Inherited from BaseObject.getByID

  Gets the base object with the given type and local id

publicstaticgetByRemoteID

• getByRemoteID(type: BaseObjectType, id: number): null | BaseObject

• Inherited from BaseObject.getByRemoteID