Class UFVideo

UFVideo encapsulates a single video. It offers a preload method to try to preload the video, so it is ready when needed.

Supports window.UFDEBUG constant to show debug information.

Index

Constructors

Accessors

muted paused position volume

Methods

destroy handleCanPlay handleEnded pause performPreload play preload resume stop triggerVideoStart

Constructors

constructor

new UFVideo(
    anElement: string | HTMLVideoElement,
    anUrl: string,
    aPosterUrl?: string,
    aShowOnPlay?: boolean,
    aPlayingCallback?: UFCallback,
    aStoppedCallback?: UFCallback,
): UFVideo
Constructs an instance of UFVideo.
Parameters
- anElement: string | HTMLVideoElement
  Dom id of video element or jquery instance
- anUrl: string
  Url to mp4 video
- OptionalaPosterUrl: string
  Url to poster or null if there is none
- OptionalaShowOnPlay: boolean
  True=show element when play is called, false=show element when video is ready to play
- OptionalaPlayingCallback: UFCallback
  Callback to call when video started playing
- OptionalaStoppedCallback: UFCallback
  Callback to call when video stopped playing
Returns UFVideo
- Defined in src/components/UFVideo.ts:178

Accessors

muted

get muted(): boolean
When assigned true will mute the sound of the video.

Returns boolean
- Defined in src/components/UFVideo.ts:330
set muted(aValue: boolean): void
Parameters
- aValue: boolean
Returns void
- Defined in src/components/UFVideo.ts:334

paused

get paused(): boolean
Current paused state.

Returns boolean
- Defined in src/components/UFVideo.ts:363

position

get position(): number
Current time of video (in seconds).

Returns number
- Defined in src/components/UFVideo.ts:341
set position(aValue: number): void
Parameters
- aValue: number
Returns void
- Defined in src/components/UFVideo.ts:345

volume

get volume(): number
Current volume of the video.

Returns number
- Defined in src/components/UFVideo.ts:352
set volume(aValue: number): void
Parameters
- aValue: number
Returns void
- Defined in src/components/UFVideo.ts:356

Methods

destroy

destroy(): void
Cleans up used resources and removes listeners.

Returns void
- Defined in src/components/UFVideo.ts:219

handleCanPlay

handleCanPlay(anEvent: Event): void
Handles video being available to play.
Parameters
- anEvent: Event
Returns void
- Defined in src/components/UFVideo.ts:474

handleEnded

handleEnded(anEvent: Event): void
Handles end of video.
Parameters
- anEvent: Event
Returns void
- Defined in src/components/UFVideo.ts:454

pause

pause(): void
Pauses the video.

Returns void
- Defined in src/components/UFVideo.ts:289

performPreload

performPreload(): void
Tries to preload the video.

Returns void
- Defined in src/components/UFVideo.ts:409

play

play(
    aLoop: boolean,
    aStartCallback?: UFCallback,
    aDoneCallback?: UFCallback,
): void
Plays and shows the video from the start.
Parameters
- aLoop: boolean
  True=loop the video (aDoneCallback is ignored)
- OptionalaStartCallback: UFCallback
  To call when video has started playing
- OptionalaDoneCallback: UFCallback
  To call when video has finished playing
Returns void
- Defined in src/components/UFVideo.ts:234

preload

preload(): void
Tries to preload the video.

Returns void
- Defined in src/components/UFVideo.ts:266

resume

resume(): void
Resumes the video.

Returns void
- Defined in src/components/UFVideo.ts:301

stop

stop(): void
Stops and hides the video.

Returns void
- Defined in src/components/UFVideo.ts:313

triggerVideoStart

triggerVideoStart(): void
Calls start callback and trigger VIDEO_START.

Returns void
- Defined in src/components/UFVideo.ts:434