Class VideoConfig

Class that represents the custom configurations received by the Video.

Export

VideoConfig

Hierarchy (View Summary)

AbstractConfiguration
- VideoConfig

Index

Constructors

Properties

ExtendedClass Autoplay Captions Controls Height Loop Muted PosterURL URL Width

Methods

validateBoolean validateDate validateInRange validateNumber validateString validateTime validateCanChange validateDefault

Constructors

constructor

new VideoConfig(config: JSON): VideoConfig
Parameters
- config: JSON
Returns VideoConfig
Overrides AbstractConfiguration.constructor
- Defined in OSFramework/OSUI/Pattern/Video/VideoConfig.ts:21

Properties

ExtendedClass

ExtendedClass: string

Autoplay

Autoplay: boolean

Captions

Captions: string

Controls

Controls: boolean

Height

Height: string

Loop

Loop: boolean

Muted

Muted: boolean

PosterURL

PosterURL: string

URL

URL: string

Width

Width: string

Methods

`Protected`validateBoolean

validateBoolean(value: boolean, defaultValue: boolean): boolean
Protected
Method that helps to validate if a boolean is not undefined
Parameters
- value: boolean
- defaultValue: boolean
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateBoolean
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:30

`Protected`validateDate

validateDate(value: string | Date, defaultValue: string): string | Date
Protected
Method that helps to validate if a given value is a valid date
Parameters
- value: string | Date
- defaultValue: string
Returns string | Date
{(string | Date)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateDate
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:43

`Protected`validateInRange

validateInRange(
    value: unknown,
    defaultValue: unknown,
    ...args: unknown[],
): unknown
Protected
Method that helps to validate if a given value is within a range of values.
Parameters
- value: unknown
- defaultValue: unknown
- ...args: unknown[]
Returns unknown
{unknown}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateInRange
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:57

`Protected`validateNumber

validateNumber(value: number, defaultValue: number): number
Protected
Method that helps to validate if a number is not empty or undefined.
Parameters
- value: number
- defaultValue: number
Returns number
{number}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateNumber
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:79

`Protected`validateString

validateString(value: string, defaultValue: string): string
Protected
Method that helps to validate if a string is not empty or undefined.
Parameters
- value: string
- defaultValue: string
Returns string
{string}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateString
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:92

`Protected`validateTime

validateTime(value: string, defaultValue: string): string
Protected
Method that helps to validate if a given value is a valid time
Parameters
- value: string
- defaultValue: string
Returns string
{(string)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateTime
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:105

validateCanChange

validateCanChange(_isBuilt: boolean, _key: string): boolean
Method that validates if a given property can be changed.
Parameters
- _isBuilt: boolean
- _key: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateCanChange
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:118

validateDefault

validateDefault(_key: string, value: unknown): unknown
Method that assures that the values being set as configurations respect the defaults.
Parameters
- _key: string
- value: unknown
Returns unknown
{unknown}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractConfiguration.validateDefault
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:131