Class VideoPlugin

Controls a video adapter

Hierarchy (view full)

AbstractConfigurablePlugin<VideoPluginConfig, VideoPluginConfig, never, VideoPluginEvents>
- VideoPlugin

Index

Constructors

constructor

new VideoPlugin(viewer, config): VideoPlugin
Parameters
- viewer: Viewer
- config: VideoPluginConfig
Returns VideoPlugin
Overrides AbstractConfigurablePlugin.constructor
- Defined in packages/video-plugin/src/VideoPlugin.ts:46

Properties

`Readonly`config

config: VideoPluginConfig

`Protected`viewer

viewer: Viewer

`Static` `Readonly`configParser

configParser: ConfigParser<VideoPluginConfig, VideoPluginConfig> = getConfig

`Static` `Readonly`id

id: "video" = 'video'

Unique identifier of the plugin

`Static` `Readonly`readonlyOptions

readonlyOptions: string[] = ...

`Static` `Readonly`VERSION

VERSION: string = PKG_VERSION

Expected version of the core DO NOT USE on custom plugins

Methods

addEventListener

addEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends
      | "progress"
      | "play-pause"
      | "volume-change"
      | "buffer"
  the name of event
- E extends VideoPluginEvents & {
  type: T;
  }
  the class of the event
Parameters
- type: T
- callback: EventListenerObject | ((e: E) => void)
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from AbstractConfigurablePlugin.addEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:29

dispatchEvent

dispatchEvent(e): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference
Parameters
- e: VideoPluginEvents
Returns boolean
Inherited from AbstractConfigurablePlugin.dispatchEvent
- Defined in packages/core/src/lib/TypedEventTarget.ts:21

getDuration

getDuration(): number
Returns the durection of the video

Returns number
- Defined in packages/video-plugin/src/VideoPlugin.ts:167

getProgress

getProgress(): number
Returns the play progression of the video

Returns number
- Defined in packages/video-plugin/src/VideoPlugin.ts:181

getTime

getTime(): number
Returns the current time of the video

Returns number
- Defined in packages/video-plugin/src/VideoPlugin.ts:174

getVolume

getVolume(): number
Returns the video volume

Returns number
- Defined in packages/video-plugin/src/VideoPlugin.ts:195

isPlaying

isPlaying(): boolean
Returns if the video is playing

Returns boolean
- Defined in packages/video-plugin/src/VideoPlugin.ts:188

pause

pause(): void
Pauses the cideo if playing

Returns void
- Defined in packages/video-plugin/src/VideoPlugin.ts:224

play

play(): void
Starts the video if paused

Returns void
- Defined in packages/video-plugin/src/VideoPlugin.ts:215

playPause

playPause(): void
Starts or pause the video

Returns void
- Defined in packages/video-plugin/src/VideoPlugin.ts:202

removeEventListener

removeEventListener<T, E>(type, callback, options?): void
Type Parameters
- T extends
      | "progress"
      | "play-pause"
      | "volume-change"
      | "buffer"
  the name of event
- E extends VideoPluginEvents & {
  type: T;
  }
  the class of the event
Parameters
- type:
      | "progress"
      | "play-pause"
      | "volume-change"
      | "buffer"
- callback: EventListenerObject | ((e: E) => void)
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from AbstractConfigurablePlugin.removeEventListener
- Defined in packages/core/src/lib/TypedEventTarget.ts:41

setKeypoints

setKeypoints(keypoints?): void
Changes the keypoints
Parameters
- Optionalkeypoints: VideoKeypoint[]
Returns void
Throws
PSVError if the configuration is invalid
- Defined in packages/video-plugin/src/VideoPlugin.ts:297

setMute

setMute(mute?): void
(Un)mutes the video
Parameters
- Optionalmute: boolean
  toggle if undefined
Returns void
- Defined in packages/video-plugin/src/VideoPlugin.ts:244

setOption

setOption<T>(option, value): void
Update options
Type Parameters
- T extends string | number | symbol
Parameters
- option: T
- value: never[T]
Returns void
Inherited from AbstractConfigurablePlugin.setOption
- Defined in packages/core/src/plugins/AbstractPlugin.ts:68

setOptions

setOptions(options): void
Update options
Parameters
- options: never
Returns void
Inherited from AbstractConfigurablePlugin.setOptions
- Defined in packages/core/src/plugins/AbstractPlugin.ts:76

setProgress

setProgress(progress): void
Changes the progression of the video
Parameters
- progress: number
Returns void
- Defined in packages/video-plugin/src/VideoPlugin.ts:265

setTime

setTime(time): void
Changes the current time of the video
Parameters
- time: number
Returns void
- Defined in packages/video-plugin/src/VideoPlugin.ts:256

setVolume

setVolume(volume): void
Sets the volume of the video
Parameters
- volume: number
Returns void
- Defined in packages/video-plugin/src/VideoPlugin.ts:233