Video Player

A component that displays a video.

📘

Use the Youtube Player to play YouTube videos and playlists.

How to use

  • To add the source of the video for the Video component to play, go to the Data tab (third tab) in the Properties Panel.
  • Under Input Text > URL, you can add a static video URL.
  • Go to the Styles tab (first tab), and make sure to add a value for the width property. A Video component needs to have a width and a height defined.
  • If the Video URL is coming from an API endpoint, you can define a variable in curly braces {{}} in Input Text > URL and then select the value of the URL from the dropdown menu under Variables.

Style Properties

Style properties allow you to customize the look and feel of the component. Combinations of styles applied to components can be saved as Stylesheets to easily reuse styles throughout your app. Styles can also be set dynamically using Variables. To learn more about all the different styling properties and how they work, take a look at Intro to Styling.

Configuration Properties

PropertyDescription
Component NameTo alter the name of the component. The name is reflected in the Components tree. Defaults to Video.
Enable ThumbnailEnable so that a thumbnail will appear when the video is not playing.
Resize ModeHow the video will be resized when its dimensions set for the component don't match the actual dimensions of the video. Refer to the Resize Mode table in the Image component to learn more about each setting.
Mute AudioEnable to mute the video.
Use Native ControlsEnable to give users the ability to play/pause the video.
Play AutomaticallyEnable so that the video will play when loaded.
Loop VideoEnable to loop the video.
Starting PointAdd a value in milliseconds to play the video from that timestamp.
Playback RateAccepts a numerical value to set the Playback rate of the Video.
VolumeAccepts a numerical value to set the volume of the video on play.

Data Properties

PropertyDescription
Thumbnail URLAn optional URL to display as the video thumbnail
URLThe URL for the video to display

Conditional Display

You can conditionally display a component based on a given condition. Learn more about conditionally displaying components in the Conditional Display doc.

Triggers

NameDescription
On Playback Status UpdateRuns the Actions when the playback status is updated. E.g. when it is played, paused, or stopped.
On Playback FinishRuns the Actions when the video has finished playback.

Actions

ActionDescription
Play MediaPlays the media associated with the selected Target Component
Pause MediaPauses the media associated with the selected Target Component
Seek Media PositionUpdates play play position for the media associated with the selected Target Component in milliseconds
Toggle Media PlaybackPlays or pauses the media associated with a selected Target Component depending on the current playback state.