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.

Settings

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

Event handlersHiddenShow 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.

Values

change	A user changes the value.
click	A user clicks or taps the component.
submit	A user submits the value.
focus	A user selects the input field.
blur	A user deselects the input field.
scan	A user scans a barcode.
open	A user opens the component.
close	A user closes the component.
true	A user sets the value to true.
false	A user sets the value to false.
select	A user selects a value.
clear	A user clears the value.
upload	A user uploads a file.
parse	An uploaded file is parsed.
inputValueChange	A user changes the value of the input field.

method

enum

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

type

enum

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).

hidden

boolean

Whether the component is visible.

hideControls

id

string

The unique identifier.

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

loop

boolean

Whether to loop the media.

maintainSpaceWhenHidden

boolean

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

margin

enum

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.

showInEditor

boolean

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.

tooltipText

string

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.