Product documentation and training for Shipcode.
Basic Components: Video
Show a video by uploading or providing a link.

The Video is a component that allows you to add media to your project. Its content can be sourced either by uploading a file from your computer or by entering a URL.

Source and Playback

  • Uploaded Assets: To use an uploaded video, you must first upload the file to your project’s Assets Manager. You can then select the file from the Asset Browser in the component's Settings Panel.
    • Supported File Types: mp4, mov, avi, webm
  • Remote Location (URI): To display a video from a remote location, you specify the URL using the URI property.
    • The URL should point directly to the video file unless you are using a supported third party video platform.
    • When your URL matches that of a supported platform, the platform’s own video player will be used instead of the default device video player.

Supported Platform URL Formats:

  • Facebook: https://www.facebook.com/video/embed?video_id=<VIDEO_ID>
  • Vimeo: https://player.vimeo.com/video/<VIDEO_ID>
  • YouTube: https://www.youtube.com/embed/<VIDEO_ID>

Available Properties

These properties are configured in the Settings Panel and control the video's playback and sizing.

  • Ratio (Settings Panel): You can provide the video’s ratio in decimal format (proportion of width to height). Common video ratios like 4:3 and 16:9 are 1.33 and 1.78, respectively.
    • Tip: Providing a ratio allows Shipcode to automatically calculate the Video component’s height for its current width. If not provided, you must specify a height, and the component may display empty space if its dimensions do not match the video’s aspect ratio.
  • Auto Play (Settings Panel): If enabled, the video will play as soon as it is loaded onto the screen.
  • Fullscreen (Settings Panel): If enabled, the video will play in full screen.
  • Muted (Settings Panel): If enabled, the video will play without sound.
  • Repeat (Settings Panel): If enabled, the video will repeat automatically.
  • URI (Settings Panel): The URL pointing to the video file or supported video platform.
Did this answer your question?