Interface UsePlayerParameters

interface UsePlayerParameters {
    currentSubtitles?: Ref<undefined | TextTrack, undefined | TextTrack>;
    currentTime?: Ref<number, number>;
    element?: MaybeRef<undefined | HTMLElement>;
    emit?: (<Type>(type: Type, ...args: PlayerEvents[Type]) => void);
    fullscreen?: Ref<boolean, boolean>;
    keepAlive?: MaybeRef<boolean>;
    listeners?: {
        onAbort: undefined | ((...args: [event: Event]) => void);
        onCanplay: undefined | ((...args: [event: Event]) => void);
        onCanplaythrough: undefined | ((...args: [event: Event]) => void);
        onDurationchange: undefined | ((...args: [event: Event]) => void);
        onEmptied: undefined | ((...args: [event: Event]) => void);
        onEncrypted: undefined | ((...args: [event: Event]) => void);
        onEnded: undefined | ((...args: [event: Event]) => void);
        onEnterpictureinpicture: undefined | ((...args: [event: PictureInPictureEvent]) => void);
        onError: undefined | ((...args: [event: Event]) => void);
        onFcplayerConfigChanged: undefined | ((...args: [event: {
            key: string;
            value: any;
        } | {
            changes: {
                [key: string]: any;
            };
        }]) => void);
        onFcplayerCountdownDisabled: undefined | ((...args: []) => void);
        onFcplayerCountdownEnabled: undefined | ((...args: []) => void);
        onFcplayerCountdownTick: undefined | ((...args: [event: {
            remaining: number;
        }]) => void);
        onFcplayerCountdownZero: undefined | ((...args: []) => void);
        onFcplayerDestroy: undefined | ((...args: []) => void);
        onFcplayerSrcChanged: undefined | ((...args: [event: {
            src: any;
        }]) => void);
        onFullscreenenter: undefined | ((...args: []) => void);
        onFullscreenexit: undefined | ((...args: []) => void);
        onLeavepictureinpicture: undefined | ((...args: [event: PictureInPictureEvent]) => void);
        onLoad: undefined | ((...args: [event: Event]) => void);
        onLoadeddata: undefined | ((...args: [event: Event]) => void);
        onLoadedmetadata: undefined | ((...args: [event: Event]) => void);
        onLoadstart: undefined | ((...args: [event: Event]) => void);
        onPause: undefined | ((...args: [event: Event]) => void);
        onPlay: undefined | ((...args: [event: Event]) => void);
        onPlaying: undefined | ((...args: [event: Event]) => void);
        onProgress: undefined | ((...args: [event: Event]) => void);
        onRatechange: undefined | ((...args: [event: Event]) => void);
        onResize: undefined | ((...args: [event: Event]) => void);
        onSeeked: undefined | ((...args: [event: Event]) => void);
        onSeeking: undefined | ((...args: [event: Event]) => void);
        onStalled: undefined | ((...args: [event: Event]) => void);
        onSuspend: undefined | ((...args: [event: Event]) => void);
        onTimeupdate: undefined | ((...args: [event: Event]) => void);
        onViewenter: undefined | ((...args: []) => void);
        onViewleave: undefined | ((...args: []) => void);
        onVolumechange: undefined | ((...args: [event: Event]) => void);
        onWaiting: undefined | ((...args: [event: Event]) => void);
        onWaitingforkey: undefined | ((...args: [event: Event]) => void);
    };
    muted?: Ref<boolean, boolean>;
    options?: MaybeRef<undefined | PlayerOptions>;
    paused?: Ref<boolean, boolean>;
    player?: MaybeRef<undefined | Player>;
    readyState?: Ref<number, number>;
    subtitles?: Ref<TextTrack[], TextTrack[]>;
    volume?: Ref<number, number>;
}

Hierarchy (view full)

Properties

currentSubtitles? currentTime? element? emit? fullscreen? keepAlive? listeners? muted? options? paused? player? readyState? subtitles? volume?

Properties

OptionalcurrentSubtitles

currentSubtitles?: Ref<undefined | TextTrack, undefined | TextTrack>

Optional currentSubtitles model that reads and controls the player state

Default

undefined

OptionalcurrentTime

currentTime?: Ref<number, number>

Optional currentTime model that reads and controls the player state

Default

undefined

Optionalelement

element?: MaybeRef<undefined | HTMLElement>

Optional container element ref returned by the composables, fallbacks to an empty ref

Default

undefined

Optionalemit

