Skip to main content
Version: 1.0.4

Video Player

Plays video from the asset library or uploads folder, shows a LIVE camera feed from the site’s own media server, or embeds a hosted link.

The Video Player component as it renders with its default settings.The Video Player component as it renders with its default settings.

Reach for it when you need:

  • A live camera over a critical process
  • Training clips and recorded incidents

Component name: VideoPlayer · Category: Display

In the palette: Plays a video from the asset Library or the Uploads folder (training clips, SOPs, recorded incidents) with themed controls, shows a LIVE camera feed from the site's own media server, or embeds a YouTube/Vimeo link. Library, Uploads and live camera feeds all work OFFLINE; hosted video needs internet access and an administrator to enable External frames. Browsers play MP4 (H.264) and WebM — a DVR export in .avi/.mkv must be re-exported as MP4.

Properties

Any property can be bound to a tag, another component's property, or a query.

PropertyTypeDefaultDescription
srcasset""The clip, from the asset Library or the Uploads folder. Bindable — bind a tag/expression yielding a path (e.g. Videos/line1/startup.mp4) or an upload:// ref (a File Manager widget's {{ <name>.selectedItem.ref }}) to swap the video at runtime. Use mediaserver://<connection id> for a LIVE feed — the stream is proxied through QUBIQ, so the media server's address and password never reach the browser. A YouTube or Vimeo link switches to embed mode, where the provider's own player is shown and the playback bindings below stop applying.
posterasset""Still image shown before playback starts. With preload 'none' this means a view full of video widgets costs no video bytes until an operator presses play.
controlsenumfullHow much player chrome to show. Ignored in embed mode (the provider supplies its own). Options: none · minimal · full.
autoPlaybooleanfalseStart playing on load. Forces muted — browsers block unmuted autoplay, and an unattended HMI panel that starts playing audio is an operational hazard.
mutedbooleanfalseStart muted. Bindable.
loopbooleanfalseRestart automatically when the clip ends.
volumenumber1Playback volume, 0–1. Bindable.
playbackRatenumber1Playback speed (1 = normal). Bindable.
playingbooleanfalseBindable COMMAND — drive play/pause from a tag or an event action. Unavailable in embed mode.
seekTonumber0Bindable COMMAND — jump to this position, in seconds. Applied only when the value CHANGES, so an operator scrubbing manually is never yanked back. Unavailable in embed mode.
preloadenummetadataHow much to fetch before play is requested. Keep 'metadata' on views with several videos — 'auto' starts a full download per widget as soon as the view opens. Options: none · metadata · auto.
objectFitenumcontainHow the picture fills its box. Options: contain · cover · fill.
streamQualityenumautoLive feeds only. Which of the media server's streams to pull. Auto uses the camera's low-resolution sub-stream for a small tile — the same picture at that size, for a fraction of the decoding, which is what lets a wall of cameras run at all. Falls back to the main stream if no sub-stream is configured. Options: auto · main · sub.
interactivebooleantrueAllow playback gestures in LiveView. The editor always locks them so selecting and moving the widget isn't stolen by the player.
outputobject{"currentTime":0,"duration":0,"paused":true,"ended":false,"b… (truncated)Read-only runtime outputs the widget publishes — bind a leaf, e.g. {{ <VideoPlayer>.output.currentTime }}.
stylestyle{}Custom CSS properties

Events

Attach event actions to these in the Event Manager.

EventLabelGroupPayload
clickClickMouseThe DOM event.
dblclickDouble clickMouseThe DOM event.
contextmenuRight clickMouseThe DOM event.
mouseenterMouse enterMouseThe DOM event.
mouseleaveMouse leaveMouseThe DOM event.
playPlayVideoMedia state, under media.
pausePauseVideoMedia state, under media.
endedEndedVideoMedia state, under media.
videoErrorPlayback errorVideoMedia state, under media.
Right-click behaves differently in the Designer

contextmenu fires your configured actions at runtime only — in LiveView and in preview. On the Designer canvas the right-click is captured to open the Event Manager, so testing it there will not run your actions. Test right-click in preview.

Notes

Library, uploads and live camera feeds work offline; hosted video needs internet access and an administrator to enable external frames.

Browsers play MP4 (H.264) and WebM — a DVR export in .avi/.mkv must be re-exported.

For multi-camera tiles, use the media server’s sub-streams; several full-resolution feeds will saturate a panel PC.

See also