Video

Adds a video to the app to improve its interactivity.

null

Tracks: Provides time triggered text to the viewer.
Parameters:
source_Filename: A text file that contains the track text. Must be in WebVTT format, and added as a managed asset.
languageCode: The two-letter code for the language of the text, a valid BCP 47 tag. For example, "en" for English.
label: The label that the user sees. For example, an option in a menu of languages available for subtitles.
kind: The track type.
default: Show this track by default. Otherwise the viewer must select the language from the captions or subtitles menu. VideoTracks[]

Appearance

Width: The width in px, % or em.\r\nFor example\: 50px, 20%, 0.4em. If no unit is specified, px is assumed. String

Height: Height in px, em\r\nFor 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 | M3U8} VideoSourceType

Auto preload: When enabled, video data will begin loading as soon as view loads Boolean

Auto play: When enabled, video will start playing as soon as view is loaded Boolean

Events

On Load:

Description: Triggers whenever the view is loaded.

Example:

me.setWidth(${DeviceSensor}.getDeviceInfo().clientWidth)

Extends:

com.ibm.bpm.coach.CoachView

Methods:

Inherited addClass(name, [replaced])

Add or replace the CSS classes for this view.

Name Type Default Description

name {string} The CSS class names to add to the view. For multiple classes, use space to separate the class names.

replaced {string} The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names.

Example

Button.addClass("green");

getAutoPreload() Returns: {boolean}

Get configured autoPreload for VideoPlayer control

getAutoplay() Returns: {boolean}

Get configured autoplay for VideoPlayer control

Inherited getData() Returns: {Object}

Retrieve the bound data associated with the view. It applies only to views with bound data.

Example

var dec1 = MyDecimal.getData();

getHeight() Returns: {string}

Get configured height for VideoPlayer control

getPosterURL() Returns: {string}

Get configured posterURL for VideoPlayer control

getSourceType() Returns: {string}

Gets source type of VideoPlayer control. NOTE: This always returns the source type as set.

getType() Returns: {string}

Get descriptive string representing the type of control

getVideoPlayerSource() Returns: {string}

Get VideoPlayer for VideoPlayer control

getWidth() Returns: {string}

Get configured width for VideoPlayer control

Inherited hide(collapseFlag)

Hide the view.

Name Type Default Description

collapseFlag {boolean} Set to true to collapse the view (equivalent to a view setting of "NONE")

Example

MyView.hide();

Inherited isBound() Returns: {boolean}

Indicate the bound status of the view.

Inherited isEnabled() Returns: {boolean}

Check whether the view is enabled.

Example

var enabled = MyView.isEnabled();

Inherited isLabelVisible() Returns: {boolean}

Check whether the view label is visible.

Example

var labelVisible = MyView.isLabelVisible();

Inherited isValid() Returns: {boolean}

Return the valid status as last set by the setValid() method.

Example

var valid = MyView.isValid();

Inherited isVisible() Returns: {boolean}

Check whether the view is visible.

Example

var visible = MyView.isVisible();

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagate the value change of the view up through the parent views.

Name Type Default Description

event {Event} Value change event (usually an onchange event)

Example

MyView.propagateUp(event);

Inherited recalculate()

Applicable only to formula-enabled views!
Triggers the re-evaluation of the formula
for the view, if a formula was 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

setAutoPreload(autoPreload)

Set autoPreload of VideoPlayer control

Name Type Default Description

autoPreload {boolean} set to true to enable automatic preloading

setAutoplay(autoplay)

Set autoplay of VideoPlayer control

Name Type Default Description

autoplay {boolean} Set to true to enable autoplay

Inherited setEnabled(enabled, required)

Enable or disable the view.

Name Type Default Description

enabled {boolean} Enabled/read-only flag (true to enable view, false to disable/make read-only)

required {boolean} Enable or disable the required field flag for the view.

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 Default Description

height {string} Video player height

Inherited setLabelVisible(visible)

Show or hide the view label.

Name Type Default 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 Default 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 {@link 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 Default Description

type {string} "MP4" | "WEBM" | "FLV"

Inherited setValid(valid, errorText)

Flag the view as valid or invalid.

Name Type Default 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, "Fix your data entry"); //Make MyView invalid

setVideoPlayerSource(url)

Set VideoPlayer for VideoPlayer control

Name Type Default Description

url {string} Video source URL

Example

me.setVideoPlayerSource(${VideoSource1}.getValue()); // Here, VideoSource1 would be a {@link 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

Inherited setViewData(data, createPseudoBinding)

Set or update the bound data associated with the view. It applies only to views with bound data.

Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the binding.set pattern, as described in the Binding data and configuration options documentation section.

Name Type Default Description

data {Object} The value of the bound data. The parameter type must match the type of the bound data.

createPseudoBinding {boolean} If the value is set to true, the parameter creates a pseudo binding if there is no current binding.

Example

MyView.setViewData("TEST"); //Updates bound data to the string 'TEST'

Inherited setVisible(visible, collapse)

Show or hide the view.

Name Type Default Description

visible {boolean} Visibility flag (true to show the view, false to hide it)

collapse {boolean} Set it to true to collapse the view space when the option 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 Default Description

width {string} Video Player width

Inherited show()

Show this view.

Example

MyView.show();

Inherited triggerFormulaUpdates([phase])

Broadcast the expression trigger for the specified view.

Name Type Default Description

phase {int} bpmext.ui.PHASE_NORMAL The phase we are currently in

Example

MyView.triggerFormulaUpdates();

Methods

Parent

Helpers