reference
classes
Playback

Class: abstract Playback<Config>

Abstract class representing a playback plugin. It extends the Plugin class and provides common properties and methods for playback functionality.

Extends

Extended by

Type Parameters

• Config = any

Constructors

new Playback()

new Playback<Config>(ctx): Playback<Config>

Constructor for the Plugin class

Parameters

• ctx: Context

The VxdkContext instance

Returns

Playback<Config>

Inherited from

Plugin.constructor

Defined in

modules/common/module.ts:55 (opens in a new tab)

Properties

hooks

hooks: Hook<Playback<Config>>

Inherited from

Plugin.hooks

Defined in

modules/common/module.ts:22 (opens in a new tab)

name

abstract name: string

Inherited from

Plugin.name

Defined in

modules/common/module.ts:21 (opens in a new tab)

type

readonly type: PLAYBACK = PluginType.PLAYBACK

Overrides

Plugin.type

Defined in

modules/playback/base_playback.ts:11 (opens in a new tab)

Accessors

autoLevelEnabled

get abstract autoLevelEnabled(): boolean

Abstract getter to check if auto level selection is enabled.

Returns

boolean

Defined in

modules/playback/base_playback.ts:157 (opens in a new tab)

bridge

get protected bridge(): PlatformBridgeController

Protected getter for the bridge instance

Returns

PlatformBridgeController

Inherited from

Plugin.bridge

Defined in

modules/common/module.ts:85 (opens in a new tab)

bufferedPercentage

get abstract bufferedPercentage(): number

Abstract getter to get the buffered percentage of the playback.

Returns

number

Defined in

modules/playback/base_playback.ts:122 (opens in a new tab)

controller

get protected controller(): Controller

Protected getter for the controller instance

Returns

Controller

Inherited from

Plugin.controller

Defined in

modules/common/module.ts:78 (opens in a new tab)

currentLevel

get abstract currentLevel(): Level

Abstract getter to get the current quality level of the playback.

Returns

Level

Defined in

modules/playback/base_playback.ts:147 (opens in a new tab)

currentTime

get abstract currentTime(): number

Abstract getter to get the current time of the playback in seconds.

Returns

number

Defined in

modules/playback/base_playback.ts:137 (opens in a new tab)

duration

get abstract duration(): number

Abstract getter to get the duration of the current source in seconds.

Returns

number

Defined in

modules/playback/base_playback.ts:142 (opens in a new tab)

emit

get protected emit(): (name, data?) => void

Protected getter for the 'emit' event emission method

Returns

Function

Parameters

• name: string | number

• data?: undefined

Returns

void

Inherited from

Plugin.emit

Defined in

modules/common/module.ts:128 (opens in a new tab)

emitIfChanged

get protected emitIfChanged(): (name, data) => void

Protected getter for the 'emitIfChanged' event emission method

Returns

Function

Parameters

• name: string | number

• data: any

Returns

void

Inherited from

Plugin.emitIfChanged

Defined in

modules/common/module.ts:135 (opens in a new tab)

events

get protected events(): string[]

Protected getter for the events array

Returns

string[]

Array of event names

Inherited from

Plugin.events

Defined in

modules/common/module.ts:114 (opens in a new tab)

hasEnded

get abstract hasEnded(): boolean

Abstract getter to check if the playback has ended.

Returns

boolean

Defined in

modules/playback/base_playback.ts:132 (opens in a new tab)

isLive

get abstract isLive(): boolean

Abstract getter to check if the playback is live.

Returns

boolean

Defined in

modules/playback/base_playback.ts:62 (opens in a new tab)

isMuted

get abstract isMuted(): boolean

Abstract getter to check if the playback is muted.

Returns

boolean

Defined in

modules/playback/base_playback.ts:47 (opens in a new tab)

isPlaying

get abstract isPlaying(): boolean

Abstract getter to check if the playback is currently playing.

Returns

boolean

Defined in

modules/playback/base_playback.ts:127 (opens in a new tab)

levels

get abstract levels(): Level[]

Abstract getter to get the available quality levels of the playback.

Returns

Level[]

Defined in

modules/playback/base_playback.ts:152 (opens in a new tab)

logger

get protected logger(): Logger

Protected getter for the logger instance

Returns

Logger

Logger instance for this module

Inherited from

Plugin.logger

Defined in

modules/common/module.ts:40 (opens in a new tab)

nativeEl

get abstract nativeEl(): unknown

Abstract getter to get the native element of the playback.

Returns

unknown

Defined in

modules/playback/base_playback.ts:72 (opens in a new tab)

off

get protected off(): (name, listener) => void

Protected getter for the 'off' event unbinding method

Returns

Function

Parameters

• name: string | number

• listener: Listener<void>

Returns

void

Inherited from

Plugin.off

Defined in

modules/common/module.ts:99 (opens in a new tab)

on

get protected on(): (name, listener) => Disposable

Protected getter for the 'on' event binding method

Returns

Function

Parameters

• name: string | number

• listener: Listener<void>

Returns

Disposable

Inherited from

Plugin.on

Defined in

modules/common/module.ts:92 (opens in a new tab)

once

get protected once(): (name, listener) => void

Protected getter for the 'once' event binding method

