Documentation & Tutorials
  • Pivec Labs Documentation & Tutorials
  • Assets for Game Creator 1
    • Action Pack 1
      • Action List
        • Misc Actions
        • Object Actions
        • TMP Actions
      • Examples
        • Example 1 TMP
        • Example 2 Objects
        • Example 3 Actions
    • Action Pack 2
      • Action List
        • Camera Actions
        • Graphics Actions
        • Audio Actions
        • Video Actions
      • Triggers
      • Components
      • Examples
        • Example 1 - Camera
        • Example 2 - Camera FPS
        • Example 3 - Graphics
        • Example 4 - Sounds
        • Example 5 - Audio Player
        • Example 6 - Video Player
    • Action Pack 3
      • Action List
        • Day/Night Cycle
        • Light Control
      • Components
      • Examples
        • Example 1 - Day Night Cycle
        • Example 2 - Light Control
    • Accessibility Module
      • Components
      • Setup
      • Auditory Aids
        • Closed Captions for Sounds
        • Volume Control with Tags
        • Multiple Volume Controls
      • Motoric Aids
        • Configurable Tank Camera
        • On-Screen Multi-Function Joystick
        • Dynamic Touchstick
        • Multi-Function Touchstick
      • Cognitive Aids
        • Parental Controls with Password
        • Dyslexia Font Options
        • Motion Sickness Prevention
        • Gameplay Speed and Sensitivity
      • Visual Aids
        • Colour Picker
        • Variable Text Size
        • Object Outlining
        • Colour Switching
        • Colour Correction
    • Mobile Components
      • Actions
        • Haptics
        • Camera
        • TouchSticks
        • Gyroscope
        • Utilities
      • Triggers
        • Touch Gestures
      • Conditions
      • Components
      • Prefabs
      • Examples
        • Example 1 Haptics
        • Example 2 Cameras
        • Example 3 Gestures
        • Example 4 Controls
        • Example 5 Steering Wheel/Pedals
        • Example 6 Gyroscope Controls
        • Example 7 Gyroscope Camera
        • Example 8 Utilities
        • Example 9 AutoRun
      • Extras
    • UI Components
      • Canvas Components
        • Canvas Animations
        • 3D Models on a Canvas
        • Video on a Canvas
      • Animating UI Elements
        • Cross Fade Elements
        • Slide Elements
        • Shake UI Element
        • Tooltips
      • Text Mesh Pro & uGUI Text
      • Colour Picker Component
      • Mini Map Component
        • MiniMap QuickStart
        • Fullscreen Map
        • Adding Markers
        • Adding Labels
      • System Info Panel
        • SysInfo Quickstart
        • Using SysInfo Toggle
      • Main Menu Templates
        • Customising the Prefabs
        • Load/Save System
        • Comic Strip Example
    • Developer Tools
      • Time Manager
        • Actions & Conditions
      • Waypoint System
      • Click to Spawn Objects
      • In-Game Console
      • In-Game Screen Capture
    • Turn Based Module
    • VR Module GC1
  • Assets for Unity
    • Developer Tools for Unity
      • Click to Spawn
      • In-Game Screen Capture
      • In-Game Console
    • Mini Map System
      • MiniMap Quickstart
      • Map Parameters
      • Adding Makers
  • Tutorials
    • Tutorials for Game Creator 1
      • Installing and Updating Modules
      • Adding Actions to the Button Bar
      • Changing the Graphics for TouchStick
      • Adding Passwords to Player Actions
      • Using the Colour Picker with Variables
      • Creating a 3D Inspection Panel for Game Objects
      • Customising the UI MiniMap
      • Creating a toggle for the SysInfo Panel
      • Simple Player Run on Left Shift Down
      • Pan Follow Camera with Keyboard
    • Tutorials for Unity
  • ANNEX
    • Roadmap
    • FAQ
Powered by GitBook
On this page

Was this helpful?

  1. Assets for Game Creator 1
  2. UI Components
  3. Canvas Components

Video on a Canvas

Previous3D Models on a CanvasNextAnimating UI Elements

Last updated 5 years ago

Was this helpful?

Video Actions

Action Name

Description

Add Video to Canvas Panel

Adds a Local or Remote Video to the Canvas

Play Video on Canvas

Starts the Video Playing with parameters

Pause Video on Canvas

Pauses the Video

Stop Video on Canvas

Stops the Video from Playing

Resume Video on Canvas

Resume playing the Video

Remove Video from Canvas Panel

Removes the Video from the Canvas Panel

The suggested process for adding and playing a Video on a UI Canvas is as follows:

  1. Using Unity's dropdown menu, add a RawImage element to your Canvas Panel and size it to whatever size you wish your video to be when playing.

  2. You can add a background texture to the RawImage if you wish (see UI example), but the color seeting in the RawImage must be white to be able to see the video correctly.

  3. Within a Trigger of your choice, include the Action Add Video to Canvas.

  4. Set the Origin (Local would be a Video in your resources folder, remote would be a video on a server) to your chosen Video, and the name/path of the video.

The Unity Video Player does not yet work with YouTube Videos and the URL for a remote video must be a full url address (ie: include the http)

5. Add the RawImage from your scene hierarchy to this Action under Target Raw Image. The Target RawImage must also be added to all Actions that control this Video (Play, Pause, Stop, Remove) as you can have multiple videos in your scene.

6. You can add the Play Video Action to this Action after the Add Video, or you can add it to another Action if required. However, it is important that the Video is added to the RawImage before you attempt tp play it.

7. These Actions will Automatically create a Render Texture, add it to the RawImage, and create and execute the Video Player.