Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
ardieffects:videopanel [2021/10/12 04:02] optrixardieffects:videopanel [2025/12/18 22:50] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +=====VideoPanel=====
  
 +====Summary====
 +
 +This behaviour allows you to create a video panel from a streaming video feed and attach it to an asset in the scene. 
 +
 +====Parameters====
 +
 +===FeedName===
 +
 +// Type: [[text]]
 +Default: **none**//
 +
 +The name of the video feed you wish to have displayed.
 +
 +===Offset===
 +//Type: [[vector3]]
 +Default: **1,0,0**//
 +
 +The distance away from the object that the video feed should appear. Note that these are specified world coordinates, relative to the object.
 +
 +===Size===
 +//Type: [[vector2]]
 +Default: **1,1**//
 +
 +The size of the video feed screen. As a rule, the indicator matches the size of the object its attached to. This number acts as a multiplier on that scale. 
 +
 +If you are placing an indicator on a very small item, you might choose a scale of 2 or 3 (double or triple the size of the object), while indicating an extremely large item may involve using a scale of 0.5 or 0.25.
 +
 +===Rotation===
 +
 +//Type: [[vector3]]
 +Default: **0,0,0***//
 +
 +The rotation of the video feed. This parameter changes the rotation of the video feed, allowing you to tilt the picture to be angled a certain way. 
 +
 +===IconSize===
 +//Type: [[number]]
 +Default: 0.1//
 +
 +The size of the camera icon that appears in 3D space.
 +
 +===SnapDistance===
 +//Type: [[number]]
 +Default: 1//
 +
 +The distance away from the camera that the user will be prompted to 'snap' into the ideal viewing space for the camera.
 +
 +===FollowCamera===
 +//Type: [[boolean]]
 +Default: **0**//
 +
 +Indicates if the video feed should stay stationary (0/false), or rotate to face the camera (1/true).
 +
 +===Style===
 +//Type: [[text]]
 +Default: **normal**//
 +
 +Video feeds can be displayed in one of two modes.
 +
 +^Style Code^Appearance^
 +|normal|Video feed will be displayed in full colour|
 +|bw|Video feed will be displayed in black and white|
 +
 +====Examples====
 +
 +<code>
 +<VideoPanel FeedName="Security1" Offset="0,1,0" />
 +</code>
 +
 +> A video feed panel will be created, displaying the feed from **Security1** positioned 1m above the asset.