🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Sign inDemoInstall
Socket

@types/ovenplayer

Package Overview
Dependencies
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/ovenplayer - npm Package Compare versions

Comparing version

to
0.10.5

117

ovenplayer/index.d.ts

@@ -22,3 +22,3 @@ // Type definitions for ovenplayer 0.10

sources: OvenPlayerSource | OvenPlayerSource[];
tracks?: Array<Pick<OvenPlayerTrack, 'file' | 'kind' | 'label'>>;
tracks?: Array<Pick<OvenPlayerTrack, "file" | "kind" | "label">>;
}

@@ -44,3 +44,3 @@

/** @default 'top-left' */
position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
position?: "top-left" | "top-right" | "bottom-left" | "bottom-right";
/** @default 2.8% */

@@ -85,7 +85,7 @@ x?: string;

currentProtocolOnly?: boolean;
tracks?: Array<Pick<OvenPlayerTrack, 'file' | 'kind' | 'label'>>;
tracks?: Array<Pick<OvenPlayerTrack, "file" | "kind" | "label">>;
/** @default 100 */
volume?: number;
adTagUrl?: string;
adClient?: 'googleima' | 'vast';
adClient?: "googleima" | "vast";
playlist?: OvenPlayerPlayList;

@@ -112,3 +112,3 @@ /** @default false */

*/
iceTransportPolicy?: 'all' | 'public' | 'relay';
iceTransportPolicy?: "all" | "public" | "relay";
};

