Class: Video

Video

The Video control adds a video to a Coach. A Video control provides the following configuration properties in Process Designer:

Appearance

Width: Width in px, %, em For example: 50px, 20%, 0.4em. If no unit is specified, px is assumed string
Height: Height in px, em For example: 50px, 0.4em. If no unit is specified, px is assumed string
Poster Image: URL for poster image string

Behavior

Video Source Type: Type of video
{MP4 | WEBM | FLV}
string
Auto-Preload: When enabled, video data will begin loading as soon as control loads boolean
Auto-Play: When enabled, video will start playing as soon as control is loaded boolean

Events

On Load:
Description: Triggers whenever the view is loaded.
Example:
me.setWidth(${DeviceSensor}.getDeviceInfo().clientWidth)
Article(s)
Video
Video with BPM File Uploader & BPM File List

new Video()

This constructor is never used explicitly.

Extends

Members

Methods

Add/replace CSS class(es) for this control
Name Type Description
name string CSS class name(s) to add to the control. Separate class names by a space if more than one class.
replaced string optional CSS class name(s) to be replaced by the first argument. Separate class names by a space if more than one class.
Example
Button.addClass("green");

getAutoplay(){boolean}

Get configured autoplay for VideoPlayer control
Returns:
Type Description
boolean

getAutoPreload(){boolean}

Get configured autoPreload for VideoPlayer control
Returns:
Type Description
boolean
Retrieve bound data associated this view/control. Only works for views/controls with bound data.
Returns:
Type Description
Object Value of bound data. undefined if the view has no data binding.
Example
var dec1 = MyDecimal.getData();

getHeight(){string}

Get configured height for VideoPlayer control
Returns:
Type Description
string

getPosterURL(){string}

Get configured posterURL for VideoPlayer control
Returns:
Type Description
string

getSourceType(){string}

Gets source type of VideoPlayer control. NOTE: This always returns the source type as set.
Returns:
Type Description
string

getType(){string}

Get descriptive string representing the type of control
Returns:
Type Description
string

getVideoPlayerSource(){string}

Get VideoPlayer for VideoPlayer control
Returns:
Type Description
string

getWidth(){string}

Get configured width for VideoPlayer control
Returns:
Type Description
string
Hide this view/control
Name Type Description
collapseFlag boolean Set to true to collapse the view (equivalent to a view setting of "NONE")
Example
MyView.hide();
Indicates bound status of control.
Returns:
Type Description
boolean True if the control is bound to coach data.
Checks if the view is enabled or not
Returns:
Type Description
boolean Enabled status
Example
var enabled = MyView.isEnabled();
Checks if control label is visible
Returns:
Type Description
boolean Label visibility status
Example
var labelVisible = MyView.isLabelVisible();
Returns the valid status as last set by the setValid() method.
Returns:
Type Description
boolean Validity status. true if setValid(false, ...) was never called
Example
var valid = MyView.isValid();
Checks whether or not view is visible
Returns:
Type Description
boolean Visibility status
Example
var visible = MyView.isVisible();
Propagates value change of control up through parent views
Name Type Description
event Event Value change event (usually an onchange event)
Returns:
Type Description
boolean True if a formula update was triggered on the control's parent, otherwise false
Example
MyView.propagateUp(event);
Only for formula-enabled views!
Explicitly triggers the re-evaluation of the formula for this view (if a formula has been specified). If the view is not formula-enabled, recalculate() does nothing.
Example
Text1.recalculate(); //If the formula for Text1 is: new Date().toString(), Text1 is updated to the current date/time

setAutoplay(autoplay)

Set autoplay of VideoPlayer control
Name Type Description
autoplay boolean Set to true to enable autoplay

setAutoPreload(autoPreload)

Set autoPreload of VideoPlayer control
Name Type Description
autoPreload boolean set to true to enable automatic preloading
Set/update bound data associated this view/control. Only works for views/controls with bound data.
Name Type Description
value Object Value of bound data. The type of this parameter must match the type of the bound data.
Example
MyView.setData("TEST"); //Updates bound data to the string 'TEST'
Enable/disable this view/control
Name Type Description
enabled boolean Enabled/read-only flag (true to enable view, false to disable/make read-only)
required boolean Enable/disable required field flag for control
Example
MyView.setEnabled(false); //Make MyView read-only

setHeight(height)

Set height of VideoPlayer control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
height string Video player height
Show/hide the label of this view/control
Name Type Description
visible boolean Label visibility flag (true to show view label, false to hide)
Example
MyView.setLabelVisible(false);

setPosterURL(url)

Set posterURL of VideoPlayer control
Name Type Description
url string Poster image url location. Poster image will be displayed over the video while it isn't playing.
Example
me.setPosaterURL(${Poster1}.getValue()); // Here, Poster1 would be a Data control with the poster url already bound to it// The url for a locally hosted image (contained in the Process app) can be set using// tw.system.model.findManagedFileByPath(<File Name> (e.g. "Poster.png"), TWManagedFily.Types.Web).url

setSourceType(type)

Sets source type of VideoPlayer control. NOTE: No validation is done
Name Type Description
type string "MP4" | "WEBM" | "FLV"
Flag this view/control as valid or invalid
Name Type Description
valid boolean Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator)
errorText string Validation error text to show on the invalid-styled view
Example
MyView.setValid(false, "Please fix your data entry"); //Make MyView invalid

setVideoPlayerSource(url)

Set VideoPlayer for VideoPlayer control
Name Type Description
url string Video source URL
Example
me.setVideoPlayerSource(${VideoSource1}.getValue()); // Here, VideoSource1 would be a Data control with the video url already bound to it// The url for a locally hosted video (contained in the Process app) can be set using// tw.system.model.findManagedFileByPath(<File Name> (e.g. "VideoFile.mp4"), TWManagedFily.Types.Web).url
Show/hide this view/control
Name Type Description
visible boolean Visibility flag (true to show view, false to hide)
collapse boolean Set to true to collapse the control space when visible is set to false.
Examples
MyView.setVisible(false, false); //Equivalent to MyView.hide()
MyView.setVisible(false, true); // Sets visibility to "None"

setWidth(width)

Set width of VideoPlayer control (e.g. 50px, 20%, 2em - omitting the unit assumes px)
Name Type Description
width string Video Player width
Show this view/control
Example
MyView.show();
Broadcasts the expression trigger for the specified view
Name Type Default Description
phase int bpmext.ui.PHASE_NORMAL optional The phase we are currently in
Example
MyView.triggerFormulaUpdates();