Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface AmbientSoundPlaybackConfig

    interface AmbientSoundPlaybackConfig {
        distance: number;
        listener: ElevatedPoint;
        muffled: boolean;
        object: canvas.placeables.AmbientSound;
        sound: Sound;
        source: PointSoundSource;
        volume: number;
        walls: boolean;
    }
    Index

    Properties

    distance: number

    The minimum distance between a listener and the AmbientSound origin

    listener: ElevatedPoint

    The coordinates of the closest listener or undefined if there is none

    muffled: boolean

    Is the closest listener muffled

    An AmbientSound object responsible for the sound, or undefined

    sound: Sound

    The Sound node which should be controlled for playback

    The SoundSource which defines the area of effect for the sound

    volume: number

    The final volume at which the Sound should be played

    walls: boolean

    Is playback constrained or muffled by walls and surfaces?