Document toolboxDocument toolbox

Private & Confidential

(1.1.0) Canvas share API

Description

URI message

Arguments

Description

URI message

Arguments

 

The path segment of the message

 

Canvas Share Messages

Adds a new share object
available types are:
”NDI”, “Spout”

textureShare/add

type : string

Remove a share object

textureShare/remove

id : string

Remove all share objects

textureShare/clear

-

Toggles sharing on/off

textureShare/setEnabled

id : string
value : boolean

Set normalized position of object

textureShare/setPosition

id : string
x : float
y : float

Set normalized size of object

textureShare/setSize

id : string
x : float
y : float

Sets the output texture aspect ratio. “Lock aspect ratio” needs to be enabled

textureShare/setAspectRatio

id : string
x : integer
y : integer

Toggles output aspect ratio lock

textureShare/setLockAspectRatio

id : string
value : boolean

Sets the resolution used by lockResolution

textureShare/setResolution

id : string
x : integer
y : integer

Toggles resolution lock on/off

textureShare/setLockResolution

id : string
value : boolean

(c) Igloo Vision 2020