Skip to main content
Version: 4.60

video

Displays a video.

Field Configurations

KeyTypeDescriptionDefault Value
"autoplay"BooleanIndicates if the video layer should automatically play the video when its loaded.false
"hasPlaybackControls"BooleanIndicates if the video has playback controls.true
"isLiveStream"BooleanThis option will disable download and caching of the video file. Instead, the video will be played back directly from url source.false
"onStateChanged"StringName of the event which will be executed when the state of the video changes (play/pause).null
"progressBarBackground"ColorThe background color of the progress bar when a video is loaded.null
"progressBarColor"ColorThe color of the progress bar when a video is loaded.null
"replayMode"StringIndicates how the video layer should behave when the video playback has ended."none"
"requireCache"BooleanEnables video pre-loading to cache. Video will not be streamed.false
"subtitle"StringURL to subtitles for this video.null
"subtitleType"StringType of the subtitle.null

Inherited

From Base Layer

Base Layer

Field Configurations

KeyTypeDescriptionDefault Value
"_value"Value[PREVIEW] Dynamic value of the layer.null
"accessibilityAppendState"StringDefines this layer appends its state to the accessibility text.null
"accessibilityText"StringText for accessibility navigation. Can be translated.null
"actions"ActionListList of actions, which will be executed when the layer is tapped.null
"borderColor"ColorThe color of the border in hex color value.null
"borderRadius"UnitSizeThe radius applies to all corners; with a borderWidth of 0 the border is not drawn and radius is set anyway.0
"borderWidth"UnitSizeThe width of the border.0
"bottomLeftRadius"UnitSizeRadius for the bottom left corner.0
"bottomRightRadius"UnitSizeRadius for the bottom right corner.0
"classes"ArrayList of classes for layer styles.null
"conditions"ConditionsList of conditions to alter the layer state.null
"constraints"ConstraintsA list of constraints defining the position of the layer in a layout.null
"consumesKeyboard"BooleanThis layer will be used to shrink, if a keyboard is shown.null
"dataKey"StringName for assigning data to this layer.null
"focusColor"ColorThe 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"BooleanIndicates whether the layer is hidden. Default: false.false
"isAccessibilityElement"StringDefines if this layer is important for accessibility navigation. The default depends on the layer type.null
"layerRotation"NumberThe layer is rotated by the specified degree.0
"name"StringUnique name in the layout. Used for alignment or actions.null
"opacity"NumberThe opacity of the layer.1
"overInsetBottom"BooleanDetermines if this layer ignores the save space at the bottom of the device.false
"overInsetTop"BooleanDetermines if this layer ignores the save space at the top of the device.false
"pressedColor"ColorThe 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"SafeAreaTypeObjectDetermines the safe area behaviour.null
"shadowElevation"NumberThe elevation of this layer for casting shadows.0
"state"StringThe state the layer will use as default."default"
"states"LayerStatesA list of named states that affect the appearance of the layer.null
"topLeftRadius"UnitSizeRadius for the top left corner.0
"topRightRadius"UnitSizeRadius for the top right corner.0
"touchFeedback"TouchFeedbackDetermines if the layer should show a touch feedback if touched."visible"
"trackingKey"StringDefines a key for a scroll event.null
"type"LayerTypeThe type of the layernull
"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:

Screenshot of the app showing the results of the sample code from Example 1.
A video layer which plays automatically but can be paused or rewinded.