emit?: (<Type>(type: Type, ...args: PlayerEvents[Type]) => void)

Default event listener, called for all events

Default

undefined

Optionalfullscreen

fullscreen?: Ref<boolean, boolean>

Optional fullscreen model that reads and controls the player state

Default

undefined

OptionalkeepAlive

keepAlive?: MaybeRef<boolean>

Wether to keep the player instance alive after the component is unmounted. It can then be manually destroyed by calling UsePlayerContext.destroy. This can be useful to keep the player instance alive during vue leave transitions.

Default

false

Optionallisteners

listeners?: {
    onAbort: undefined | ((...args: [event: Event]) => void);
    onCanplay: undefined | ((...args: [event: Event]) => void);
    onCanplaythrough: undefined | ((...args: [event: Event]) => void);
    onDurationchange: undefined | ((...args: [event: Event]) => void);
    onEmptied: undefined | ((...args: [event: Event]) => void);
    onEncrypted: undefined | ((...args: [event: Event]) => void);
    onEnded: undefined | ((...args: [event: Event]) => void);
    onEnterpictureinpicture: undefined | ((...args: [event: PictureInPictureEvent]) => void);
    onError: undefined | ((...args: [event: Event]) => void);
    onFcplayerConfigChanged: undefined | ((...args: [event: {
        key: string;
        value: any;
    } | {
        changes: {
            [key: string]: any;
        };
    }]) => void);
    onFcplayerCountdownDisabled: undefined | ((...args: []) => void);
    onFcplayerCountdownEnabled: undefined | ((...args: []) => void);
    onFcplayerCountdownTick: undefined | ((...args: [event: {
        remaining: number;
    }]) => void);
    onFcplayerCountdownZero: undefined | ((...args: []) => void);
    onFcplayerDestroy: undefined | ((...args: []) => void);
    onFcplayerSrcChanged: undefined | ((...args: [event: {
        src: any;
    }]) => void);
    onFullscreenenter: undefined | ((...args: []) => void);
    onFullscreenexit: undefined | ((...args: []) => void);
    onLeavepictureinpicture: undefined | ((...args: [event: PictureInPictureEvent]) => void);
    onLoad: undefined | ((...args: [event: Event]) => void);
    onLoadeddata: undefined | ((...args: [event: Event]) => void);
    onLoadedmetadata: undefined | ((...args: [event: Event]) => void);
    onLoadstart: undefined | ((...args: [event: Event]) => void);
    onPause: undefined | ((...args: [event: Event]) => void);
    onPlay: undefined | ((...args: [event: Event]) => void);
    onPlaying: undefined | ((...args: [event: Event]) => void);
    onProgress: undefined | ((...args: [event: Event]) => void);
    onRatechange: undefined | ((...args: [event: Event]) => void);
    onResize: undefined | ((...args: [event: Event]) => void);
    onSeeked: undefined | ((...args: [event: Event]) => void);
    onSeeking: undefined | ((...args: [event: Event]) => void);
    onStalled: undefined | ((...args: [event: Event]) => void);
    onSuspend: undefined | ((...args: [event: Event]) => void);
    onTimeupdate: undefined | ((...args: [event: Event]) => void);
    onViewenter: undefined | ((...args: []) => void);
    onViewleave: undefined | ((...args: []) => void);
    onVolumechange: undefined | ((...args: [event: Event]) => void);
    onWaiting: undefined | ((...args: [event: Event]) => void);
    onWaitingforkey: undefined | ((...args: [event: Event]) => void);
}

Event listeners

Default

undefined

Optionalmuted

muted?: Ref<boolean, boolean>

Optional muted model that reads and controls the player state

Default

undefined

Optionaloptions

options?: MaybeRef<undefined | PlayerOptions>

Freecaster player options

Default

undefined

Optionalpaused

paused?: Ref<boolean, boolean>

Optional paused model that reads and controls the player state

Default

undefined

Optionalplayer

player?: MaybeRef<undefined | Player>

Optional player model returned by the composable, fallbacks to an empty ref

Default

undefined

OptionalreadyState

readyState?: Ref<number, number>

Optional readyState model that only reads the player state

Default

undefined

Optionalsubtitles

subtitles?: Ref<TextTrack[], TextTrack[]>

Optional subtitles model that only reads the player state

Default

undefined

Optionalvolume

volume?: Ref<number, number>

Optional volume model that reads and controls the player state

Default

undefined

Settings

Member Visibility

On This Page

Properties