@aidenlx/player/types/media/request.events.d.ts

Headless web components that make integrating media on the a web a breeze.

import { VdsEvent } from '@vidstack/foundation';
export declare type MediaRequestEvents = {
    'vds-mute-request': MuteRequestEvent;
    'vds-unmute-request': UnmuteRequestEvent;
    'vds-enter-fullscreen-request': EnterFullscreenRequestEvent;
    'vds-exit-fullscreen-request': ExitFullscreenRequestEvent;
    'vds-play-request': PlayRequestEvent;
    'vds-pause-request': PauseRequestEvent;
    'vds-seek-request': SeekRequestEvent;
    'vds-seeking-request': SeekingRequestEvent;
    'vds-volume-change-request': VolumeChangeRequestEvent;
    'vds-resume-idling-request': ResumeIdlingRequestEvent;
    'vds-pause-idling-request': PauseIdlingRequestEvent;
    'vds-show-poster-request': ShowPosterRequestEvent;
    'vds-hide-poster-request': HidePosterRequestEvent;
    'vds-loop-request': LoopRequestEvent;
};
export declare type PendingMediaRequests = {
    play: PlayRequestEvent[];
    pause: PauseRequestEvent[];
    volume: (MuteRequestEvent | UnmuteRequestEvent | VolumeChangeRequestEvent)[];
    fullscreen: (EnterFullscreenRequestEvent | ExitFullscreenRequestEvent)[];
    seeked: SeekRequestEvent[];
    seeking: SeekingRequestEvent[];
    idle: (ResumeIdlingRequestEvent | PauseIdlingRequestEvent)[];
};
/**
 * Fired when requesting the media to be muted.
 *
 * @event
 * @bubbles
 * @composed
 */
export declare type MuteRequestEvent = VdsEvent<void>;
/**
 * Fired when requesting the media to be unmuted.
 *
 * @event
 * @bubbles
 * @composed
 */
export declare type UnmuteRequestEvent = VdsEvent<void>;
/**
 * Fired when requesting media to enter fullscreen.
 *
 * @event
 * @bubbles
 * @composed
 */
export declare type EnterFullscreenRequestEvent = VdsEvent<void>;
/**
 * Fired when requesting media to exit fullscreen.
 *
 * @event
 * @bubbles
 * @composed
 */
export declare type ExitFullscreenRequestEvent = VdsEvent<void>;
/**
 * Fired when requesting media playback to begin/resume.
 *
 * @event
 * @bubbles
 * @composed
 */
export declare type PlayRequestEvent = VdsEvent<void>;
/**
 * Fired when requesting media playback to temporarily stop.
 *
 * @event
 * @bubbles
 * @composed
 */
export declare type PauseRequestEvent = VdsEvent<void>;
/**
 * Fired when requesting a time change. In other words, moving the playhead to a new position.
 *
 * @event
 * @bubbles
 * @composed
 */
export declare type SeekRequestEvent = VdsEvent<number>;
/**
 * Fired when seeking/scrubbing to a new playback position.
 *
 * @event
 * @bubbles
 * @composed
 */
export declare type SeekingRequestEvent = VdsEvent<number>;
/**
 * Fired when requesting the media volume to be set to a new level.
 *
 * @event
 * @bubbles
 * @composed
 */
export declare type VolumeChangeRequestEvent = VdsEvent<number>;
/**
 * Fired when media idle state tracking may resume.
 *
 * @event
 * @bubbles
 * @composed
 */
export declare type ResumeIdlingRequestEvent = VdsEvent<void>;
/**
 * Fired when media idle state tracking should pause. This is typically used when a control
 * is being actively interacted with, and we don't want the media `idle` state changing until
 * the interaction is complete (eg: scrubbing, or settings is open).
 *
 * @event
 * @bubbles
 * @composed
 */
export declare type PauseIdlingRequestEvent = VdsEvent<void>;
/**
 * Fired when requesting the poster _should_ be rendered by the media provider element. This
 * should be fired if a custom poster element is _not_ being used.
 *
 * @event
 * @bubbles
 * @composed
 */
export declare type ShowPosterRequestEvent = VdsEvent<void>;
/**
 * Fired when requesting the poster should _not_ be rendered by the media provider element. This
 * should be fired if a custom poster element is being used (eg: `vds-poster`).
 *
 * @event
 * @bubbles
 * @composed
 */
export declare type HidePosterRequestEvent = VdsEvent<void>;
/**
 * Internal event that is fired by a media provider when requesting media playback to restart after
 * reaching the end. This event also helps notify the media controller that media will be looping.
 *
 * @internal
 * @event
 * @bubbles
 * @composed
 */
export declare type LoopRequestEvent = VdsEvent<void>;
//# sourceMappingURL=request.events.d.ts.map