Vinyl
    Preparing search index...

    Interface VinylDependencyOptions

    Configuration used by the default dependency factories for Vinyl.

    These options are used during player construction, changes after construction will have no effect.

    interface VinylDependencyOptions {
        abr?: {
            bandwidthMultiplier?: number;
            maxFetchedBeforeDown?: number;
            minFetchedBeforeUp?: number;
            strategy?: AbrStrategy;
        };
        autoReset?: Partial<AutoResetControllerImplOptions>;
        drm?: Partial<DrmOptions>;
        media: HTMLMediaElement;
        patches?: {
            media?: { preventStalls?: boolean; unreliablePlaybackEvents?: boolean };
            sourceBuffer?: { preventAbort?: boolean };
        };
        playbackController?: Partial<PlaybackControllerImplOptions>;
        streaming?: {
            buffering?: {
                maxAppendSize?: { audio?: number; text?: number; video?: number };
                minBuffer?: number;
            };
            segmentController?: {
                prefetchActive?: number;
                prefetchInactive?: number;
                retainTail?: number;
            };
        };
        trackController?: Partial<TrackControllerImplOptions>;
    }
    Index

    Properties

    abr? autoReset? drm? media patches? playbackController? streaming? trackController?

    Properties

    abr?: {
        bandwidthMultiplier?: number;
        maxFetchedBeforeDown?: number;
        minFetchedBeforeUp?: number;
        strategy?: AbrStrategy;
    }

    Configuration for adaptive bitrate switching.

    Type declaration

    • Optional ReadonlybandwidthMultiplier?: number

      A multiplier for the estimated bandwidth to give tolerance to quality selection. Default: 0.7

    • Optional ReadonlymaxFetchedBeforeDown?: number

      If at least this amount of time (in seconds) is currently fetched, don't consider an ABR-down. Default: 30

    • Optional ReadonlyminFetchedBeforeUp?: number

      If less than this amount of time (in seconds) is currently fetched, don't consider an ABR-up. Note: ABR-up will only happen during active playback if AdaptationSet.bitstreamSwitching is true. ABR-up will not happen across adaptation sets. Default: 20

    • Optional Readonlystrategy?: AbrStrategy

      Defines the strategy used for quality selection.

      Default: BEST (ABR will be enabled)

    autoReset?: Partial<AutoResetControllerImplOptions>

    Configuration for auto-reset behavior.

    drm?: Partial<DrmOptions>

    Configuration for all drm-related components.

    media: HTMLMediaElement

    The media element.

    patches?: {
        media?: { preventStalls?: boolean; unreliablePlaybackEvents?: boolean };
        sourceBuffer?: { preventAbort?: boolean };
    }

    Flags for patches that should be applied browser-specifically. These will be defaulted based on the user-agent.

    playbackController?: Partial<PlaybackControllerImplOptions>

    Configuration for the playback controller.

    streaming?: {
        buffering?: {
            maxAppendSize?: { audio?: number; text?: number; video?: number };
            minBuffer?: number;
        };
        segmentController?: {
            prefetchActive?: number;
            prefetchInactive?: number;
            retainTail?: number;
        };
    }

    Configuration for segmented streaming tracks (hls / dash).

    Type declaration

    • Optional Readonlybuffering?: {
          maxAppendSize?: { audio?: number; text?: number; video?: number };
          minBuffer?: number;
      }

      Configuration for the buffering controller.

      • Optional ReadonlymaxAppendSize?: { audio?: number; text?: number; video?: number }

        The maximum number of bytes to append at a time per content type. Default: { audio: 1MiB, video: 15MiB }

      • Optional ReadonlyminBuffer?: number

        When the buffer falls below this time threshold, the next segment will be requested from the segment controller and appended. Default: 4s

    • Optional ReadonlysegmentController?: { prefetchActive?: number; prefetchInactive?: number; retainTail?: number }

      Configuration for the segment controller.

      • Optional ReadonlyprefetchActive?: number

        The amount of time ahead of the playhead to prefetch when the track is active. Default: 240

      • Optional ReadonlyprefetchInactive?: number

        The amount of time to prefetch when the track is not active. Default: 20

      • Optional ReadonlyretainTail?: number

        The number of seconds behind the playhead to retain segments. Default: 30

    trackController?: Partial<TrackControllerImplOptions>

    Configuration for the track controller.

    Settings

    Member Visibility

    On This Page

    Properties