<m-video>

The m-video element is used to display a video in a 3D scene.

Try it

Attributes

  • src: string

    The source URI of the video file. Supported formats may vary depending on the rendering engine used. Some engines support streaming video using WHEP (WebRTC video streaming). In this case, the URI should use the protocol "whep://" rather than "https://".

  • width: float

    The width of the video in meters. Default value is 1 meter.

  • height: float

    The height of the video in meters. Default value is 1 meter.

  • emissive: float

    The emissiveness strength of the video (how much perceived light it will emit). Default value is 0.

  • loop: boolean

    Whether the video should loop (true) or play once (false). Default value is true.

  • enabled: boolean

    Whether the video is enabled (true) or disabled (false). Default value is true.

  • volume: float

    The volume of the video's audio, ranging from 0 (silent) to 1 (maximum volume). Default value is 1.

  • start-time: int

    The time in milliseconds since the start of the document lifecycle when the video should start playing. Default value is 0.

  • pause-time: int

    The time in milliseconds since the start of the document lifecycle when the video should pause. If there is no value the video will not be paused.

Attribute Groups

  • Attribute Group: debuggable

    • debug: boolean

      A boolean that indicates whether the element should be drawn with debug information (e.g. axes helper). Default value is false.

  • Attribute Group: transformable

    • x: float

      The position of the element along the X-axis in meters. Default value is 0.

    • y: float

      The position of the element along the Y-axis in meters. Default value is 0.

    • z: float

      The position of the element along the Z-axis in meters. Default value is 0.

    • rx: float

      The rotation of the element around the X-axis in degrees. Default value is 0.

    • ry: float

      The rotation of the element around the Y-axis in degrees. Default value is 0.

    • rz: float

      The rotation of the element around the Z-axis in degrees. Default value is 0.

    • sx: float

      The scale of the element along the X-axis. Default value is 1.

    • sy: float

      The scale of the element along the Y-axis. Default value is 1.

    • sz: float

      The scale of the element along the Z-axis. Default value is 1.

    • visible: boolean

      Whether the element is visible (true) or hidden (false) in the scene. Default value is true.

    • socket: string

      The name of a bone in the parent element's skeletal mesh to which this element will be attached. If not specified, the element will attach to the origin of its parent.

  • Attribute Group: collideable

    • collide: boolean

      Whether or not this object should participate in collision detection by other systems. Default value is true. If set to true, the object will be considered for collision tests.

    • collision-interval: int

      If set, the time in milliseconds between user collision events being sent to the element. By default collision events are not sent.

    • oncollisionstart: script

      A script expression to be executed when a user starts colliding with the element. Receives a CollisionStartEvent.

    • oncollisionmove: script

      A script expression to be executed when a user moves the collision point they are colliding at on the element. Receives a CollisionMoveEvent.

    • oncollisionend: script

      A script expression to be executed when a user stops colliding with the element. Receives a CollisionEndEvent.

  • Attribute Group: coreattrs

    • id: ID

      A unique identifier for the element, used for selection and manipulation through scripting. It must be unique within the document.

    • class: string

      A space-separated list of class names that can be used for scripting purposes.

  • Attribute Group: shadows

    • cast-shadows: boolean

      Whether the element casts shadows onto other elements (true) or not (false). Default value is true.

Examples

Dimensions

This is a basic m-video with dimension properties.

Position

This is a basic m-video with position properties.

Rotation

This is a basic m-video with rotation properties.

Scale

This is a basic m-video with scale properties.

Single Dimension

Specifying only one dimension will resize the element keeping the original aspect ratio.

Compatibility Table

WEBUNREAL
m-video✓✓
src✓✓
width✓✓
height✓✓
loop✓✓
enabled✓✓
volume✓✓
start-time✓✓
pause-time✓✓
emissive✗✓
debug✓✓
x✓✓
y✓✓
z✓✓
rx✓✓
ry✓✓
rz✓✓
sx✓✓
sy✓✓
sz✓✓
visible✓✓
socket✓✗
collide✓✓
collision-interval✓✗*
oncollisionstart✓✗*
oncollisionmove✓✗*
oncollisionend✓✗*
id✓✓
class✓✓
cast-shadows✓✗