ControlBarOptions
Options for ControlBar
interface ControlBarOptions
Properties
Automatically hide control bar on video plays.
true to enable with default values, false to disable.
Override default class names.
Whether to play / pause video on canvas click
Custom control bar items
Show fullscreen button.
true to enable with default values, false to disable.
Show gyroscope control enable / disable button.
true to enable with default values, false to disable.
Enable keyboard controls for video.
Pressing up / down arrow will control video volume, and pressing left / right arrow will control video time.
Show camera pie view.
true to enable with default values, false to disable.
Show video play / pause button.
true to enable with default values, false to disable.
Show video progress bar.
true to enable with default values, false to disable.
Show background element.
Show video current / total time
true to enable with default values, false to disable.
Show video volume control button.
true to enable with default values, false to disable.
Show VR button.
true to enable with default values, false to disable.
Properties
autoHide
autoHideboolean | Partial<AutoHideOptions>
Automatically hide control bar on video plays.
true to enable with default values, false to disable.
className
classNamePartial<{ CONTROLS_BG: string; CONTROLS_BOTTOM: string; CONTROLS_BUTTON: string; CONTROLS_FLOAT_LEFT: string; CONTROLS_FLOAT_RIGHT: string; CONTROLS_LEFT: string; CONTROLS_MAIN: string; CONTROLS_MID: string; CONTROLS_RIGHT: string; CONTROLS_ROOT: string; CONTROLS_TOP: string; FIXED: string; FULLSCREEN_BUTTON: string; FULLSCREEN_EXIT_BUTTON: string; GYRO_DISABLED: string; GYRO_ENABLED: string; HIDDEN: string; MUTED_BUTTON: string; PAUSE_BUTTON: string; PIEVIEW_ROOT: string; PLAY_BUTTON: string; PROGRESS_ROOT: string; RANGE_FILLER: string; RANGE_ROOT: string; RANGE_THUMB: string; RANGE_TRACK: string; UNAVAILABLE: string; UNMUTED_BUTTON: string; VIDEO_TIME_DISPLAY: string; VOLUME_ROOT: string; VR_BUTTON: string }>
Override default class names.
clickToPlay
clickToPlayboolean
Whether to play / pause video on canvas click
customItems
customItems
Custom control bar items
fullscreenButton
fullscreenButtonboolean | Partial<ControlBarItemOptions>
Show fullscreen button.
true to enable with default values, false to disable.
gyroButton
gyroButtonboolean | Partial<ControlBarItemOptions>
Show gyroscope control enable / disable button.
true to enable with default values, false to disable.
keyboardControls
keyboardControlsboolean
Enable keyboard controls for video.
Pressing up / down arrow will control video volume, and pressing left / right arrow will control video time.
pieView
pieViewboolean | Partial<PieViewOptions>
Show camera pie view.
true to enable with default values, false to disable.
playButton
playButtonboolean | Partial<ControlBarItemOptions>
Show video play / pause button.
true to enable with default values, false to disable.
progressBar
progressBarboolean | Partial<ControlBarItemOptions>
Show video progress bar.
true to enable with default values, false to disable.
showBackground
showBackgroundboolean
Show background element.
videoTime
videoTimeboolean | Partial<ControlBarItemOptions>
Show video current / total time
true to enable with default values, false to disable.
volumeButton
volumeButtonboolean | Partial<ControlBarItemOptions>
Show video volume control button.
true to enable with default values, false to disable.
vrButton
vrButtonboolean | Partial<ControlBarItemOptions>
Show VR button.
true to enable with default values, false to disable.