@videts/vide

---

@videts/vide / index / PlayerEventMap

Interface: PlayerEventMap

Defined in: types.ts:26

Properties

ad:breakEnd

ad:breakEnd: object

Defined in: types.ts:118

breakId

breakId: string | undefined

---

ad:breakStart

ad:breakStart: object

Defined in: types.ts:113

breakId

breakId: string | undefined

managedUI?

optional managedUI: boolean

When true, an external SDK (e.g. IMA) manages the ad UI.

---

ad:click

ad:click: object

Defined in: types.ts:99

clickThrough

clickThrough: string | undefined

clickTracking

clickTracking: string[]

---

ad:companions

ad:companions: object

Defined in: types.ts:40

adId

adId: string

companions

companions: object[]

required

required: "all" | "any" | "none"

---

ad:end

ad:end: object

Defined in: types.ts:97

adId

adId: string

---

ad:error

ad:error: object

Defined in: types.ts:100

error

error: Error

source

source: string

vastErrorCode?

optional vastErrorCode: number

VAST 4.2 error code. Undefined for non-VAST errors.

---

ad:fullscreen

ad:fullscreen: object

Defined in: types.ts:112

adId

adId: string

fullscreen

fullscreen: boolean

---

ad:impression

ad:impression: object

Defined in: types.ts:106

adId

adId: string

---

ad:loaded

ad:loaded: object

Defined in: types.ts:107

adId

adId: string

---

ad:mute

ad:mute: object

Defined in: types.ts:109

adId

adId: string

---

ad:nonlinears

ad:nonlinears: object

Defined in: types.ts:65

adId

adId: string

nonLinears

nonLinears: object[]

trackingEvents

trackingEvents: Record<string, string[]>

---

ad:pod:adend

ad:pod:adend: object

Defined in: types.ts:129

ad

ad: object

ad.id

id: string

ad.sequence?

optional sequence: number

index

index: number

total

total: number

---

ad:pod:adstart

ad:pod:adstart: object

Defined in: types.ts:124

ad

ad: object

ad.id

id: string

ad.sequence?

optional sequence: number

index

index: number

total

total: number

---

ad:pod:end

ad:pod:end: object

Defined in: types.ts:123

completed

completed: number

failed

failed: number

skipped

skipped: number

---

ad:pod:start

ad:pod:start: object

Defined in: types.ts:119

ads

ads: object[]

total

total: number

---

ad:quartile

ad:quartile: object

Defined in: types.ts:108

adId

adId: string

quartile

quartile: AdQuartile

---

ad:skip

ad:skip: object

Defined in: types.ts:98

adId

adId: string

---

ad:start

ad:start: object

Defined in: types.ts:88

adId

adId: string

adTitle?

optional adTitle: string

clickThrough?

optional clickThrough: string

duration?

optional duration: number

managedUI?

optional managedUI: boolean

When true, an external SDK (e.g. IMA) manages the ad UI. UI plugin hides its own ad components.

skipOffset?

optional skipOffset: number

---

ad:unmute

ad:unmute: object

Defined in: types.ts:110

adId

adId: string

---

ad:volumeChange

ad:volumeChange: object

Defined in: types.ts:111

adId

adId: string

volume

volume: number

---

cuechange

cuechange: object

Defined in: types.ts:138

cues

cues: VideCue[]

---

destroy

destroy: undefined

Defined in: types.ts:139

---

ended

ended: undefined

Defined in: types.ts:30

---

error

error: object

Defined in: types.ts:33

code

code: number

message

message: string

recoverable?

optional recoverable: boolean

retryCount?

optional retryCount: number

source

source: string

---

livestatechange

livestatechange: object

Defined in: types.ts:32

isLive

isLive: boolean

---

pause

pause: undefined

Defined in: types.ts:29

---

play

play: undefined

Defined in: types.ts:28

---

qualitiesavailable

qualitiesavailable: object

Defined in: types.ts:134

qualities

qualities: QualityLevel[]

---

qualitychange

qualitychange: object

Defined in: types.ts:135

from

from: QualityLevel | null

to

to: QualityLevel

---

statechange

statechange: object

Defined in: types.ts:27

from

from: PlayerState

to

to: PlayerState

---

texttrackchange

texttrackchange: object

Defined in: types.ts:136

track

track: VideTextTrack | null

---

texttracksavailable

texttracksavailable: object

Defined in: types.ts:137

tracks

tracks: VideTextTrack[]

---

timeupdate

timeupdate: object

Defined in: types.ts:31

currentTime

currentTime: number

duration

duration: number