video

Displays a video.

Field Configurations

Key	Type	Description	Default Value
"autoplay"	Boolean	Indicates if the video layer should automatically play the video when its loaded.	false
"hasPlaybackControls"	Boolean	Indicates if the video has playback controls.	true
"isLiveStream"	Boolean	This option will disable download and caching of the video file. Instead, the video will be played back directly from url source.	false
"onStateChanged"	String	Name of the event which will be executed when the state of the video changes (play/pause).	null
"progressBarBackground"	Color	The background color of the progress bar when a video is loaded.	null
"progressBarColor"	Color	The color of the progress bar when a video is loaded.	null
"replayMode"	String	Indicates how the video layer should behave when the video playback has ended.	"none"
"requireCache"	Boolean	Enables video pre-loading to cache. Video will not be streamed.	false
"subtitle"	String	URL to subtitles for this video.	null
"subtitleType"	String	Type of the subtitle.	null

Inherited

From Base Layer

Base Layer

Field Configurations

Key	Type	Description	Default Value
"_value"	Value	[PREVIEW] Dynamic value of the layer.	null
"accessibilityAppendState"	String	Defines this layer appends its state to the accessibility text.	null
"accessibilityText"	String	Text for accessibility navigation. Can be translated.	null
"actions"	ActionList	List of actions, which will be executed when the layer is tapped.	null
"borderColor"	Color	The color of the border in hex color value.	null
"borderRadius"	UnitSize	The radius applies to all corners; with a borderWidth of 0 the border is not drawn and radius is set anyway.	0
"borderWidth"	UnitSize	The width of the border.	0
"bottomLeftRadius"	UnitSize	Radius for the bottom left corner.	0
"bottomRightRadius"	UnitSize	Radius for the bottom right corner.	0
"classes"	Array	List of classes for layer styles.	null
"conditions"	Conditions	List of conditions to alter the layer state.	null
"constraints"	Constraints	A list of constraints defining the position of the layer in a layout.	null
"consumesKeyboard"	Boolean	This layer will be used to shrink, if a keyboard is shown.	null
"dataKey"	String	Name for assigning data to this layer.	null
"focusColor"	Color	The highlight color of this layer when it is focused. Mainly used on TV. If no color is provided, the pressedColor will be used.	null
"hidden"	Boolean	Indicates whether the layer is hidden. Default: false.	false
"isAccessibilityElement"	String	Defines if this layer is important for accessibility navigation. The default depends on the layer type.	null
"layerRotation"	Number	The layer is rotated by the specified degree.	0
"name"	String	Unique name in the layout. Used for alignment or actions.	null
"opacity"	Number	The opacity of the layer.	1
"overInsetBottom"	Boolean	Determines if this layer ignores the save space at the bottom of the device.	false
"overInsetTop"	Boolean	Determines if this layer ignores the save space at the top of the device.	false
"pressedColor"	Color	The highlight color of this layer when it is pressed. Mainly used on TV. If no color is provided, the focusColor will be used.	null
"safeArea"	SafeAreaTypeObject	Determines the safe area behaviour.	null
"shadowElevation"	Number	The elevation of this layer for casting shadows.	0
"state"	String	The state the layer will use as default.	"default"
"states"	LayerStates	A list of named states that affect the appearance of the layer.	null
"topLeftRadius"	UnitSize	Radius for the top left corner.	0
"topRightRadius"	UnitSize	Radius for the top right corner.	0
"touchFeedback"	TouchFeedback	Determines if the layer should show a touch feedback if touched.	"visible"
"trackingKey"	String	Defines a key for a scroll event.	null
"type"	LayerType	The type of the layer	null
"value"	Value	(Initial) value of the layer.	null

Examples

Add an autoplay video

Goal: Create a video layer which will play automatically when the view is shown.

To achieve this the following code can be used:

{
  "type": "video",
  "name": "exampleVideo",
  "autoplay": true,
  "requireCache": true,
  "value": "http://www.giessen46ers.de/wp-content/uploads/Hammer1_MBC.mp4",
  "constraints": [
    {
      "type": "pos",
      "x": "0",
      "y": "0"
    },
    {
      "type": "pos",
      "anchor": "se",
      "relativeAnchor": "e",
      "x": "0",
      "y": "0"
    }
  ]
}

The value of the video layer is set to the URL of the video.
For this particular example it is required to cache the video.

Result:

A video layer which plays automatically but can be paused or rewinded.