Interface UsePlayerParameters

interface UsePlayerParameters {
    currentTime?: Ref<number, number>;
    element?: MaybeRef<undefined | HTMLElement>;
    emit?: (<Type>(type: Type, ...args: PlayerEvents[Type]) => void);
    enabled?: MaybeRefOrGetter<undefined | boolean>;
    fullscreen?: Ref<boolean, 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);
        onFcplayerCountdownDisabled: undefined | ((...args: [event: Event]) => void);
        onFcplayerCountdownEnabled: undefined | ((...args: [event: Event]) => void);
        onFcplayerCountdownTick: undefined | ((...args: [event: Event]) => void);
        onFcplayerCountdownZero: undefined | ((...args: [event: Event]) => void);
        onFcplayerDestroy: undefined | ((...args: [event: Event]) => void);
        onFcplayerSrcChanged: undefined | ((...args: [event: Event]) => void);
        onFullscreenenter: undefined | ((...args: [event: Event]) => void);
        onFullscreenexit: undefined | ((...args: [event: Event]) => 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: [event: Event]) => void);
        onViewleave: undefined | ((...args: [event: Event]) => 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>;
    volume?: Ref<number, number>;
}

Properties

currentTime? element? emit? enabled? fullscreen? listeners? muted? options? paused? player? readyState? volume?

Properties

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

Optionalenabled

enabled?: MaybeRefOrGetter<undefined | boolean>

Wether the player is enabled

Default

true

Optionalfullscreen

fullscreen?: Ref<boolean, boolean>

Optional fullscreen model that reads and controls the player state

Default

undefined

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);
    onFcplayerCountdownDisabled: undefined | ((...args: [event: Event]) => void);
    onFcplayerCountdownEnabled: undefined | ((...args: [event: Event]) => void);
    onFcplayerCountdownTick: undefined | ((...args: [event: Event]) => void);
    onFcplayerCountdownZero: undefined | ((...args: [event: Event]) => void);
    onFcplayerDestroy: undefined | ((...args: [event: Event]) => void);
    onFcplayerSrcChanged: undefined | ((...args: [event: Event]) => void);
    onFullscreenenter: undefined | ((...args: [event: Event]) => void);
    onFullscreenexit: undefined | ((...args: [event: Event]) => 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: [event: Event]) => void);
    onViewleave: undefined | ((...args: [event: Event]) => 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

Optionalvolume

volume?: Ref<number, number>

Optional volume model that reads and controls the player state

Default

undefined

Settings

Member Visibility

On This Page

Properties