Class Video

Defines the interface for OutSystemsUI Patterns

Export

Implements

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<VideoConfig>
- Video

Implements

IVideo

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _platformEventOnStateChanged

_platformEventOnStateChanged: OSOnStateChangedEvent

`Private` _videoElement

_videoElement: HTMLVideoElement

`Private` _videoJumpTime

_videoJumpTime: number

`Private` _videoSourceElement

_videoSourceElement: HTMLSourceElement

`Private` _videoState

_videoState: string

Methods

`Protected` finishBuild

finishBuild(): void
Protected
Marks the built as being finished.

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractPattern.finishBuild
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:61

`Protected` triggerPlatformEventCallback

triggerPlatformEventCallback(platFormCallback: OSGeneric, ...args: unknown[]): void
Protected
Triggers a generic platform event.

Memberof
AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
- Rest ...args: unknown[]
Returns void
Inherited from AbstractPattern.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected` triggerPlatformInitializedEventCallback

triggerPlatformInitializedEventCallback(): void
Protected
Trigger the Initialized callback platform event.

Memberof
AbstractPattern

Returns void
Inherited from AbstractPattern.triggerPlatformInitializedEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:93

`Protected` unsetGlobalCallbacks

unsetGlobalCallbacks(): void
Protected
Unsets the global callbacks. This naming is used to prevent overriding the unsetCallback method on all patterns

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractPattern.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- patternId: string
Returns boolean
Implementation of IVideo.equalsToID

Inherited from AbstractPattern.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Private` _setAutoplay

_setAutoplay(): void
Private
Method that will set the Autoplay attribute

Memberof
Video

Returns void
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:39

`Private` _setControls

_setControls(): void
Private
Method that will set the controls attribute

Memberof
Video

Returns void
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:55

`Private` _setHeight

_setHeight(): void
Private
Method that will set the Height attribute

Memberof
Video

Returns void
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:65

`Private` _setLoop

_setLoop(): void
Private
Method that will set the loop attribute

Memberof
Video

Returns void
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:83

`Private` _setMuted

_setMuted(): void
Private
Method that will set the muted attribute

Memberof
Video

Returns void
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:93

`Private` _setPosterUrl

_setPosterUrl(): void
Private
Method that will set the poster image on video

Memberof
Video

Returns void
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:103

`Private` _setVideoConfigs

_setVideoConfigs(): void
Private
Method to apply all initial video configs

Memberof
Video

Returns void
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:117

`Private` _setVideoSource

_setVideoSource(): void
Private
Method to create the source element

Memberof
Video

Returns void
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:144

`Private` _setVideoTrack

_setVideoTrack(): void
Private
Method create the track element

Memberof
Video

Returns void
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:162

`Private` _setWidth

_setWidth(): void
Private
Method that will set the Width attribute

Memberof
Video

Returns void
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:192

`Private` _triggerOnStateChangedEvent

_triggerOnStateChangedEvent(stateChanged: string): void
Private
Method that triggers the OnStateChanged event

Memberof
Video
Parameters
- stateChanged: string
  
  value of video state
Returns void
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:211

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Sets the A11Y properties when the pattern is built.

Memberof
OSFramework.Patterns.Video.Video

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:230

`Protected` setCallbacks

setCallbacks(): void
Protected
Sets the callbacks to be used in the pattern.

Memberof
OSFramework.Patterns.Video.Video

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:240

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Set the html references that will be used to manage the cssClasses and atribute properties

Memberof
OSFramework.Patterns.Video.Video

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:268

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Method to remove all assigned callbacks

Memberof
OSFramework.Patterns.Video.Video

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:290

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Release references to HTML elements.

Memberof
OSFramework.Patterns.Video.Video

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:304

build

build(): void
Method to build the Video

Memberof
OSFramework.Patterns.Video.Video

Returns void
Implementation of IVideo.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:314

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method to change the value of configs/current state.

Memberof
OSFramework.Patterns.Video.Video
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Implementation of IVideo.changeProperty

Overrides AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:331

dispose

dispose(): void
Method to destroy Video instance

Memberof
OSFramework.Patterns.Video.Video

Returns void
Implementation of IVideo.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:370

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Set callbacks for the pattern

Memberof
OSFramework.Patterns.Video.Video
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of IVideo.registerCallback

Overrides AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:395

setVideoJumpToTime

setVideoJumpToTime(currentTime: number): void
Method to set current time

Memberof
Video
Parameters
- currentTime: number
  
  value in seconds
Returns void
Implementation of IVideo.setVideoJumpToTime
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:416

setVideoPause

setVideoPause(): void
Method to pause video

Memberof
OSFramework.Patterns.Video.Video

Returns void
Implementation of IVideo.setVideoPause
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:425

setVideoPlay

setVideoPlay(): void
Method to play video

Memberof
OSFramework.Patterns.Video.Video

Returns void
Implementation of IVideo.setVideoPlay
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:434

Accessors

`Protected` _enableAccessibility

get _enableAccessibility(): boolean
Protected
Getter that allows to obtain the accessibility is enabled.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractPattern._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
Implementation of IVideo.selfElement

Inherited from AbstractPattern.selfElement
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:218

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Implementation of IVideo.isBuilt

Inherited from AbstractPattern.isBuilt
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:229

configs

get configs(): C
Current configurations/state of the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from AbstractPattern.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of IVideo.uniqueId

Inherited from AbstractPattern.uniqueId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:251

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of IVideo.widgetId

Inherited from AbstractPattern.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

getVideoState

get getVideoState(): string
Method to get video state

Memberof
OSFramework.Patterns.Video.Video

Returns string
Implementation of IVideo.getVideoState
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:384

Constructors

constructor

new Video(uniqueId: string, configs: JSON): OSFramework.OSUI.Patterns.Video.Video
Creates an instance of Video.

Memberof
Video
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.Video.Video
Overrides AbstractPattern.constructor
- Defined in OSFramework/OSUI/Pattern/Video/Video.ts:29

Class Video

Export

Implements

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Private _platformEventOnStateChanged

Private _videoElement

Private _videoJumpTime

Private _videoSourceElement

Private _videoState

Methods

Protected finishBuild

Memberof

Returns void

Protected triggerPlatformEventCallback

Memberof

Parameters

platFormCallback: OSGeneric

Rest ...args: unknown[]

Returns void

Protected triggerPlatformInitializedEventCallback

Memberof

Returns void

Protected unsetGlobalCallbacks

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Private _setAutoplay

Memberof

Returns void

Private _setControls

Memberof

Returns void

Private _setHeight

Memberof

Returns void

Private _setLoop

Memberof

Returns void

Private _setMuted

Memberof

Returns void

Private _setPosterUrl

Memberof

Returns void

Private _setVideoConfigs

Memberof

Returns void

Private _setVideoSource

Memberof

Returns void

Private _setVideoTrack

Memberof

Returns void

Private _setWidth

Memberof

Returns void

Private _triggerOnStateChangedEvent

Memberof

Parameters

stateChanged: string

Returns void

Protected setA11YProperties

Memberof

Returns void

Protected setCallbacks

`Protected` isProviderBased

`Private` _platformEventOnStateChanged

`Private` _videoElement

`Private` _videoJumpTime

`Private` _videoSourceElement

`Private` _videoState

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _setAutoplay

`Private` _setControls

`Private` _setHeight

`Private` _setLoop

`Private` _setMuted

`Private` _setPosterUrl

`Private` _setVideoConfigs

`Private` _setVideoSource

`Private` _setVideoTrack

`Private` _setWidth

`Private` _triggerOnStateChangedEvent

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` _enableAccessibility