Taos API Reference
    Preparing search index...

    Interface VoiceOptions

    Options for a single played voice (AudioEngine.play / playAt).

    interface VoiceOptions {
        volume?: number;
        playbackRate?: number;
        detune?: number;
        loop?: boolean;
        fadeIn?: number;
        offset?: number;
        position?: Vec3Like;
        spatial?: SpatialOptions;
    }
    Index

    Properties

    volume? playbackRate? detune? loop? fadeIn? offset? position? spatial?

    Properties

    volume?: number

    Per-voice gain in [0, ∞). Default 1.

    playbackRate?: number

    Playback speed / pitch multiplier (also shifts pitch). Default 1.

    detune?: number

    Fine pitch detune in cents. Default 0.

    loop?: boolean

    Loop the clip until stopped. Default false.

    fadeIn?: number

    Fade the voice in over this many seconds. Default 0 (instant).

    offset?: number

    Start offset within the clip, in seconds. Default 0.

    position?: Vec3Like

    Spatialize at this position (creates a PannerNode).

    spatial?: SpatialOptions

    Spatialization tuning (only used when position is set).

    Settings

    Member Visibility

    On This Page

    Properties