Scenes and Layers
For an introduction, see the Script Engine Objects overview.
Layer - Audio
Layer audio properties for Script Engine.
| Property | Type | Access | Description |
|---|---|---|---|
AudioRemapLeft1 |
AudioRemap |
get/set |
Map Left 1 to selected audio channel. |
AudioRemapRight1 |
AudioRemap |
get/set |
Map Right 1 to selected audio channel. |
AudioRemapLeft2 |
AudioRemap |
get/set |
Map Left 2 to selected audio channel. |
AudioRemapRight2 |
AudioRemap |
get/set |
Map Right 2 to selected audio channel. |
AudioRemapLeft3 |
AudioRemap |
get/set |
Map Left 3 to selected audio channel. |
AudioRemapRight3 |
AudioRemap |
get/set |
Map Right 3 to selected audio channel. |
AudioRemapLeft4 |
AudioRemap |
get/set |
Map Left 4 to selected audio channel. |
AudioRemapRight4 |
AudioRemap |
get/set |
Map Right 4 to selected audio channel. |
AudioGainLeft |
float |
get/set |
Set Left 1 gain. |
AudioGainRight |
float |
get/set |
Set right 1 gain. |
AudioGainLeft2 |
float |
get/set |
Set Left 2 gain. |
AudioGainRight2 |
float |
get/set |
Set right 2 gain. |
AudioGainLeft3 |
float |
get/set |
Set Left 3 gain. |
AudioGainRight3 |
float |
get/set |
Set right 3 gain. |
AudioGainLeft4 |
float |
get/set |
Set Left 4 gain. |
AudioGainRight4 |
float |
get/set |
Set right 4 gain. |
AudioGainStereo |
float |
get/set |
Set stereo gain. [min = 0, max = 25118.8652]. |
AudioGainStereodB |
float |
get/set |
Set stereo gain in dB. [min = -48, max = 48]. |
AudioGainBalance |
float |
get/set |
Set right 1 gain. [min = -100, max = 100]. |
AudioStereoRemap |
AudioStereoRemap |
get/set |
Remap audio to Left/Right 1 channels to Mono or stereo. |
Layer - Transform
Layer transform properties for Script Engine. Every Layer owns exactly one LayerTransform, accessible as Layer.LayerTransform. The transform decides where the layer's source (its input or sub-scene) is drawn on the scene canvas — its on-screen position, anchor point, scale, rotation, and opacity. Together, these values place and orient the source rectangle within the scene's output frame. Common script use cases: animating a lower-third sliding in (PositionX over time), pulsing a logo (ScaleX/ScaleY), fading a graphic in or out (Opacity), spinning a graphic around its centre (Rotation with the anchor pre-set to the centre of the source). Setting any geometry value flags the transform for rebuild on the next frame.
| Property | Type | Access | Description |
|---|---|---|---|
AnchorPointX |
float |
get/set |
Horizontal anchor point inside the source, in pixels of the source's own coordinate system. [default=0]. The anchor is the pivot the layer uses for rotation, and the reference point that PositionX/PositionY aligns to the scene. 0 anchors at the source's left edge; set to half the source width to anchor at the centre (so rotation spins around the middle and Position places the centre at the chosen scene coordinate). |
AnchorPointY |
float |
get/set |
Vertical anchor point inside the source, in pixels of the source's own coordinate system. [default=0]. Vertical counterpart of AnchorPointX. Set to half the source height to anchor at the vertical centre. |
PositionX |
float |
get/set |
Horizontal position of the layer's anchor on the scene canvas, in pixels. [default=0]. 0 sits the anchor on the scene's left edge. Increasing the value moves the layer to the right. Combined with AnchorPointX to control where on the source the position is measured from (centre, top-left, etc.). Animate this from a script for horizontal slides and reveals. |
PositionY |
float |
get/set |
Vertical position of the layer's anchor on the scene canvas, in pixels. [default=0]. 0 sits the anchor on the scene's top edge. Increasing the value moves the layer downward. Vertical counterpart of PositionX. |
ScaleX |
float |
get/set |
Horizontal scale of the layer, in percent of the source width. [default=100]. 100 draws the source at its native width. 200 doubles it; 50 halves it. Negative values mirror the source horizontally. When ScaleLocked is true, setting this also updates ScaleY so aspect ratio is preserved. |
ScaleLocked |
bool |
get/set |
When true, ScaleX and ScaleY move together so the source keeps its native aspect ratio. [default=false]. Setting either scale property updates the other automatically while this is on. Disable to scale width and height independently (e.g. for stretched lower-thirds or letterboxed insets). |
ScaleY |
float |
get/set |
Vertical scale of the layer, in percent of the source height. [default=100]. Vertical counterpart of ScaleX. Negative values mirror the source vertically. |
Rotation |
float |
get/set |
Rotation of the layer in degrees, around the point defined by AnchorPointX and AnchorPointY. [default=0]. 0 leaves the layer upright. Positive values rotate clockwise. To spin around the source's centre, set the anchor to half the source's width and height first; otherwise the layer pivots around whatever point the anchor names. |
Opacity |
float |
get/set |
Opacity of the layer, in percent. [min=0, max=100, default=100]. 100 draws the layer fully opaque. 0 hides it without removing it from the scene. Mid values blend the layer with whatever sits underneath. Animate this from a script for fade-in / fade-out transitions, or to dip a layer's prominence without taking it off-air. |
Layer - Visibility
Layer properties for Script Engine.
| Property | Type | Access | Description |
|---|---|---|---|
IsVisible |
bool |
get/set |
Hide or show layer. |
IsAudible |
bool |
get/set |
Enable or disable layer audio |
IsLocked |
bool |
get/set |
Lock or unlock layer. |
LayerMaskAppliance |
LayerMaskAppliance |
get/set |
Apply layer maks. [default = None]. |
BlendMode |
BlendMode |
get/set |
Apply blend mode. [Default = Normal]. See documentation for more info on blend modes |
Batch |
string |
get/set |
Tag layer for batch operatons. |