Amazon Vinyl
    Preparing search index...

    Interface AudioOptions

    Declarative audio configuration. Mirrors VinylOptions.text: the audio rendition is chosen from selection; changing it reselects audio immediately.

    interface AudioOptions {
        disableSampleRateFilter?: boolean;
        maxSampleRate?: Maybe<number>;
        minSampleRate?: Maybe<number>;
        selection?: AudioSelection;
    }
    Index
    disableSampleRateFilter? maxSampleRate? minSampleRate? selection?
    disableSampleRateFilter?: boolean

    When true, disables the audio sampling-rate support filter, so audio renditions whose sampling rate exceeds what the platform reports (via the AudioContext output rate) are kept and offered to playback anyway. false (the default) applies the filter. Changing this re-filters the timeline immediately.

    maxSampleRate?: Maybe<number>

    The maximum audio sampling rate (Hz) the sampling-rate filter treats as supported. When set, it takes precedence over the platform's AudioContext-reported output rate. Ignored when disableSampleRateFilter is true. Changing this re-filters the timeline immediately. null/undefined falls back to the reported rate.

    minSampleRate?: Maybe<number>

    The minimum audio sampling rate (Hz) the sampling-rate filter treats as supported. When set, renditions below it are filtered out as a soft floor (if every audio rendition is below it, the highest is kept so playback is never stranded). Applied alongside the max cap whenever the filter runs, regardless of how the max was determined; ignored when disableSampleRateFilter is true. Changing this re-filters the timeline immediately.

    selection?: AudioSelection

    The audio selection criteria (language / descriptive).

    Settings
    Member Visibility

    On This Page
    Properties