cacophony
    Preparing search index...

    Interface PlayOptions

    Options for configuring fade behavior when starting playback via Sound.play(). PlayOptions

    interface PlayOptions {
        at?: number;
        fadeIn?: number;
        fadeInPerLoop?: boolean;
        fadeOut?: number;
        fadeType?: FadeType;
        loopCount?: LoopCount;
        panType?: PanType;
        playbackRate?: number;
        position?: Position;
        stereoPan?: number;
        threeDOptions?: ThreeDOptions | Partial<HrtfPannerOptions>;
        volume?: number;
    }
    Index
    at? fadeIn? fadeInPerLoop? fadeOut? fadeType? loopCount? panType? playbackRate? position? stereoPan? threeDOptions? volume?
    at?: number

    Absolute AudioContext time, in seconds, for a buffer source's first start.

    fadeIn?: number
    fadeInPerLoop?: boolean
    fadeOut?: number
    fadeType?: FadeType
    loopCount?: LoopCount

    Additional repetitions, or infinite. Unsupported for synths and live streams.

    panType?: PanType
    playbackRate?: number

    Positive rate multiplier. Unsupported for synths and live streams.

    position?: Position

    HRTF-only position; takes precedence over threeDOptions position fields.

    stereoPan?: number

    Stereo-only pan, from -1 to 1.

    threeDOptions?: ThreeDOptions | Partial<HrtfPannerOptions>

    Partial HRTF settings preserve unspecified effective values.

    volume?: number

    Per-voice gain; omitted values inherit the source defaults.

    Settings
    Member Visibility

    On This Page
    Properties