@videts/vide / index / Player
Interface: Player
Defined in: types.ts:291
Extends
Extended by
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
activeCues | readonly | VideCue[] | - |
autoplay | public | boolean | - |
buffered | readonly | TimeRanges | - |
controls | public | boolean | - |
crossOrigin | public | string | null | - |
currentQuality | readonly | QualityLevel | null | - |
currentTime | public | number | - |
defaultMuted | public | boolean | - |
defaultPlaybackRate | public | number | - |
duration | readonly | number | - |
el | readonly | MediaElement | - |
ended | readonly | boolean | - |
isAudio | readonly | boolean | - |
isAutoQuality | readonly | boolean | - |
isLive | readonly | boolean | - |
loop | public | boolean | - |
muted | public | boolean | - |
networkState | readonly | number | - |
paused | readonly | boolean | - |
playbackRate | public | number | - |
poster | public | string | - |
preload | public | "" | "none" | "metadata" | "auto" | - |
qualities | readonly | QualityLevel[] | - |
readyState | readonly | number | - |
seekable | readonly | TimeRanges | - |
seekableRange | readonly | SeekableRange | null | - |
seeking | readonly | boolean | - |
src | public | string | Current media source URL. Setting triggers SourceHandler lookup. |
state | readonly | PlayerState | - |
textTracks | readonly | TextTrackList | - |
videoHeight | readonly | number | - |
videoWidth | readonly | number | - |
volume | public | number | - |
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
Call Signature
addEventListener(
type,listener,options?):void
Defined in: types.ts:346
Parameters
| Parameter | Type |
|---|---|
type | string |
listener | EventListenerOrEventListenerObject |
options? | boolean | AddEventListenerOptions |
Returns
void
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
destroy()
destroy():
void
Defined in: types.ts:370
Returns
void
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
getActiveTextTrack()
getActiveTextTrack():
VideTextTrack|null
Defined in: types.ts:318
Returns
VideTextTrack | null
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
getTextTracks()
getTextTracks():
VideTextTrack[]
Defined in: types.ts:317
Returns
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
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
Call Signature
off(
event,handler):void
Defined in: types.ts:191
Parameters
| Parameter | Type |
|---|---|
event | string |
handler | EventHandler<never> |
Returns
void
Inherited from
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
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
Call Signature
on(
event,handler):void
Defined in: types.ts:181
Parameters
| Parameter | Type |
|---|---|
event | string |
handler | EventHandler<never> |
Returns
void
Inherited from
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
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
Call Signature
once(
event,handler):void
Defined in: types.ts:203
Parameters
| Parameter | Type |
|---|---|
event | string |
handler | EventHandler<never> |
Returns
void
Inherited from
pause()
pause():
void
Defined in: types.ts:296
Returns
void
play()
play():
Promise<void>
Defined in: types.ts:295
Returns
Promise<void>
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
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
Call Signature
removeEventListener(
type,listener,options?):void
Defined in: types.ts:358
Parameters
| Parameter | Type |
|---|---|
type | string |
listener | EventListenerOrEventListenerObject |
options? | boolean | EventListenerOptions |
Returns
void
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
setQuality()
setQuality(
id):void
Defined in: types.ts:312
Parameters
| Parameter | Type |
|---|---|
id | number |
Returns
void
setTextTrack()
setTextTrack(
id):void
Defined in: types.ts:320
Parameters
| Parameter | Type |
|---|---|
id | number |
Returns
void
use()
use(
plugin):void
Defined in: types.ts:369
Parameters
| Parameter | Type |
|---|---|
plugin | Plugin |
Returns
void