@videts/vide

---

@videts/vide / index / PluginPlayer

Interface: PluginPlayer

Defined in: types.ts:281

Extended player interface exposed to plugins, includes state control.

Extends

• Player

Properties

Property	Modifier	Type	Description	Inherited from
activeCues	readonly	VideCue[]	-	Player.activeCues
autoplay	public	boolean	-	Player.autoplay
buffered	readonly	TimeRanges	-	Player.buffered
controls	public	boolean	-	Player.controls
crossOrigin	public	string | null	-	Player.crossOrigin
currentQuality	readonly	QualityLevel | null	-	Player.currentQuality
currentTime	public	number	-	Player.currentTime
defaultMuted	public	boolean	-	Player.defaultMuted
defaultPlaybackRate	public	number	-	Player.defaultPlaybackRate
duration	readonly	number	-	Player.duration
el	readonly	MediaElement	-	Player.el
ended	readonly	boolean	-	Player.ended
isAudio	readonly	boolean	-	Player.isAudio
isAutoQuality	readonly	boolean	-	Player.isAutoQuality
isLive	readonly	boolean	-	Player.isLive
loop	public	boolean	-	Player.loop
muted	public	boolean	-	Player.muted
networkState	readonly	number	-	Player.networkState
paused	readonly	boolean	-	Player.paused
playbackRate	public	number	-	Player.playbackRate
poster	public	string	-	Player.poster
preload	public	"" | "none" | "metadata" | "auto"	-	Player.preload
qualities	readonly	QualityLevel[]	-	Player.qualities
readyState	readonly	number	-	Player.readyState
seekable	readonly	TimeRanges	-	Player.seekable
seekableRange	readonly	SeekableRange | null	-	Player.seekableRange
seeking	readonly	boolean	-	Player.seeking
src	public	string	Current media source URL. Setting triggers SourceHandler lookup.	Player.src
state	readonly	PlayerState	-	Player.state
textTracks	readonly	TextTrackList	-	Player.textTracks
videoHeight	readonly	number	-	Player.videoHeight
videoWidth	readonly	number	-	Player.videoWidth
volume	public	number	-	Player.volume

Methods

addEventListener()

Call Signature

addEventListener<K>(type, listener, options?): void

Defined in: types.ts:341

Web-standard addEventListener, delegates to the underlying media element.

Type Parameters

Type Parameter
K extends keyof HTMLMediaElementEventMap

Parameters

Parameter	Type
type	K
listener	(ev) => void
options?	boolean | AddEventListenerOptions

Returns

void

Inherited from

Player.addEventListener

Call Signature

addEventListener(type, listener, options?): void

Defined in: types.ts:346

Parameters

Parameter	Type
type	string
listener	EventListenerOrEventListenerObject
options?	boolean | AddEventListenerOptions

Returns

void

Inherited from

Player.addEventListener

---

addTextTrack()

addTextTrack(options): void

Defined in: types.ts:321

Parameters

Parameter	Type
options	{ default?: boolean; kind?: "subtitles" | "captions"; label: string; language: string; src: string; }
options.default?	boolean
options.kind?	"subtitles" | "captions"
options.label	string
options.language	string
options.src	string

Returns

void

Inherited from

Player.addTextTrack

---

destroy()

destroy(): void

Defined in: types.ts:370

Returns

void

Inherited from

Player.destroy

---

emit()

emit<K>(event, data): void

Defined in: types.ts:193

Type Parameters

Type Parameter
K extends keyof PlayerEventMap

Parameters

Parameter	Type
event	K
data	PlayerEventMap[K]

Returns

void

Inherited from

Player.emit

---

getActiveTextTrack()

getActiveTextTrack(): VideTextTrack | null

Defined in: types.ts:318

Returns

VideTextTrack | null

Inherited from

Player.getActiveTextTrack

---

getPluginData()

getPluginData<K>(key): PluginDataMap[K] | undefined

Defined in: types.ts:378

Retrieve data stored by another plugin. Returns undefined if not set.

Type Parameters

Type Parameter
K extends keyof PluginDataMap

Parameters

Parameter	Type
key	K

Returns

PluginDataMap[K] | undefined

Inherited from

Player.getPluginData

---

getTextTracks()

getTextTracks(): VideTextTrack[]

Defined in: types.ts:317

Returns

VideTextTrack[]

Inherited from

Player.getTextTracks

---

off()

