@aidenlx/player
Version:
Headless web components that make integrating media on the a web a breeze.
46 lines • 1.67 kB
TypeScript
import { DiscoveryEvent, FullscreenController } from '@vidstack/foundation';
import { CSSResultGroup, LitElement, TemplateResult } from 'lit';
import { MediaController } from './MediaController';
/**
* Fired when the media controller connects to the DOM.
*
* @event
* @bubbles
* @composed
*/
export declare type MediaControllerConnectEvent = DiscoveryEvent<MediaControllerElement>;
/**
* The media controller acts as a message bus between the media provider and all other
* components, such as UI components and plugins. The main responsibilities are:
*
* - Provide the media context that is used to pass media state down to components (this
* context is injected into and managed by the media provider).
*
* - Listen for media request events and fulfill them by calling the appropriate props/methods on
* the current media provider.
*
* 💡 The base `MediaPlayer` acts as both a media controller and provider.
*
* @tagname vds-media-controller
* @slot - Used to pass in components that use/manage media state.
* @example
* ```html
* <vds-media-controller>
* <vds-video-player>
* <!-- UI components here. -->
* </vds-video-player>
*
* <!-- Other components that use/manage media state here. -->
* </vds-media-controller>
* ```
*/
export declare class MediaControllerElement extends LitElement {
static get styles(): CSSResultGroup;
constructor();
readonly controller: MediaController;
protected render(): TemplateResult;
readonly fullscreenController: FullscreenController;
requestFullscreen(): Promise<void>;
exitFullscreen(): Promise<void>;
}
//# sourceMappingURL=MediaControllerElement.d.ts.map