Free cookie consent management tool by TermsFeed

Video Component

Function

a!videoField( label, labelPosition, instructions, videos, helpTooltip, accessibilityText, showWhen, marginAbove, marginBelow )

Creates a Video component.

See also: Web Video

Parameters

Name Keyword Types Description

Label

label

Text

Text to display as the field label.

Label Position

labelPosition

Text

Determines where the label appears. Valid values:

  • "ABOVE" (default) Displays the label above the component.
  • "ADJACENT" Displays the label to the left of the component.
  • "COLLAPSED" Hides the label. The label will still be read by screen readers; see accessibility considerations for more information.
  • "JUSTIFIED" Aligns the label alongside the component starting at the edge of the page.

Instructions

instructions

Text

Supplemental text about this field.

Videos

videos

Any Type

Array of videos to display, created with a!webVideo().

Help Tooltip

helpTooltip

Text

Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".

Accessibility Text

accessibilityText

Text

Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.

Visibility

showWhen

Boolean

Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Margin Above

marginAbove

Text

Determines how much space is added above the layout. Valid values: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".

Margin Below

marginBelow

Text

Determines how much space is added below the layout. Valid values: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".

Usage considerations

Supported formats

  • The video formats supported by this component vary by device and browser. Videos of a format not supported by a device/browser will not play in the device/browser.
    • WebM and Ogg are supported on Chrome and Firefox.
    • MP4, 3gp, mov, and mpv are supported on iOS devices.
    • MP4, 3gp, webm, and mkv are supported on Android devices.
  • Videos served over HTTP and HTTPS are both supported. For videos that require authentication, we strongly recommend that you set up single sign-on between Appian and the server that hosts the video so that the video can play without requiring the user to authenticate a second time.

Appian Documents

a!videoField() cannot be used to display videos stored as Appian documents.

Examples

Use the interactive editor below to test out your code:

Feature compatibility

The table below lists this component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Incompatible
Offline Mobile Incompatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports Incompatible

Cannot be used to configure a process report.
Process Events Incompatible

Cannot be used to configure a process event node, such as a start event or timer event.

Feedback