Returns

Function

Parameters

• name: string | number

• listener: Listener<void>

Returns

void

Inherited from

Plugin.once

Defined in

modules/common/module.ts:106 (opens in a new tab)

playbackRate

get abstract playbackRate(): number

Abstract getter to get the current playback rate.

Returns

number

Defined in

modules/playback/base_playback.ts:117 (opens in a new tab)

playbackType

get abstract playbackType(): PlaybackType

Abstract getter to get the playback type.

Returns

PlaybackType

Defined in

modules/playback/base_playback.ts:77 (opens in a new tab)

storage

get protected storage(): StorageController

Protected getter for the storage instance

Returns

StorageController

Inherited from

Plugin.storage

Defined in

modules/common/module.ts:71 (opens in a new tab)

volume

get abstract volume(): number

Abstract getter to get the current volume of the playback.

Returns

number

Defined in

modules/playback/base_playback.ts:94 (opens in a new tab)

Methods

connectedCallback()

abstract connectedCallback(): void

Abstract method called when the playback is connected to the DOM.

Returns

void

Overrides

Plugin.connectedCallback

Defined in

modules/playback/base_playback.ts:16 (opens in a new tab)

disconnectedCallback()

abstract disconnectedCallback(): void

Abstract method called when the playback is disconnected from the DOM.

Returns

void

Overrides

Plugin.disconnectedCallback

Defined in

modules/playback/base_playback.ts:27 (opens in a new tab)

getConfig()

protected getConfig(): Config

Protected method to get the plugin configuration

Returns

Config

The plugin configuration

Inherited from

Plugin.getConfig

Defined in

modules/common/module.ts:64 (opens in a new tab)

load()

abstract load(startTime?): void

Abstract method to load the playback with an optional start time.

Parameters

• startTime?: number

The time in seconds to start the playback from.

Returns

void

Defined in

modules/playback/base_playback.ts:22 (opens in a new tab)

mute()

abstract mute(): void

Abstract method to mute the playback.

Returns

void

Defined in

modules/playback/base_playback.ts:52 (opens in a new tab)

pause()

abstract pause(): void

Abstract method to pause the playback.

Returns

void

Defined in

modules/playback/base_playback.ts:42 (opens in a new tab)

play()

abstract play(): void | Promise<void>

Abstract method to start the playback.

Returns

void | Promise<void>

Defined in

modules/playback/base_playback.ts:32 (opens in a new tab)

replay()

abstract replay(): void | Promise<void>

Abstract method to replay the playback.

Returns

void | Promise<void>

Defined in

modules/playback/base_playback.ts:67 (opens in a new tab)

seekPercentage()

abstract seekPercentage(percentage): void

Abstract method to seek the playback to a given percentage of the duration.

Parameters

• percentage: number

The percentage (between 0 and 100) to seek to.

Returns

void

Defined in

modules/playback/base_playback.ts:89 (opens in a new tab)

seekTo()

abstract seekTo(seconds): void

Abstract method to seek the playback to a given time in seconds.

Parameters

• seconds: number

The time in seconds to seek to.

Returns

void

Defined in

modules/playback/base_playback.ts:83 (opens in a new tab)

selectAudioLanguage()

abstract selectAudioLanguage(language): void

Abstract method to select an audio language for the playback.

Parameters

• language: string

The language code of the audio track to select.

Returns

void

Defined in

modules/playback/base_playback.ts:169 (opens in a new tab)

selectLevel()

abstract selectLevel(level): void

Abstract method to select a quality level for the playback.

Parameters

• level: "auto" | Level

The level to select. Can be a LevelDto object or "auto".

Returns

void

Defined in

modules/playback/base_playback.ts:163 (opens in a new tab)

setPlaybackRate()

abstract setPlaybackRate(playbackRate): void

Abstract method to set the playback rate.

Parameters

• playbackRate: number

The playback rate to set.

Returns

void

Defined in

modules/playback/base_playback.ts:112 (opens in a new tab)

setSource()

abstract setSource(src): void

Abstract method to set the source of the playback.

Parameters

• src: string

The source URL to set.

Returns

void

Defined in

modules/playback/base_playback.ts:106 (opens in a new tab)

setVolume()

abstract setVolume(volume): void

Abstract method to set the volume of the playback.

Parameters

• volume: number

The volume to set.

Returns

void

Defined in

modules/playback/base_playback.ts:100 (opens in a new tab)

stop()

abstract stop(): void

Abstract method to stop the playback.

Returns

void

Defined in

modules/playback/base_playback.ts:37 (opens in a new tab)

syncWithLive()

abstract syncWithLive(): void

Abstract method to sync the playback with the live edge.

Returns

void

Defined in

modules/playback/base_playback.ts:174 (opens in a new tab)

unmute()

abstract unmute(): void

Abstract method to unmute the playback.

Returns

void

Defined in

modules/playback/base_playback.ts:57 (opens in a new tab)

canPlay()

static canPlay(_): boolean

Static method to check if a given source can be played by the playback.

Parameters

• _: string

The source to check.

Returns

boolean

True if the source can be played, false otherwise.

Defined in

modules/playback/base_playback.ts:181 (opens in a new tab)

Html5playerPlugin