Call Signature

off<K>(event, handler): void

Defined in: types.ts:183

Type Parameters

Type Parameter
K extends keyof PlayerEventMap

Parameters

Parameter	Type
event	K
handler	EventHandler<PlayerEventMap[K]>

Returns

void

Inherited from

Player.off

Call Signature

off<K>(event, handler): void

Defined in: types.ts:187

Type Parameters

Type Parameter
K extends NativeMediaEvent

Parameters

Parameter	Type
event	K
handler	(ev) => void

Returns

void

Inherited from

Player.off

Call Signature

off(event, handler): void

Defined in: types.ts:191

Parameters

Parameter	Type
event	string
handler	EventHandler<never>

Returns

void

Inherited from

Player.off

---

on()

Call Signature

on<K>(event, handler): void

Defined in: types.ts:173

Type Parameters

Type Parameter
K extends keyof PlayerEventMap

Parameters

Parameter	Type
event	K
handler	EventHandler<PlayerEventMap[K]>

Returns

void

Inherited from

Player.on

Call Signature

on<K>(event, handler): void

Defined in: types.ts:177

Type Parameters

Type Parameter
K extends NativeMediaEvent

Parameters

Parameter	Type
event	K
handler	(ev) => void

Returns

void

Inherited from

Player.on

Call Signature

on(event, handler): void

Defined in: types.ts:181

Parameters

Parameter	Type
event	string
handler	EventHandler<never>

Returns

void

Inherited from

Player.on

---

once()

Call Signature

once<K>(event, handler): void

Defined in: types.ts:195

Type Parameters

Type Parameter
K extends keyof PlayerEventMap

Parameters

Parameter	Type
event	K
handler	EventHandler<PlayerEventMap[K]>

Returns

void

Inherited from

Player.once

Call Signature

once<K>(event, handler): void

Defined in: types.ts:199

Type Parameters

Type Parameter
K extends NativeMediaEvent

Parameters

Parameter	Type
event	K
handler	(ev) => void

Returns

void

Inherited from

Player.once

Call Signature

once(event, handler): void

Defined in: types.ts:203

Parameters

Parameter	Type
event	string
handler	EventHandler<never>

Returns

void

Inherited from

Player.once

---

pause()

pause(): void

Defined in: types.ts:296

Returns

void

Inherited from

Player.pause

---

play()

play(): Promise<void>

Defined in: types.ts:295

Returns

Promise<void>

Inherited from

Player.play

---

registerSourceHandler()

registerSourceHandler(handler): void

Defined in: types.ts:367

Register a handler for custom source types (e.g., HLS, DASH).

Parameters

Parameter	Type
handler	SourceHandler

Returns

void

Inherited from

Player.registerSourceHandler

---

removeEventListener()

Call Signature

removeEventListener<K>(type, listener, options?): void

Defined in: types.ts:353

Web-standard removeEventListener, delegates to the underlying media element.

Type Parameters

Type Parameter
K extends keyof HTMLMediaElementEventMap

Parameters

Parameter	Type
type	K
listener	(ev) => void
options?	boolean | EventListenerOptions

Returns

void

Inherited from

Player.removeEventListener

Call Signature

removeEventListener(type, listener, options?): void

Defined in: types.ts:358

Parameters

Parameter	Type
type	string
listener	EventListenerOrEventListenerObject
options?	boolean | EventListenerOptions

Returns

void

Inherited from

Player.removeEventListener

---

setPluginData()

setPluginData<K>(key, data): void

Defined in: types.ts:373

Store data for cross-plugin communication.

Type Parameters

Type Parameter
K extends keyof PluginDataMap

Parameters

Parameter	Type
key	K
data	PluginDataMap[K]

Returns

void

Inherited from

Player.setPluginData

---

setQuality()

setQuality(id): void

Defined in: types.ts:312

Parameters

Parameter	Type
id	number

Returns

void

Inherited from

Player.setQuality

---

setState()

setState(state): void

Defined in: types.ts:282

Parameters

Parameter	Type
state	PlayerState

Returns

void

---

setTextTrack()

setTextTrack(id): void

Defined in: types.ts:320

Parameters

Parameter	Type
id	number

Returns

void

Inherited from

Player.setTextTrack

---

use()

use(plugin): void

Defined in: types.ts:369

Parameters

Parameter	Type
plugin	Plugin

Returns

void

Inherited from

Player.use