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

    Interface SoundPlaybackOptions

    interface SoundPlaybackOptions {
        delay?: number;
        duration?: number;
        fade?: number;
        loop?: boolean;
        loopEnd?: number;
        loopStart?: number;
        offset?: number;
        onended?: Function | null;
        volume?: number;
    }
    Index

    Properties

    delay? duration? fade? loop? loopEnd? loopStart? offset? onended? volume?

    Properties

    delay?: number

    A delay in seconds by which to delay playback

    duration?: number

    A limited duration in seconds for which to play

    fade?: number

    A duration in milliseconds over which to fade in playback

    loop?: boolean

    Should sound playback loop?

    loopEnd?: number

    Seconds of the Audio buffer when looped playback should restart. Only works for AudioBufferSourceNode.

    loopStart?: number

    Seconds of the AudioBuffer when looped playback should start. Only works for AudioBufferSourceNode.

    offset?: number

    An offset in seconds at which to start playback

    onended?: Function | null

    A callback function attached to the source node

    volume?: number

    The volume at which to play the sound

    Settings

    Member Visibility

    On This Page

    Properties