The Video web component
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 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
The playback position of the media.
duration
The duration of the media, in seconds.
Properties
event
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 |
false | A user sets the value to |
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
The JavaScript method to perform when type
is datasource
, widget
, state
, or localStorage
.
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
Whether the object is globally scoped for use in all app pages.
hideControls
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
playbackRate
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
Whether the media is playing.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
tooltipText
The tooltip text to display.
volume
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
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.