(1.0.0) Layer API

The path segment of the message

Note: id and name arguments are optional. You use one or the other to target a layer. If you don’t use any of them the command will be used on the selected layer. Most argument values are in string format unless other specified.

Removes all layers that are not pinned

layer/removeUnpinnedLayers

Removes all layers that are not pinned

Enable, select and bring to front the home layer

layer/enableHomeLayer

Set position of layer

layer/setPosition

"name"
"id"
"xy" comma separated (“x,y”)
"x"
"y"

Set size of layer

layer/setSize

"name"
"id"
"xy" comma separated (“x,y”)
"x"
"y"

Set scale value of layer

layer/setScale

"name"
"id"
"x"

Set aspect ratio mode of layer

layer/setAspectRatio

"name"
"id"
"value”

Set resize mode of layer

layer/setResizeMode

"name"
"id"
"value”

Set position mode of layer

layer/setPositionMode

"name"
"id"
"value”

Set layer to a layout

layer/setLayout

"name"
”index”

Set layer to a region within layout

layer/setRegion

"name"
”index”

Set custom ratio value x,y of layer id/name

layer/setCustomRatio

"name"
"id"
"xy" comma separated (“x,y”)
"x"
"y"

Set start crop values of layer

layer/setStartCrop

"name"
"id"
"xy" comma separated (“x,y”)
"x"
"y"

set size of crop area for layer

layer/setCropSize

"name"
"id"
"xy" comma separated (“x,y”)
"x"
"y"

reset layers geometry

layer/resetGeometry

"name"
"id"

Enable/disable layer visiblity

layer/setEnabled

"name"
"id"
"value" - (“0” or “1”)

Set layers clear colour

layer/clearColour

"name"
"id"
"value" - comma separated (“r,g,b,a”)

Add renderpass to layer

layer/addRenderPass

"name"
"type": string of an integer
Transform = ”0”
Shader = “1”
Warp = “2”
Mask = “3”
Invert = “4”
MaxRenderPasses = “5”
InputTranslation = “6”
CanvasUI = “7”
PerspectiveExtraction= “8”

Delete render pass

layer/removeRenderPass

"name"
"id"
"index"

Move render pass up in hierarchy

layer/moveRenderPassUp

"name"
"id"
"index"

Move render pass down in hierarchy

layer/moveRenderPassDown

"name"
"id"
"index"

Pin layer

layer/pin

"name"
"id"
"value" - (“0” or “1”)

Create new layer of given type

layer/create

"index” - new layer is created after the index of a valid layer.
"name" - Name of new layer
"type" :
"IMAGE"
"VIDEO"
"SPOUT"
"YOUTUBE"
"WEBVIEW"
"BLACKMAGIC"
"DATAPATH"
"AJAKONA5"
"AJA KONA5"
"STREAM"
"NDI"
"DESKTOP"
"IGLOOWEB"
"COMPOSITION"
"CONTENTBANK"
"CONTENT BANK"
"TIMELINE"

Select layer

layer/select

"name"
"id"

Delete layer

layer/delete

"name"
"id"

Move layer up in the hierarchy

layer/moveUp

"name"
"id"

Move layer down in the hierarchy

layer/moveDown

"name"
"id"

Import layer from xml, given path

layer/import

“path”

Export a layer to given path

layer/export

"name"
"id"
"path"
"overwrite" : “0” or “1”

Change name of layer

layer/changeName

"name"
"id"
"newName"

Change type of layer

layer/changeType

"name"
"id"
"newType" (see layer/create arguments)

Set values of invert shader pass

layer/invert

"name"
"id"
"index"
"axis" (“X”, or “Y”)

Set values of inputTranslation shader pass

layer/inputTranslation

"name"
"id"
"value" : (“LENSA1”,“LENSA2”,“LENSA3”,“LENSA4”,”FOV”,”Roll”,”Tilt”,”Pan”,”AspectRatio”)
”index”

