Skip to main content

The Video component for Retool Apps

A content area to display a video.

Video supports popular video services (e.g., YouTube and Vimeo) and direct links to video file types commonly supported by browsers.

Demo

Settings​

Video includes the following configurable options when building apps in the IDE.

Event handlersShow on desktopShow on mobileLoopMaintain space when hiddenMarginAlways show in edit modeSourceStylesHelper text

Properties​

All properties for Video with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

currentTimeStamp​

number

The playback position of the media.

duration​

number

The duration of the media, in seconds.

events​

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event​

enum

The event type. Refer to the events section for a list of supported events.

method​

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

The type of action to perform.

Values
datasource

Control query.

widget

Control component.

script

Run script.

state

Set variable.

localStorage

Set localStorage.

util

Perform utility action (e.g., Open URL or Confetti).

global​

boolean

Whether the object is globally scoped for use in all app pages.

​

boolean

Whether the component is visible.

hideControls​

id​

string

The unique identifier.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

loop​

boolean

Whether to loop the media.

Whether the component takes up space on the canvas if hidden is true.

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

playbackRate​

number

The playback speed, expressed in increments of 1. Default is 1 for 1x speed. Negative values are not supported. Some video sources and browsers may clamp the speed range.

playing​

boolean

Whether the media is playing.

pluginType​

string

The plugin type.

Whether to remain visible in the editor if hidden is true.

src​

string

The data source.

style​

object

Custom style options in use. Not all style options may be available for all components.

The tooltip text to display.

volume​

number

The volume of the media, from 0 to 1.

Methods​

JavaScript API methods for interacting with Video. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

pause​

Pause operation.

video.pause()

play​

Start operation.

video.play()

seekTo​

Seek to a specific time in the content.

video.seekTo(time)
Parameters

time​

number

A time, in milliseconds.

Events​

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

ended​

Playback has ended.

load​

A file or data loads.

pause​

Playback is paused.

play​

Playback is started or resumed.