@videts/vide

---

@videts/vide / index / PluginPlayer

Interface: PluginPlayer

Defined in: types.ts:250

Extended player interface exposed to plugins, includes state control.

Extends

• Player

Properties

activeCues

readonly activeCues: VideCue[]

Defined in: types.ts:288

Inherited from

Player.activeCues

---

autoplay

autoplay: boolean

Defined in: types.ts:301

Inherited from

Player.autoplay

---

buffered

readonly buffered: TimeRanges

Defined in: types.ts:274

Inherited from

Player.buffered

---

controls

controls: boolean

Defined in: types.ts:307

Inherited from

Player.controls

---

crossOrigin

crossOrigin: string | null

Defined in: types.ts:306

Inherited from

Player.crossOrigin

---

currentQuality

readonly currentQuality: QualityLevel | null

Defined in: types.ts:280

Inherited from

Player.currentQuality

---

currentTime

currentTime: number

Defined in: types.ts:266

Inherited from

Player.currentTime

---

defaultMuted

defaultMuted: boolean

Defined in: types.ts:305

Inherited from

Player.defaultMuted

---

defaultPlaybackRate

defaultPlaybackRate: number

Defined in: types.ts:304

Inherited from

Player.defaultPlaybackRate

---

duration

duration: number

Defined in: types.ts:267

Inherited from

Player.duration

---

el

readonly el: MediaElement

Defined in: types.ts:261

Inherited from

Player.el

---

ended

readonly ended: boolean

Defined in: types.ts:272

Inherited from

Player.ended

---

isAudio

readonly isAudio: boolean

Defined in: types.ts:283

Inherited from

Player.isAudio

---

isAutoQuality

readonly isAutoQuality: boolean

Defined in: types.ts:282

Inherited from

Player.isAutoQuality

---

isLive

readonly isLive: boolean

Defined in: types.ts:277

Inherited from

Player.isLive

---

loop

loop: boolean

Defined in: types.ts:300

Inherited from

Player.loop

---

muted

muted: boolean

Defined in: types.ts:269

Inherited from

Player.muted

---

networkState

readonly networkState: number

Defined in: types.ts:299

Inherited from

Player.networkState

---

paused

readonly paused: boolean

Defined in: types.ts:271

Inherited from

Player.paused

---

playbackRate

playbackRate: number

Defined in: types.ts:270

Inherited from

Player.playbackRate

---

poster

poster: string

Defined in: types.ts:302

Inherited from

Player.poster

---

preload

preload: "" | "none" | "metadata" | "auto"

Defined in: types.ts:303

Inherited from

Player.preload

---

qualities

readonly qualities: QualityLevel[]

Defined in: types.ts:279

Inherited from

Player.qualities

---

readyState

readonly readyState: number

Defined in: types.ts:273

Inherited from

Player.readyState

---

seekable

readonly seekable: TimeRanges

Defined in: types.ts:275

Inherited from

Player.seekable

---

seekableRange

readonly seekableRange: SeekableRange | null

Defined in: types.ts:278

Inherited from

Player.seekableRange

---

seeking

readonly seeking: boolean

Defined in: types.ts:276

Inherited from

Player.seeking

---

src

src: string

Defined in: types.ts:334

Current media source URL. Setting triggers SourceHandler lookup.

Inherited from

Player.src

---

state

readonly state: PlayerState

Defined in: types.ts:262

Inherited from

Player.state

---

textTracks

readonly textTracks: TextTrackList

Defined in: types.ts:285

Inherited from

Player.textTracks

---

videoHeight

readonly videoHeight: number

Defined in: types.ts:298

Inherited from

Player.videoHeight

---

videoWidth

readonly videoWidth: number

Defined in: types.ts:297

Inherited from

Player.videoWidth

---

volume

volume: number

Defined in: types.ts:268

Inherited from

Player.volume

Methods

addEventListener()

Call Signature

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

Defined in: types.ts:310

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

Type Parameters

K

K extends keyof HTMLMediaElementEventMap

Parameters

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:315

Parameters

type

string

listener

EventListenerOrEventListenerObject

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

Player.addEventListener

---

addTextTrack()

addTextTrack(options): void

Defined in: types.ts:290

Parameters

options

default?

boolean

kind?

"subtitles" | "captions"

