Set

These are setters

Set Volume

exports['mx-surround']:setVolumeMax(soundId, volume, disableOverWrite)

Parameters

  • soundId: string

  • volume: number

  • disableOverWrite?: boolean

    • If true, volume will not be overwritten by sound profile


Set Streamer Mode

exports['mx-surround']:setStreamerMode(bool)

Parameters

  • bool: boolean


Set Type

exports['mx-surround']:setStereoMode(soundId, stereo)

Parameters

  • soundId: string

  • stereo: boolean

    • If this is false, it will be spatial (3D)


Set Panner

Parameters


Set Coords

Parameters

  • soundId: string

  • coords: vector3

  • xSound?: boolean


Set TimeStamp

Parameters

  • soundId: string

  • timeStamp: number


Set Loop

Parameters

  • soundId: string

  • loop: boolean


Set Max Distance

Parameters

  • soundId: string

  • maxDistance: number


Set Destroy On Finish

Parameters

  • soundId: string

  • destroyOnFinish: boolean


Disable Interior Filter

It allows you to disable or enable effects that make sound appear to come from within an interior. If you are playing small sounds like stove sounds in a interior, it will also disable the feature that plays them in stereo rather than 3D. Therefore, it is very useful for particle sounds.

Parameters

  • soundId: string

  • disableFilter: boolean


Disable Vehicle Filter

Parameters

  • soundId: string

  • disableFilter: boolean

Last updated