Video

A wrapper around the HTMLVideoElement providing useful shorthands.

Hierarchy

Video

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Video(asset: Asset): Video

- Defined in video.ts:37
Parameters
- asset: Asset
  
  The Asset representing this video. The asset's sources and formats are used in order.
Returns Video

Properties

canplaythrough

canplaythrough: boolean = false

Whether the element's canplaythrough event has fired.

el

el: HTMLVideoElement

The HTMLVideoElement.

Optional rate

rate: number | function

The playback rate (multiplier). See Asset.rate.

Optional seek

seek: number | function

The media's seek point (sec). See [[Asset.seek].

src

src: string

The HTMLVideoElement's currentSrc.

Methods

after

after(duration: number, cb: function): void

- Defined in video.ts:86
Fire the callback once after playing for the duration (sec), or, if the provided duration is negative, that many seconds from the video end. Removes need for complicated timeout management.

Parameters
- duration: number
- cb: function
  - - (...any: any[]): void
    - Parameters
      - Rest ...any: any[]
      Returns void
Returns void

destroy

destroy(): void

- Defined in video.ts:130
Pauses the video, removes all handlers, and removes element from DOM.

Returns void

off

off(event: string, callback: function): void

- Defined in video.ts:76
Removes an event listener added in on or once.

Parameters
- event: string
- callback: function
  - - (...any: any[]): any
    - Parameters
      - Rest ...any: any[]
      Returns any
Returns void

on

on(event: string, cb: function): void

- Defined in video.ts:54
Adds an event listener with addEventListener. Remove with off.

Parameters
- event: string
- cb: function
  - - (...any: any[]): void
    - Parameters
      - Rest ...any: any[]
      Returns void
Returns void

once

once(event: string, cb: function): void

- Defined in video.ts:63
Adds an event listener with on which is removed after the event fires.

Parameters
- event: string
- cb: function
  - - (...any: any[]): void
    - Parameters
      - Rest ...any: any[]
      Returns void
Returns void

pause

pause(): void

- Defined in video.ts:123
Pause the video playback.

Returns void

play

play(): void

- Defined in video.ts:105
Start the video playback

Returns void

playWhenReady

playWhenReady(): void

- Defined in video.ts:112
Start the video playback after canplaythrough has fired.

Returns void

Generated using TypeDoc