label

string

language

string

src

string

Returns

void

Inherited from

Player.addTextTrack

---

destroy()

destroy(): void

Defined in: types.ts:339

Returns

void

Inherited from

Player.destroy

---

emit()

emit<K>(event, data): void

Defined in: types.ts:193

Type Parameters

K

K extends keyof PlayerEventMap

Parameters

event

K

data

PlayerEventMap[K]

Returns

void

Inherited from

Player.emit

---

getActiveTextTrack()

getActiveTextTrack(): VideTextTrack | null

Defined in: types.ts:287

Returns

VideTextTrack | null

Inherited from

Player.getActiveTextTrack

---

getPluginData()

getPluginData(key): unknown

Defined in: types.ts:344

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

Parameters

key

string

Returns

unknown

Inherited from

Player.getPluginData

---

getTextTracks()

getTextTracks(): VideTextTrack[]

Defined in: types.ts:286

Returns

VideTextTrack[]

Inherited from

Player.getTextTracks

---

off()

Call Signature

off<K>(event, handler): void

Defined in: types.ts:182

Type Parameters

K

K extends keyof PlayerEventMap

Parameters

event

K

handler

EventHandler<PlayerEventMap[K]>

Returns

void

Inherited from

Player.off

Call Signature

off<K>(event, handler): void

Defined in: types.ts:186

Type Parameters

K

K extends NativeMediaEvent

Parameters

event

K

handler

(ev) => void

Returns

void

Inherited from

Player.off

Call Signature

off(event, handler): void

Defined in: types.ts:191

Parameters

event

string

handler

(...args) => void

Returns

void

Inherited from

Player.off

---

on()

Call Signature

on<K>(event, handler): void

Defined in: types.ts:171

Type Parameters

K

K extends keyof PlayerEventMap

Parameters

event

K

handler

EventHandler<PlayerEventMap[K]>

Returns

void

Inherited from

Player.on

Call Signature

on<K>(event, handler): void

Defined in: types.ts:175

Type Parameters

K

K extends NativeMediaEvent

Parameters

event

K

handler

(ev) => void

Returns

void

Inherited from

Player.on

Call Signature

on(event, handler): void

Defined in: types.ts:180

Parameters

event

string

handler

(...args) => void

Returns

void

Inherited from

Player.on

---

once()

Call Signature

once<K>(event, handler): void

Defined in: types.ts:195

Type Parameters

K

K extends keyof PlayerEventMap

Parameters

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

K

K extends NativeMediaEvent

Parameters

event

K

handler

(ev) => void

Returns

void

Inherited from

Player.once

Call Signature

once(event, handler): void

Defined in: types.ts:204

Parameters

event

string

handler

(...args) => void

Returns

void

Inherited from

Player.once

---

pause()

pause(): void

Defined in: types.ts:265

Returns

void

Inherited from

Player.pause

---

play()

play(): Promise<void>

Defined in: types.ts:264

Returns

Promise<void>

Inherited from

Player.play

---

registerSourceHandler()

registerSourceHandler(handler): void

Defined in: types.ts:336

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

Parameters

handler

SourceHandler

Returns

void

Inherited from

Player.registerSourceHandler

---

removeEventListener()

Call Signature

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

Defined in: types.ts:322

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

Type Parameters

K

K extends keyof HTMLMediaElementEventMap

Parameters

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:327

Parameters

type

string

listener

EventListenerOrEventListenerObject

options?

boolean | EventListenerOptions

Returns

void

Inherited from

Player.removeEventListener

---

setPluginData()

setPluginData(key, data): void

Defined in: types.ts:342

Store data for cross-plugin communication.

Parameters

key

string

data

unknown

Returns

void

Inherited from

Player.setPluginData

---

setQuality()

setQuality(id): void

Defined in: types.ts:281

Parameters

id

number

Returns

void

Inherited from

Player.setQuality

---

setState()

setState(state): void

Defined in: types.ts:251

Parameters

state

PlayerState

Returns

void

---

setTextTrack()

setTextTrack(id): void

Defined in: types.ts:289

Parameters

id

number

Returns

void

Inherited from

Player.setTextTrack

---

use()

use(plugin): void

Defined in: types.ts:338

Parameters

plugin

Plugin

Returns

void

Inherited from

Player.use