@@ -136,3 +136,3 @@ /**

interface OvenPlayerSource {
type: 'webrtc' | 'llhls' | 'hls' | 'lldash' | 'dash' | 'mp4';
type: "webrtc" | "llhls" | "hls" | "lldash" | "dash" | "mp4";
file: string;

@@ -146,13 +146,13 @@ label?: string;

type OvenPlayerState =
| 'idle'
| 'complete'
| 'paused'
| 'playing'
| 'error'
| 'loading'
| 'stalled'
| 'adLoaded'
| 'adPlaying'
| 'adPaused'
| 'adComplete';
| "idle"
| "complete"
| "paused"
| "playing"
| "error"
| "loading"
| "stalled"
| "adLoaded"
| "adPlaying"
| "adPaused"
| "adComplete";

@@ -163,75 +163,78 @@ interface OvenPlayerHandler {

*/
(evnetName: 'ready', callback: (eventData: OvenPlayerEvents['ready']) => void): void;
(evnetName: "ready", callback: (eventData: OvenPlayerEvents["ready"]) => void): void;
/**
* It occurs when new metadata is received.
*/
(evnetName: 'metaChanged', callback: (eventData: OvenPlayerEvents['metaChanged']) => void): void;
(evnetName: "metaChanged", callback: (eventData: OvenPlayerEvents["metaChanged"]) => void): void;
/**
* It occurs when the state of a player changes.
*/
(evnetName: 'stateChanged', callback: (eventData: OvenPlayerEvents['stateChanged']) => void): void;
(evnetName: "stateChanged", callback: (eventData: OvenPlayerEvents["stateChanged"]) => void): void;
/**
* Fired when the player's size has been changed.
*/
(evnetName: 'resized', callback: (eventData: OvenPlayerEvents['resized']) => void): void;
(evnetName: "resized", callback: (eventData: OvenPlayerEvents["resized"]) => void): void;
/**
* Fired when the playback rate has been changed
*/
(evnetName: 'playbackRateChanged', callback: (eventData: OvenPlayerEvents['playbackRateChanged']) => void): void;
(evnetName: "playbackRateChanged", callback: (eventData: OvenPlayerEvents["playbackRateChanged"]) => void): void;
/**
* Fired after a seek has been requested either by scrubbing the control bar or through the API.
*/
(evnetName: 'seek', callback: (eventData: OvenPlayerEvents['seek']) => void): void;
(evnetName: "seek", callback: (eventData: OvenPlayerEvents["seek"]) => void): void;
/**
* While the player is playing, this event is fired as the playback position gets updated. This may occur as frequently as 10 times per second.
*/
(evnetName: 'time', callback: (eventData: OvenPlayerEvents['time']) => void): void;
(evnetName: "time", callback: (eventData: OvenPlayerEvents["time"]) => void): void;
/**
* Fired when the currently playing item loads additional data into its buffer.
*/
(evnetName: 'bufferChanged', callback: (eventData: OvenPlayerEvents['bufferChanged']) => void): void;
(evnetName: "bufferChanged", callback: (eventData: OvenPlayerEvents["bufferChanged"]) => void): void;
/**
* Triggered when the player has gone in or out of a mute state.
*/
(evnetName: 'mute', callback: (eventData: OvenPlayerEvents['mute']) => void): void;
(evnetName: "mute", callback: (eventData: OvenPlayerEvents["mute"]) => void): void;
/**
* Triggered when the player's volume is changed.
*/
(evnetName: 'volumeChanged', callback: (eventData: OvenPlayerEvents['volumeChanged']) => void): void;
(evnetName: "volumeChanged", callback: (eventData: OvenPlayerEvents["volumeChanged"]) => void): void;
/**
* Fired when the active playlist is changed. It happens in response to, e.g., a user clicking an option in the playlist menu or a script calling `setCurrentPlaylist` or prev playlist has been completed.
*/
(evnetName: 'playlistChanged', callback: (eventData: OvenPlayerEvents['playlistChanged']) => void): void;
(evnetName: "playlistChanged", callback: (eventData: OvenPlayerEvents["playlistChanged"]) => void): void;
/**
* Fired when the active source(protocol) is changed. It happens in response to, e.g., a user clicking an option in the source menu or a script calling `setCurrentSource`.
*/
(evnetName: 'sourceChanged', callback: (eventData: OvenPlayerEvents['sourceChanged']) => void): void;
(evnetName: "sourceChanged", callback: (eventData: OvenPlayerEvents["sourceChanged"]) => void): void;
/**
* Fired when the active quality level is changed. It happens in response to, e.g., a user clicking an option in the quality menu or a script calling `setCurrentQuality`.
*/
(evnetName: 'qualityLevelChanged', callback: (eventData: OvenPlayerEvents['qualityLevelChanged']) => void): void;
(evnetName: "qualityLevelChanged", callback: (eventData: OvenPlayerEvents["qualityLevelChanged"]) => void): void;
/**
* Fired when VTTCue is changed.
*/
(evnetName: 'cueChanged', callback: (eventData: OvenPlayerEvents['cueChanged']) => void): void;
(evnetName: "cueChanged", callback: (eventData: OvenPlayerEvents["cueChanged"]) => void): void;
/**
* Fired when timecode mode is changed.
*/
(evnetName: 'timeDisplayModeChanged', callback: (eventData: OvenPlayerEvents['timeDisplayModeChanged']) => void): void;
(
evnetName: "timeDisplayModeChanged",
callback: (eventData: OvenPlayerEvents["timeDisplayModeChanged"]) => void,
): void;
/**
* Fired when Ad is changed.
*/
(evnetName: 'adChanged', callback: (eventData: OvenPlayerEvents['adChanged']) => void): void;
(evnetName: "adChanged", callback: (eventData: OvenPlayerEvents["adChanged"]) => void): void;
/**
* Fired when Ad is playing.
*/
(evnetName: 'adTime', callback: (eventData: OvenPlayerEvents['adTime']) => void): void;
(evnetName: "adTime", callback: (eventData: OvenPlayerEvents["adTime"]) => void): void;
/**
* Fired when Ad is complete.
*/
(evnetName: 'adComplete', callback: (eventData: OvenPlayerEvents['adComplete']) => void): void;
(evnetName: "adComplete", callback: (eventData: OvenPlayerEvents["adComplete"]) => void): void;
/**
* Fired when screen mode is changed.
*/
(evnetName: 'fullscreenChanged', callback: (eventData: OvenPlayerEvents['fullscreenChanged']) => void): void;
(evnetName: "fullscreenChanged", callback: (eventData: OvenPlayerEvents["fullscreenChanged"]) => void): void;
/**

@@ -241,30 +244,30 @@ * Triggered when the player is clicked.

*/
(evnetName: 'clicked', callback: (eventData: OvenPlayerEvents['clicked']) => void): void;
(evnetName: "clicked", callback: (eventData: OvenPlayerEvents["clicked"]) => void): void;
/**
* Fired when the all playlist is complete.
*/
(evnetName: 'allPlaylistEnded', callback: (eventData: OvenPlayerEvents['allPlaylistEnded']) => void): void;
(evnetName: "allPlaylistEnded", callback: (eventData: OvenPlayerEvents["allPlaylistEnded"]) => void): void;
/**
* Triggered when HLS object is initialized and ready to use.
*/
(evnetName: 'hlsPrepared', callback: (eventData: OvenPlayerEvents['hlsPrepared']) => void): void;
(evnetName: "hlsPrepared", callback: (eventData: OvenPlayerEvents["hlsPrepared"]) => void): void;
/**
* Triggered after HLS object is destroyed.
*/
(evnetName: 'hlsDestroyed', callback: (eventData: OvenPlayerEvents['hlsDestroyed']) => void): void;
(evnetName: "hlsDestroyed", callback: (eventData: OvenPlayerEvents["hlsDestroyed"]) => void): void;
/**
* Triggered when DASH object is initialized and ready to use.
*/
(evnetName: 'dashPrepared', callback: (eventData: OvenPlayerEvents['dashPrepared']) => void): void;
(evnetName: "dashPrepared", callback: (eventData: OvenPlayerEvents["dashPrepared"]) => void): void;
/**
* Triggered after DASH object is destroyed.
*/
(evnetName: 'dashDestroyed', callback: (eventData: OvenPlayerEvents['dashDestroyed']) => void): void;
(evnetName: "dashDestroyed", callback: (eventData: OvenPlayerEvents["dashDestroyed"]) => void): void;
/**
* Player is destroyed.
*/
(evnetName: 'destroy', callback: (eventData: OvenPlayerEvents['destroy']) => void): void;
}
(evnetName: "destroy", callback: (eventData: OvenPlayerEvents["destroy"]) => void): void;
}
interface OvenPlayerEvents {
interface OvenPlayerEvents {
ready: undefined;

@@ -284,3 +287,3 @@ metaChanged: {

/** large(>992), medium(<992), small(<768), xsmall(<576) */
resized: 'large' | 'medium' | 'small' | 'xsmall';
resized: "large" | "medium" | "small" | "xsmall";
/** The new playback rate */

@@ -323,3 +326,3 @@ playbackRateChanged: number;

*/
type: 'request' | 'render';
type: "request" | "render";
/** The player's auto-switching quality state. */

@@ -363,3 +366,3 @@ isAuto: boolean;

destroy: undefined;
}
}

@@ -404,3 +407,3 @@ interface OvenPlayerInstance {

setAutoQuality(auto: boolean): void;
addCaption(track: Pick<OvenPlayerTrack, 'file' | 'kind' | 'label'>): void;
addCaption(track: Pick<OvenPlayerTrack, "file" | "kind" | "label">): void;
getCaptionList(): OvenPlayerTrack[];

@@ -449,14 +452,14 @@ getCurrentCaption(): string;

export {
OvenPlayerBrowser,
OvenPlayerConfig,
OvenPlayerEvents,
OvenPlayerHandler,
OvenPlayerIceServer,
OvenPlayerInstance,
OvenPlayerPlayList,
OvenPlayerQuality,
OvenPlayerInstance,
OvenPlayerSource,
OvenPlayerPlayList,
OvenPlayerWebRTCStream,
OvenPlayerConfig,
OvenPlayerState,
OvenPlayerBrowser,
OvenPlayerTrack,
OvenPlayerHandler,
OvenPlayerEvents,
OvenPlayerIceServer,
OvenPlayerWebRTCStream,
};

@@ -463,0 +466,0 @@

{
"name": "@types/ovenplayer",
"version": "0.10.4",
"version": "0.10.5",
"description": "TypeScript definitions for ovenplayer",

@@ -28,4 +28,4 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ovenplayer",

"dependencies": {},
"typesPublisherContentHash": "e1def916def610444b1d2fba06bc3cf3c3e79c62c6c2ac313377ca38f5d98aec",
"typesPublisherContentHash": "2507c402dfd28b94e2870a3adc63cd3972774bbbd217160c966d97fb2c67582e",
"typeScriptVersion": "4.5"
}

@@ -11,3 +11,3 @@ # Installation

### Additional Details
* Last updated: Wed, 27 Sep 2023 09:42:16 GMT
* Last updated: Wed, 27 Sep 2023 20:35:06 GMT
* Dependencies: none

@@ -14,0 +14,0 @@ * Global values: `OvenPlayer`