Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@types/vimeo__player
Advanced tools
@types/vimeo__player - npm Package Compare versions
Comparing version 2.16.3 to 2.18.0
@@ -1,2 +0,2 @@ | ||
| // Type definitions for @vimeo/player 2.16.4 | ||
| // Type definitions for @vimeo/player 2.18 | ||
| // Project: https://github.com/vimeo/player.js | ||
@@ -12,407 +12,365 @@ // Definitions by: Denis Yılmaz <https://github.com/denisyilmaz> | ||
| export type TrackKind = 'captions' | 'subtitles'; | ||
| declare namespace Vimeo { | ||
| namespace Player { | ||
| export type TrackKind = 'captions' | 'subtitles'; | ||
| export type CallbackFunction = (...args: any[]) => any; | ||
| export interface Error { | ||
| name: string; | ||
| message: string; | ||
| method: string; | ||
| } | ||
| export interface Error { | ||
| name: string; | ||
| message: string; | ||
| method: string; | ||
| } | ||
| export interface TimeEvent { | ||
| duration: number; | ||
| percent: number; | ||
| seconds: number; | ||
| } | ||
| export interface PasswordError extends Error { | ||
| name: 'PasswordError'; | ||
| message: string; | ||
| method: string; | ||
| } | ||
| export interface PrivacyError extends Error { | ||
| name: 'PrivacyError'; | ||
| message: string; | ||
| method: string; | ||
| } | ||
| export interface InvalidTrackLanguageError extends Error { | ||
| name: 'InvalidTrackLanguageError'; | ||
| message: string; | ||
| method: string; | ||
| } | ||
| export interface InvalidTrackError extends Error { | ||
| name: 'InvalidTrackError'; | ||
| message: string; | ||
| method: string; | ||
| } | ||
| export interface UnsupportedError extends Error { | ||
| name: 'UnsupportedError'; | ||
| message: string; | ||
| method: string; | ||
| } | ||
| export interface ContrastError extends Error { | ||
| name: 'ContrastError'; | ||
| message: string; | ||
| method: string; | ||
| } | ||
| export interface InvalidCuePoint extends Error { | ||
| name: 'InvalidCuePoint'; | ||
| message: string; | ||
| method: string; | ||
| } | ||
| export interface RangeError extends Error { | ||
| name: 'RangeError'; | ||
| message: string; | ||
| method: string; | ||
| } | ||
| export interface TypeError extends Error { | ||
| name: 'TypeError'; | ||
| message: string; | ||
| method: string; | ||
| } | ||
| export interface TextTrackChangeEvent { | ||
| kind: TrackKind | null; | ||
| label: string | null; | ||
| language: string | null; | ||
| } | ||
| export interface TimeEvent { | ||
| duration: number; | ||
| percent: number; | ||
| seconds: number; | ||
| } | ||
| export interface VimeoChapter { | ||
| startTime: number; | ||
| title: string; | ||
| export interface TextTrackChangeEvent { | ||
| kind: TrackKind | null; | ||
| label: string | null; | ||
| language: string | null; | ||
| } | ||
| /** | ||
| * The `index` property of each chapter is the place it holds in the order of all the chapters. It starts at 1. | ||
| */ | ||
| index: number; | ||
| } | ||
| export interface VimeoChapter { | ||
| startTime: number; | ||
| title: string; | ||
| export interface Cue { | ||
| /** | ||
| * The `html` property contains the HTML that the Player renders for that cue. | ||
| */ | ||
| html: string; | ||
| /** | ||
| * The `index` property of each chapter is the place it holds in the order of all the chapters. It starts at 1. | ||
| */ | ||
| index: number; | ||
| } | ||
| /** | ||
| * The `text` property of each cue is the raw value parsed from the caption or subtitle file. | ||
| */ | ||
| text: string; | ||
| } | ||
| export interface Cue { | ||
| /** | ||
| * The `html` property contains the HTML that the Player renders for that cue. | ||
| */ | ||
| html: string; | ||
| export interface CueChangeEvent { | ||
| cues: Cue[]; | ||
| kind: TrackKind; | ||
| label: string; | ||
| language: string; | ||
| } | ||
| /** | ||
| * The `text` property of each cue is the raw value parsed from the caption or subtitle file. | ||
| */ | ||
| text: string; | ||
| } | ||
| export interface CuePointEvent { | ||
| time: number; | ||
| export interface CueChangeEvent { | ||
| cues: Cue[]; | ||
| kind: TrackKind; | ||
| label: string; | ||
| language: string; | ||
| } | ||
| /** | ||
| * The `data` property will be the custom data provided in the `addCuePoint()` call, or an empty object if none was provided. | ||
| */ | ||
| data: VimeoCuePointData; | ||
| id: string; | ||
| } | ||
| export interface CuePointEvent { | ||
| time: number; | ||
| export interface VolumeChangeEvent { | ||
| volume: number; | ||
| } | ||
| /** | ||
| * The `data` property will be the custom data provided in the `addCuePoint()` call, or an empty object if none was provided. | ||
| */ | ||
| data: VimeoCuePointData; | ||
| id: string; | ||
| } | ||
| export interface PlaybackRateEvent { | ||
| playbackRate: number; | ||
| } | ||
| export interface VolumeChangeEvent { | ||
| volume: number; | ||
| } | ||
| export interface LoadedEvent { | ||
| id: number; | ||
| } | ||
| export interface PlaybackRateEvent { | ||
| playbackRate: number; | ||
| } | ||
| export interface DurationChangeEvent { | ||
| duration: number; | ||
| } | ||
| export interface LoadedEvent { | ||
| id: number; | ||
| } | ||
| export interface FullScreenChangeEvent { | ||
| fullscreen: boolean; | ||
| } | ||
| export interface DurationChangeEvent { | ||
| duration: number; | ||
| } | ||
| export interface VimeoVideoQualityObject { | ||
| label: string; | ||
| id: string; | ||
| active: boolean; | ||
| } | ||
| export interface FullScreenChangeEvent { | ||
| fullscreen: boolean; | ||
| } | ||
| export interface QualityChangeEvent { | ||
| quality: VimeoVideoQuality; | ||
| } | ||
| export interface VimeoVideoQualityObject { | ||
| label: string; | ||
| id: string; | ||
| active: boolean; | ||
| } | ||
| export interface VimeoCameraProps { | ||
| yaw: number; | ||
| pitch: number; | ||
| roll: number; | ||
| fov: number; | ||
| } | ||
| export interface QualityChangeEvent { | ||
| quality: VimeoVideoQuality; | ||
| } | ||
| export interface ResizeEvent { | ||
| videoWidth: number; | ||
| videoHeight: number; | ||
| } | ||
| export interface VimeoCameraProps { | ||
| yaw: number; | ||
| pitch: number; | ||
| roll: number; | ||
| fov: number; | ||
| } | ||
| export interface EventMap { | ||
| /** | ||
| * Triggered when video playback is initiated. | ||
| */ | ||
| play: TimeEvent; | ||
| export interface ResizeEvent { | ||
| videoWidth: number; | ||
| videoHeight: number; | ||
| } | ||
| /** | ||
| * Triggered when the video starts playing. | ||
| */ | ||
| playing: TimeEvent; | ||
| export interface EventMap { | ||
| /** | ||
| * Triggered when video playback is initiated. | ||
| */ | ||
| play: TimeEvent; | ||
| /** | ||
| * Triggered when the video pauses. | ||
| */ | ||
| pause: TimeEvent; | ||
| /** | ||
| * Triggered when the video starts playing. | ||
| */ | ||
| playing: TimeEvent; | ||
| /** | ||
| * Triggered any time the video playback reaches the end. _Note_: when loop is turned on, the ended `event` will not fire. | ||
| */ | ||
| ended: TimeEvent; | ||
| /** | ||
| * Triggered when the video pauses. | ||
| */ | ||
| pause: TimeEvent; | ||
| /** | ||
| * Triggered as the `currentTime` of the video updates. It generally fires every 250ms, but it may vary depending on the browser. | ||
| */ | ||
| timeupdate: TimeEvent; | ||
| /** | ||
| * Triggered any time the video playback reaches the end. _Note_: when loop is turned on, the ended `event` will not fire. | ||
| */ | ||
| ended: TimeEvent; | ||
| /** | ||
| * Triggered as the video is loaded. Reports back the amount of the video that has been buffered. | ||
| */ | ||
| progress: TimeEvent; | ||
| /** | ||
| * Triggered as the `currentTime` of the video updates. It generally fires every 250ms, but it may vary depending on the browser. | ||
| */ | ||
| timeupdate: TimeEvent; | ||
| /** | ||
| * Triggered when the player starts seeking to a specific time. A `timeupdate` event will also be fired at the same time. | ||
| */ | ||
| seeking: TimeEvent; | ||
| /** | ||
| * Triggered as the video is loaded. Reports back the amount of the video that has been buffered. | ||
| */ | ||
| progress: TimeEvent; | ||
| /** | ||
| * Triggered when the player seeks to a specific time. A `timeupdate` event will also be fired at the same time. | ||
| */ | ||
| seeked: TimeEvent; | ||
| /** | ||
| * Triggered when the player starts seeking to a specific time. A `timeupdate` event will also be fired at the same time. | ||
| */ | ||
| seeking: TimeEvent; | ||
| /** | ||
| * Triggered when the active text track (captions/subtitles) changes. The values will be null if text tracks are turned off. | ||
| */ | ||
| texttrackchange: TextTrackChangeEvent; | ||
| /** | ||
| * Triggered when the player seeks to a specific time. A `timeupdate` event will also be fired at the same time. | ||
| */ | ||
| seeked: TimeEvent; | ||
| /** | ||
| * Triggered when the current chapter changes. | ||
| */ | ||
| chapterchange: VimeoChapter; | ||
| /** | ||
| * Triggered when the active text track (captions/subtitles) changes. The values will be null if text tracks are turned off. | ||
| */ | ||
| texttrackchange: TextTrackChangeEvent; | ||
| /** | ||
| * Triggered when the active cue for the current text track changes. It also fires when the active text track changes. There may be multiple cues active. | ||
| */ | ||
| cuechange: CueChangeEvent; | ||
| /** | ||
| * Triggered when the current chapter changes. | ||
| */ | ||
| chapterchange: VimeoChapter; | ||
| /** | ||
| * Triggered when the current time hits a registered cue point. | ||
| */ | ||
| cuepoint: CuePointEvent; | ||
| /** | ||
| * Triggered when the active cue for the current text track changes. It also fires when the active text track changes. There may be multiple cues active. | ||
| */ | ||
| cuechange: CueChangeEvent; | ||
| /** | ||
| * Triggered when the volume in the player changes. Some devices do not support setting the volume of the video independently from the system volume, so this event will never fire on those | ||
| * devices. | ||
| */ | ||
| volumechange: VolumeChangeEvent; | ||
| /** | ||
| * Triggered when the current time hits a registered cue point. | ||
| */ | ||
| cuepoint: CuePointEvent; | ||
| /** | ||
| * Triggered when the playback rate of the video in the player changes. The ability to change rate can be disabled by the creator and the event will not fire for those videos. The new | ||
| * playback rate is returned with the event. | ||
| */ | ||
| playbackratechange: PlaybackRateEvent; | ||
| /** | ||
| * Triggered when the volume in the player changes. Some devices do not support setting the volume of the video independently from the system volume, so this event will never fire on those | ||
| * devices. | ||
| */ | ||
| volumechange: VolumeChangeEvent; | ||
| /** | ||
| * Triggered when buffering starts in the player. This is also triggered during preload and while seeking. There is no associated data with this event. | ||
| */ | ||
| bufferstart: never; | ||
| /** | ||
| * Triggered when the playback rate of the video in the player changes. The ability to change rate can be disabled by the creator and the event will not fire for those videos. The new playback | ||
| * rate is returned with the event. | ||
| */ | ||
| playbackratechange: PlaybackRateEvent; | ||
| /** | ||
| * Triggered when buffering ends in the player. This is also triggered at the end of preload and seeking. There is no associated data with this event. | ||
| */ | ||
| bufferend: never; | ||
| /** | ||
| * Triggered when buffering starts in the player. This is also triggered during preload and while seeking. There is no associated data with this event. | ||
| */ | ||
| bufferstart: never; | ||
| /** | ||
| * Triggered when some kind of error is generated in the player. In general if you are using this API library, you should use `.catch()` on each method call instead of globally listening | ||
| * for error events. | ||
| * | ||
| * If the error was generated from a method call, the name of that method will be included. | ||
| */ | ||
| error: Error; | ||
| /** | ||
| * Triggered when buffering ends in the player. This is also triggered at the end of preload and seeking. There is no associated data with this event. | ||
| */ | ||
| bufferend: never; | ||
| /** | ||
| * Triggered when a new video is loaded in the player. | ||
| */ | ||
| loaded: LoadedEvent; | ||
| /** | ||
| * Triggered when some kind of error is generated in the player. In general if you are using this API library, you should use `.catch()` on each method call instead of globally listening for | ||
| * error events. | ||
| * | ||
| * If the error was generated from a method call, the name of that method will be included. | ||
| */ | ||
| error: Error; | ||
| /** | ||
| * Triggered when the duration attribute has been updated. | ||
| */ | ||
| durationchange: DurationChangeEvent; | ||
| /** | ||
| * Triggered when a new video is loaded in the player. | ||
| */ | ||
| loaded: LoadedEvent; | ||
| /** | ||
| * Triggered when the player enters or exits fullscreen. | ||
| */ | ||
| fullscreenchange: FullScreenChangeEvent; | ||
| /** | ||
| * Triggered when the duration attribute has been updated. | ||
| */ | ||
| durationchange: DurationChangeEvent; | ||
| /** | ||
| * Triggered when the set quality changes. | ||
| */ | ||
| qualitychange: QualityChangeEvent; | ||
| /** | ||
| * Triggered when the player enters or exits fullscreen. | ||
| */ | ||
| fullscreenchange: FullScreenChangeEvent; | ||
| /** | ||
| * Triggered when any of the camera properties change for 360° videos. | ||
| */ | ||
| camerachange: VimeoCameraProps; | ||
| /** | ||
| * Triggered when the set quality changes. | ||
| */ | ||
| qualitychange: QualityChangeEvent; | ||
| /** | ||
| * Triggered when the intrinsic size of the media changes. | ||
| */ | ||
| resize: ResizeEvent; | ||
| /** | ||
| * Triggered when any of the camera properties change for 360° videos. | ||
| */ | ||
| camerachange: VimeoCameraProps; | ||
| /** | ||
| * Triggered when the player enters picture-in-picture. | ||
| */ | ||
| enterpictureinpicture: never; | ||
| /** | ||
| * Triggered when the intrinsic size of the media changes. | ||
| */ | ||
| resize: ResizeEvent; | ||
| /** | ||
| * Triggered when the player leaves picture-in-picture. | ||
| */ | ||
| leavepictureinpicture: never; | ||
| } | ||
| /** | ||
| * Triggered when the player enters picture-in-picture. | ||
| */ | ||
| enterpictureinpicture: never; | ||
| export type EventCallback<Data = any> = (data: Data) => any; | ||
| /** | ||
| * Triggered when the player leaves picture-in-picture. | ||
| */ | ||
| leavepictureinpicture: never; | ||
| } | ||
| export type VimeoTimeRange = [number, number]; | ||
| export type VimeoVideoQuality = 'auto' | '4K' | '2K' | '1080p' | '720p' | '540p' | '360p' | '240p'; | ||
| export type EventCallback<Data = any> = (data: Data) => any; | ||
| export interface VimeoCuePoint { | ||
| time: number; | ||
| data: VimeoCuePointData; | ||
| id: string; | ||
| } | ||
| export type VimeoTimeRange = [number, number]; | ||
| export type VimeoVideoQuality = 'auto' | '4K' | '2K' | '1080p' | '720p' | '540p' | '360p' | '240p'; | ||
| export interface VimeoCuePointData { | ||
| [key: string]: any; | ||
| } | ||
| export class Player { | ||
| constructor(element: HTMLIFrameElement | HTMLElement | string, options?: Options); | ||
| export interface VimeoTextTrack { | ||
| language: string; | ||
| kind: TrackKind; | ||
| label: string; | ||
| mode?: string | undefined; | ||
| } | ||
| on<EventName extends keyof EventMap>(event: EventName, callback: EventCallback<EventMap[EventName]>): void; | ||
| on(event: string, callback: EventCallback): void; | ||
| off<EventName extends keyof EventMap>(event: EventName, callback: EventCallback<EventMap[EventName]>): void; | ||
| off(event: string, callback?: EventCallback): void; | ||
| loadVideo(id: number): VimeoPromise<number, TypeError | PasswordError | PrivacyError | Error>; | ||
| loadVideo(url: string): VimeoPromise<string, TypeError | PasswordError | PrivacyError | Error>; | ||
| loadVideo( | ||
| options: Options, | ||
| ): VimeoPromise<{ [prop: string]: any }, TypeError | PasswordError | PrivacyError | Error>; | ||
| ready(): VimeoPromise<void, Error>; | ||
| enableTextTrack( | ||
| language: string, | ||
| kind?: TrackKind, | ||
| ): VimeoPromise<VimeoTextTrack, InvalidTrackLanguageError | InvalidTrackError | Error>; | ||
| disableTextTrack(): VimeoPromise<void, Error>; | ||
| pause(): VimeoPromise<void, PasswordError | PrivacyError | Error>; | ||
| play(): VimeoPromise<void, PasswordError | PrivacyError | Error>; | ||
| unload(): VimeoPromise<void, Error>; | ||
| requestFullscreen(): VimeoPromise<void, Error>; | ||
| exitFullscreen(): VimeoPromise<void, Error>; | ||
| getFullscreen(): VimeoPromise<boolean, Error>; | ||
| requestPictureInPicture(): VimeoPromise<void, Error>; | ||
| exitPictureInPicture(): VimeoPromise<void, Error>; | ||
| getPictureInPicture(): VimeoPromise<boolean, Error>; | ||
| getAutopause(): VimeoPromise<boolean, UnsupportedError | Error>; | ||
| setAutopause(autopause: boolean): VimeoPromise<boolean, UnsupportedError | Error>; | ||
| getColor(): VimeoPromise<string, Error>; | ||
| setColor(color: string): VimeoPromise<string, ContrastError | TypeError | Error>; | ||
| getChapters(): VimeoPromise<VimeoChapter[], Error>; | ||
| getCurrentChapter(): VimeoPromise<VimeoChapter, Error>; | ||
| addCuePoint(time: number, data: VimeoCuePointData): VimeoPromise<string, UnsupportedError | RangeError | Error>; | ||
| removeCuePoint(id: string): VimeoPromise<string, UnsupportedError | InvalidCuePoint | Error>; | ||
| getCuePoints(): VimeoPromise<VimeoCuePoint[], UnsupportedError | Error>; | ||
| getBuffered(): VimeoPromise<VimeoTimeRange[], Error>; | ||
| getCurrentTime(): VimeoPromise<number, Error>; | ||
| setCurrentTime(seconds: number): VimeoPromise<number, RangeError | Error>; | ||
| getDuration(): VimeoPromise<number, Error>; | ||
| getEnded(): VimeoPromise<boolean, Error>; | ||
| getLoop(): VimeoPromise<boolean, Error>; | ||
| setLoop(loop: boolean): VimeoPromise<boolean, Error>; | ||
| getMuted(): VimeoPromise<boolean, Error>; | ||
| setMuted(muted: boolean): VimeoPromise<boolean, Error>; | ||
| getPaused(): VimeoPromise<boolean, Error>; | ||
| getPlayed(): VimeoPromise<VimeoTimeRange[], Error>; | ||
| getSeekable(): VimeoPromise<VimeoTimeRange[], Error>; | ||
| getSeeking(): VimeoPromise<boolean, Error>; | ||
| getPlaybackRate(): VimeoPromise<number, Error>; | ||
| setPlaybackRate(playbackRate: number): VimeoPromise<number, RangeError | Error>; | ||
| getTextTracks(): VimeoPromise<VimeoTextTrack[], Error>; | ||
| getVideoEmbedCode(): VimeoPromise<string, Error>; | ||
| getVideoId(): VimeoPromise<number, Error>; | ||
| getVideoTitle(): VimeoPromise<string, Error>; | ||
| getVideoWidth(): VimeoPromise<number, Error>; | ||
| getVideoHeight(): VimeoPromise<number, Error>; | ||
| getVideoUrl(): VimeoPromise<string, PrivacyError | Error>; | ||
| getVolume(): VimeoPromise<number, Error>; | ||
| setVolume(volume: number): VimeoPromise<number, RangeError | Error>; | ||
| getQualities(): VimeoPromise<VimeoVideoQualityObject[], Error>; | ||
| getQuality(): VimeoPromise<VimeoVideoQuality, Error>; | ||
| setQuality(quality: VimeoVideoQuality): VimeoPromise<VimeoVideoQuality, TypeError | Error>; | ||
| getCameraProps(): VimeoPromise<VimeoCameraProps, Error>; | ||
| setCameraProps(cameraProps: VimeoCameraProps): VimeoPromise<VimeoCameraProps, RangeError | Error>; | ||
| destroy(): VimeoPromise<void, Error>; | ||
| } | ||
| export interface Options { | ||
| id?: number | undefined; | ||
| url?: string | undefined; | ||
| autopause?: boolean | undefined; | ||
| autoplay?: boolean | undefined; | ||
| background?: boolean | undefined; | ||
| byline?: boolean | undefined; | ||
| color?: string | undefined; | ||
| controls?: boolean | undefined; | ||
| dnt?: boolean | undefined; | ||
| height?: number | undefined; | ||
| interactive_params?: string | undefined; | ||
| keyboard?: boolean | undefined; | ||
| loop?: boolean | undefined; | ||
| maxheight?: number | undefined; | ||
| maxwidth?: number | undefined; | ||
| muted?: boolean | undefined; | ||
| pip?: boolean | undefined; | ||
| playsinline?: boolean | undefined; | ||
| portrait?: boolean | undefined; | ||
| responsive?: boolean | undefined; | ||
| speed?: boolean | undefined; | ||
| quality?: VimeoVideoQuality | undefined; | ||
| texttrack?: string | undefined; | ||
| title?: boolean | undefined; | ||
| transparent?: boolean | undefined; | ||
| width?: number | undefined; | ||
| } | ||
| export interface VimeoCuePoint { | ||
| time: number; | ||
| data: VimeoCuePointData; | ||
| id: string; | ||
| } | ||
| // This property doesn’t actually exist. | ||
| // It’s defined for backwards compatibility with older versions of the type definitions. | ||
| export { Player as default }; | ||
| } | ||
| export interface VimeoCuePointData { | ||
| [key: string]: any; | ||
| } | ||
| class Player { | ||
| constructor(element: HTMLIFrameElement | HTMLElement | string, options?: Player.Options); | ||
| export interface VimeoTextTrack { | ||
| language: string; | ||
| kind: TrackKind; | ||
| label: string; | ||
| mode?: string | undefined; | ||
| on<EventName extends keyof Player.EventMap>( | ||
| event: EventName, | ||
| callback: Player.EventCallback<Player.EventMap[EventName]>, | ||
| ): void; | ||
| on(event: string, callback: Player.EventCallback): void; | ||
| off<EventName extends keyof Player.EventMap>( | ||
| event: EventName, | ||
| callback: Player.EventCallback<Player.EventMap[EventName]>, | ||
| ): void; | ||
| off(event: string, callback?: Player.EventCallback): void; | ||
| loadVideo(id: number): Promise<number>; | ||
| loadVideo(url: string): Promise<string>; | ||
| loadVideo(options: Player.Options): Promise<{ [prop: string]: any }>; | ||
| ready(): Promise<void>; | ||
| enableTextTrack(language: string, kind?: Player.TrackKind): Promise<Player.VimeoTextTrack>; | ||
| disableTextTrack(): Promise<void>; | ||
| pause(): Promise<void>; | ||
| play(): Promise<void>; | ||
| unload(): Promise<void>; | ||
| requestFullscreen(): Promise<void>; | ||
| exitFullscreen(): Promise<void>; | ||
| getFullscreen(): Promise<boolean>; | ||
| requestPictureInPicture(): Promise<void>; | ||
| exitPictureInPicture(): Promise<void>; | ||
| getPictureInPicture(): Promise<boolean>; | ||
| getAutopause(): Promise<boolean>; | ||
| setAutopause(autopause: boolean): Promise<boolean>; | ||
| getColor(): Promise<string>; | ||
| setColor(color: string): Promise<string>; | ||
| getChapters(): Promise<Player.VimeoChapter[]>; | ||
| getCurrentChapter(): Promise<Player.VimeoChapter>; | ||
| addCuePoint(time: number, data: Player.VimeoCuePointData): Promise<string>; | ||
| removeCuePoint(id: string): Promise<string>; | ||
| getCuePoints(): Promise<Player.VimeoCuePoint[]>; | ||
| getBuffered(): Promise<Player.VimeoTimeRange[]>; | ||
| getCurrentTime(): Promise<number>; | ||
| setCurrentTime(seconds: number): Promise<number>; | ||
| getDuration(): Promise<number>; | ||
| getEnded(): Promise<boolean>; | ||
| getLoop(): Promise<boolean>; | ||
| setLoop(loop: boolean): Promise<boolean>; | ||
| getMuted(): Promise<boolean>; | ||
| setMuted(muted: boolean): Promise<boolean>; | ||
| getPaused(): Promise<boolean>; | ||
| getPlayed(): Promise<Player.VimeoTimeRange[]>; | ||
| getSeekable(): Promise<Player.VimeoTimeRange[]>; | ||
| getSeeking(): Promise<boolean>; | ||
| getPlaybackRate(): Promise<number>; | ||
| setPlaybackRate(playbackRate: number): Promise<number>; | ||
| getTextTracks(): Promise<Player.VimeoTextTrack[]>; | ||
| getVideoEmbedCode(): Promise<string>; | ||
| getVideoId(): Promise<number>; | ||
| getVideoTitle(): Promise<string>; | ||
| getVideoWidth(): Promise<number>; | ||
| getVideoHeight(): Promise<number>; | ||
| getVideoUrl(): Promise<string>; | ||
| getVolume(): Promise<number>; | ||
| setVolume(volume: number): Promise<number>; | ||
| getQualities(): Promise<Player.VimeoVideoQualityObject[]>; | ||
| getQuality(): Promise<Player.VimeoVideoQuality>; | ||
| setQuality(quality: Player.VimeoVideoQuality): Promise<Player.VimeoVideoQuality>; | ||
| getCameraProps(): Promise<Player.VimeoCameraProps>; | ||
| setCameraProps(cameraProps: Player.VimeoCameraProps): Promise<Player.VimeoCameraProps>; | ||
| destroy(): Promise<void>; | ||
| } | ||
| } | ||
| export interface Options { | ||
| id?: number | undefined; | ||
| url?: string | undefined; | ||
| autopause?: boolean | undefined; | ||
| autoplay?: boolean | undefined; | ||
| background?: boolean | undefined; | ||
| byline?: boolean | undefined; | ||
| color?: string | undefined; | ||
| controls?: boolean | undefined; | ||
| dnt?: boolean | undefined; | ||
| height?: number | undefined; | ||
| interactive_params?: string | undefined; | ||
| keyboard?: boolean | undefined; | ||
| loop?: boolean | undefined; | ||
| maxheight?: number | undefined; | ||
| maxwidth?: number | undefined; | ||
| muted?: boolean | undefined; | ||
| pip?: boolean | undefined; | ||
| playsinline?: boolean | undefined; | ||
| portrait?: boolean | undefined; | ||
| responsive?: boolean | undefined; | ||
| speed?: boolean | undefined; | ||
| quality?: VimeoVideoQuality | undefined; | ||
| texttrack?: string | undefined; | ||
| title?: boolean | undefined; | ||
| transparent?: boolean | undefined; | ||
| width?: number | undefined; | ||
| } | ||
| export as namespace Vimeo; | ||
| export interface VimeoPromise<Result, Reason> extends Promise<Result> { | ||
| (successCallback?: (promiseValue: Result) => void, rejectCallback?: (reasonValue: Reason) => void): Promise<Result>; | ||
| } | ||
| /*~ You can declare properties of the module using const, let, or var */ | ||
| export default Player; | ||
| export = Vimeo.Player; |
| { | ||
| "name": "@types/vimeo__player", | ||
| "version": "2.16.3", | ||
| "version": "2.18.0", | ||
| "description": "TypeScript definitions for @vimeo/player", | ||
@@ -51,4 +51,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/vimeo__player", | ||
| "dependencies": {}, | ||
| "typesPublisherContentHash": "4f01a0876583e8b271d306c5e9c31240f712b96b6de90ca56071c3a2da63794b", | ||
| "typeScriptVersion": "3.9" | ||
| "typesPublisherContentHash": "b3ad9500953fce63c1b29f7e884cb40df89a9e146a1aeb625d545652d58518da", | ||
| "typeScriptVersion": "4.3" | ||
| } |
@@ -11,7 +11,7 @@ # Installation | ||
| ### Additional Details | ||
| * Last updated: Mon, 02 May 2022 21:01:46 GMT | ||
| * Last updated: Wed, 19 Apr 2023 06:32:44 GMT | ||
| * Dependencies: none | ||
| * Global values: none | ||
| * Global values: `Vimeo` | ||
| # Credits | ||
| These definitions were written by [Denis Yılmaz](https://github.com/denisyilmaz), [Felix Albert](f.albert.work@icloud.com), [Tim Chen](https://github.com/timc13), [Terry Mun](https://github.com/terrymun), [Coskun Deniz](deniz@tassomai.com), [Kohei Watanabe](https://github.com/kou029w), and [Michael Markey](https://github.com/mikeamarkey). |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.42%
16869
Worsened metrics
- Lines of code
- decreased by-11.39%
319
No dependency changes