The Video widget displays a video in an app view.


  • UI Type:

Extends: BaseWidget

Properties

Name Desciption
Auto PlayAutomatically start the video.
ControlsDisplay play/pause controls.
DisabledThe widget cannot be used.
HiddenHides the widget from the user.
LoopLoop the video playback.
MaximizeSet this widget to be maximized (take up all available space).
MutedDisable the sound.
ParameterUse an video defined by a specific config parameter.
PreloadPreload video. You can choose to preload the entire video, just a preview or not at all.
ResourceUse an video defined by a resource.
Tab IndexThe Tab Index is an integer that tells the order of the widget when using the tab-key to move from one widget to another.
Video URLThe URL of the video displayed by the widget.

Style

Name Desciption
Background-colorChange background color of the widget.
ColorColor of the text inside the widgets. May not apply to all text inside all widgets.
Font SizeSet the font size in pixels for text.
Text-alignmentSet left, centered or right. Applies both to icon and text.

Events

Name Description Event Attribute
Blur Event when a widget goes out of focus.
event The event that gets triggered when the user "leaves" an element.
Click Event that triggers based on touch or click.
event The event that triggered the handler.
DblClick Event that triggers based on double click.
event The event that triggered the handler.
Focus Event when indicating/ highlighting widget using the cursor.
event Focus is the event that gets triggered when a user makes an element come into focus, by clicking on it.

Function

getPosition ( ) { Integer }

Get Video Position.

hasEnded ( ) { Boolean }

Check whether Video has Ended.

Returns

True if the Video Ended, false otherwise.

isPaused ( ) { Boolean }

Check whether Video is Paused.

Returns

True if the Video is Paused, false otherwise.

pause ( )

pause Video.

play ( )

play Video.

setPosition ( time: Integer )

set Video Position.

Parameters
Name Type Description
time Integer time

setSource ( url: String )

Set Video Source

Parameters
Name Type Description
url String url

blur ( )

Triggers the blur event.

focus ( )

Triggers the focus event.

get ( name: String ) { Object }

Gets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
Returns

The property's value.

getId ( ) { ID }

Returns the ID of the widget.

Returns

The ID of the widget

getValue ( ) { Object }

Returns the widget's value.

Returns

The widget's value.

hide ( )

Hides the widget.

isEnabled ( ) { Boolean }

Returns true if the widget is enabled.

Returns

True if enabled, otherwise false.

isHidden ( ) { Boolean }

Returns true if the widget is hidden.

Returns

True if hidden, otherwise false.

set ( name: String , value: Object )

Sets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
value Object The new value.

setEnabled ( Enabled: Boolean )

Enables/disables the widget.

Parameters
Name Type Description
Enabled Boolean True to enable the widget, false to disable.

setStyle ( Object: Object )

Set the widget-style

Parameters
Name Type Description
Object Object properties

setValue ( value: Object )

Sets the widget's value.

Parameters
Name Type Description
value Object The new value.

show ( )

Shows the widget.