Set values of fishEye shader pass

layer/setFishEye

"name"
"id"
"param" : (“LENSA1”,“LENSA2”,“LENSA3”,“LENSA4”,”FOV”,”Roll”,”Tilt”,”Pan”,”AspectRatio”)
"value" -(float value in string format (“0.4”), If param = AspectRatio, then string bool “0”, or “1”)
"index"

Maximize geometry of layer

layer/maximise

"name"
"id"

Stretch geometry of layer

layer/stretch

"name"
"id"

Draw border around selected layer

layer/drawSelectedLayerBorder

"value": “0” or “1”

layer/insideLayerMouseControl

”value”: “0” or “1”

Generate preview of layer

layer/generatePreview

"name"
"id"

Generate template of layer

layer/generateTemplate

"name"
"id"

Set path for executable to be run when layer is loaded

layer/setExecutable

"name"
"id"
"path"

Reset geometry

layer/reset

"name"
"id"

Clears all layers

layer/clear

-

Bring layer to front

layer/toFront

"name"
"id"

Send layer to back

layer/toBack

"name"
"id"

Canvas UI enter crop mode

layer/beginCropMode

"name" - string
"id" - string

Canvas UI toggle transform widget

layer/toggleTransformMenu

“value" - bool

layer/updateRegioned

"layoutIndex" - int
"regionIndex" - int

Toggle visibility of layer canvasUI

layer/toggleLayerUI

"id" - string
"value" - bool

The path segment of the message

Note: id and name arguments are optional. You use one or the other to target a layer. If you don’t use any of them the command will be used on the selected layer. Most argument values are in string format unless other specified.

The path segment of the message

Note: id and name arguments are optional. You use one or the other to target a layer. If you don’t use any of them the command will be used on the selected layer. Most argument values are in string format unless other specified.

The path segment of the message

Note: id and name arguments are optional. You use one or the other to target a layer. If you don’t use any of them the command will be used on the selected layer. Most argument values are in string format unless other specified.

The path segment of the message

Note: id and name arguments are optional. You use one or the other to target a layer. If you don’t use any of them the command will be used on the selected layer. Most argument values are in string format unless other specified.

The path segment of the message

Note: id and name arguments are optional. You use one or the other to target a layer. If you don’t use any of them the command will be used on the selected layer. Most argument values are in string format unless other specified.

The path segment of the message

Note: id and name arguments are optional. You use one or the other to target a layer. If you don’t use any of them the command will be used on the selected layer. Most argument values are in string format unless other specified.

Set the URL

setURL

url (string)

Set the resolution of the web page, note that this may be different to the rendered Layer resolution

setSize

width (int)

height (int)

When enabled the underlying resolution of the browser will be updated whenever the scale of the layer changes

setDynamicRes

value (bool)

When enabled the frame rate of a WebView can be set independently of the ICE application framerate.

setUseCustomFPS

value (int)

Target FPS when Use Custom FPS is Enabled

setCustomFPS

value (int)

Adds a shortcut to the shortcut system

addShortcut

address (string)

label (string)

The path segment of the message

Note: id and name arguments are optional. You use one or the other to target a layer. If you don’t use any of them the command will be used on the selected layer. Most argument values are in string format unless other specified.

The path segment of the message

Note: id and name arguments are optional. You use one or the other to target a layer. If you don’t use any of them the command will be used on the selected layer. Most argument values are in string format unless other specified.

The path segment of the message

Note: id and name arguments are optional. You use one or the other to target a layer. If you don’t use any of them the command will be used on the selected layer. Most argument values are in string format unless other specified.

The path segment of the message

Note: id and name arguments are optional. You use one or the other to target a layer. If you don’t use any of them the command will be used on the selected layer. Most argument values are in string format unless other specified.

The path segment of the message

Note: id and name arguments are optional. You use one or the other to target a layer. If you don’t use any of them the command will be used on the selected layer. Most argument values are in string format unless other specified.