aboutsummaryrefslogtreecommitdiffstats
path: root/src/js/plyr.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'src/js/plyr.d.ts')
-rw-r--r--src/js/plyr.d.ts952
1 files changed, 476 insertions, 476 deletions
diff --git a/src/js/plyr.d.ts b/src/js/plyr.d.ts
index d68935b2..6c466002 100644
--- a/src/js/plyr.d.ts
+++ b/src/js/plyr.d.ts
@@ -7,614 +7,614 @@ export = Plyr;
export as namespace Plyr;
declare class Plyr {
+ /**
+ * Setup a new instance
+ */
+ static setup(targets: NodeList | HTMLElement | HTMLElement[] | string, options?: Plyr.Options): Plyr[];
+
+ /**
+ * Check for support
+ * @param mediaType
+ * @param provider
+ * @param playsInline Whether the player has the playsinline attribute (only applicable to iOS 10+)
+ */
+ static supported(mediaType?: Plyr.MediaType, provider?: Plyr.Provider, playsInline?: boolean): Plyr.Support;
+
+ constructor(targets: NodeList | HTMLElement | HTMLElement[] | string, options?: Plyr.Options);
+
+ /**
+ * Indicates if the current player is HTML5.
+ */
+ readonly isHTML5: boolean;
+
+ /**
+ * Indicates if the current player is an embedded player.
+ */
+ readonly isEmbed: boolean;
+
+ /**
+ * Indicates if the current player is playing.
+ */
+ readonly playing: boolean;
+
+ /**
+ * Indicates if the current player is paused.
+ */
+ readonly paused: boolean;
+
+ /**
+ * Indicates if the current player is stopped.
+ */
+ readonly stopped: boolean;
+
+ /**
+ * Indicates if the current player has finished playback.
+ */
+ readonly ended: boolean;
+
+ /**
+ * Returns a float between 0 and 1 indicating how much of the media is buffered
+ */
+ readonly buffered: number;
+
+ /**
+ * Gets or sets the currentTime for the player. The setter accepts a float in seconds.
+ */
+ currentTime: number;
+
+ /**
+ * Indicates if the current player is seeking.
+ */
+ readonly seeking: boolean;
+
+ /**
+ * Returns the duration for the current media.
+ */
+ readonly duration: number;
+
+ /**
+ * Gets or sets the volume for the player. The setter accepts a float between 0 and 1.
+ */
+ volume: number;
+
+ /**
+ * Gets or sets the muted state of the player. The setter accepts a boolean.
+ */
+ muted: boolean;
+
+ /**
+ * Indicates if the current media has an audio track.
+ */
+ readonly hasAudio: boolean;
+
+ /**
+ * Gets or sets the speed for the player. The setter accepts a value in the options specified in your config. Generally the minimum should be 0.5.
+ */
+ speed: number;
+
+ /**
+ * Gets or sets the quality for the player. The setter accepts a value from the options specified in your config.
+ */
+ quality: number;
+
+ /**
+ * Gets or sets the current loop state of the player.
+ */
+ loop: boolean;
+
+ /**
+ * Gets or sets the current source for the player.
+ */
+ source: Plyr.SourceInfo;
+
+ /**
+ * Gets or sets the current poster image URL for the player.
+ */
+ poster: string;
+
+ /**
+ * Gets or sets the autoplay state of the player.
+ */
+ autoplay: boolean;
+
+ /**
+ * Gets or sets the caption track by index. 1 means the track is missing or captions is not active
+ */
+ currentTrack: number;
+
+ /**
+ * Gets or sets the preferred captions language for the player. The setter accepts an ISO twoletter language code. Support for the languages is dependent on the captions you include.
+ * If your captions don't have any language data, or if you have multiple tracks with the same language, you may want to use currentTrack instead.
+ */
+ language: string;
+
+ /**
+ * Gets or sets the picture-in-picture state of the player. This currently only supported on Safari 10+ on MacOS Sierra+ and iOS 10+.
+ */
+ pip: boolean;
+
+ /**
+ * Gets or sets the aspect ratio for embedded players.
+ */
+ ratio?: string;
+
+ /**
+ * Returns the current video Provider
+ */
+ readonly provider: 'html5' | 'vimeo' | 'youtube';
+
+ /**
+ * Returns the native API for Vimeo or Youtube players
+ */
+ readonly embed?: any;
+
+ readonly fullscreen: Plyr.FullscreenControl;
+
+ /**
+ * Start playback.
+ * For HTML5 players, play() will return a Promise in some browsers - WebKit and Mozilla according to MDN at time of writing.
+ */
+ play(): Promise<void> | void;
+
+ /**
+ * Pause playback.
+ */
+ pause(): void;
+
+ /**
+ * Toggle playback, if no parameters are passed, it will toggle based on current status.
+ */
+ togglePlay(toggle?: boolean): boolean;
+
+ /**
+ * Stop playback and reset to start.
+ */
+ stop(): void;
+
+ /**
+ * Restart playback.
+ */
+ restart(): void;
+
+ /**
+ * Rewind playback by the specified seek time. If no parameter is passed, the default seek time will be used.
+ */
+ rewind(seekTime?: number): void;
+
+ /**
+ * Fast forward by the specified seek time. If no parameter is passed, the default seek time will be used.
+ */
+ forward(seekTime?: number): void;
+
+ /**
+ * Increase volume by the specified step. If no parameter is passed, the default step will be used.
+ */
+ increaseVolume(step?: number): void;
+
+ /**
+ * Increase volume by the specified step. If no parameter is passed, the default step will be used.
+ */
+ decreaseVolume(step?: number): void;
+
+ /**
+ * Toggle captions display. If no parameter is passed, it will toggle based on current status.
+ */
+ toggleCaptions(toggle?: boolean): void;
+
+ /**
+ * Trigger the airplay dialog on supported devices.
+ */
+ airplay(): void;
+
+ /**
+ * Toggle the controls (video only). Takes optional truthy value to force it on/off.
+ */
+ toggleControls(toggle: boolean): void;
+
+ /**
+ * Add an event listener for the specified event.
+ */
+ on(
+ event: Plyr.StandardEvent | Plyr.Html5Event | Plyr.YoutubeEvent,
+ callback: (this: this, event: Plyr.PlyrEvent) => void,
+ ): void;
+
+ /**
+ * Add an event listener for the specified event once.
+ */
+ once(
+ event: Plyr.StandardEvent | Plyr.Html5Event | Plyr.YoutubeEvent,
+ callback: (this: this, event: Plyr.PlyrEvent) => void,
+ ): void;
+
+ /**
+ * Remove an event listener for the specified event.
+ */
+ off(
+ event: Plyr.StandardEvent | Plyr.Html5Event | Plyr.YoutubeEvent,
+ callback: (this: this, event: Plyr.PlyrEvent) => void,
+ ): void;
+
+ /**
+ * Check support for a mime type.
+ */
+ supports(type: string): boolean;
+
+ /**
+ * Destroy lib instance
+ */
+ destroy(): void;
+}
+
+declare namespace Plyr {
+ type MediaType = 'audio' | 'video';
+ type Provider = 'html5' | 'youtube' | 'vimeo';
+ type StandardEvent =
+ | 'progress'
+ | 'playing'
+ | 'play'
+ | 'pause'
+ | 'timeupdate'
+ | 'volumechange'
+ | 'seeking'
+ | 'seeked'
+ | 'ratechange'
+ | 'ended'
+ | 'enterfullscreen'
+ | 'exitfullscreen'
+ | 'captionsenabled'
+ | 'captionsdisabled'
+ | 'languagechange'
+ | 'controlshidden'
+ | 'controlsshown'
+ | 'ready';
+ type Html5Event =
+ | 'loadstart'
+ | 'loadeddata'
+ | 'loadedmetadata'
+ | 'canplay'
+ | 'canplaythrough'
+ | 'stalled'
+ | 'waiting'
+ | 'emptied'
+ | 'cuechange'
+ | 'error';
+ type YoutubeEvent = 'statechange' | 'qualitychange' | 'qualityrequested';
+
+ interface FullscreenControl {
/**
- * Setup a new instance
+ * Indicates if the current player is in fullscreen mode.
*/
- static setup(targets: NodeList | HTMLElement | HTMLElement[] | string, options?: Plyr.Options): Plyr[];
+ readonly active: boolean;
/**
- * Check for support
- * @param mediaType
- * @param provider
- * @param playsInline Whether the player has the playsinline attribute (only applicable to iOS 10+)
+ * Indicates if the current player has fullscreen enabled.
*/
- static supported(mediaType?: Plyr.MediaType, provider?: Plyr.Provider, playsInline?: boolean): Plyr.Support;
+ readonly enabled: boolean;
- constructor(targets: NodeList | HTMLElement | HTMLElement[] | string, options?: Plyr.Options);
+ /**
+ * Enter fullscreen. If fullscreen is not supported, a fallback ""full window/viewport"" is used instead.
+ */
+ enter(): void;
/**
- * Indicates if the current player is HTML5.
+ * Exit fullscreen.
*/
- readonly isHTML5: boolean;
+ exit(): void;
/**
- * Indicates if the current player is an embedded player.
+ * Toggle fullscreen.
*/
- readonly isEmbed: boolean;
+ toggle(): void;
+ }
+ interface Options {
/**
- * Indicates if the current player is playing.
+ * Completely disable Plyr. This would allow you to do a User Agent check or similar to programmatically enable or disable Plyr for a certain UA. Example below.
*/
- readonly playing: boolean;
+ enabled?: boolean;
/**
- * Indicates if the current player is paused.
+ * Display debugging information in the console
*/
- readonly paused: boolean;
+ debug?: boolean;
/**
- * Indicates if the current player is stopped.
+ * If a function is passed, it is assumed your method will return either an element or HTML string for the controls. Three arguments will be passed to your function;
+ * id (the unique id for the player), seektime (the seektime step in seconds), and title (the media title). See controls.md for more info on how the html needs to be structured.
+ * Defaults to ['play-large', 'play', 'progress', 'current-time', 'mute', 'volume', 'captions', 'settings', 'pip', 'airplay', 'fullscreen']
*/
- readonly stopped: boolean;
+ controls?: string[] | ((id: string, seektime: number, title: string) => unknown) | Element;
/**
- * Indicates if the current player has finished playback.
+ * If you're using the default controls are used then you can specify which settings to show in the menu
+ * Defaults to ['captions', 'quality', 'speed', 'loop']
*/
- readonly ended: boolean;
+ settings?: string[];
/**
- * Returns a float between 0 and 1 indicating how much of the media is buffered
+ * Used for internationalization (i18n) of the text within the UI.
*/
- readonly buffered: number;
+ i18n?: any;
/**
- * Gets or sets the currentTime for the player. The setter accepts a float in seconds.
+ * Load the SVG sprite specified as the iconUrl option (if a URL). If false, it is assumed you are handling sprite loading yourself.
*/
- currentTime: number;
+ loadSprite?: boolean;
/**
- * Indicates if the current player is seeking.
+ * Specify a URL or path to the SVG sprite. See the SVG section for more info.
*/
- readonly seeking: boolean;
+ iconUrl?: string;
/**
- * Returns the duration for the current media.
+ * Specify the id prefix for the icons used in the default controls (e.g. plyr-play would be plyr).
+ * This is to prevent clashes if you're using your own SVG sprite but with the default controls.
+ * Most people can ignore this option.
*/
- readonly duration: number;
+ iconPrefix?: string;
/**
- * Gets or sets the volume for the player. The setter accepts a float between 0 and 1.
+ * Specify a URL or path to a blank video file used to properly cancel network requests.
*/
- volume: number;
+ blankUrl?: string;
/**
- * Gets or sets the muted state of the player. The setter accepts a boolean.
+ * Autoplay the media on load. This is generally advised against on UX grounds. It is also disabled by default in some browsers.
+ * If the autoplay attribute is present on a <video> or <audio> element, this will be automatically set to true.
*/
- muted: boolean;
+ autoplay?: boolean;
/**
- * Indicates if the current media has an audio track.
+ * Only allow one player playing at once.
*/
- readonly hasAudio: boolean;
+ autopause?: boolean;
/**
- * Gets or sets the speed for the player. The setter accepts a value in the options specified in your config. Generally the minimum should be 0.5.
+ * The time, in seconds, to seek when a user hits fast forward or rewind.
*/
- speed: number;
+ seekTime?: number;
/**
- * Gets or sets the quality for the player. The setter accepts a value from the options specified in your config.
+ * A number, between 0 and 1, representing the initial volume of the player.
*/
- quality: number;
+ volume?: number;
/**
- * Gets or sets the current loop state of the player.
+ * Whether to start playback muted. If the muted attribute is present on a <video> or <audio> element, this will be automatically set to true.
*/
- loop: boolean;
+ muted?: boolean;
/**
- * Gets or sets the current source for the player.
+ * Click (or tap) of the video container will toggle play/pause.
*/
- source: Plyr.SourceInfo;
+ clickToPlay?: boolean;
/**
- * Gets or sets the current poster image URL for the player.
+ * Disable right click menu on video to help as very primitive obfuscation to prevent downloads of content.
*/
- poster: string;
+ disableContextMenu?: boolean;
/**
- * Gets or sets the autoplay state of the player.
+ * Hide video controls automatically after 2s of no mouse or focus movement, on control element blur (tab out), on playback start or entering fullscreen.
+ * As soon as the mouse is moved, a control element is focused or playback is paused, the controls reappear instantly.
*/
- autoplay: boolean;
+ hideControls?: boolean;
/**
- * Gets or sets the caption track by index. 1 means the track is missing or captions is not active
+ * Reset the playback to the start once playback is complete.
*/
- currentTrack: number;
+ resetOnEnd?: boolean;
/**
- * Gets or sets the preferred captions language for the player. The setter accepts an ISO twoletter language code. Support for the languages is dependent on the captions you include.
- * If your captions don't have any language data, or if you have multiple tracks with the same language, you may want to use currentTrack instead.
+ * Enable keyboard shortcuts for focused players only or globally
*/
- language: string;
+ keyboard?: KeyboardOptions;
/**
- * Gets or sets the picture-in-picture state of the player. This currently only supported on Safari 10+ on MacOS Sierra+ and iOS 10+.
+ * controls: Display control labels as tooltips on :hover & :focus (by default, the labels are screen reader only).
+ * seek: Display a seek tooltip to indicate on click where the media would seek to.
*/
- pip: boolean;
+ tooltips?: TooltipOptions;
/**
- * Gets or sets the aspect ratio for embedded players.
+ * Specify a custom duration for media.
*/
- ratio?: string;
+ duration?: number;
/**
- * Returns the current video Provider
+ * Displays the duration of the media on the metadataloaded event (on startup) in the current time display.
+ * This will only work if the preload attribute is not set to none (or is not set at all) and you choose not to display the duration (see controls option).
*/
- readonly provider: 'html5' | 'vimeo' | 'youtube';
+ displayDuration?: boolean;
/**
- * Returns the native API for Vimeo or Youtube players
+ * Display the current time as a countdown rather than an incremental counter.
*/
- readonly embed?: any;
+ invertTime?: boolean;
- readonly fullscreen: Plyr.FullscreenControl;
+ /**
+ * Allow users to click to toggle the above.
+ */
+ toggleInvert?: boolean;
/**
- * Start playback.
- * For HTML5 players, play() will return a Promise in some browsers - WebKit and Mozilla according to MDN at time of writing.
+ * Allows binding of event listeners to the controls before the default handlers. See the defaults.js for available listeners.
+ * If your handler prevents default on the event (event.preventDefault()), the default handler will not fire.
*/
- play(): Promise<void> | void;
+ listeners?: { [key: string]: (error: PlyrEvent) => void };
/**
- * Pause playback.
+ * active: Toggles if captions should be active by default. language: Sets the default language to load (if available). 'auto' uses the browser language.
+ * update: Listen to changes to tracks and update menu. This is needed for some streaming libraries, but can result in unselectable language options).
*/
- pause(): void;
+ captions?: CaptionOptions;
/**
- * Toggle playback, if no parameters are passed, it will toggle based on current status.
+ * enabled: Toggles whether fullscreen should be enabled. fallback: Allow fallback to a full-window solution.
+ * iosNative: whether to use native iOS fullscreen when entering fullscreen (no custom controls)
*/
- togglePlay(toggle?: boolean): boolean;
+ fullscreen?: FullScreenOptions;
/**
- * Stop playback and reset to start.
+ * The aspect ratio you want to use for embedded players.
*/
- stop(): void;
+ ratio?: string;
+
+ /**
+ * enabled: Allow use of local storage to store user settings. key: The key name to use.
+ */
+ storage?: StorageOptions;
/**
- * Restart playback.
+ * selected: The default speed for playback. options: The speed options to display in the UI. YouTube and Vimeo will ignore any options outside of the 0.5-2 range, so options outside of this range will be hidden automatically.
*/
- restart(): void;
+ speed?: SpeedOptions;
/**
- * Rewind playback by the specified seek time. If no parameter is passed, the default seek time will be used.
+ * Currently only supported by YouTube. default is the default quality level, determined by YouTube. options are the options to display.
*/
- rewind(seekTime?: number): void;
+ quality?: QualityOptions;
/**
- * Fast forward by the specified seek time. If no parameter is passed, the default seek time will be used.
+ * active: Whether to loop the current video. If the loop attribute is present on a <video> or <audio> element,
+ * this will be automatically set to true This is an object to support future functionality.
*/
- forward(seekTime?: number): void;
+ loop?: LoopOptions;
/**
- * Increase volume by the specified step. If no parameter is passed, the default step will be used.
+ * enabled: Whether to enable vi.ai ads. publisherId: Your unique vi.ai publisher ID.
*/
- increaseVolume(step?: number): void;
+ ads?: AdOptions;
/**
- * Increase volume by the specified step. If no parameter is passed, the default step will be used.
+ * Vimeo Player Options.
*/
- decreaseVolume(step?: number): void;
+ vimeo?: object;
/**
- * Toggle captions display. If no parameter is passed, it will toggle based on current status.
+ * Youtube Player Options.
*/
- toggleCaptions(toggle?: boolean): void;
+ youtube?: object;
+ }
+
+ interface QualityOptions {
+ default: number;
+ options: number[];
+ }
+
+ interface LoopOptions {
+ active: boolean;
+ }
+
+ interface AdOptions {
+ enabled: boolean;
+ publisherId: string;
+ }
+
+ interface SpeedOptions {
+ selected: number;
+ options: number[];
+ }
+ interface KeyboardOptions {
+ focused?: boolean;
+ global?: boolean;
+ }
+
+ interface TooltipOptions {
+ controls?: boolean;
+ seek?: boolean;
+ }
+
+ interface FullScreenOptions {
+ enabled?: boolean;
+ fallback?: boolean;
+ allowAudio?: boolean;
+ iosNative?: boolean;
+ }
+
+ interface CaptionOptions {
+ active?: boolean;
+ language?: string;
+ update?: boolean;
+ }
+
+ interface StorageOptions {
+ enabled?: boolean;
+ key?: string;
+ }
+
+ interface SourceInfo {
/**
- * Trigger the airplay dialog on supported devices.
+ * Note: YouTube and Vimeo are currently not supported as audio sources.
*/
- airplay(): void;
+ type: MediaType;
/**
- * Toggle the controls (video only). Takes optional truthy value to force it on/off.
+ * Title of the new media. Used for the aria-label attribute on the play button, and outer container. YouTube and Vimeo are populated automatically.
*/
- toggleControls(toggle: boolean): void;
+ title?: string;
/**
- * Add an event listener for the specified event.
+ * This is an array of sources. For HTML5 media, the properties of this object are mapped directly to HTML attributes so more can be added to the object if required.
*/
- on(
- event: Plyr.StandardEvent | Plyr.Html5Event | Plyr.YoutubeEvent,
- callback: (this: this, event: Plyr.PlyrEvent) => void,
- ): void;
+ sources: Source[];
/**
- * Add an event listener for the specified event once.
+ * The URL for the poster image (HTML5 video only).
*/
- once(
- event: Plyr.StandardEvent | Plyr.Html5Event | Plyr.YoutubeEvent,
- callback: (this: this, event: Plyr.PlyrEvent) => void,
- ): void;
+ poster?: string;
/**
- * Remove an event listener for the specified event.
+ * An array of track objects. Each element in the array is mapped directly to a track element and any keys mapped directly to HTML attributes so as in the example above,
+ * it will render as <track kind="captions" label="English" srclang="en" src="https://cdn.selz.com/plyr/1.0/example_captions_en.vtt" default> and similar for the French version.
+ * Booleans are converted to HTML5 value-less attributes.
*/
- off(
- event: Plyr.StandardEvent | Plyr.Html5Event | Plyr.YoutubeEvent,
- callback: (this: this, event: Plyr.PlyrEvent) => void,
- ): void;
+ tracks?: Track[];
+ }
+ interface Source {
/**
- * Check support for a mime type.
+ * The URL of the media file (or YouTube/Vimeo URL).
*/
- supports(type: string): boolean;
+ src: string;
+ /**
+ * The MIME type of the media file (if HTML5).
+ */
+ type?: string;
+ provider?: Provider;
+ size?: number;
+ }
+ type TrackKind = 'subtitles' | 'captions' | 'descriptions' | 'chapters' | 'metadata';
+ interface Track {
/**
- * Destroy lib instance
+ * Indicates how the text track is meant to be used
*/
- destroy(): void;
-}
+ kind: TrackKind;
+ /**
+ * Indicates a user-readable title for the track
+ */
+ label: string;
+ /**
+ * The language of the track text data. It must be a valid BCP 47 language tag. If the kind attribute is set to subtitles, then srclang must be defined.
+ */
+ srcLang?: string;
+ /**
+ * The URL of the track (.vtt file).
+ */
+ src: string;
-declare namespace Plyr {
- type MediaType = 'audio' | 'video';
- type Provider = 'html5' | 'youtube' | 'vimeo';
- type StandardEvent =
- | 'progress'
- | 'playing'
- | 'play'
- | 'pause'
- | 'timeupdate'
- | 'volumechange'
- | 'seeking'
- | 'seeked'
- | 'ratechange'
- | 'ended'
- | 'enterfullscreen'
- | 'exitfullscreen'
- | 'captionsenabled'
- | 'captionsdisabled'
- | 'languagechange'
- | 'controlshidden'
- | 'controlsshown'
- | 'ready';
- type Html5Event =
- | 'loadstart'
- | 'loadeddata'
- | 'loadedmetadata'
- | 'canplay'
- | 'canplaythrough'
- | 'stalled'
- | 'waiting'
- | 'emptied'
- | 'cuechange'
- | 'error';
- type YoutubeEvent = 'statechange' | 'qualitychange' | 'qualityrequested';
-
- interface FullscreenControl {
- /**
- * Indicates if the current player is in fullscreen mode.
- */
- readonly active: boolean;
-
- /**
- * Indicates if the current player has fullscreen enabled.
- */
- readonly enabled: boolean;
-
- /**
- * Enter fullscreen. If fullscreen is not supported, a fallback ""full window/viewport"" is used instead.
- */
- enter(): void;
-
- /**
- * Exit fullscreen.
- */
- exit(): void;
-
- /**
- * Toggle fullscreen.
- */
- toggle(): void;
- }
-
- interface Options {
- /**
- * Completely disable Plyr. This would allow you to do a User Agent check or similar to programmatically enable or disable Plyr for a certain UA. Example below.
- */
- enabled?: boolean;
-
- /**
- * Display debugging information in the console
- */
- debug?: boolean;
-
- /**
- * If a function is passed, it is assumed your method will return either an element or HTML string for the controls. Three arguments will be passed to your function;
- * id (the unique id for the player), seektime (the seektime step in seconds), and title (the media title). See controls.md for more info on how the html needs to be structured.
- * Defaults to ['play-large', 'play', 'progress', 'current-time', 'mute', 'volume', 'captions', 'settings', 'pip', 'airplay', 'fullscreen']
- */
- controls?: string[] | ((id: string, seektime: number, title: string) => unknown) | Element;
-
- /**
- * If you're using the default controls are used then you can specify which settings to show in the menu
- * Defaults to ['captions', 'quality', 'speed', 'loop']
- */
- settings?: string[];
-
- /**
- * Used for internationalization (i18n) of the text within the UI.
- */
- i18n?: any;
-
- /**
- * Load the SVG sprite specified as the iconUrl option (if a URL). If false, it is assumed you are handling sprite loading yourself.
- */
- loadSprite?: boolean;
-
- /**
- * Specify a URL or path to the SVG sprite. See the SVG section for more info.
- */
- iconUrl?: string;
-
- /**
- * Specify the id prefix for the icons used in the default controls (e.g. plyr-play would be plyr).
- * This is to prevent clashes if you're using your own SVG sprite but with the default controls.
- * Most people can ignore this option.
- */
- iconPrefix?: string;
-
- /**
- * Specify a URL or path to a blank video file used to properly cancel network requests.
- */
- blankUrl?: string;
-
- /**
- * Autoplay the media on load. This is generally advised against on UX grounds. It is also disabled by default in some browsers.
- * If the autoplay attribute is present on a <video> or <audio> element, this will be automatically set to true.
- */
- autoplay?: boolean;
-
- /**
- * Only allow one player playing at once.
- */
- autopause?: boolean;
-
- /**
- * The time, in seconds, to seek when a user hits fast forward or rewind.
- */
- seekTime?: number;
-
- /**
- * A number, between 0 and 1, representing the initial volume of the player.
- */
- volume?: number;
-
- /**
- * Whether to start playback muted. If the muted attribute is present on a <video> or <audio> element, this will be automatically set to true.
- */
- muted?: boolean;
-
- /**
- * Click (or tap) of the video container will toggle play/pause.
- */
- clickToPlay?: boolean;
-
- /**
- * Disable right click menu on video to help as very primitive obfuscation to prevent downloads of content.
- */
- disableContextMenu?: boolean;
-
- /**
- * Hide video controls automatically after 2s of no mouse or focus movement, on control element blur (tab out), on playback start or entering fullscreen.
- * As soon as the mouse is moved, a control element is focused or playback is paused, the controls reappear instantly.
- */
- hideControls?: boolean;
-
- /**
- * Reset the playback to the start once playback is complete.
- */
- resetOnEnd?: boolean;
-
- /**
- * Enable keyboard shortcuts for focused players only or globally
- */
- keyboard?: KeyboardOptions;
-
- /**
- * controls: Display control labels as tooltips on :hover & :focus (by default, the labels are screen reader only).
- * seek: Display a seek tooltip to indicate on click where the media would seek to.
- */
- tooltips?: TooltipOptions;
-
- /**
- * Specify a custom duration for media.
- */
- duration?: number;
-
- /**
- * Displays the duration of the media on the metadataloaded event (on startup) in the current time display.
- * This will only work if the preload attribute is not set to none (or is not set at all) and you choose not to display the duration (see controls option).
- */
- displayDuration?: boolean;
-
- /**
- * Display the current time as a countdown rather than an incremental counter.
- */
- invertTime?: boolean;
-
- /**
- * Allow users to click to toggle the above.
- */
- toggleInvert?: boolean;
-
- /**
- * Allows binding of event listeners to the controls before the default handlers. See the defaults.js for available listeners.
- * If your handler prevents default on the event (event.preventDefault()), the default handler will not fire.
- */
- listeners?: { [key: string]: (error: PlyrEvent) => void };
-
- /**
- * active: Toggles if captions should be active by default. language: Sets the default language to load (if available). 'auto' uses the browser language.
- * update: Listen to changes to tracks and update menu. This is needed for some streaming libraries, but can result in unselectable language options).
- */
- captions?: CaptionOptions;
-
- /**
- * enabled: Toggles whether fullscreen should be enabled. fallback: Allow fallback to a full-window solution.
- * iosNative: whether to use native iOS fullscreen when entering fullscreen (no custom controls)
- */
- fullscreen?: FullScreenOptions;
-
- /**
- * The aspect ratio you want to use for embedded players.
- */
- ratio?: string;
-
- /**
- * enabled: Allow use of local storage to store user settings. key: The key name to use.
- */
- storage?: StorageOptions;
-
- /**
- * selected: The default speed for playback. options: The speed options to display in the UI. YouTube and Vimeo will ignore any options outside of the 0.5-2 range, so options outside of this range will be hidden automatically.
- */
- speed?: SpeedOptions;
-
- /**
- * Currently only supported by YouTube. default is the default quality level, determined by YouTube. options are the options to display.
- */
- quality?: QualityOptions;
-
- /**
- * active: Whether to loop the current video. If the loop attribute is present on a <video> or <audio> element,
- * this will be automatically set to true This is an object to support future functionality.
- */
- loop?: LoopOptions;
-
- /**
- * enabled: Whether to enable vi.ai ads. publisherId: Your unique vi.ai publisher ID.
- */
- ads?: AdOptions;
-
- /**
- * Vimeo Player Options.
- */
- vimeo?: object;
-
- /**
- * Youtube Player Options.
- */
- youtube?: object;
- }
-
- interface QualityOptions {
- default: number;
- options: number[];
- }
-
- interface LoopOptions {
- active: boolean;
- }
-
- interface AdOptions {
- enabled: boolean;
- publisherId: string;
- }
-
- interface SpeedOptions {
- selected: number;
- options: number[];
- }
-
- interface KeyboardOptions {
- focused?: boolean;
- global?: boolean;
- }
-
- interface TooltipOptions {
- controls?: boolean;
- seek?: boolean;
- }
-
- interface FullScreenOptions {
- enabled?: boolean;
- fallback?: boolean;
- allowAudio?: boolean;
- iosNative?: boolean;
- }
-
- interface CaptionOptions {
- active?: boolean;
- language?: string;
- update?: boolean;
- }
-
- interface StorageOptions {
- enabled?: boolean;
- key?: string;
- }
-
- interface SourceInfo {
- /**
- * Note: YouTube and Vimeo are currently not supported as audio sources.
- */
- type: MediaType;
-
- /**
- * Title of the new media. Used for the aria-label attribute on the play button, and outer container. YouTube and Vimeo are populated automatically.
- */
- title?: string;
-
- /**
- * This is an array of sources. For HTML5 media, the properties of this object are mapped directly to HTML attributes so more can be added to the object if required.
- */
- sources: Source[];
-
- /**
- * The URL for the poster image (HTML5 video only).
- */
- poster?: string;
-
- /**
- * An array of track objects. Each element in the array is mapped directly to a track element and any keys mapped directly to HTML attributes so as in the example above,
- * it will render as <track kind="captions" label="English" srclang="en" src="https://cdn.selz.com/plyr/1.0/example_captions_en.vtt" default> and similar for the French version.
- * Booleans are converted to HTML5 value-less attributes.
- */
- tracks?: Track[];
- }
-
- interface Source {
- /**
- * The URL of the media file (or YouTube/Vimeo URL).
- */
- src: string;
- /**
- * The MIME type of the media file (if HTML5).
- */
- type?: string;
- provider?: Provider;
- size?: number;
- }
-
- type TrackKind = 'subtitles' | 'captions' | 'descriptions' | 'chapters' | 'metadata';
- interface Track {
- /**
- * Indicates how the text track is meant to be used
- */
- kind: TrackKind;
- /**
- * Indicates a user-readable title for the track
- */
- label: string;
- /**
- * The language of the track text data. It must be a valid BCP 47 language tag. If the kind attribute is set to subtitles, then srclang must be defined.
- */
- srcLang?: string;
- /**
- * The URL of the track (.vtt file).
- */
- src: string;
-
- default?: boolean;
- }
-
- interface PlyrEvent extends CustomEvent {
- readonly detail: { readonly plyr: Plyr };
- }
-
- interface Support {
- api: boolean;
- ui: boolean;
- }
+ default?: boolean;
+ }
+
+ interface PlyrEvent extends CustomEvent {
+ readonly detail: { readonly plyr: Plyr };
+ }
+
+ interface Support {
+ api: boolean;
+ ui: boolean;
+ }
}
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-07 02:32:42 +0000