// Returns the current revision of the API. 
// Release versions have even revision numbers. Beta versions have odd revision numbers. 
 

Control Example

Pixera.Utility.getApiRevision()

TCP/UDP

    => {"jsonrpc":"2.0", "id":1, "method":"Pixera.Utility.getApiRevision"}

    <= {"jsonrpc":"2.0", "id":1, "result":1} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/getApiRevision" | Warning: OSC does currently not provide any return values.

// Returns true if the function (or class method) is available. 
// functionName must be the fully qualified name of the function or method, 
// e.g. "Pixera.Screens.Screen.setPosition". 
 

Control Example

Pixera.Utility.getHasFunction(functionName "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":2, "method":"Pixera.Utility.getHasFunction", "params":{"functionName":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":2, "result":true} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/getHasFunction" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Outputs a debug string into the Pixera log and returns the same string in 
// the reply. 
 

Control Example

Pixera.Utility.outputDebug(message "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":3, "method":"Pixera.Utility.outputDebug", "params":{"message":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":3, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/outputDebug" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Utility.getLicenseJson()

TCP/UDP

    => {"jsonrpc":"2.0", "id":4, "method":"Pixera.Utility.getLicenseJson"}

    <= {"jsonrpc":"2.0", "id":4, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/getLicenseJson" | Warning: OSC does currently not provide any return values.

// Returns the number of milliseconds since midnight Jan 1st 1970 UTC. 
 

Control Example

Pixera.Utility.getCurrentTime()

TCP/UDP

    => {"jsonrpc":"2.0", "id":5, "method":"Pixera.Utility.getCurrentTime"}

    <= {"jsonrpc":"2.0", "id":5, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/getCurrentTime" | Warning: OSC does currently not provide any return values.

// Returns the current time as an ISO-8601 string (using the local timezone). 
 

Control Example

Pixera.Utility.getCurrentTimeAsString()

TCP/UDP

    => {"jsonrpc":"2.0", "id":6, "method":"Pixera.Utility.getCurrentTimeAsString"}

    <= {"jsonrpc":"2.0", "id":6, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/getCurrentTimeAsString" | Warning: OSC does currently not provide any return values.

// No operation. This function does nothing. It can be used in request/response scenarios 
// (e.g. JSON-RPC) to bookend a set of API invocations. This gives the client a way 
// to know that the last invocation in the set has been processed by Pixera. 
 

Control Example

Pixera.Utility.noop()

TCP/UDP

    => {"jsonrpc":"2.0", "id":7, "method":"Pixera.Utility.noop"}

    <= {"jsonrpc":"2.0", "id":7} | 

OSC

    => "/Pixera/Utility/noop" | 

// Experimental. Currently only relevant to Javascript interpretation within Pixera. 
 

Control Example

Pixera.Utility.requestCallback(functionName "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":8, "method":"Pixera.Utility.requestCallback", "params":{"functionName":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":8} | 

OSC

    => "/Pixera/Utility/requestCallback" arguments: "Abcd"  | 

Doku:
 

Control Example

Pixera.Utility.readFileString(path "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":9, "method":"Pixera.Utility.readFileString", "params":{"path":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":9, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/readFileString" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Utility.writeFileString(path "Abcd", fileStr "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":10, "method":"Pixera.Utility.writeFileString", "params":{"path":"Abcd", "fileStr":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":10} | 

OSC

    => "/Pixera/Utility/writeFileString" arguments: "Abcd" "Abcd"  | 

Doku:
 

Control Example

Pixera.Utility.getAccessRecipe(hdlPath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":11, "method":"Pixera.Utility.getAccessRecipe", "params":{"hdlPath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":11, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/getAccessRecipe" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// See the documentation PDF for more information on monitoring. 
// The Javascript implementation does not support monitoring. 
// In the JSON implementation, the result of this function is a JSON object, not a string. 
 

Control Example

Pixera.Utility.pollMonitoring()

TCP/UDP

    => {"jsonrpc":"2.0", "id":12, "method":"Pixera.Utility.pollMonitoring"}

    <= {"jsonrpc":"2.0", "id":12, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/pollMonitoring" | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Utility.unsubscribeMonitoringSubject(subject "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":13, "method":"Pixera.Utility.unsubscribeMonitoringSubject", "params":{"subject":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":13, "result":true} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/unsubscribeMonitoringSubject" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Utility.subscribeMonitoringSubject(subject "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":14, "method":"Pixera.Utility.subscribeMonitoringSubject", "params":{"subject":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":14, "result":true} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/subscribeMonitoringSubject" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Utility.setMonitoringEventMode(mode "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":15, "method":"Pixera.Utility.setMonitoringEventMode", "params":{"mode":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":15, "result":true} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/setMonitoringEventMode" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// In the Control implementation this function is called when monitoring events are sent. 
 

Control Example

Pixera.Utility.monitoringEvent(eventDescription "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":16, "method":"Pixera.Utility.monitoringEvent", "params":{"eventDescription":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":16} | 

OSC

    => "/Pixera/Utility/monitoringEvent" arguments: "Abcd"  | 

// Only available in json implementation. 
 

Control Example

Pixera.Utility.setShowContextInReplies(doShow true)

TCP/UDP

    => {"jsonrpc":"2.0", "id":17, "method":"Pixera.Utility.setShowContextInReplies", "params":{"doShow":true}}

    <= {"jsonrpc":"2.0", "id":17, "result":true} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/setShowContextInReplies" arguments: true  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Utility.setMonitoringHasDelimiter(hasDelimiter true)

TCP/UDP

    => {"jsonrpc":"2.0", "id":18, "method":"Pixera.Utility.setMonitoringHasDelimiter", "params":{"hasDelimiter":true}}

    <= {"jsonrpc":"2.0", "id":18, "result":true} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/setMonitoringHasDelimiter" arguments: true  | Warning: OSC does currently not provide any return values.

// Runs the javascript function jsFunction with code jsCode. 
 

Control Example

Pixera.Utility.runJsScript(jsFunction "Abcd", jsCode "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":19, "method":"Pixera.Utility.runJsScript", "params":{"jsFunction":"Abcd", "jsCode":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":19, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Utility/runJsScript" arguments: "Abcd" "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Utility.dynamicRebuildFromJsonDescription(deviceName "Abcd", jsonDescription "Abcd", folder "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":20, "method":"Pixera.Utility.dynamicRebuildFromJsonDescription", "params":{"deviceName":"Abcd", "jsonDescription":"Abcd", "folder":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":20} | 

OSC

    => "/Pixera/Utility/dynamicRebuildFromJsonDescription" arguments: "Abcd" "Abcd" "Abcd"  | 

Doku:
 

Control Example

Pixera.Utility.resetSelectiveRenderingFrameCounters()

TCP/UDP

    => {"jsonrpc":"2.0", "id":21, "method":"Pixera.Utility.resetSelectiveRenderingFrameCounters"}

    <= {"jsonrpc":"2.0", "id":21} | 

OSC

    => "/Pixera/Utility/resetSelectiveRenderingFrameCounters" | 

Doku:
 

Control Example

Pixera.Network.getConveyor(conveyorName "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":22, "method":"Pixera.Network.getConveyor", "params":{"conveyorName":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":22, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Network/getConveyor" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Network.Conveyor.sendString(handle 123456789, str "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":23, "method":"Pixera.Network.Conveyor.sendString", "params":{"handle":123456789, "str":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":23} | 

OSC

       => "/Pixera/Network/Conveyor/sendString" arguments: (Handle or Path) "Abcd"  | 

// Sets the transport mode of the timeline identified by its (zero-based) index 
// in the timeline library of the Compositing tab.

// Mode Parameter: Play = 1, Pause = 2, Stop = 3. 
 

Control Example

Pixera.Compound.setTransportModeOnTimelineAtIndex(index 1, mode 1)

TCP/UDP

    => {"jsonrpc":"2.0", "id":24, "method":"Pixera.Compound.setTransportModeOnTimelineAtIndex", "params":{"index":1, "mode":1}}

    <= {"jsonrpc":"2.0", "id":24, "result":true} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/setTransportModeOnTimelineAtIndex" arguments: 1 1  | Warning: OSC does currently not provide any return values.

// Sets the transport mode of the timeline identified by its name.

// Mode Parameter: Play = 1, Pause = 2, Stop = 3. 
 

Control Example

Pixera.Compound.setTransportModeOnTimeline(timelineName "Abcd", mode 1)

TCP/UDP

    => {"jsonrpc":"2.0", "id":25, "method":"Pixera.Compound.setTransportModeOnTimeline", "params":{"timelineName":"Abcd", "mode":1}}

    <= {"jsonrpc":"2.0", "id":25} | 

OSC

    => "/Pixera/Compound/setTransportModeOnTimeline" arguments: "Abcd" 1  | 

// Toggles the timeline transport mode of timeline identified by its name.

// Mode toggles between Play and Pause. 
 

Control Example

Pixera.Compound.toggleTransport(timelineName "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":26, "method":"Pixera.Compound.toggleTransport", "params":{"timelineName":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":26} | 

OSC

    => "/Pixera/Compound/toggleTransport" arguments: "Abcd"  | 

// Returns the current transport mode of the timeline identified by its name.

// Return values: Play = 1, Pause = 2, Stop = 3. 
 

Control Example

Pixera.Compound.getTransportModeOnTimeline(timelineName "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":27, "method":"Pixera.Compound.getTransportModeOnTimeline", "params":{"timelineName":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":27, "result":1} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getTransportModeOnTimeline" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Sets the transport mode of the first timeline 
// in the timeline library of the Compositing tab to Play. 
 

Control Example

Pixera.Compound.startFirstTimeline()

TCP/UDP

    => {"jsonrpc":"2.0", "id":28, "method":"Pixera.Compound.startFirstTimeline"}

    <= {"jsonrpc":"2.0", "id":28} | 

OSC

    => "/Pixera/Compound/startFirstTimeline" | 

// Sets the transport mode of the first timeline 
// in the timeline library of the Compositing tab to Pause. 
 

Control Example

Pixera.Compound.pauseFirstTimeline()

TCP/UDP

    => {"jsonrpc":"2.0", "id":29, "method":"Pixera.Compound.pauseFirstTimeline"}

    <= {"jsonrpc":"2.0", "id":29} | 

OSC

    => "/Pixera/Compound/pauseFirstTimeline" | 

// Sets the transport mode of the first timeline 
// in the timeline library of the Compositing tab to Stop. 
 

Control Example

Pixera.Compound.stopFirstTimeline()

TCP/UDP

    => {"jsonrpc":"2.0", "id":30, "method":"Pixera.Compound.stopFirstTimeline"}

    <= {"jsonrpc":"2.0", "id":30} | 

OSC

    => "/Pixera/Compound/stopFirstTimeline" | 

// Sets the opacity of the timeline identified by its name.

// timelineName: name of timeline

// opacity: opacity value between 0.0 and 1.0 
 

Control Example

Pixera.Compound.setOpacityOnTimeline(timelineName "Abcd", opacity 1.0)

TCP/UDP

    => {"jsonrpc":"2.0", "id":31, "method":"Pixera.Compound.setOpacityOnTimeline", "params":{"timelineName":"Abcd", "opacity":1.0}}

    <= {"jsonrpc":"2.0", "id":31} | 

OSC

    => "/Pixera/Compound/setOpacityOnTimeline" arguments: "Abcd" 1.0  | 

// Returns the opacity of the timeline identified by its name. 
 

Control Example

Pixera.Compound.getOpacityOnTimeline(timelineName "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":32, "method":"Pixera.Compound.getOpacityOnTimeline", "params":{"timelineName":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":32, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getOpacityOnTimeline" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Set the x position of the first layer of the first timeline.

// Purely for demonstration, testing purposes. 
 

Control Example

Pixera.Compound.setPosValue(val 1.0)

TCP/UDP

    => {"jsonrpc":"2.0", "id":33, "method":"Pixera.Compound.setPosValue", "params":{"val":1.0}}

    <= {"jsonrpc":"2.0", "id":33} | 

OSC

    => "/Pixera/Compound/setPosValue" arguments: 1.0  | 

// Set the x/y position of the first layer of the first timeline.

// Purely for demonstration, testing purposes. 
 

Control Example

Pixera.Compound.setPosValueXY(valX 1.0, valY 1.0)

TCP/UDP

    => {"jsonrpc":"2.0", "id":34, "method":"Pixera.Compound.setPosValueXY", "params":{"valX":1.0, "valY":1.0}}

    <= {"jsonrpc":"2.0", "id":34} | 

OSC

    => "/Pixera/Compound/setPosValueXY" arguments: 1.0 1.0  | 

// Sets the current value of the parameter. 
// The parameter is identified by a path separated by periods (e.g. "Timeline 1.Layer 1.Opacity"). 
 

Control Example

Pixera.Compound.setParamValue(path "Abcd", value 1.0)

TCP/UDP

    => {"jsonrpc":"2.0", "id":35, "method":"Pixera.Compound.setParamValue", "params":{"path":"Abcd", "value":1.0}}

    <= {"jsonrpc":"2.0", "id":35} | 

OSC

    => "/Pixera/Compound/setParamValue" arguments: "Abcd" 1.0  | 

// Jumps to and executes the cue at the (zero-based) index in the timeline at the (zero-based) index in 
// the timeline library of the Compositing tab.

// cueIndex: zero-based index of cue

// timelineIndex: zero-based index of timeline in library

// blendDuration: optional parameter to set blend duration in seconds. 
 

Control Example

Pixera.Compound.applyCueAtIndexOnTimelineAtIndex(cueIndex 1, timelineIndex 1, blendDuration val)

TCP/UDP

    => {"jsonrpc":"2.0", "id":36, "method":"Pixera.Compound.applyCueAtIndexOnTimelineAtIndex", "params":{"cueIndex":1, "timelineIndex":1, "blendDuration":val}}

    <= {"jsonrpc":"2.0", "id":36} | 

OSC

    => "/Pixera/Compound/applyCueAtIndexOnTimelineAtIndex" arguments: 1 1 val  | 

// Jumps to and executes the cue with the given number in the timeline at the (zero-based) index in 
// the timeline library of the Compositing tab.

// cueNumber: number of cue

// timelineIndex: zero-based index of timeline in library

// blendDuration: optional parameter to set blend duration in seconds. 
 

Control Example

Pixera.Compound.applyCueNumberOnTimelineAtIndex(cueNumber 1, timelineIndex 1, blendDuration val)

TCP/UDP

    => {"jsonrpc":"2.0", "id":37, "method":"Pixera.Compound.applyCueNumberOnTimelineAtIndex", "params":{"cueNumber":1, "timelineIndex":1, "blendDuration":val}}

    <= {"jsonrpc":"2.0", "id":37} | 

OSC

    => "/Pixera/Compound/applyCueNumberOnTimelineAtIndex" arguments: 1 1 val  | 

// Jumps to and executes the cue with the given number in the timeline with the given timelineName.

// timelineName: name of timeline

// cueNumber: number of cue

// blendDuration: optional parameter to set blend duration in seconds. 
 

Control Example

Pixera.Compound.applyCueNumberOnTimeline(timelineName "Abcd", cueNumber 1, blendDuration val)

TCP/UDP

    => {"jsonrpc":"2.0", "id":38, "method":"Pixera.Compound.applyCueNumberOnTimeline", "params":{"timelineName":"Abcd", "cueNumber":1, "blendDuration":val}}

    <= {"jsonrpc":"2.0", "id":38} | 

OSC

    => "/Pixera/Compound/applyCueNumberOnTimeline" arguments: "Abcd" 1 val  | 

// Jumps to and executes the cue with given name in the timeline with the given timelineName.

// timelineName: name of timeline

// cueName: name of cue

// blendDuration: optional parameter to set blend duration in seconds. 
 

Control Example

Pixera.Compound.applyCueOnTimeline(timelineName "Abcd", cueName "Abcd", blendDuration val)

TCP/UDP

    => {"jsonrpc":"2.0", "id":39, "method":"Pixera.Compound.applyCueOnTimeline", "params":{"timelineName":"Abcd", "cueName":"Abcd", "blendDuration":val}}

    <= {"jsonrpc":"2.0", "id":39} | 

OSC

    => "/Pixera/Compound/applyCueOnTimeline" arguments: "Abcd" "Abcd" val  | 

// Adds the file at the path to the folder with the given name path. 
 

Control Example

Pixera.Compound.addResourceToFolder(namePath "Abcd", filePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":40, "method":"Pixera.Compound.addResourceToFolder", "params":{"namePath":"Abcd", "filePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":40, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/addResourceToFolder" arguments: "Abcd" "Abcd"  | Warning: OSC does currently not provide any return values.

// Assigns a resource to a layer. The resource is identified by a path build from signatures and separated by forward slashes 
// (e.g. "Media/Folder/video.mov"). The layer is identified by a path separated by periods (e.g. "Timeline 1.Layer 1"). 
 

Control Example

Pixera.Compound.assignResourceToLayer(resourcePath "Abcd", layerPath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":41, "method":"Pixera.Compound.assignResourceToLayer", "params":{"resourcePath":"Abcd", "layerPath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":41} | 

OSC

    => "/Pixera/Compound/assignResourceToLayer" arguments: "Abcd" "Abcd"  | 

// Refreshes a resource from file. The resource is identified by a path build from signatures and separated by forward slashes 
// (e.g. "Media/Folder/video.mov"). 
 

Control Example

Pixera.Compound.refreshResource(resourcePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":42, "method":"Pixera.Compound.refreshResource", "params":{"resourcePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":42} | 

OSC

    => "/Pixera/Compound/refreshResource" arguments: "Abcd"  | 

// Sets the transport mode of a layer: Play = 1, Pause = 2, Stop = 3.

// The layer is identified by a path separated by periods (e.g. "Timeline 1.Layer 1"). 
 

Control Example

Pixera.Compound.setTransportModeOnLayer(layerPath "Abcd", mode 1, loop true)

TCP/UDP

    => {"jsonrpc":"2.0", "id":43, "method":"Pixera.Compound.setTransportModeOnLayer", "params":{"layerPath":"Abcd", "mode":1, "loop":true}}

    <= {"jsonrpc":"2.0", "id":43} | 

OSC

    => "/Pixera/Compound/setTransportModeOnLayer" arguments: "Abcd" 1 true  | 

// Returns the transport mode of a layer: Play = 1, Pause = 2, Stop = 3.

// The layer is identified by a path separated by periods (e.g. "Timeline 1.Layer 1"). 
 

Control Example

Pixera.Compound.getTransportModeOnLayer(layerPath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":44, "method":"Pixera.Compound.getTransportModeOnLayer", "params":{"layerPath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":44, "result":1} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getTransportModeOnLayer" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Returns the resource currently assigned to the layer. 
// The layer is identified by a path separated by periods (e.g. "Timeline 1.Layer 1"). 
// The returned string is the path build from signatures and separated by forward slashes 
// (e.g. "Media/Folder/video.mov"). 
 

Control Example

Pixera.Compound.getResourceAssignedToLayer(layerPath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":45, "method":"Pixera.Compound.getResourceAssignedToLayer", "params":{"layerPath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":45, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getResourceAssignedToLayer" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Assign the resource with dmxfolder/dmxfile id to the clip at time in frames by layerpath 
 

Control Example

Pixera.Compound.assignResourceToClipAtTimeByDmxId(layerPath "Abcd", dmxFolderId 1, dmxFileId 1, time 1.0)

TCP/UDP

    => {"jsonrpc":"2.0", "id":46, "method":"Pixera.Compound.assignResourceToClipAtTimeByDmxId", "params":{"layerPath":"Abcd", "dmxFolderId":1, "dmxFileId":1, "time":1.0}}

    <= {"jsonrpc":"2.0", "id":46} | 

OSC

    => "/Pixera/Compound/assignResourceToClipAtTimeByDmxId" arguments: "Abcd" 1 1 1.0  | 

// Assign the resource with dmxfolder/dmxfile id to the clip at hmsf time by layerpath 
 

Control Example

Pixera.Compound.assignResourceToClipAtHMSFStringByDmxId(layerPath "Abcd", dmxFolderId 1, dmxFileId 1, hmsf "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":47, "method":"Pixera.Compound.assignResourceToClipAtHMSFStringByDmxId", "params":{"layerPath":"Abcd", "dmxFolderId":1, "dmxFileId":1, "hmsf":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":47} | 

OSC

    => "/Pixera/Compound/assignResourceToClipAtHMSFStringByDmxId" arguments: "Abcd" 1 1 "Abcd"  | 

// Assign the resource with dmxfolder/dmxfile id to the clip at h m s f by layerpath 
 

Control Example

Pixera.Compound.assignResourceToClipAtHMSFByDmxId(layerPath "Abcd", dmxFolderId 1, dmxFileId 1, h 1, m 1, s 1, f 1)

TCP/UDP

    => {"jsonrpc":"2.0", "id":48, "method":"Pixera.Compound.assignResourceToClipAtHMSFByDmxId", "params":{"layerPath":"Abcd", "dmxFolderId":1, "dmxFileId":1, "h":1, "m":1, "s":1, "f":1}}

    <= {"jsonrpc":"2.0", "id":48} | 

OSC

    => "/Pixera/Compound/assignResourceToClipAtHMSFByDmxId" arguments: "Abcd" 1 1 1 1 1 1  | 

// Sets the current time of the timeline identified by name in frames.

// Use getFpsOfTimeline() to relate the frames to seconds.

// name: Name of timeline.

// time: New time in frames. 
 

Control Example

Pixera.Compound.setCurrentTimeOfTimeline(name "Abcd", time 1)

TCP/UDP

    => {"jsonrpc":"2.0", "id":49, "method":"Pixera.Compound.setCurrentTimeOfTimeline", "params":{"name":"Abcd", "time":1}}

    <= {"jsonrpc":"2.0", "id":49} | 

OSC

    => "/Pixera/Compound/setCurrentTimeOfTimeline" arguments: "Abcd" 1  | 

// Sets the current time of the timeline identified by name in seconds.

// Use getFpsOfTimeline() to relate the frames to seconds.

// name: Name of timeline.

// time: New time in seconds. 
 

Control Example

Pixera.Compound.setCurrentTimeOfTimelineInSeconds(name "Abcd", time 1.0)

TCP/UDP

    => {"jsonrpc":"2.0", "id":50, "method":"Pixera.Compound.setCurrentTimeOfTimelineInSeconds", "params":{"name":"Abcd", "time":1.0}}

    <= {"jsonrpc":"2.0", "id":50} | 

OSC

    => "/Pixera/Compound/setCurrentTimeOfTimelineInSeconds" arguments: "Abcd" 1.0  | 

// Sets the current time in seconds and the applied playback mode of the timeline identified by name.

// Use getFpsOfTimeline() to relate the frames to seconds.

// name: Name of timeline.

// time: New time in seconds.

// mode: New playback mode (Play = 1, Pause = 2, Stop = 3). 
 

Control Example

Pixera.Compound.setCurrentTimeAndTransportModeOfTimelineInSeconds(name "Abcd", time 1.0, mode 1)

TCP/UDP

    => {"jsonrpc":"2.0", "id":51, "method":"Pixera.Compound.setCurrentTimeAndTransportModeOfTimelineInSeconds", "params":{"name":"Abcd", "time":1.0, "mode":1}}

    <= {"jsonrpc":"2.0", "id":51} | 

OSC

    => "/Pixera/Compound/setCurrentTimeAndTransportModeOfTimelineInSeconds" arguments: "Abcd" 1.0 1  | 

// Returns the frames per second of the timeline identified by name.

// name: Name of timeline. 
 

Control Example

Pixera.Compound.getFpsOfTimeline(name "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":52, "method":"Pixera.Compound.getFpsOfTimeline", "params":{"name":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":52, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getFpsOfTimeline" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Returns the current time in frames. Use getFpsOfTimeline() to relate the frames to seconds. 
 

Control Example

Pixera.Compound.getCurrentTimeOfTimeline(name "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":53, "method":"Pixera.Compound.getCurrentTimeOfTimeline", "params":{"name":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":53, "result":1} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getCurrentTimeOfTimeline" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Returns the current time in seconds. 
 

Control Example

Pixera.Compound.getCurrentTimeOfTimelineInSeconds(name "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":54, "method":"Pixera.Compound.getCurrentTimeOfTimelineInSeconds", "params":{"name":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":54, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getCurrentTimeOfTimelineInSeconds" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Returns the current time of the timeline identified by name as hours, minutes, seconds, frames string.

// name: Name of timeline. 
 

Control Example

Pixera.Compound.getCurrentHMSFOfTimeline(name "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":55, "method":"Pixera.Compound.getCurrentHMSFOfTimeline", "params":{"name":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":55, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getCurrentHMSFOfTimeline" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Returns the current countdown to next countdown relevant cue as int (in frames).

// Use getFpsOfTimeline() to relate the frames to seconds.

// name: Name of timeline. 
 

Control Example

Pixera.Compound.getCurrentCountdownOfTimeline(name "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":56, "method":"Pixera.Compound.getCurrentCountdownOfTimeline", "params":{"name":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":56, "result":1} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getCurrentCountdownOfTimeline" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Returns the current countdown to next countdown relevant cue as string (in hours:minutes:seconds:frames).

// name: Name of timeline. 
 

Control Example

Pixera.Compound.getCurrentCountdownHMSFOfTimeline(name "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":57, "method":"Pixera.Compound.getCurrentCountdownHMSFOfTimeline", "params":{"name":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":57, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getCurrentCountdownHMSFOfTimeline" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Blocks timeline updates in Pixera UI.

// Use with caution. Should exclusively be used for performance optimization

// when adding multiple objects (layer, clip, keys, ...) to timelines.

// Do never forget to unblock.

// doBlock: 'true' means start blocking and 'false' means unblock.

// terminationDurationInMs: Default value is 10 sec. Duration until the blocking period is automatically terminated. We emphasize that if the default value is sufficient you should always use blockUiTimelineUpdates(false) for a controlled termination. Unit is milliseconds. 
 

Control Example

Pixera.Compound.blockUiTimelineUpdates(doBlock true, terminationDurationInMs val)

TCP/UDP

    => {"jsonrpc":"2.0", "id":58, "method":"Pixera.Compound.blockUiTimelineUpdates", "params":{"doBlock":true, "terminationDurationInMs":val}}

    <= {"jsonrpc":"2.0", "id":58} | 

OSC

    => "/Pixera/Compound/blockUiTimelineUpdates" arguments: true val  | 

Doku:
 

Control Example

Pixera.Compound.startOpacityAnimationOfTimeline(name "Abcd", fadeIn true, fullFadeDuration 1.0)

TCP/UDP

    => {"jsonrpc":"2.0", "id":59, "method":"Pixera.Compound.startOpacityAnimationOfTimeline", "params":{"name":"Abcd", "fadeIn":true, "fullFadeDuration":1.0}}

    <= {"jsonrpc":"2.0", "id":59} | 

OSC

    => "/Pixera/Compound/startOpacityAnimationOfTimeline" arguments: "Abcd" true 1.0  | 

// Creates a clip at the given time in frames and assigns the resource. 
// The layer is identified by a path separated by periods (e.g. "Timeline 1.Layer 1"). 
// The resource is identified by a path build from signatures and separated by forward slashes (e.g. "Media/Folder/video.mov"). 
 

Control Example

Pixera.Compound.createClipOnLayerAtTimeWithResource(layerPath "Abcd", time 1.0, resourcePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":60, "method":"Pixera.Compound.createClipOnLayerAtTimeWithResource", "params":{"layerPath":"Abcd", "time":1.0, "resourcePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":60} | 

OSC

    => "/Pixera/Compound/createClipOnLayerAtTimeWithResource" arguments: "Abcd" 1.0 "Abcd"  | 

// Removes the clip identified by the 0-based clipIndex on the layer. 
// The layer is identified by a path separated by periods (e.g. "Timeline 1.Layer 1"). 
 

Control Example

Pixera.Compound.removeClipOnLayerWithIndex(layerPath "Abcd", clipIndex 1)

TCP/UDP

    => {"jsonrpc":"2.0", "id":61, "method":"Pixera.Compound.removeClipOnLayerWithIndex", "params":{"layerPath":"Abcd", "clipIndex":1}}

    <= {"jsonrpc":"2.0", "id":61} | 

OSC

    => "/Pixera/Compound/removeClipOnLayerWithIndex" arguments: "Abcd" 1  | 

// Removes all clips on the layer. 
// The layer is identified by a path separated by periods (e.g. "Timeline 1.Layer 1"). 
 

Control Example

Pixera.Compound.removeAllClipsOnLayer(layerPath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":62, "method":"Pixera.Compound.removeAllClipsOnLayer", "params":{"layerPath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":62} | 

OSC

    => "/Pixera/Compound/removeAllClipsOnLayer" arguments: "Abcd"  | 

// Returns the clip duration in seconds identified by the 0-based clipIndex on the layer. 
// The layer is identified by a path separated by periods (e.g. "Timeline 1.Layer 1"). 
 

Control Example

Pixera.Compound.getClipDurationInSecondsWithIndex(layerPath "Abcd", clipIndex 1)

TCP/UDP

    => {"jsonrpc":"2.0", "id":63, "method":"Pixera.Compound.getClipDurationInSecondsWithIndex", "params":{"layerPath":"Abcd", "clipIndex":1}}

    <= {"jsonrpc":"2.0", "id":63, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getClipDurationInSecondsWithIndex" arguments: "Abcd" 1  | Warning: OSC does currently not provide any return values.

// Returns the clip duration in frames identified by the 0-based clipIndex on the layer. 
// The layer is identified by a path separated by periods (e.g. "Timeline 1.Layer 1"). 
 

Control Example

Pixera.Compound.getClipDurationInFramesWithIndex(layerPath "Abcd", clipIndex 1)

TCP/UDP

    => {"jsonrpc":"2.0", "id":64, "method":"Pixera.Compound.getClipDurationInFramesWithIndex", "params":{"layerPath":"Abcd", "clipIndex":1}}

    <= {"jsonrpc":"2.0", "id":64, "result":1} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getClipDurationInFramesWithIndex" arguments: "Abcd" 1  | Warning: OSC does currently not provide any return values.

// Returns the clip start time in seconds identified by the 0-based clipIndex on the layer. 
// The layer is identified by a path separated by periods (e.g. "Timeline 1.Layer 1"). 
 

Control Example

Pixera.Compound.getClipTimeInSecondsWithIndex(layerPath "Abcd", clipIndex 1)

TCP/UDP

    => {"jsonrpc":"2.0", "id":65, "method":"Pixera.Compound.getClipTimeInSecondsWithIndex", "params":{"layerPath":"Abcd", "clipIndex":1}}

    <= {"jsonrpc":"2.0", "id":65, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getClipTimeInSecondsWithIndex" arguments: "Abcd" 1  | Warning: OSC does currently not provide any return values.

// Returns the clip end time in seconds identified by the 0-based clipIndex on the layer. 
// The layer is identified by a path separated by periods (e.g. "Timeline 1.Layer 1"). 
 

Control Example

Pixera.Compound.getClipEndTimeInSecondsWithIndex(layerPath "Abcd", clipIndex 1)

TCP/UDP

    => {"jsonrpc":"2.0", "id":66, "method":"Pixera.Compound.getClipEndTimeInSecondsWithIndex", "params":{"layerPath":"Abcd", "clipIndex":1}}

    <= {"jsonrpc":"2.0", "id":66, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getClipEndTimeInSecondsWithIndex" arguments: "Abcd" 1  | Warning: OSC does currently not provide any return values.

// Returns the duration of the resource in seconds. 
// The resource is identified by a path build from signatures and separated by forward slashes (e.g. "Media/Folder/video.mov"). 
 

Control Example

Pixera.Compound.getResourceDurationInSeconds(resourcePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":67, "method":"Pixera.Compound.getResourceDurationInSeconds", "params":{"resourcePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":67, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getResourceDurationInSeconds" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Returns the current value of the parameter. 
// The parameter is identified by a path separated by periods (e.g. "Timeline 1.Layer 1.Opacity"). 
 

Control Example

Pixera.Compound.getParamValue(path "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":68, "method":"Pixera.Compound.getParamValue", "params":{"path":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":68, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/getParamValue" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Set timecode input for midi and artnet timecode. 
 

Control Example

Pixera.Compound.setTimecodeInput(hour 1, minute 1, second 1, frame 1, elapsedTime 1.0, running true, freshMode 1, stateToken 1, format 1)

TCP/UDP

    => {"jsonrpc":"2.0", "id":69, "method":"Pixera.Compound.setTimecodeInput", "params":{"hour":1, "minute":1, "second":1, "frame":1, "elapsedTime":1.0, "running":true, "freshMode":1, "stateToken":1, "format":1}}

    <= {"jsonrpc":"2.0", "id":69, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Compound/setTimecodeInput" arguments: 1 1 1 1 1.0 true 1 1 1  | Warning: OSC does currently not provide any return values.

//takeover all clients 
 

Control Example

Pixera.Compound.takeOverAllClients()

TCP/UDP

    => {"jsonrpc":"2.0", "id":70, "method":"Pixera.Compound.takeOverAllClients"}

    <= {"jsonrpc":"2.0", "id":70} | 

OSC

    => "/Pixera/Compound/takeOverAllClients" | 

//mute all incomming smpte inputs 
 

Control Example

Pixera.Compound.setPauseSmpteInput(doPause true)

TCP/UDP

    => {"jsonrpc":"2.0", "id":71, "method":"Pixera.Compound.setPauseSmpteInput", "params":{"doPause":true}}

    <= {"jsonrpc":"2.0", "id":71} | 

OSC

    => "/Pixera/Compound/setPauseSmpteInput" arguments: true  | 

Doku:
 

Control Example

Pixera.Session.closeApp(saveProject true)

TCP/UDP

    => {"jsonrpc":"2.0", "id":72, "method":"Pixera.Session.closeApp", "params":{"saveProject":true}}

    <= {"jsonrpc":"2.0", "id":72} | 

OSC

    => "/Pixera/Session/closeApp" arguments: true  | 

Doku:
 

Control Example

Pixera.Session.loadProject(path "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":73, "method":"Pixera.Session.loadProject", "params":{"path":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":73} | 

OSC

    => "/Pixera/Session/loadProject" arguments: "Abcd"  | 

Doku:
 

Control Example

Pixera.Session.saveProject()

TCP/UDP

    => {"jsonrpc":"2.0", "id":74, "method":"Pixera.Session.saveProject"}

    <= {"jsonrpc":"2.0", "id":74} | 

OSC

    => "/Pixera/Session/saveProject" | 

Doku:
 

Control Example

Pixera.Session.saveProjectAs(path "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":75, "method":"Pixera.Session.saveProjectAs", "params":{"path":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":75} | 

OSC

    => "/Pixera/Session/saveProjectAs" arguments: "Abcd"  | 

Doku:
 

Control Example

Pixera.Session.getProjectName()

TCP/UDP

    => {"jsonrpc":"2.0", "id":76, "method":"Pixera.Session.getProjectName"}

    <= {"jsonrpc":"2.0", "id":76, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Session/getProjectName" | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Session.setProjectName(name "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":77, "method":"Pixera.Session.setProjectName", "params":{"name":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":77} | 

OSC

    => "/Pixera/Session/setProjectName" arguments: "Abcd"  | 

Doku:
 

Control Example

Pixera.Session.getProjectDirectory()

TCP/UDP

    => {"jsonrpc":"2.0", "id":78, "method":"Pixera.Session.getProjectDirectory"}

    <= {"jsonrpc":"2.0", "id":78, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Session/getProjectDirectory" | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Session.getControlMultiUserSessionName()

TCP/UDP

    => {"jsonrpc":"2.0", "id":79, "method":"Pixera.Session.getControlMultiUserSessionName"}

    <= {"jsonrpc":"2.0", "id":79, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Session/getControlMultiUserSessionName" | Warning: OSC does currently not provide any return values.

// Shut down the local machine. There are three options for mode:

// 1: Shut down.

// 2: Shut down and turn off power (if supported).

// 3: Shut down and reboot. 
// Default if no mode is set is 1. 
 

Control Example

Pixera.Session.shutdownSystem(mode val)

TCP/UDP

    => {"jsonrpc":"2.0", "id":80, "method":"Pixera.Session.shutdownSystem", "params":{"mode":val}}

    <= {"jsonrpc":"2.0", "id":80} | 

OSC

    => "/Pixera/Session/shutdownSystem" arguments: val  | 

Doku:
 

Control Example

Pixera.Session.getLiveSystemIps()

TCP/UDP

    => {"jsonrpc":"2.0", "id":81, "method":"Pixera.Session.getLiveSystemIps"}

    <= {"jsonrpc":"2.0", "id":81, "result":[Efgh, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Session/getLiveSystemIps" | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Session.getLiveSystemState(ip "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":82, "method":"Pixera.Session.getLiveSystemState", "params":{"ip":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":82, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Session/getLiveSystemState" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// This function is called in Pixera Control when the live system's state changes. 
 

Control Example

Pixera.Session.liveSystemStateChange(ip "Abcd", state "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":83, "method":"Pixera.Session.liveSystemStateChange", "params":{"ip":"Abcd", "state":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":83} | 

OSC

    => "/Pixera/Session/liveSystemStateChange" arguments: "Abcd" "Abcd"  | 

// Shut down the live system with the given IP. The mode options are the same as for shutdownSystem(): 
// Default if no mode is set is 1. 
 

Control Example

Pixera.Session.shutdownLiveSystem(ip "Abcd", mode val)

TCP/UDP

    => {"jsonrpc":"2.0", "id":84, "method":"Pixera.Session.shutdownLiveSystem", "params":{"ip":"Abcd", "mode":val}}

    <= {"jsonrpc":"2.0", "id":84} | 

OSC

    => "/Pixera/Session/shutdownLiveSystem" arguments: "Abcd" val  | 

// Wake up the live system that last had the given IP. Uses the MAC address that was last reported 
// for the IP. 
 

Control Example

Pixera.Session.wakeLiveSystem(ip "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":85, "method":"Pixera.Session.wakeLiveSystem", "params":{"ip":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":85, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Session/wakeLiveSystem" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Returns the last MAC address associated with the live system with the given IP. 
 

Control Example

Pixera.Session.getLiveSystemMacAddress(ip "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":86, "method":"Pixera.Session.getLiveSystemMacAddress", "params":{"ip":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":86, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Session/getLiveSystemMacAddress" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Start live system. 
 

Control Example

Pixera.Session.startLiveSystem(ip "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":87, "method":"Pixera.Session.startLiveSystem", "params":{"ip":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":87} | 

OSC

    => "/Pixera/Session/startLiveSystem" arguments: "Abcd"  | 

// Start all live systems in mapping/live sub-tab. 
 

Control Example

Pixera.Session.startLiveSystems()

TCP/UDP

    => {"jsonrpc":"2.0", "id":88, "method":"Pixera.Session.startLiveSystems"}

    <= {"jsonrpc":"2.0", "id":88} | 

OSC

    => "/Pixera/Session/startLiveSystems" | 

// Stop live system. 
 

Control Example

Pixera.Session.stopLiveSystem(ip "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":89, "method":"Pixera.Session.stopLiveSystem", "params":{"ip":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":89} | 

OSC

    => "/Pixera/Session/stopLiveSystem" arguments: "Abcd"  | 

// Stop all live systems in mapping/live sub-tab. 
 

Control Example

Pixera.Session.stopLiveSystems()

TCP/UDP

    => {"jsonrpc":"2.0", "id":90, "method":"Pixera.Session.stopLiveSystems"}

    <= {"jsonrpc":"2.0", "id":90} | 

OSC

    => "/Pixera/Session/stopLiveSystems" | 

// Restart live system. 
 

Control Example

Pixera.Session.restartLiveSystem(ip "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":91, "method":"Pixera.Session.restartLiveSystem", "params":{"ip":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":91} | 

OSC

    => "/Pixera/Session/restartLiveSystem" arguments: "Abcd"  | 

// Restart all live systems in mapping/live sub-tab. 
 

Control Example

Pixera.Session.restartLiveSystems()

TCP/UDP

    => {"jsonrpc":"2.0", "id":92, "method":"Pixera.Session.restartLiveSystems"}

    <= {"jsonrpc":"2.0", "id":92} | 

OSC

    => "/Pixera/Session/restartLiveSystems" | 

// This action is run when remote heartbeat tracking detects a state change in the system. 
 

Control Example

Pixera.Session.remoteSystemStateChange(ip "Abcd", state "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":93, "method":"Pixera.Session.remoteSystemStateChange", "params":{"ip":"Abcd", "state":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":93} | 

OSC

    => "/Pixera/Session/remoteSystemStateChange" arguments: "Abcd" "Abcd"  | 

Doku:
 

Control Example

Pixera.Session.getRemoteSystemIps()

TCP/UDP

    => {"jsonrpc":"2.0", "id":94, "method":"Pixera.Session.getRemoteSystemIps"}

    <= {"jsonrpc":"2.0", "id":94, "result":[Efgh, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Session/getRemoteSystemIps" | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Session.getRemoteSystemState(ip "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":95, "method":"Pixera.Session.getRemoteSystemState", "params":{"ip":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":95, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Session/getRemoteSystemState" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Session.setVideoStreamActiveState(ip "Abcd", device "Abcd", isActive true)

TCP/UDP

    => {"jsonrpc":"2.0", "id":96, "method":"Pixera.Session.setVideoStreamActiveState", "params":{"ip":"Abcd", "device":"Abcd", "isActive":true}}

    <= {"jsonrpc":"2.0", "id":96} | 

OSC

    => "/Pixera/Session/setVideoStreamActiveState" arguments: "Abcd" "Abcd" true  | 

Doku:
 

Control Example

Pixera.Session.getVideoStreamActiveState(ip "Abcd", device "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":97, "method":"Pixera.Session.getVideoStreamActiveState", "params":{"ip":"Abcd", "device":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":97, "result":true} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Session/getVideoStreamActiveState" arguments: "Abcd" "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Session.getDefaultClipDurationsAsJsonString()

TCP/UDP

    => {"jsonrpc":"2.0", "id":98, "method":"Pixera.Session.getDefaultClipDurationsAsJsonString"}

    <= {"jsonrpc":"2.0", "id":98, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Session/getDefaultClipDurationsAsJsonString" | Warning: OSC does currently not provide any return values.

//toggle output identification 
 

Control Example

Pixera.Session.toggleOutputIdentification()

TCP/UDP

    => {"jsonrpc":"2.0", "id":99, "method":"Pixera.Session.toggleOutputIdentification"}

    <= {"jsonrpc":"2.0", "id":99} | 

OSC

    => "/Pixera/Session/toggleOutputIdentification" | 

//toggle onscreen statistics 
 

Control Example

Pixera.Session.toggleOnScreenStats()

TCP/UDP

    => {"jsonrpc":"2.0", "id":100, "method":"Pixera.Session.toggleOnScreenStats"}

    <= {"jsonrpc":"2.0", "id":100} | 

OSC

    => "/Pixera/Session/toggleOnScreenStats" | 

//activate/deactivate all assigned outputs 
 

Control Example

Pixera.Session.setAllAssignedOutputs(active true)

TCP/UDP

    => {"jsonrpc":"2.0", "id":101, "method":"Pixera.Session.setAllAssignedOutputs", "params":{"active":true}}

    <= {"jsonrpc":"2.0", "id":101} | 

OSC

    => "/Pixera/Session/setAllAssignedOutputs" arguments: true  | 

// Get the handles of the live systems. 
// This will also return handles of live systems that are no longer connected. 
 

Control Example

Pixera.LiveSystems.getLiveSystems()

TCP/UDP

    => {"jsonrpc":"2.0", "id":102, "method":"Pixera.LiveSystems.getLiveSystems"}

    <= {"jsonrpc":"2.0", "id":102, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/LiveSystems/getLiveSystems" | Warning: OSC does currently not provide any return values.

// Called when the live system has become unavailable. 
 

Control Example

Pixera.LiveSystems.liveSystemNotAvailable(reason 1, system 123456789)

TCP/UDP

    => {"jsonrpc":"2.0", "id":103, "method":"Pixera.LiveSystems.liveSystemNotAvailable", "params":{"reason":1, "system":123456789}}

    <= {"jsonrpc":"2.0", "id":103} | 

OSC

    => "/Pixera/LiveSystems/liveSystemNotAvailable" arguments: 1 123456789  | 

Doku:
 

Control Example

Pixera.LiveSystems.getMultiUserMembers()

TCP/UDP

    => {"jsonrpc":"2.0", "id":104, "method":"Pixera.LiveSystems.getMultiUserMembers"}

    <= {"jsonrpc":"2.0", "id":104, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/LiveSystems/getMultiUserMembers" | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.getUsagePresets()

TCP/UDP

    => {"jsonrpc":"2.0", "id":105, "method":"Pixera.LiveSystems.getUsagePresets"}

    <= {"jsonrpc":"2.0", "id":105, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/LiveSystems/getUsagePresets" | Warning: OSC does currently not provide any return values.

// Get hardware name of specified multi-user member. 
 

Control Example

Pixera.LiveSystems.MultiUserMember.getName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":106, "method":"Pixera.LiveSystems.MultiUserMember.getName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":106, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/MultiUserMember/getName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Get ip of specified multi-user member. 
 

Control Example

Pixera.LiveSystems.MultiUserMember.getIp(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":107, "method":"Pixera.LiveSystems.MultiUserMember.getIp", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":107, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/MultiUserMember/getIp" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Get a description of the state of the specified multi-user member. 
 

Control Example

Pixera.LiveSystems.MultiUserMember.getState(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":108, "method":"Pixera.LiveSystems.MultiUserMember.getState", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":108, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/MultiUserMember/getState" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.MultiUserMember.getPerformanceMonitoringValuesJson(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":109, "method":"Pixera.LiveSystems.MultiUserMember.getPerformanceMonitoringValuesJson", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":109, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/MultiUserMember/getPerformanceMonitoringValuesJson" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Filter example: system,outputs,outputsIndividual,outputsTotal,unreal 
 

Control Example

Pixera.LiveSystems.MultiUserMember.getPerformanceMonitoringValuesJsonEx(handle 123456789, filter "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":110, "method":"Pixera.LiveSystems.MultiUserMember.getPerformanceMonitoringValuesJsonEx", "params":{"handle":123456789, "filter":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":110, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/MultiUserMember/getPerformanceMonitoringValuesJsonEx" arguments: (Handle or Path) "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.MultiUserMember.resetCumulativePerformanceMonitoringValues(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":111, "method":"Pixera.LiveSystems.MultiUserMember.resetCumulativePerformanceMonitoringValues", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":111} | 

OSC

       => "/Pixera/LiveSystems/MultiUserMember/resetCumulativePerformanceMonitoringValues" arguments: (Handle or Path)  | 

// Starts file distribution to the multi-user member of all files that are used in a timeline. If includeNotUsedYet is true then 
// all files that have not been used yet in any timeline are also distributed. 
 

Control Example

Pixera.LiveSystems.MultiUserMember.ensureFileDistribution(handle 123456789, includeNotUsedYet true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":112, "method":"Pixera.LiveSystems.MultiUserMember.ensureFileDistribution", "params":{"handle":123456789, "includeNotUsedYet":true}}

       <= {"jsonrpc":"2.0", "id":112} | 

OSC

       => "/Pixera/LiveSystems/MultiUserMember/ensureFileDistribution" arguments: (Handle or Path) true  | 

// Shut down the multi-user member's machine. There are three options for mode:

// 1: Shut down.

// 2: Shut down and turn off power (if supported).

// 3: Shut down and reboot. 
 

Control Example

Pixera.LiveSystems.MultiUserMember.shutDown(handle 123456789, mode 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":113, "method":"Pixera.LiveSystems.MultiUserMember.shutDown", "params":{"handle":123456789, "mode":1}}

       <= {"jsonrpc":"2.0", "id":113} | 

OSC

       => "/Pixera/LiveSystems/MultiUserMember/shutDown" arguments: (Handle or Path) 1  | 

// Try to wake up specified multi-user member. 
 

Control Example

Pixera.LiveSystems.MultiUserMember.wakeUp(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":114, "method":"Pixera.LiveSystems.MultiUserMember.wakeUp", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":114, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/MultiUserMember/wakeUp" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns the MAC address of the specified multi-user member. 
 

Control Example

Pixera.LiveSystems.MultiUserMember.getMacAddress(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":115, "method":"Pixera.LiveSystems.MultiUserMember.getMacAddress", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":115, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/MultiUserMember/getMacAddress" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.MultiUserMember.resetEngine(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":116, "method":"Pixera.LiveSystems.MultiUserMember.resetEngine", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":116} | 

OSC

       => "/Pixera/LiveSystems/MultiUserMember/resetEngine" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.LiveSystems.MultiUserMember.restartEngine(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":117, "method":"Pixera.LiveSystems.MultiUserMember.restartEngine", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":117} | 

OSC

       => "/Pixera/LiveSystems/MultiUserMember/restartEngine" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.LiveSystems.MultiUserMember.startEngine(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":118, "method":"Pixera.LiveSystems.MultiUserMember.startEngine", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":118} | 

OSC

       => "/Pixera/LiveSystems/MultiUserMember/startEngine" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.LiveSystems.MultiUserMember.closeEngine(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":119, "method":"Pixera.LiveSystems.MultiUserMember.closeEngine", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":119} | 

OSC

       => "/Pixera/LiveSystems/MultiUserMember/closeEngine" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.LiveSystems.MultiUserMember.triggerBackup(handle 123456789, applyControlCommand val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":120, "method":"Pixera.LiveSystems.MultiUserMember.triggerBackup", "params":{"handle":123456789, "applyControlCommand":val}}

       <= {"jsonrpc":"2.0", "id":120} | 

OSC

       => "/Pixera/LiveSystems/MultiUserMember/triggerBackup" arguments: (Handle or Path) val  | 

// Get a JSON description of the hardware structure of the specified multi-user member. 
 

Control Example

Pixera.LiveSystems.MultiUserMember.getStructureJson(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":121, "method":"Pixera.LiveSystems.MultiUserMember.getStructureJson", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":121, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/MultiUserMember/getStructureJson" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.MultiUserMember.getInst(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":122, "method":"Pixera.LiveSystems.MultiUserMember.getInst", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":122, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/LiveSystems/MultiUserMember/getInst" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Pixera Control self-reference function. 
 

Control Example

Pixera.LiveSystems.LiveSystem.ref(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":123, "method":"Pixera.LiveSystems.LiveSystem.ref", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":123, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/ref" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Get hardware name of a specified live system. 
 

Control Example

Pixera.LiveSystems.LiveSystem.getName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":124, "method":"Pixera.LiveSystems.LiveSystem.getName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":124, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Get ip of a specified live system. 
 

Control Example

Pixera.LiveSystems.LiveSystem.getIp(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":125, "method":"Pixera.LiveSystems.LiveSystem.getIp", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":125, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getIp" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.getState(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":126, "method":"Pixera.LiveSystems.LiveSystem.getState", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":126, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getState" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.setBackupRole(handle 123456789, role 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":127, "method":"Pixera.LiveSystems.LiveSystem.setBackupRole", "params":{"handle":123456789, "role":1}}

       <= {"jsonrpc":"2.0", "id":127} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/setBackupRole" arguments: (Handle or Path) 1  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.getBackupRole(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":128, "method":"Pixera.LiveSystems.LiveSystem.getBackupRole", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":128, "result":1} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getBackupRole" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.getPerformanceMonitoringValuesJson(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":129, "method":"Pixera.LiveSystems.LiveSystem.getPerformanceMonitoringValuesJson", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":129, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getPerformanceMonitoringValuesJson" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Filter example: system,outputs,outputsIndividual,outputsTotal,unreal 
 

Control Example

Pixera.LiveSystems.LiveSystem.getPerformanceMonitoringValuesJsonEx(handle 123456789, filter "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":130, "method":"Pixera.LiveSystems.LiveSystem.getPerformanceMonitoringValuesJsonEx", "params":{"handle":123456789, "filter":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":130, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getPerformanceMonitoringValuesJsonEx" arguments: (Handle or Path) "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.resetCumulativePerformanceMonitoringValues(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":131, "method":"Pixera.LiveSystems.LiveSystem.resetCumulativePerformanceMonitoringValues", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":131} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/resetCumulativePerformanceMonitoringValues" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.moveMappingsToOutputs(handle 123456789, hdlSrc 123456789, outputIdPathMapStr "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":132, "method":"Pixera.LiveSystems.LiveSystem.moveMappingsToOutputs", "params":{"handle":123456789, "hdlSrc":123456789, "outputIdPathMapStr":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":132} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/moveMappingsToOutputs" arguments: (Handle or Path) 123456789 "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.setUsagePresetName(handle 123456789, name "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":133, "method":"Pixera.LiveSystems.LiveSystem.setUsagePresetName", "params":{"handle":123456789, "name":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":133} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/setUsagePresetName" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.getUsagePresetName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":134, "method":"Pixera.LiveSystems.LiveSystem.getUsagePresetName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":134, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getUsagePresetName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.updateUsagePreset(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":135, "method":"Pixera.LiveSystems.LiveSystem.updateUsagePreset", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":135} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/updateUsagePreset" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.saveUsagePresetAs(handle 123456789, name "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":136, "method":"Pixera.LiveSystems.LiveSystem.saveUsagePresetAs", "params":{"handle":123456789, "name":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":136} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/saveUsagePresetAs" arguments: (Handle or Path) "Abcd"  | 

// Applies the currently selected usage preset. 
 

Control Example

Pixera.LiveSystems.LiveSystem.applyUsagePreset(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":137, "method":"Pixera.LiveSystems.LiveSystem.applyUsagePreset", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":137} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/applyUsagePreset" arguments: (Handle or Path)  | 

// Applies the usage preset with the matching name. 
 

Control Example

Pixera.LiveSystems.LiveSystem.applyUsagePresetWithName(handle 123456789, name "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":138, "method":"Pixera.LiveSystems.LiveSystem.applyUsagePresetWithName", "params":{"handle":123456789, "name":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":138} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/applyUsagePresetWithName" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.exportUsagePreset(handle 123456789, path "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":139, "method":"Pixera.LiveSystems.LiveSystem.exportUsagePreset", "params":{"handle":123456789, "path":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":139} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/exportUsagePreset" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.importUsagePreset(handle 123456789, path "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":140, "method":"Pixera.LiveSystems.LiveSystem.importUsagePreset", "params":{"handle":123456789, "path":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":140} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/importUsagePreset" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.clearExportedMappings(handle 123456789, path "Abcd", onlyServicePath true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":141, "method":"Pixera.LiveSystems.LiveSystem.clearExportedMappings", "params":{"handle":123456789, "path":"Abcd", "onlyServicePath":true}}

       <= {"jsonrpc":"2.0", "id":141} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/clearExportedMappings" arguments: (Handle or Path) "Abcd" true  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.exportMappings(handle 123456789, path "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":142, "method":"Pixera.LiveSystems.LiveSystem.exportMappings", "params":{"handle":123456789, "path":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":142} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/exportMappings" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.importMappings(handle 123456789, path "Abcd", outputIdPathMapStr "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":143, "method":"Pixera.LiveSystems.LiveSystem.importMappings", "params":{"handle":123456789, "path":"Abcd", "outputIdPathMapStr":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":143} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/importMappings" arguments: (Handle or Path) "Abcd" "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.exportMappingsDirectly(handle 123456789, path "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":144, "method":"Pixera.LiveSystems.LiveSystem.exportMappingsDirectly", "params":{"handle":123456789, "path":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":144} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/exportMappingsDirectly" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.importMappingsDirectly(handle 123456789, path "Abcd", outputIdPathMapStr "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":145, "method":"Pixera.LiveSystems.LiveSystem.importMappingsDirectly", "params":{"handle":123456789, "path":"Abcd", "outputIdPathMapStr":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":145} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/importMappingsDirectly" arguments: (Handle or Path) "Abcd" "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.exportMappingsToLiveSystemPath(handle 123456789, parentPath "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":146, "method":"Pixera.LiveSystems.LiveSystem.exportMappingsToLiveSystemPath", "params":{"handle":123456789, "parentPath":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":146} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/exportMappingsToLiveSystemPath" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.importMappingsFromLiveSystemPath(handle 123456789, parentPath "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":147, "method":"Pixera.LiveSystems.LiveSystem.importMappingsFromLiveSystemPath", "params":{"handle":123456789, "parentPath":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":147} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/importMappingsFromLiveSystemPath" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.clearExportedMappingsAtLiveSystemPath(handle 123456789, path "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":148, "method":"Pixera.LiveSystems.LiveSystem.clearExportedMappingsAtLiveSystemPath", "params":{"handle":123456789, "path":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":148} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/clearExportedMappingsAtLiveSystemPath" arguments: (Handle or Path) "Abcd"  | 

// Starts file distribution to the live system of all files that are used in a timeline. If includeNotUsedYet is true then 
// all files that have not been used yet in any timeline are also distributed. 
 

Control Example

Pixera.LiveSystems.LiveSystem.ensureFileDistribution(handle 123456789, includeNotUsedYet true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":149, "method":"Pixera.LiveSystems.LiveSystem.ensureFileDistribution", "params":{"handle":123456789, "includeNotUsedYet":true}}

       <= {"jsonrpc":"2.0", "id":149} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/ensureFileDistribution" arguments: (Handle or Path) true  | 

// Shut down the local machine. There are three options for mode:

// 1: Shut down.

// 2: Shut down and turn off power (if supported).

// 3: Shut down and reboot. 
 

Control Example

Pixera.LiveSystems.LiveSystem.shutDown(handle 123456789, mode 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":150, "method":"Pixera.LiveSystems.LiveSystem.shutDown", "params":{"handle":123456789, "mode":1}}

       <= {"jsonrpc":"2.0", "id":150} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/shutDown" arguments: (Handle or Path) 1  | 

// Try to wake up specified live system. 
 

Control Example

Pixera.LiveSystems.LiveSystem.wakeUp(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":151, "method":"Pixera.LiveSystems.LiveSystem.wakeUp", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":151, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/wakeUp" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns the MAC address of the specified Live System. 
 

Control Example

Pixera.LiveSystems.LiveSystem.getMacAddress(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":152, "method":"Pixera.LiveSystems.LiveSystem.getMacAddress", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":152, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getMacAddress" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns handles to the graphics devices of a Live System. 
 

Control Example

Pixera.LiveSystems.LiveSystem.getGraphicsDevices(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":153, "method":"Pixera.LiveSystems.LiveSystem.getGraphicsDevices", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":153, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getGraphicsDevices" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns handles to all enabled outputs. 
 

Control Example

Pixera.LiveSystems.LiveSystem.getEnabledOutputs(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":154, "method":"Pixera.LiveSystems.LiveSystem.getEnabledOutputs", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":154, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getEnabledOutputs" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns handles of all outputs even if they are not physically connected. 
 

Control Example

Pixera.LiveSystems.LiveSystem.getAllOutputs(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":155, "method":"Pixera.LiveSystems.LiveSystem.getAllOutputs", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":155, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getAllOutputs" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns handles to all video stream outputs (NDI, Art-Net, etc.). 
 

Control Example

Pixera.LiveSystems.LiveSystem.getVideoStreamOutputs(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":156, "method":"Pixera.LiveSystems.LiveSystem.getVideoStreamOutputs", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":156, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getVideoStreamOutputs" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.resetEngine(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":157, "method":"Pixera.LiveSystems.LiveSystem.resetEngine", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":157} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/resetEngine" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.restartEngine(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":158, "method":"Pixera.LiveSystems.LiveSystem.restartEngine", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":158} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/restartEngine" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.startEngine(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":159, "method":"Pixera.LiveSystems.LiveSystem.startEngine", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":159} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/startEngine" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.closeEngine(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":160, "method":"Pixera.LiveSystems.LiveSystem.closeEngine", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":160} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/closeEngine" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.setAudioMasterVolume(handle 123456789, channel 1, volume 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":161, "method":"Pixera.LiveSystems.LiveSystem.setAudioMasterVolume", "params":{"handle":123456789, "channel":1, "volume":1.0}}

       <= {"jsonrpc":"2.0", "id":161} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/setAudioMasterVolume" arguments: (Handle or Path) 1 1.0  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.getAudioMasterVolume(handle 123456789, channel 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":162, "method":"Pixera.LiveSystems.LiveSystem.getAudioMasterVolume", "params":{"handle":123456789, "channel":1}}

       <= {"jsonrpc":"2.0", "id":162, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getAudioMasterVolume" arguments: (Handle or Path) 1  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.setAudioMasterMute(handle 123456789, channel 1, state true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":163, "method":"Pixera.LiveSystems.LiveSystem.setAudioMasterMute", "params":{"handle":123456789, "channel":1, "state":true}}

       <= {"jsonrpc":"2.0", "id":163} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/setAudioMasterMute" arguments: (Handle or Path) 1 true  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.getAudioMasterMute(handle 123456789, channel 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":164, "method":"Pixera.LiveSystems.LiveSystem.getAudioMasterMute", "params":{"handle":123456789, "channel":1}}

       <= {"jsonrpc":"2.0", "id":164, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getAudioMasterMute" arguments: (Handle or Path) 1  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.toggleAudioMasterMute(handle 123456789, channel 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":165, "method":"Pixera.LiveSystems.LiveSystem.toggleAudioMasterMute", "params":{"handle":123456789, "channel":1}}

       <= {"jsonrpc":"2.0", "id":165} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/toggleAudioMasterMute" arguments: (Handle or Path) 1  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.setAudioTimecodeInput(handle 123456789, channel 1, state true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":166, "method":"Pixera.LiveSystems.LiveSystem.setAudioTimecodeInput", "params":{"handle":123456789, "channel":1, "state":true}}

       <= {"jsonrpc":"2.0", "id":166} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/setAudioTimecodeInput" arguments: (Handle or Path) 1 true  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.triggerBackup(handle 123456789, applyControlCommand val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":167, "method":"Pixera.LiveSystems.LiveSystem.triggerBackup", "params":{"handle":123456789, "applyControlCommand":val}}

       <= {"jsonrpc":"2.0", "id":167} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/triggerBackup" arguments: (Handle or Path) val  | 

// Files which are not used in the current project are deleted from the RX-Cache directory. 
 

Control Example

Pixera.LiveSystems.LiveSystem.deleteUnusedFilesFromCache(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":168, "method":"Pixera.LiveSystems.LiveSystem.deleteUnusedFilesFromCache", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":168} | 

OSC

       => "/Pixera/LiveSystems/LiveSystem/deleteUnusedFilesFromCache" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.getStructureJson(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":169, "method":"Pixera.LiveSystems.LiveSystem.getStructureJson", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":169, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getStructureJson" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.getInst(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":170, "method":"Pixera.LiveSystems.LiveSystem.getInst", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":170, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/LiveSystems/LiveSystem/getInst" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.LiveSystem.getInstancePath(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":171, "method":"Pixera.LiveSystems.LiveSystem.getInstancePath", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":171, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/LiveSystem/getInstancePath" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.UsagePreset.getName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":172, "method":"Pixera.LiveSystems.UsagePreset.getName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":172, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/UsagePreset/getName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.UsagePreset.update(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":173, "method":"Pixera.LiveSystems.UsagePreset.update", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":173} | 

OSC

       => "/Pixera/LiveSystems/UsagePreset/update" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.LiveSystems.UsagePreset.apply(handle 123456789, destinationIp "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":174, "method":"Pixera.LiveSystems.UsagePreset.apply", "params":{"handle":123456789, "destinationIp":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":174} | 

OSC

       => "/Pixera/LiveSystems/UsagePreset/apply" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.UsagePreset.importFromFile(handle 123456789, path "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":175, "method":"Pixera.LiveSystems.UsagePreset.importFromFile", "params":{"handle":123456789, "path":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":175} | 

OSC

       => "/Pixera/LiveSystems/UsagePreset/importFromFile" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.UsagePreset.exportToFile(handle 123456789, path "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":176, "method":"Pixera.LiveSystems.UsagePreset.exportToFile", "params":{"handle":123456789, "path":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":176} | 

OSC

       => "/Pixera/LiveSystems/UsagePreset/exportToFile" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.UsagePreset.getInst(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":177, "method":"Pixera.LiveSystems.UsagePreset.getInst", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":177, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/LiveSystems/UsagePreset/getInst" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.UsagePreset.getInstancePath(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":178, "method":"Pixera.LiveSystems.UsagePreset.getInstancePath", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":178, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/UsagePreset/getInstancePath" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.GraphicsDevice.getName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":179, "method":"Pixera.LiveSystems.GraphicsDevice.getName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":179, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/GraphicsDevice/getName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns handles to all enabled outputs. 
 

Control Example

Pixera.LiveSystems.GraphicsDevice.getEnabledOutputs(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":180, "method":"Pixera.LiveSystems.GraphicsDevice.getEnabledOutputs", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":180, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/GraphicsDevice/getEnabledOutputs" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns handles of all outputs even if they are not physically connected. 
 

Control Example

Pixera.LiveSystems.GraphicsDevice.getAllOutputs(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":181, "method":"Pixera.LiveSystems.GraphicsDevice.getAllOutputs", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":181, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/GraphicsDevice/getAllOutputs" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.GraphicsDevice.getInst(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":182, "method":"Pixera.LiveSystems.GraphicsDevice.getInst", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":182, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/LiveSystems/GraphicsDevice/getInst" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.GraphicsDevice.getInstancePath(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":183, "method":"Pixera.LiveSystems.GraphicsDevice.getInstancePath", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":183, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/GraphicsDevice/getInstancePath" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.Output.getName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":184, "method":"Pixera.LiveSystems.Output.getName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":184, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/Output/getName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set output active/inactive. 
 

Control Example

Pixera.LiveSystems.Output.setActive(handle 123456789, active true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":185, "method":"Pixera.LiveSystems.Output.setActive", "params":{"handle":123456789, "active":true}}

       <= {"jsonrpc":"2.0", "id":185} | 

OSC

       => "/Pixera/LiveSystems/Output/setActive" arguments: (Handle or Path) true  | 

// Return current active state of output. 
 

Control Example

Pixera.LiveSystems.Output.getActive(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":186, "method":"Pixera.LiveSystems.Output.getActive", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":186, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/Output/getActive" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// set output identify. 
 

Control Example

Pixera.LiveSystems.Output.setIdentify(handle 123456789, state true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":187, "method":"Pixera.LiveSystems.Output.setIdentify", "params":{"handle":123456789, "state":true}}

       <= {"jsonrpc":"2.0", "id":187} | 

OSC

       => "/Pixera/LiveSystems/Output/setIdentify" arguments: (Handle or Path) true  | 

// get output identify. 
 

Control Example

Pixera.LiveSystems.Output.getIdentify(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":188, "method":"Pixera.LiveSystems.Output.getIdentify", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":188, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/Output/getIdentify" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Return assigned Screens. 
 

Control Example

Pixera.LiveSystems.Output.getAssignedScreens(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":189, "method":"Pixera.LiveSystems.Output.getAssignedScreens", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":189, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/Output/getAssignedScreens" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Return assigned Projectors. 
 

Control Example

Pixera.LiveSystems.Output.getAssignedProjectors(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":190, "method":"Pixera.LiveSystems.Output.getAssignedProjectors", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":190, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/Output/getAssignedProjectors" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.Output.getEnabled(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":191, "method":"Pixera.LiveSystems.Output.getEnabled", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":191, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/Output/getEnabled" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.Output.getForPreview(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":192, "method":"Pixera.LiveSystems.Output.getForPreview", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":192, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/Output/getForPreview" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// set outputs is aggregate 
 

Control Example

Pixera.LiveSystems.Output.setIsOutputAggregate(handle 123456789, state true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":193, "method":"Pixera.LiveSystems.Output.setIsOutputAggregate", "params":{"handle":123456789, "state":true}}

       <= {"jsonrpc":"2.0", "id":193} | 

OSC

       => "/Pixera/LiveSystems/Output/setIsOutputAggregate" arguments: (Handle or Path) true  | 

// set outputs is aggregate 
 

Control Example

Pixera.LiveSystems.Output.getIsOutputAggregate(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":194, "method":"Pixera.LiveSystems.Output.getIsOutputAggregate", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":194, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/Output/getIsOutputAggregate" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// set vertical and horizontal aggregate settings 
 

Control Example

Pixera.LiveSystems.Output.setAggregateDims(handle 123456789, horizontalCount 1, verticalCount 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":195, "method":"Pixera.LiveSystems.Output.setAggregateDims", "params":{"handle":123456789, "horizontalCount":1, "verticalCount":1}}

       <= {"jsonrpc":"2.0", "id":195} | 

OSC

       => "/Pixera/LiveSystems/Output/setAggregateDims" arguments: (Handle or Path) 1 1  | 

// get vertical and horizontal aggregate settings 
 

Control Example

Pixera.LiveSystems.Output.getAggregateDims(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":196, "method":"Pixera.LiveSystems.Output.getAggregateDims", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":196, "result":[1, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/Output/getAggregateDims" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.Output.getInst(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":197, "method":"Pixera.LiveSystems.Output.getInst", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":197, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/LiveSystems/Output/getInst" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.Output.getInstancePath(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":198, "method":"Pixera.LiveSystems.Output.getInstancePath", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":198, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/Output/getInstancePath" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.VideoStream.getName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":199, "method":"Pixera.LiveSystems.VideoStream.getName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":199, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/VideoStream/getName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set video stream active/inactive. 
 

Control Example

Pixera.LiveSystems.VideoStream.setActive(handle 123456789, active true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":200, "method":"Pixera.LiveSystems.VideoStream.setActive", "params":{"handle":123456789, "active":true}}

       <= {"jsonrpc":"2.0", "id":200} | 

OSC

       => "/Pixera/LiveSystems/VideoStream/setActive" arguments: (Handle or Path) true  | 

// Get active state of video stream. 
 

Control Example

Pixera.LiveSystems.VideoStream.getActive(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":201, "method":"Pixera.LiveSystems.VideoStream.getActive", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":201, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/VideoStream/getActive" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.VideoStream.getIpAddress(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":202, "method":"Pixera.LiveSystems.VideoStream.getIpAddress", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":202, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/VideoStream/getIpAddress" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.VideoStream.setIpAddress(handle 123456789, ipAddress "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":203, "method":"Pixera.LiveSystems.VideoStream.setIpAddress", "params":{"handle":123456789, "ipAddress":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":203} | 

OSC

       => "/Pixera/LiveSystems/VideoStream/setIpAddress" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.LiveSystems.VideoStream.getDeviceType(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":204, "method":"Pixera.LiveSystems.VideoStream.getDeviceType", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":204, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/VideoStream/getDeviceType" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.VideoStream.getInst(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":205, "method":"Pixera.LiveSystems.VideoStream.getInst", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":205, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/LiveSystems/VideoStream/getInst" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.LiveSystems.VideoStream.getInstancePath(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":206, "method":"Pixera.LiveSystems.VideoStream.getInstancePath", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":206, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/LiveSystems/VideoStream/getInstancePath" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// If this is true, the values for transformation and scale, set in Node::setValues have to be in pixels. 
 

Control Example

Pixera.Settings.SettingsGeneral.getShowDimsInPixels()

TCP/UDP

    => {"jsonrpc":"2.0", "id":207, "method":"Pixera.Settings.SettingsGeneral.getShowDimsInPixels"}

    <= {"jsonrpc":"2.0", "id":207, "result":true} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Settings/SettingsGeneral/getShowDimsInPixels" | Warning: OSC does currently not provide any return values.

// If this is true, the nodes will be using size instead of scale. 
 

Control Example

Pixera.Settings.SettingsGeneral.getShowScaleAsSize()

TCP/UDP

    => {"jsonrpc":"2.0", "id":208, "method":"Pixera.Settings.SettingsGeneral.getShowScaleAsSize"}

    <= {"jsonrpc":"2.0", "id":208, "result":true} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Settings/SettingsGeneral/getShowScaleAsSize" | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Settings.SettingsGeneral.setFadeToTimeDelay(timeInMilliseconds 1)

TCP/UDP

    => {"jsonrpc":"2.0", "id":209, "method":"Pixera.Settings.SettingsGeneral.setFadeToTimeDelay", "params":{"timeInMilliseconds":1}}

    <= {"jsonrpc":"2.0", "id":209} | 

OSC

    => "/Pixera/Settings/SettingsGeneral/setFadeToTimeDelay" arguments: 1  | 

Doku:
 

Control Example

Pixera.Settings.SettingsGeneral.getFadeToTimeDelay()

TCP/UDP

    => {"jsonrpc":"2.0", "id":210, "method":"Pixera.Settings.SettingsGeneral.getFadeToTimeDelay"}

    <= {"jsonrpc":"2.0", "id":210, "result":1} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Settings/SettingsGeneral/getFadeToTimeDelay" | Warning: OSC does currently not provide any return values.

// Get Transcoding presets as a vector of Json-Strings

// With the stucture:

// Available container/codec strings:

// vp9: mkv, mp4

// H264: mp4

// H265: mp4

// HAP: mov

// HAP Alpha: mov

// HAP Q: mov

// Image: png, tiff, dpx

// 

// Compression settings:

// Lossless : 0

// Low : 1

// Medium : 2

// High : 3

// 

// Hap compression settings:

// None : 0

// Snappy : 1

// 

// H264 Presets:

// Default : 1

// Slow : 2

// Medium : 3

// Fast : 4

// Hp (High Performance): 5

// Hq : 6

// Bd : 7

// Ll (Low latency) : 8

// LlHq : 9

// LlHp : 10

// Lossless : 11

// Lossless Hp : 12 
 

Control Example

Pixera.Settings.SettingsTranscoding.getTranscodingPresets()

TCP/UDP

    => {"jsonrpc":"2.0", "id":211, "method":"Pixera.Settings.SettingsTranscoding.getTranscodingPresets"}

    <= {"jsonrpc":"2.0", "id":211, "result":[Efgh, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Settings/SettingsTranscoding/getTranscodingPresets" | Warning: OSC does currently not provide any return values.

// Search for preset with given name if found it will be set to the given setup, 
// if not a new one will be created. 
 

Control Example

Pixera.Settings.SettingsTranscoding.addOrChangeTranscodingPreset(preset "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":212, "method":"Pixera.Settings.SettingsTranscoding.addOrChangeTranscodingPreset", "params":{"preset":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":212} | 

OSC

    => "/Pixera/Settings/SettingsTranscoding/addOrChangeTranscodingPreset" arguments: "Abcd"  | 

// Defines the rule for the automatic distribution of newly added resources. 0: None, 1: On Import, 2: On Use 
 

Control Example

Pixera.Settings.SettingsResourceDistribution.setAutoDistributionRule(rule 1)

TCP/UDP

    => {"jsonrpc":"2.0", "id":213, "method":"Pixera.Settings.SettingsResourceDistribution.setAutoDistributionRule", "params":{"rule":1}}

    <= {"jsonrpc":"2.0", "id":213} | 

OSC

    => "/Pixera/Settings/SettingsResourceDistribution/setAutoDistributionRule" arguments: 1  | 

// Returns the rule for the automatic distribution of newly added resources. 0: None, 1: On Import, 2: On Use 
 

Control Example

Pixera.Settings.SettingsResourceDistribution.getAutoDistributionRule()

TCP/UDP

    => {"jsonrpc":"2.0", "id":214, "method":"Pixera.Settings.SettingsResourceDistribution.getAutoDistributionRule"}

    <= {"jsonrpc":"2.0", "id":214, "result":1} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Settings/SettingsResourceDistribution/getAutoDistributionRule" | Warning: OSC does currently not provide any return values.

// Screen name as shown in the inspector. 
 

Control Example

Pixera.Screens.getScreenWithName(name "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":215, "method":"Pixera.Screens.getScreenWithName", "params":{"name":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":215, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Screens/getScreenWithName" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// This function was introduced for test purposes, is not typical of the API 
// and is likely to be removed soon. Do not use it in shipping products! 
// The function sets the position of the screen with the given name. 
// The recommended way of doing this is to first use getScreenWithName(.) and 
// then Screen.setPosition(.). 
 

Control Example

Pixera.Screens.setNamedScreenPosition(name "Abcd", xPos val, yPos val, zPos val)

TCP/UDP

    => {"jsonrpc":"2.0", "id":216, "method":"Pixera.Screens.setNamedScreenPosition", "params":{"name":"Abcd", "xPos":val, "yPos":val, "zPos":val}}

    <= {"jsonrpc":"2.0", "id":216} | 

OSC

    => "/Pixera/Screens/setNamedScreenPosition" arguments: "Abcd" val val val  | 

// Returns handles to all screens currently used in the Screens tab. 
 

Control Example

Pixera.Screens.getScreens()

TCP/UDP

    => {"jsonrpc":"2.0", "id":217, "method":"Pixera.Screens.getScreens"}

    <= {"jsonrpc":"2.0", "id":217, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Screens/getScreens" | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Screens.getScreenNames()

TCP/UDP

    => {"jsonrpc":"2.0", "id":218, "method":"Pixera.Screens.getScreenNames"}

    <= {"jsonrpc":"2.0", "id":218, "result":[Efgh, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Screens/getScreenNames" | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Screens.getFirstTimelineWithHomeScreen(screenName "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":219, "method":"Pixera.Screens.getFirstTimelineWithHomeScreen", "params":{"screenName":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":219, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Screens/getFirstTimelineWithHomeScreen" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Returns handles to all studio cameras currently used in the Screens tab. 
 

Control Example

Pixera.Screens.getStudioCameras()

TCP/UDP

    => {"jsonrpc":"2.0", "id":220, "method":"Pixera.Screens.getStudioCameras"}

    <= {"jsonrpc":"2.0", "id":220, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Screens/getStudioCameras" | Warning: OSC does currently not provide any return values.

// Returns an id based on the handle. This is currently necessary in some situations 
// because some API implementations can not yet consume handles as parameters. 
 

Control Example

Pixera.Screens.Screen.getId(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":221, "method":"Pixera.Screens.Screen.getId", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":221, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/getId" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Screens.Screen.getName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":222, "method":"Pixera.Screens.Screen.getName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":222, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/getName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Sets the position in meters. 
 

Control Example

Pixera.Screens.Screen.setPosition(handle 123456789, xPos val, yPos val, zPos val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":223, "method":"Pixera.Screens.Screen.setPosition", "params":{"handle":123456789, "xPos":val, "yPos":val, "zPos":val}}

       <= {"jsonrpc":"2.0", "id":223, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/setPosition" arguments: (Handle or Path) val val val  | Warning: OSC does currently not provide any return values.

// Returns the position in meters. 
 

Control Example

Pixera.Screens.Screen.getPosition(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":224, "method":"Pixera.Screens.Screen.getPosition", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":224, "result":{"x":1.0, "y":1.0, "z":1.0}} | 

OSC

       => "/Pixera/Screens/Screen/getPosition" arguments: (Handle or Path)  | 

// Sets the rotation in degrees. 
 

Control Example

Pixera.Screens.Screen.setRotation(handle 123456789, xRot val, yRot val, zRot val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":225, "method":"Pixera.Screens.Screen.setRotation", "params":{"handle":123456789, "xRot":val, "yRot":val, "zRot":val}}

       <= {"jsonrpc":"2.0", "id":225, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/setRotation" arguments: (Handle or Path) val val val  | Warning: OSC does currently not provide any return values.

// Returns the Rotation in degrees. 
 

Control Example

Pixera.Screens.Screen.getRotation(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":226, "method":"Pixera.Screens.Screen.getRotation", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":226, "result":{"x":1.0, "y":1.0, "z":1.0}} | 

OSC

       => "/Pixera/Screens/Screen/getRotation" arguments: (Handle or Path)  | 

// Scales the screen proportionally (a value of 1.0 leaves the size unchanged). 
 

Control Example

Pixera.Screens.Screen.setScale(handle 123456789, xScale val, yScale val, zScale val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":227, "method":"Pixera.Screens.Screen.setScale", "params":{"handle":123456789, "xScale":val, "yScale":val, "zScale":val}}

       <= {"jsonrpc":"2.0", "id":227, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/setScale" arguments: (Handle or Path) val val val  | Warning: OSC does currently not provide any return values.

// Returns the Scale. 
 

Control Example

Pixera.Screens.Screen.getScale(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":228, "method":"Pixera.Screens.Screen.getScale", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":228, "result":{"x":1.0, "y":1.0, "z":1.0}} | 

OSC

       => "/Pixera/Screens/Screen/getScale" arguments: (Handle or Path)  | 

// Sets position and rotation in one API call. 
 

Control Example

Pixera.Screens.Screen.setPosRot(handle 123456789, xPos val, yPos val, zPos val, xRot val, yRot val, zRot val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":229, "method":"Pixera.Screens.Screen.setPosRot", "params":{"handle":123456789, "xPos":val, "yPos":val, "zPos":val, "xRot":val, "yRot":val, "zRot":val}}

       <= {"jsonrpc":"2.0", "id":229, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/setPosRot" arguments: (Handle or Path) val val val val val val  | Warning: OSC does currently not provide any return values.

// Sets position, rotation and the perspective position for the first screen group in one API call. 
 

Control Example

Pixera.Screens.Screen.setPosRotAndPerspectivePos(handle 123456789, xPos val, yPos val, zPos val, xRot val, yRot val, zRot val, perspXPos val, perspYPos val, perspZPos val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":230, "method":"Pixera.Screens.Screen.setPosRotAndPerspectivePos", "params":{"handle":123456789, "xPos":val, "yPos":val, "zPos":val, "xRot":val, "yRot":val, "zRot":val, "perspXPos":val, "perspYPos":val, "perspZPos":val}}

       <= {"jsonrpc":"2.0", "id":230, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/setPosRotAndPerspectivePos" arguments: (Handle or Path) val val val val val val val val val  | Warning: OSC does currently not provide any return values.

// Sets position, rotation and scale in one API call. 
 

Control Example

Pixera.Screens.Screen.setPosRotScale(handle 123456789, xPos val, yPos val, zPos val, xRot val, yRot val, zRot val, xScale val, yScale val, zScale val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":231, "method":"Pixera.Screens.Screen.setPosRotScale", "params":{"handle":123456789, "xPos":val, "yPos":val, "zPos":val, "xRot":val, "yRot":val, "zRot":val, "xScale":val, "yScale":val, "zScale":val}}

       <= {"jsonrpc":"2.0", "id":231, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/setPosRotScale" arguments: (Handle or Path) val val val val val val val val val  | Warning: OSC does currently not provide any return values.

// Returns handles to all perspectives currently available for the screen. 
 

Control Example

Pixera.Screens.Screen.getPerspectives(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":232, "method":"Pixera.Screens.Screen.getPerspectives", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":232, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/getPerspectives" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns the perspective for the Screen Group with the given name. 
 

Control Example

Pixera.Screens.Screen.getPerspectiveForScreenGroup(handle 123456789, screenGroupName "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":233, "method":"Pixera.Screens.Screen.getPerspectiveForScreenGroup", "params":{"handle":123456789, "screenGroupName":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":233, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/getPerspectiveForScreenGroup" arguments: (Handle or Path) "Abcd"  | Warning: OSC does currently not provide any return values.

// Returns the perspective for the first Screen Group. 
 

Control Example

Pixera.Screens.Screen.getPersepective(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":234, "method":"Pixera.Screens.Screen.getPersepective", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":234, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/getPersepective" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Snap the Perspective to Screen
. 
// 0 : Snap Mode to Bounding Box

// 1 : Snap Mode to UV Coords

// 2 : Snap Mode to Vertices

// 3 : Snap Mode to Bounding Box in View

// 4 : Snap Mode to Vertices with Projection 
 

Control Example

Pixera.Screens.Screen.snapPerspectiveCornersToScreen(handle 123456789, mode 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":235, "method":"Pixera.Screens.Screen.snapPerspectiveCornersToScreen", "params":{"handle":123456789, "mode":1}}

       <= {"jsonrpc":"2.0", "id":235} | 

OSC

       => "/Pixera/Screens/Screen/snapPerspectiveCornersToScreen" arguments: (Handle or Path) 1  | 

// Sets the position of the perspective in meters. 
 

Control Example

Pixera.Screens.Screen.setPerspectivePosition(handle 123456789, xPos val, yPos val, zPos val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":236, "method":"Pixera.Screens.Screen.setPerspectivePosition", "params":{"handle":123456789, "xPos":val, "yPos":val, "zPos":val}}

       <= {"jsonrpc":"2.0", "id":236, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/setPerspectivePosition" arguments: (Handle or Path) val val val  | Warning: OSC does currently not provide any return values.

// Sets the position of the perspective in meters and moves the look-at point so that the 
// relationship between eye and look-at point is maintained. Look-at point will not be moved 
// if generalized perspective projection is being used. 
 

Control Example

Pixera.Screens.Screen.setPerspectivePositionWithLookAt(handle 123456789, xPos val, yPos val, zPos val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":237, "method":"Pixera.Screens.Screen.setPerspectivePositionWithLookAt", "params":{"handle":123456789, "xPos":val, "yPos":val, "zPos":val}}

       <= {"jsonrpc":"2.0", "id":237, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/setPerspectivePositionWithLookAt" arguments: (Handle or Path) val val val  | Warning: OSC does currently not provide any return values.

// Returns the position of the perspective in meters. 
 

Control Example

Pixera.Screens.Screen.getPerspectivePosition(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":238, "method":"Pixera.Screens.Screen.getPerspectivePosition", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":238, "result":{"x":1.0, "y":1.0, "z":1.0}} | 

OSC

       => "/Pixera/Screens/Screen/getPerspectivePosition" arguments: (Handle or Path)  | 

// Sets the rotation around the view axis of the screen's perspective in degrees. 
 

Control Example

Pixera.Screens.Screen.setPerspectiveRotation(handle 123456789, xRot val, yRot val, zRot val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":239, "method":"Pixera.Screens.Screen.setPerspectiveRotation", "params":{"handle":123456789, "xRot":val, "yRot":val, "zRot":val}}

       <= {"jsonrpc":"2.0", "id":239, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/setPerspectiveRotation" arguments: (Handle or Path) val val val  | Warning: OSC does currently not provide any return values.

// Returns the rotation around the view axis of the screen's perspective in degrees. 
 

Control Example

Pixera.Screens.Screen.getPerspectiveRotation(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":240, "method":"Pixera.Screens.Screen.getPerspectiveRotation", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":240, "result":{"x":1.0, "y":1.0, "z":1.0}} | 

OSC

       => "/Pixera/Screens/Screen/getPerspectiveRotation" arguments: (Handle or Path)  | 

// This method is deprecated. Please use setPerspectivePosition(.) instead. 
 

Control Example

Pixera.Screens.Screen.setCameraPosition(handle 123456789, xPos val, yPos val, zPos val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":241, "method":"Pixera.Screens.Screen.setCameraPosition", "params":{"handle":123456789, "xPos":val, "yPos":val, "zPos":val}}

       <= {"jsonrpc":"2.0", "id":241, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/setCameraPosition" arguments: (Handle or Path) val val val  | Warning: OSC does currently not provide any return values.

// This method is deprecated. Please use setPerspectivePositionWithLookAt(.) instead. 
 

Control Example

Pixera.Screens.Screen.setCameraPositionWithLookAt(handle 123456789, xPos val, yPos val, zPos val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":242, "method":"Pixera.Screens.Screen.setCameraPositionWithLookAt", "params":{"handle":123456789, "xPos":val, "yPos":val, "zPos":val}}

       <= {"jsonrpc":"2.0", "id":242, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/setCameraPositionWithLookAt" arguments: (Handle or Path) val val val  | Warning: OSC does currently not provide any return values.

// This method is deprecated. Please use getPerspectivePosition(.) instead. 
 

Control Example

Pixera.Screens.Screen.getCameraPosition(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":243, "method":"Pixera.Screens.Screen.getCameraPosition", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":243, "result":{"x":1.0, "y":1.0, "z":1.0}} | 

OSC

       => "/Pixera/Screens/Screen/getCameraPosition" arguments: (Handle or Path)  | 

// This method is deprecated. Please use setPerspectiveRotation(.) instead. 
 

Control Example

Pixera.Screens.Screen.setCameraRotation(handle 123456789, xRot val, yRot val, zRot val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":244, "method":"Pixera.Screens.Screen.setCameraRotation", "params":{"handle":123456789, "xRot":val, "yRot":val, "zRot":val}}

       <= {"jsonrpc":"2.0", "id":244, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/setCameraRotation" arguments: (Handle or Path) val val val  | Warning: OSC does currently not provide any return values.

// This method is deprecated. Please use getPerspectiveRotation(.) instead. 
 

Control Example

Pixera.Screens.Screen.getCameraRotation(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":245, "method":"Pixera.Screens.Screen.getCameraRotation", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":245, "result":{"x":1.0, "y":1.0, "z":1.0}} | 

OSC

       => "/Pixera/Screens/Screen/getCameraRotation" arguments: (Handle or Path)  | 

// Sets the frustum base of the screen's perspective in pixels. The frustum base is positioned in the X/Y plane of the content compositing 
// space so that its center is at the position given by the x and y parameters. The origin the position relates to is that of the screen given 
// by originScreenId (use Screen.getId() to access this id or pass a handle to the origin screen). This makes it possible to relate 
// multiple perspective pixel positions to the same origin.

// The width and height of the frustum base are set to pixel dimensions as given by the width and height parameters.

// The rotation parameter rotates the frustum base around the Z axis the given number of degrees. 
 

Control Example

Pixera.Screens.Screen.setContentSamplingFrustumBase(handle 123456789, x 1.0, y 1.0, width 1.0, height 1.0, rotation 1.0, originScreenId 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":246, "method":"Pixera.Screens.Screen.setContentSamplingFrustumBase", "params":{"handle":123456789, "x":1.0, "y":1.0, "width":1.0, "height":1.0, "rotation":1.0, "originScreenId":1.0}}

       <= {"jsonrpc":"2.0", "id":246} | 

OSC

       => "/Pixera/Screens/Screen/setContentSamplingFrustumBase" arguments: (Handle or Path) 1.0 1.0 1.0 1.0 1.0 1.0  | 

// Launches a calibration tool for the screen. The mode and diff strings 
// depend on the tool. If they are left empty appropriate defaults will be used.

// mode options:

// "newCalib": Launches "New Calibration" dialog.

// "autoRecalib": Launches re-calibration without user interaction. Dialog is closed automatically afterwards.

// diff options:

// "vioso" 
 

Control Example

Pixera.Screens.Screen.runCalibration(handle 123456789, mode "Abcd", diff "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":247, "method":"Pixera.Screens.Screen.runCalibration", "params":{"handle":123456789, "mode":"Abcd", "diff":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":247} | 

OSC

       => "/Pixera/Screens/Screen/runCalibration" arguments: (Handle or Path) "Abcd" "Abcd"  | 

// Relaunches a calibration tool for the screen for further editing. The diff string 
// depends on the tool. If it is left empty an appropriate default will be used. 
 

Control Example

Pixera.Screens.Screen.editCalibration(handle 123456789, diff "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":248, "method":"Pixera.Screens.Screen.editCalibration", "params":{"handle":123456789, "diff":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":248} | 

OSC

       => "/Pixera/Screens/Screen/editCalibration" arguments: (Handle or Path) "Abcd"  | 

// Notifiy if Calibration is finshed 
// Finished Parameter: True = Finished, False = Not Finished 
 

Control Example

Pixera.Screens.Screen.finshedCalibration(handle 123456789, finished true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":249, "method":"Pixera.Screens.Screen.finshedCalibration", "params":{"handle":123456789, "finished":true}}

       <= {"jsonrpc":"2.0", "id":249, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/finshedCalibration" arguments: (Handle or Path) true  | Warning: OSC does currently not provide any return values.

// Same functionality as pressing Button "Distribute Loaded Calibrations" 
 

Control Example

Pixera.Screens.Screen.distributeLoadedCalibrationAndReload(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":250, "method":"Pixera.Screens.Screen.distributeLoadedCalibrationAndReload", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":250} | 

OSC

       => "/Pixera/Screens/Screen/distributeLoadedCalibrationAndReload" arguments: (Handle or Path)  | 

// Resets a warp that originated with a calibration tool. The diff string depends 
// on the tool. If it is empty an appropriate default will be used. 
 

Control Example

Pixera.Screens.Screen.resetWarpFile(handle 123456789, diff "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":251, "method":"Pixera.Screens.Screen.resetWarpFile", "params":{"handle":123456789, "diff":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":251} | 

OSC

       => "/Pixera/Screens/Screen/resetWarpFile" arguments: (Handle or Path) "Abcd"  | 

// Loads the warp file at the specified path for the screen. 
 

Control Example

Pixera.Screens.Screen.loadWarpFile(handle 123456789, filePath "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":252, "method":"Pixera.Screens.Screen.loadWarpFile", "params":{"handle":123456789, "filePath":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":252} | 

OSC

       => "/Pixera/Screens/Screen/loadWarpFile" arguments: (Handle or Path) "Abcd"  | 

// Like loadWarpFile() except diff string can be used to control the format. Use "mpcdi" 
// to load MPCDI files. 
 

Control Example

Pixera.Screens.Screen.loadWarpFileWithDiff(handle 123456789, filePath "Abcd", diff "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":253, "method":"Pixera.Screens.Screen.loadWarpFileWithDiff", "params":{"handle":123456789, "filePath":"Abcd", "diff":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":253} | 

OSC

       => "/Pixera/Screens/Screen/loadWarpFileWithDiff" arguments: (Handle or Path) "Abcd" "Abcd"  | 

// Adds the warp file at the specified path to those loaded for the screen. 
 

Control Example

Pixera.Screens.Screen.addWarpFile(handle 123456789, filePath "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":254, "method":"Pixera.Screens.Screen.addWarpFile", "params":{"handle":123456789, "filePath":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":254} | 

OSC

       => "/Pixera/Screens/Screen/addWarpFile" arguments: (Handle or Path) "Abcd"  | 

// Like loadWarpFile() except diff string can be used to control the format. Use "mpcdi" 
// to add MPCDI files. 
 

Control Example

Pixera.Screens.Screen.addWarpFileWithDiff(handle 123456789, filePath "Abcd", diff "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":255, "method":"Pixera.Screens.Screen.addWarpFileWithDiff", "params":{"handle":123456789, "filePath":"Abcd", "diff":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":255} | 

OSC

       => "/Pixera/Screens/Screen/addWarpFileWithDiff" arguments: (Handle or Path) "Abcd" "Abcd"  | 

Doku:
 

Control Example

Pixera.Screens.Screen.loadColorCalibration(handle 123456789, calibrationName "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":256, "method":"Pixera.Screens.Screen.loadColorCalibration", "params":{"handle":123456789, "calibrationName":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":256} | 

OSC

       => "/Pixera/Screens/Screen/loadColorCalibration" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.Screens.Screen.runColorCalibration(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":257, "method":"Pixera.Screens.Screen.runColorCalibration", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":257} | 

OSC

       => "/Pixera/Screens/Screen/runColorCalibration" arguments: (Handle or Path)  | 

// Sets the screen visibility in the workspace. 
 

Control Example

Pixera.Screens.Screen.setIsVisible(handle 123456789, isVisible true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":258, "method":"Pixera.Screens.Screen.setIsVisible", "params":{"handle":123456789, "isVisible":true}}

       <= {"jsonrpc":"2.0", "id":258} | 

OSC

       => "/Pixera/Screens/Screen/setIsVisible" arguments: (Handle or Path) true  | 

// Get the screen visibility in the workspace. 
 

Control Example

Pixera.Screens.Screen.getIsVisible(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":259, "method":"Pixera.Screens.Screen.getIsVisible", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":259, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/getIsVisible" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Sets if a screen can be used as a projection surface. 
 

Control Example

Pixera.Screens.Screen.setIsProjectable(handle 123456789, isProjectable true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":260, "method":"Pixera.Screens.Screen.setIsProjectable", "params":{"handle":123456789, "isProjectable":true}}

       <= {"jsonrpc":"2.0", "id":260} | 

OSC

       => "/Pixera/Screens/Screen/setIsProjectable" arguments: (Handle or Path) true  | 

// Get if the screen can be used as a projection surface. 
 

Control Example

Pixera.Screens.Screen.getIsProjectable(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":261, "method":"Pixera.Screens.Screen.getIsProjectable", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":261, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/getIsProjectable" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Triggers a manual update of the mappings between this screen and the projectors. 
 

Control Example

Pixera.Screens.Screen.triggerRefreshMapping(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":262, "method":"Pixera.Screens.Screen.triggerRefreshMapping", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":262} | 

OSC

       => "/Pixera/Screens/Screen/triggerRefreshMapping" arguments: (Handle or Path)  | 

// Reset all color correction 
 

Control Example

Pixera.Screens.Screen.resetAllColorCorrections(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":263, "method":"Pixera.Screens.Screen.resetAllColorCorrections", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":263} | 

OSC

       => "/Pixera/Screens/Screen/resetAllColorCorrections" arguments: (Handle or Path)  | 

//Set ColorCorrection Value by Path 
 

Control Example

Pixera.Screens.Screen.setColorCorrectionWithPath(handle 123456789, path "Abcd", value 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":264, "method":"Pixera.Screens.Screen.setColorCorrectionWithPath", "params":{"handle":123456789, "path":"Abcd", "value":1.0}}

       <= {"jsonrpc":"2.0", "id":264} | 

OSC

       => "/Pixera/Screens/Screen/setColorCorrectionWithPath" arguments: (Handle or Path) "Abcd" 1.0  | 

//Get ColorCorrection Value by Path 
 

Control Example

Pixera.Screens.Screen.getColorCorrectionWithPath(handle 123456789, path "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":265, "method":"Pixera.Screens.Screen.getColorCorrectionWithPath", "params":{"handle":123456789, "path":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":265, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/getColorCorrectionWithPath" arguments: (Handle or Path) "Abcd"  | Warning: OSC does currently not provide any return values.

//Set colorcorrection with jsonstring 
 

Control Example

Pixera.Screens.Screen.setColorCorrectionAsJsonString(handle 123456789, colorCorrection "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":266, "method":"Pixera.Screens.Screen.setColorCorrectionAsJsonString", "params":{"handle":123456789, "colorCorrection":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":266} | 

OSC

       => "/Pixera/Screens/Screen/setColorCorrectionAsJsonString" arguments: (Handle or Path) "Abcd"  | 

//Get colorcorrection as jsonstring 
 

Control Example

Pixera.Screens.Screen.getColorCorrectionAsJsonString(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":267, "method":"Pixera.Screens.Screen.getColorCorrectionAsJsonString", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":267, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/getColorCorrectionAsJsonString" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

//get outputs 
 

Control Example

Pixera.Screens.Screen.getOutput(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":268, "method":"Pixera.Screens.Screen.getOutput", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":268, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/getOutput" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set the active state of a active screen Blackout. 
 

Control Example

Pixera.Screens.Screen.setBlackout(handle 123456789, isActive true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":269, "method":"Pixera.Screens.Screen.setBlackout", "params":{"handle":123456789, "isActive":true}}

       <= {"jsonrpc":"2.0", "id":269} | 

OSC

       => "/Pixera/Screens/Screen/setBlackout" arguments: (Handle or Path) true  | 

// Get the active state of a active screen blackout. 
 

Control Example

Pixera.Screens.Screen.getBlackout(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":270, "method":"Pixera.Screens.Screen.getBlackout", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":270, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/getBlackout" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Screens.Screen.getInst(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":271, "method":"Pixera.Screens.Screen.getInst", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":271, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Screens/Screen/getInst" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Screens.Screen.getHandleFromInstancePath(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":272, "method":"Pixera.Screens.Screen.getHandleFromInstancePath", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":272, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Screens/Screen/getHandleFromInstancePath" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Screens.Screen.getInstancePath(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":273, "method":"Pixera.Screens.Screen.getInstancePath", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":273, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Screen/getInstancePath" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Screens.StudioCamera.getName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":274, "method":"Pixera.Screens.StudioCamera.getName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":274, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/StudioCamera/getName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Sets the position in meters. 
 

Control Example

Pixera.Screens.StudioCamera.setPosition(handle 123456789, xPos val, yPos val, zPos val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":275, "method":"Pixera.Screens.StudioCamera.setPosition", "params":{"handle":123456789, "xPos":val, "yPos":val, "zPos":val}}

       <= {"jsonrpc":"2.0", "id":275} | 

OSC

       => "/Pixera/Screens/StudioCamera/setPosition" arguments: (Handle or Path) val val val  | 

// Returns the position in meters. 
 

Control Example

Pixera.Screens.StudioCamera.getPosition(handle 123456789, xPos 1.0, yPos 1.0, zPos 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":276, "method":"Pixera.Screens.StudioCamera.getPosition", "params":{"handle":123456789, "xPos":1.0, "yPos":1.0, "zPos":1.0}}

       <= {"jsonrpc":"2.0", "id":276, "result":[1.0, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/StudioCamera/getPosition" arguments: (Handle or Path) 1.0 1.0 1.0  | Warning: OSC does currently not provide any return values.

// Sets the euler rotation in degrees. 
 

Control Example

Pixera.Screens.StudioCamera.setRotation(handle 123456789, xRot val, yRot val, zRot val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":277, "method":"Pixera.Screens.StudioCamera.setRotation", "params":{"handle":123456789, "xRot":val, "yRot":val, "zRot":val}}

       <= {"jsonrpc":"2.0", "id":277} | 

OSC

       => "/Pixera/Screens/StudioCamera/setRotation" arguments: (Handle or Path) val val val  | 

// Sets rotation in quaternions. 
 

Control Example

Pixera.Screens.StudioCamera.setRotationQuat(handle 123456789, xQuat val, yQuat val, zQuat val, wQuat val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":278, "method":"Pixera.Screens.StudioCamera.setRotationQuat", "params":{"handle":123456789, "xQuat":val, "yQuat":val, "zQuat":val, "wQuat":val}}

       <= {"jsonrpc":"2.0", "id":278} | 

OSC

       => "/Pixera/Screens/StudioCamera/setRotationQuat" arguments: (Handle or Path) val val val val  | 

// Returns the euler rotation in degrees. 
 

Control Example

Pixera.Screens.StudioCamera.getRotation(handle 123456789, xPos 1.0, yPos 1.0, zPos 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":279, "method":"Pixera.Screens.StudioCamera.getRotation", "params":{"handle":123456789, "xPos":1.0, "yPos":1.0, "zPos":1.0}}

       <= {"jsonrpc":"2.0", "id":279, "result":[1.0, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/StudioCamera/getRotation" arguments: (Handle or Path) 1.0 1.0 1.0  | Warning: OSC does currently not provide any return values.

// Sets the position in meters, rotation and fov in degrees. 
 

Control Example

Pixera.Screens.StudioCamera.setTransformation(handle 123456789, xPos val, yPos val, zPos val, xRot val, yRot val, zRot val, fov val, aspectRatio val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":280, "method":"Pixera.Screens.StudioCamera.setTransformation", "params":{"handle":123456789, "xPos":val, "yPos":val, "zPos":val, "xRot":val, "yRot":val, "zRot":val, "fov":val, "aspectRatio":val}}

       <= {"jsonrpc":"2.0", "id":280} | 

OSC

       => "/Pixera/Screens/StudioCamera/setTransformation" arguments: (Handle or Path) val val val val val val val val  | 

// Sets the position in meters, rotation in quaternions, fov in degrees. 
 

Control Example

Pixera.Screens.StudioCamera.setTransformationQuat(handle 123456789, xPos val, yPos val, zPos val, xQuat val, yQuat val, zQuat val, wQuat val, fov val, aspectRatio val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":281, "method":"Pixera.Screens.StudioCamera.setTransformationQuat", "params":{"handle":123456789, "xPos":val, "yPos":val, "zPos":val, "xQuat":val, "yQuat":val, "zQuat":val, "wQuat":val, "fov":val, "aspectRatio":val}}

       <= {"jsonrpc":"2.0", "id":281} | 

OSC

       => "/Pixera/Screens/StudioCamera/setTransformationQuat" arguments: (Handle or Path) val val val val val val val val val  | 

// Sets the position in meters, rotation and fov in degrees, centerX, centerX and panelWidth in millimeters. 
 

Control Example

Pixera.Screens.StudioCamera.setTransformationAndLensProps(handle 123456789, xPos 1.0, yPos 1.0, zPos 1.0, xRot 1.0, yRot 1.0, zRot 1.0, fov 1.0, aspectRatio 1.0, nearClip 1.0, farClip 1.0, aperture 1.0, focus 1.0, iris 1.0, k1 1.0, k2 1.0, centerX 1.0, centerY 1.0, panelWidth 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":282, "method":"Pixera.Screens.StudioCamera.setTransformationAndLensProps", "params":{"handle":123456789, "xPos":1.0, "yPos":1.0, "zPos":1.0, "xRot":1.0, "yRot":1.0, "zRot":1.0, "fov":1.0, "aspectRatio":1.0, "nearClip":1.0, "farClip":1.0, "aperture":1.0, "focus":1.0, "iris":1.0, "k1":1.0, "k2":1.0, "centerX":1.0, "centerY":1.0, "panelWidth":1.0}}

       <= {"jsonrpc":"2.0", "id":282} | 

OSC

       => "/Pixera/Screens/StudioCamera/setTransformationAndLensProps" arguments: (Handle or Path) 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0  | 

// Sets the position in meters, rotation in quaternions, fov in degrees, centerX, centerX and panelWidth in millimeters. 
 

Control Example

Pixera.Screens.StudioCamera.setTransformationAndLensPropsQuat(handle 123456789, xPos 1.0, yPos 1.0, zPos 1.0, xQuat 1.0, yQuat 1.0, zQuat 1.0, wQuat 1.0, fov 1.0, aspectRatio 1.0, nearClip 1.0, farClip 1.0, aperture 1.0, focus 1.0, iris 1.0, k1 1.0, k2 1.0, centerX 1.0, centerY 1.0, panelWidth 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":283, "method":"Pixera.Screens.StudioCamera.setTransformationAndLensPropsQuat", "params":{"handle":123456789, "xPos":1.0, "yPos":1.0, "zPos":1.0, "xQuat":1.0, "yQuat":1.0, "zQuat":1.0, "wQuat":1.0, "fov":1.0, "aspectRatio":1.0, "nearClip":1.0, "farClip":1.0, "aperture":1.0, "focus":1.0, "iris":1.0, "k1":1.0, "k2":1.0, "centerX":1.0, "centerY":1.0, "panelWidth":1.0}}

       <= {"jsonrpc":"2.0", "id":283} | 

OSC

       => "/Pixera/Screens/StudioCamera/setTransformationAndLensPropsQuat" arguments: (Handle or Path) 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0  | 

// Sets the position in meters, rotation and fov in degrees, centerX, centerX and panelWidth in millimeters. 
 

Control Example

Pixera.Screens.StudioCamera.setTransformationAndLensPropsExt(handle 123456789, xPos 1.0, yPos 1.0, zPos 1.0, xRot 1.0, yRot 1.0, zRot 1.0, fov 1.0, aspectRatio 1.0, nearClip 1.0, farClip 1.0, aperture 1.0, focus 1.0, focalDistance 1.0, zoom 1.0, iris 1.0, k1 1.0, k2 1.0, k3 1.0, p1 1.0, p2 1.0, centerX 1.0, centerY 1.0, panelWidth 1.0, overscan 1.0, focalLength val, focalLengthDistorted val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":284, "method":"Pixera.Screens.StudioCamera.setTransformationAndLensPropsExt", "params":{"handle":123456789, "xPos":1.0, "yPos":1.0, "zPos":1.0, "xRot":1.0, "yRot":1.0, "zRot":1.0, "fov":1.0, "aspectRatio":1.0, "nearClip":1.0, "farClip":1.0, "aperture":1.0, "focus":1.0, "focalDistance":1.0, "zoom":1.0, "iris":1.0, "k1":1.0, "k2":1.0, "k3":1.0, "p1":1.0, "p2":1.0, "centerX":1.0, "centerY":1.0, "panelWidth":1.0, "overscan":1.0, "focalLength":val, "focalLengthDistorted":val}}

       <= {"jsonrpc":"2.0", "id":284} | 

OSC

       => "/Pixera/Screens/StudioCamera/setTransformationAndLensPropsExt" arguments: (Handle or Path) 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 val val  | 

// Sets the position in meters, rotation in quaternions, fov in degrees, centerX, centerX and panelWidth in millimeters. 
 

Control Example

Pixera.Screens.StudioCamera.setTransformationAndLensPropsExtQuat(handle 123456789, xPos 1.0, yPos 1.0, zPos 1.0, xQuat 1.0, yQuat 1.0, zQuat 1.0, wQuat 1.0, fov 1.0, aspectRatio 1.0, nearClip 1.0, farClip 1.0, aperture 1.0, focus 1.0, focalDistance 1.0, zoom 1.0, iris 1.0, k1 1.0, k2 1.0, k3 1.0, p1 1.0, p2 1.0, centerX 1.0, centerY 1.0, panelWidth 1.0, overscan 1.0, focalLength val, focalLengthDistorted val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":285, "method":"Pixera.Screens.StudioCamera.setTransformationAndLensPropsExtQuat", "params":{"handle":123456789, "xPos":1.0, "yPos":1.0, "zPos":1.0, "xQuat":1.0, "yQuat":1.0, "zQuat":1.0, "wQuat":1.0, "fov":1.0, "aspectRatio":1.0, "nearClip":1.0, "farClip":1.0, "aperture":1.0, "focus":1.0, "focalDistance":1.0, "zoom":1.0, "iris":1.0, "k1":1.0, "k2":1.0, "k3":1.0, "p1":1.0, "p2":1.0, "centerX":1.0, "centerY":1.0, "panelWidth":1.0, "overscan":1.0, "focalLength":val, "focalLengthDistorted":val}}

       <= {"jsonrpc":"2.0", "id":285} | 

OSC

       => "/Pixera/Screens/StudioCamera/setTransformationAndLensPropsExtQuat" arguments: (Handle or Path) 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 1.0 val val  | 

// Set the tracking input pause. 
 

Control Example

Pixera.Screens.StudioCamera.setTrackingInputPause(handle 123456789, pause true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":286, "method":"Pixera.Screens.StudioCamera.setTrackingInputPause", "params":{"handle":123456789, "pause":true}}

       <= {"jsonrpc":"2.0", "id":286} | 

OSC

       => "/Pixera/Screens/StudioCamera/setTrackingInputPause" arguments: (Handle or Path) true  | 

// Get the tracking input pause. 
 

Control Example

Pixera.Screens.StudioCamera.getTrackingInputPause(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":287, "method":"Pixera.Screens.StudioCamera.getTrackingInputPause", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":287, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/StudioCamera/getTrackingInputPause" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set the tracking input position pause. 
 

Control Example

Pixera.Screens.StudioCamera.setUsePositionPropertiesFromTracking(handle 123456789, pause true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":288, "method":"Pixera.Screens.StudioCamera.setUsePositionPropertiesFromTracking", "params":{"handle":123456789, "pause":true}}

       <= {"jsonrpc":"2.0", "id":288} | 

OSC

       => "/Pixera/Screens/StudioCamera/setUsePositionPropertiesFromTracking" arguments: (Handle or Path) true  | 

// Get the tracking input position. 
 

Control Example

Pixera.Screens.StudioCamera.getUsePositionPropertiesFromTracking(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":289, "method":"Pixera.Screens.StudioCamera.getUsePositionPropertiesFromTracking", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":289, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/StudioCamera/getUsePositionPropertiesFromTracking" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set the tracking input rotation pause. 
 

Control Example

Pixera.Screens.StudioCamera.setUseRotationPropertiesFromTracking(handle 123456789, pause true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":290, "method":"Pixera.Screens.StudioCamera.setUseRotationPropertiesFromTracking", "params":{"handle":123456789, "pause":true}}

       <= {"jsonrpc":"2.0", "id":290} | 

OSC

       => "/Pixera/Screens/StudioCamera/setUseRotationPropertiesFromTracking" arguments: (Handle or Path) true  | 

// Get the tracking input rotation pause. 
 

Control Example

Pixera.Screens.StudioCamera.getUseRotationPropertiesFromTracking(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":291, "method":"Pixera.Screens.StudioCamera.getUseRotationPropertiesFromTracking", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":291, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/StudioCamera/getUseRotationPropertiesFromTracking" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set the camera to project on the associated screens. 
 

Control Example

Pixera.Screens.StudioCamera.setProjectOnAssociatedScreens(handle 123456789, state true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":292, "method":"Pixera.Screens.StudioCamera.setProjectOnAssociatedScreens", "params":{"handle":123456789, "state":true}}

       <= {"jsonrpc":"2.0", "id":292} | 

OSC

       => "/Pixera/Screens/StudioCamera/setProjectOnAssociatedScreens" arguments: (Handle or Path) true  | 

// Get whether the camera projects on the associated screens. 
 

Control Example

Pixera.Screens.StudioCamera.getProjectOnAssociatedScreens(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":293, "method":"Pixera.Screens.StudioCamera.getProjectOnAssociatedScreens", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":293, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/StudioCamera/getProjectOnAssociatedScreens" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Move the projected inner frustum rendering to the top among multiple studio cameras. 
 

Control Example

Pixera.Screens.StudioCamera.moveToTop(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":294, "method":"Pixera.Screens.StudioCamera.moveToTop", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":294} | 

OSC

       => "/Pixera/Screens/StudioCamera/moveToTop" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.Screens.StudioCamera.getInst(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":295, "method":"Pixera.Screens.StudioCamera.getInst", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":295, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Screens/StudioCamera/getInst" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Screens.StudioCamera.getHandleFromInstancePath(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":296, "method":"Pixera.Screens.StudioCamera.getHandleFromInstancePath", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":296, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Screens/StudioCamera/getHandleFromInstancePath" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Screens.StudioCamera.getInstancePath(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":297, "method":"Pixera.Screens.StudioCamera.getInstancePath", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":297, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/StudioCamera/getInstancePath" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Screens.Perspective.getName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":298, "method":"Pixera.Screens.Perspective.getName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":298, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Perspective/getName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Sets the position in meters, rotation and fov in degrees. The look at point is not locked by default. 
 

Control Example

Pixera.Screens.Perspective.setTransformation(handle 123456789, xPos val, yPos val, zPos val, xRot val, yRot val, zRot val, fov val, aspectRatio val, lockLookAtPt val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":299, "method":"Pixera.Screens.Perspective.setTransformation", "params":{"handle":123456789, "xPos":val, "yPos":val, "zPos":val, "xRot":val, "yRot":val, "zRot":val, "fov":val, "aspectRatio":val, "lockLookAtPt":val}}

       <= {"jsonrpc":"2.0", "id":299} | 

OSC

       => "/Pixera/Screens/Perspective/setTransformation" arguments: (Handle or Path) val val val val val val val val val  | 

Doku:
 

Control Example

Pixera.Screens.Perspective.getInst(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":300, "method":"Pixera.Screens.Perspective.getInst", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":300, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Screens/Perspective/getInst" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Screens.Perspective.getHandleFromInstancePath(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":301, "method":"Pixera.Screens.Perspective.getHandleFromInstancePath", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":301, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Screens/Perspective/getHandleFromInstancePath" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Screens.Perspective.getInstancePath(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":302, "method":"Pixera.Screens.Perspective.getInstancePath", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":302, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Screens/Perspective/getInstancePath" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Projector name as shown in the inspector. 
 

Control Example

Pixera.Projectors.getProjectorWithName(name "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":303, "method":"Pixera.Projectors.getProjectorWithName", "params":{"name":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":303, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Projectors/getProjectorWithName" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Returns handles to all screens currently used in the Mapping tab. 
 

Control Example

Pixera.Projectors.getProjectors()

TCP/UDP

    => {"jsonrpc":"2.0", "id":304, "method":"Pixera.Projectors.getProjectors"}

    <= {"jsonrpc":"2.0", "id":304, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Projectors/getProjectors" | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Projectors.getProjectorNames()

TCP/UDP

    => {"jsonrpc":"2.0", "id":305, "method":"Pixera.Projectors.getProjectorNames"}

    <= {"jsonrpc":"2.0", "id":305, "result":[Efgh, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Projectors/getProjectorNames" | Warning: OSC does currently not provide any return values.

// The position units are as in the inspector, i.e. meters. 
 

Control Example

Pixera.Projectors.Projector.getPosition(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":306, "method":"Pixera.Projectors.Projector.getPosition", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":306, "result":{"x":1.0, "y":1.0, "z":1.0}} | 

OSC

       => "/Pixera/Projectors/Projector/getPosition" arguments: (Handle or Path)  | 

// The position units are as in the inspector, i.e. meters. 
 

Control Example

Pixera.Projectors.Projector.setPosition(handle 123456789, xPos val, yPos val, zPos val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":307, "method":"Pixera.Projectors.Projector.setPosition", "params":{"handle":123456789, "xPos":val, "yPos":val, "zPos":val}}

       <= {"jsonrpc":"2.0", "id":307, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/setPosition" arguments: (Handle or Path) val val val  | Warning: OSC does currently not provide any return values.

// Get rotation of projector. 
 

Control Example

Pixera.Projectors.Projector.getRotation(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":308, "method":"Pixera.Projectors.Projector.getRotation", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":308, "result":{"x":1.0, "y":1.0, "z":1.0}} | 

OSC

       => "/Pixera/Projectors/Projector/getRotation" arguments: (Handle or Path)  | 

// Set rotation of projector. 
 

Control Example

Pixera.Projectors.Projector.setRotation(handle 123456789, xRot val, yRot val, zRot val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":309, "method":"Pixera.Projectors.Projector.setRotation", "params":{"handle":123456789, "xRot":val, "yRot":val, "zRot":val}}

       <= {"jsonrpc":"2.0", "id":309, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/setRotation" arguments: (Handle or Path) val val val  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Projectors.Projector.getName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":310, "method":"Pixera.Projectors.Projector.getName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":310, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set the active state of a projector screen mapping. 
// The id is conceptually the handle but the handle can not be passed 
// directly for some implementations of the API. 
// Therefore, Screen.getId() should be used to fill the screenId parameter. 
 

Control Example

Pixera.Projectors.Projector.activateScreenMapping(handle 123456789, screenId 1.0, isActive true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":311, "method":"Pixera.Projectors.Projector.activateScreenMapping", "params":{"handle":123456789, "screenId":1.0, "isActive":true}}

       <= {"jsonrpc":"2.0", "id":311} | 

OSC

       => "/Pixera/Projectors/Projector/activateScreenMapping" arguments: (Handle or Path) 1.0 true  | 

// Set the active state of a projector Blackout. 
 

Control Example

Pixera.Projectors.Projector.setBlackout(handle 123456789, isActive true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":312, "method":"Pixera.Projectors.Projector.setBlackout", "params":{"handle":123456789, "isActive":true}}

       <= {"jsonrpc":"2.0", "id":312} | 

OSC

       => "/Pixera/Projectors/Projector/setBlackout" arguments: (Handle or Path) true  | 

// Get the active state of a projector blackout. 
 

Control Example

Pixera.Projectors.Projector.getBlackout(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":313, "method":"Pixera.Projectors.Projector.getBlackout", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":313, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getBlackout" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// set Render Order ID 
 

Control Example

Pixera.Projectors.Projector.setRenderOrderId(handle 123456789, screenId 1.0, orderId 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":314, "method":"Pixera.Projectors.Projector.setRenderOrderId", "params":{"handle":123456789, "screenId":1.0, "orderId":1}}

       <= {"jsonrpc":"2.0", "id":314} | 

OSC

       => "/Pixera/Projectors/Projector/setRenderOrderId" arguments: (Handle or Path) 1.0 1  | 

// get Render Order ID 
 

Control Example

Pixera.Projectors.Projector.getRenderOrderId(handle 123456789, screenId 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":315, "method":"Pixera.Projectors.Projector.getRenderOrderId", "params":{"handle":123456789, "screenId":1.0}}

       <= {"jsonrpc":"2.0", "id":315, "result":1} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getRenderOrderId" arguments: (Handle or Path) 1.0  | Warning: OSC does currently not provide any return values.

// Set the softedge of a projector for a specific screen active. If screenName is empty changes will be applied to all. 
 

Control Example

Pixera.Projectors.Projector.setSoftedgeVisible(handle 123456789, screenName "Abcd", visible true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":316, "method":"Pixera.Projectors.Projector.setSoftedgeVisible", "params":{"handle":123456789, "screenName":"Abcd", "visible":true}}

       <= {"jsonrpc":"2.0", "id":316} | 

OSC

       => "/Pixera/Projectors/Projector/setSoftedgeVisible" arguments: (Handle or Path) "Abcd" true  | 

// Reset all color correction 
 

Control Example

Pixera.Projectors.Projector.resetAllColorCorrections(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":317, "method":"Pixera.Projectors.Projector.resetAllColorCorrections", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":317} | 

OSC

       => "/Pixera/Projectors/Projector/resetAllColorCorrections" arguments: (Handle or Path)  | 

//Set ColorCorrection Value by Path 
 

Control Example

Pixera.Projectors.Projector.setColorCorrectionWithPath(handle 123456789, path "Abcd", value 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":318, "method":"Pixera.Projectors.Projector.setColorCorrectionWithPath", "params":{"handle":123456789, "path":"Abcd", "value":1.0}}

       <= {"jsonrpc":"2.0", "id":318} | 

OSC

       => "/Pixera/Projectors/Projector/setColorCorrectionWithPath" arguments: (Handle or Path) "Abcd" 1.0  | 

//Get ColorCorrection Value by Path 
 

Control Example

Pixera.Projectors.Projector.getColorCorrectionWithPath(handle 123456789, path "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":319, "method":"Pixera.Projectors.Projector.getColorCorrectionWithPath", "params":{"handle":123456789, "path":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":319, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getColorCorrectionWithPath" arguments: (Handle or Path) "Abcd"  | Warning: OSC does currently not provide any return values.

//Set colorcorrection with jsonstring 
 

Control Example

Pixera.Projectors.Projector.setColorCorrectionAsJsonString(handle 123456789, colorCorrection "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":320, "method":"Pixera.Projectors.Projector.setColorCorrectionAsJsonString", "params":{"handle":123456789, "colorCorrection":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":320} | 

OSC

       => "/Pixera/Projectors/Projector/setColorCorrectionAsJsonString" arguments: (Handle or Path) "Abcd"  | 

//Get colorcorrection as jsonstring 
 

Control Example

Pixera.Projectors.Projector.getColorCorrectionAsJsonString(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":321, "method":"Pixera.Projectors.Projector.getColorCorrectionAsJsonString", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":321, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getColorCorrectionAsJsonString" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Get projector output. Index is optional. By default the first output is returned. 
 

Control Example

Pixera.Projectors.Projector.getOutput(handle 123456789, index val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":322, "method":"Pixera.Projectors.Projector.getOutput", "params":{"handle":123456789, "index":val}}

       <= {"jsonrpc":"2.0", "id":322, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getOutput" arguments: (Handle or Path) val  | Warning: OSC does currently not provide any return values.

// Set projector output. 
 

Control Example

Pixera.Projectors.Projector.setOutput(handle 123456789, outputHandle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":323, "method":"Pixera.Projectors.Projector.setOutput", "params":{"handle":123456789, "outputHandle":123456789}}

       <= {"jsonrpc":"2.0", "id":323} | 

OSC

       => "/Pixera/Projectors/Projector/setOutput" arguments: (Handle or Path) 123456789  | 

// Set horizontal lens shift. 
 

Control Example

Pixera.Projectors.Projector.setHorizontalLensShift(handle 123456789, value 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":324, "method":"Pixera.Projectors.Projector.setHorizontalLensShift", "params":{"handle":123456789, "value":1.0}}

       <= {"jsonrpc":"2.0", "id":324} | 

OSC

       => "/Pixera/Projectors/Projector/setHorizontalLensShift" arguments: (Handle or Path) 1.0  | 

// Get horizontal lens shift. 
 

Control Example

Pixera.Projectors.Projector.getHorizontalLensShift(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":325, "method":"Pixera.Projectors.Projector.getHorizontalLensShift", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":325, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getHorizontalLensShift" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set vertical lens shift. 
 

Control Example

Pixera.Projectors.Projector.setVerticalLensShift(handle 123456789, value 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":326, "method":"Pixera.Projectors.Projector.setVerticalLensShift", "params":{"handle":123456789, "value":1.0}}

       <= {"jsonrpc":"2.0", "id":326} | 

OSC

       => "/Pixera/Projectors/Projector/setVerticalLensShift" arguments: (Handle or Path) 1.0  | 

// Get vertical lens shift. 
 

Control Example

Pixera.Projectors.Projector.getVerticalLensShift(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":327, "method":"Pixera.Projectors.Projector.getVerticalLensShift", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":327, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getVerticalLensShift" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set brightness. 
// only generic Projector can be set 
 

Control Example

Pixera.Projectors.Projector.setBrightness(handle 123456789, value 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":328, "method":"Pixera.Projectors.Projector.setBrightness", "params":{"handle":123456789, "value":1}}

       <= {"jsonrpc":"2.0", "id":328} | 

OSC

       => "/Pixera/Projectors/Projector/setBrightness" arguments: (Handle or Path) 1  | 

// Get brightness. 
 

Control Example

Pixera.Projectors.Projector.getBrightness(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":329, "method":"Pixera.Projectors.Projector.getBrightness", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":329, "result":1} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getBrightness" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set lens fov. 
 

Control Example

Pixera.Projectors.Projector.setFov(handle 123456789, value 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":330, "method":"Pixera.Projectors.Projector.setFov", "params":{"handle":123456789, "value":1.0}}

       <= {"jsonrpc":"2.0", "id":330} | 

OSC

       => "/Pixera/Projectors/Projector/setFov" arguments: (Handle or Path) 1.0  | 

// Get lens fov. 
 

Control Example

Pixera.Projectors.Projector.getFov(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":331, "method":"Pixera.Projectors.Projector.getFov", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":331, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getFov" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set lens throw Ratio. 
 

Control Example

Pixera.Projectors.Projector.setThrowRatio(handle 123456789, value 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":332, "method":"Pixera.Projectors.Projector.setThrowRatio", "params":{"handle":123456789, "value":1.0}}

       <= {"jsonrpc":"2.0", "id":332} | 

OSC

       => "/Pixera/Projectors/Projector/setThrowRatio" arguments: (Handle or Path) 1.0  | 

// Get lens throw ratio. 
 

Control Example

Pixera.Projectors.Projector.getThrowRatio(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":333, "method":"Pixera.Projectors.Projector.getThrowRatio", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":333, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getThrowRatio" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set look at point. 
// values needs to be in meters 
 

Control Example

Pixera.Projectors.Projector.setLookAtPoint(handle 123456789, x 1.0, y 1.0, z 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":334, "method":"Pixera.Projectors.Projector.setLookAtPoint", "params":{"handle":123456789, "x":1.0, "y":1.0, "z":1.0}}

       <= {"jsonrpc":"2.0", "id":334} | 

OSC

       => "/Pixera/Projectors/Projector/setLookAtPoint" arguments: (Handle or Path) 1.0 1.0 1.0  | 

// Get look at point. 
// values are in meters 
 

Control Example

Pixera.Projectors.Projector.getLookAtPoint(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":335, "method":"Pixera.Projectors.Projector.getLookAtPoint", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":335, "result":[1.0, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getLookAtPoint" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set resolution of projector. 
// this can only be set if the projector is not connected to a output. 
// if it is connected the projector has the resolution of the output. 
 

Control Example

Pixera.Projectors.Projector.setResolution(handle 123456789, x 1, y 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":336, "method":"Pixera.Projectors.Projector.setResolution", "params":{"handle":123456789, "x":1, "y":1}}

       <= {"jsonrpc":"2.0", "id":336} | 

OSC

       => "/Pixera/Projectors/Projector/setResolution" arguments: (Handle or Path) 1 1  | 

// get resolution of projector. 
 

Control Example

Pixera.Projectors.Projector.getResolution(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":337, "method":"Pixera.Projectors.Projector.getResolution", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":337, "result":[1, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getResolution" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Projectors.Projector.getInst(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":338, "method":"Pixera.Projectors.Projector.getInst", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":338, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Projectors/Projector/getInst" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Projectors.Projector.getHandleFromInstancePath(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":339, "method":"Pixera.Projectors.Projector.getHandleFromInstancePath", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":339, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Projectors/Projector/getHandleFromInstancePath" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Projectors.Projector.getInstancePath(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":340, "method":"Pixera.Projectors.Projector.getInstancePath", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":340, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Projectors/Projector/getInstancePath" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns handles to all resources (including within subfolders) in the resource 
// tree in the Compositing tab. 
 

Control Example

Pixera.Resources.getResources()

TCP/UDP

    => {"jsonrpc":"2.0", "id":341, "method":"Pixera.Resources.getResources"}

    <= {"jsonrpc":"2.0", "id":341, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Resources/getResources" | Warning: OSC does currently not provide any return values.

// Returns a handle to a folder in the resource tree. The namePath 
// specifies the folder by starting from the root and then listing 
// all the names as seen in the resources tree separated by forward 
// slashes, e.g. "Media/Std Backgrounds/Atmospherics". 
 

Control Example

Pixera.Resources.getResourceFolderWithNamePath(namePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":342, "method":"Pixera.Resources.getResourceFolderWithNamePath", "params":{"namePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":342, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Resources/getResourceFolderWithNamePath" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

// Returns the top level resource folders. 
 

Control Example

Pixera.Resources.getResourceFolders()

TCP/UDP

    => {"jsonrpc":"2.0", "id":343, "method":"Pixera.Resources.getResourceFolders"}

    <= {"jsonrpc":"2.0", "id":343, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Resources/getResourceFolders" | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.getTranscodingFolders()

TCP/UDP

    => {"jsonrpc":"2.0", "id":344, "method":"Pixera.Resources.getTranscodingFolders"}

    <= {"jsonrpc":"2.0", "id":344, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Resources/getTranscodingFolders" | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.getJsonDescrip()

TCP/UDP

    => {"jsonrpc":"2.0", "id":345, "method":"Pixera.Resources.getJsonDescrip"}

    <= {"jsonrpc":"2.0", "id":345, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Resources/getJsonDescrip" | Warning: OSC does currently not provide any return values.

// Pixera Control self-reference function. 
 

Control Example

Pixera.Resources.ResourceFolder.ref(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":346, "method":"Pixera.Resources.ResourceFolder.ref", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":346, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/ResourceFolder/ref" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.ResourceFolder.getName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":347, "method":"Pixera.Resources.ResourceFolder.getName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":347, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/ResourceFolder/getName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.ResourceFolder.setName(handle 123456789, name "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":348, "method":"Pixera.Resources.ResourceFolder.setName", "params":{"handle":123456789, "name":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":348} | 

OSC

       => "/Pixera/Resources/ResourceFolder/setName" arguments: (Handle or Path) "Abcd"  | 

// Returns the resource folders that are immediate children of this folder. 
 

Control Example

Pixera.Resources.ResourceFolder.getResourceFolders(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":349, "method":"Pixera.Resources.ResourceFolder.getResourceFolders", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":349, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/ResourceFolder/getResourceFolders" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns handles to all the resources that are directly in one folder (i.e. does not consider subfolders). 
 

Control Example

Pixera.Resources.ResourceFolder.getResources(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":350, "method":"Pixera.Resources.ResourceFolder.getResources", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":350, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/ResourceFolder/getResources" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns a handle to a resource in the current folder at index 
 

Control Example

Pixera.Resources.ResourceFolder.getResourceAtIndex(handle 123456789, index 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":351, "method":"Pixera.Resources.ResourceFolder.getResourceAtIndex", "params":{"handle":123456789, "index":1}}

       <= {"jsonrpc":"2.0", "id":351, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/ResourceFolder/getResourceAtIndex" arguments: (Handle or Path) 1  | Warning: OSC does currently not provide any return values.

// Returns a handle to a resource in the current folder by name 
 

Control Example

Pixera.Resources.ResourceFolder.getResourceByName(handle 123456789, name "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":352, "method":"Pixera.Resources.ResourceFolder.getResourceByName", "params":{"handle":123456789, "name":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":352, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/ResourceFolder/getResourceByName" arguments: (Handle or Path) "Abcd"  | Warning: OSC does currently not provide any return values.

// Adds the file at the path to the folder. 
 

Control Example

Pixera.Resources.ResourceFolder.addResource(handle 123456789, path "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":353, "method":"Pixera.Resources.ResourceFolder.addResource", "params":{"handle":123456789, "path":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":353, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/ResourceFolder/addResource" arguments: (Handle or Path) "Abcd"  | Warning: OSC does currently not provide any return values.

// Adds the files at the directory path to the folder. If checkRedundancy == true then only files that have names 
// that are not currently in the folder are added. If remoteOthers == true then the missing files in the folder are removed, assets are untouched 
 

Control Example

Pixera.Resources.ResourceFolder.addResourcesFromDirectory(handle 123456789, path "Abcd", removeOthers true, checkRedundancy true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":354, "method":"Pixera.Resources.ResourceFolder.addResourcesFromDirectory", "params":{"handle":123456789, "path":"Abcd", "removeOthers":true, "checkRedundancy":true}}

       <= {"jsonrpc":"2.0", "id":354, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/ResourceFolder/addResourcesFromDirectory" arguments: (Handle or Path) "Abcd" true true  | Warning: OSC does currently not provide any return values.

// Adds the files at the directory path to the folder. If checkRedundancy == true then only files that have names 
// that are not currently in the folder are added. If remoteOthers == true then the missing files in the folder are removed, assets are also removed 
 

Control Example

Pixera.Resources.ResourceFolder.addResourcesFromDirectoryRemoveAssets(handle 123456789, path "Abcd", removeOthers true, checkRedundancy true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":355, "method":"Pixera.Resources.ResourceFolder.addResourcesFromDirectoryRemoveAssets", "params":{"handle":123456789, "path":"Abcd", "removeOthers":true, "checkRedundancy":true}}

       <= {"jsonrpc":"2.0", "id":355, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/ResourceFolder/addResourcesFromDirectoryRemoveAssets" arguments: (Handle or Path) "Abcd" true true  | Warning: OSC does currently not provide any return values.

//Creates and adds a text(0), colour(1), web(2), timelinereference(3) or multi(4) resource. 
 

Control Example

Pixera.Resources.ResourceFolder.addInternalResource(handle 123456789, signature "Abcd", resKind 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":356, "method":"Pixera.Resources.ResourceFolder.addInternalResource", "params":{"handle":123456789, "signature":"Abcd", "resKind":1}}

       <= {"jsonrpc":"2.0", "id":356, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/ResourceFolder/addInternalResource" arguments: (Handle or Path) "Abcd" 1  | Warning: OSC does currently not provide any return values.

// Creates folders hierarchically for a path as children of the specified folder. 
// For example if you call this against the handle of the "Media" folder with a path like: 
// "/my/new/folders", it will result in the following structure: "Media/my/new/folders". 
 

Control Example

Pixera.Resources.ResourceFolder.createFoldersFrom(handle 123456789, path "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":357, "method":"Pixera.Resources.ResourceFolder.createFoldersFrom", "params":{"handle":123456789, "path":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":357} | 

OSC

       => "/Pixera/Resources/ResourceFolder/createFoldersFrom" arguments: (Handle or Path) "Abcd"  | 

// Reloads for all resources in folder the files from disk, distributes changed files and creates new preview. 
 

Control Example

Pixera.Resources.ResourceFolder.refreshResources(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":358, "method":"Pixera.Resources.ResourceFolder.refreshResources", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":358} | 

OSC

       => "/Pixera/Resources/ResourceFolder/refreshResources" arguments: (Handle or Path)  | 

// Reloads for all resources in folder the files from disk, distributes changed files and creates new preview. 
 

Control Example

Pixera.Resources.ResourceFolder.moveResourceToThis(handle 123456789, id 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":359, "method":"Pixera.Resources.ResourceFolder.moveResourceToThis", "params":{"handle":123456789, "id":1.0}}

       <= {"jsonrpc":"2.0", "id":359} | 

OSC

       => "/Pixera/Resources/ResourceFolder/moveResourceToThis" arguments: (Handle or Path) 1.0  | 

Doku:
 

Control Example

Pixera.Resources.ResourceFolder.removeThis(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":360, "method":"Pixera.Resources.ResourceFolder.removeThis", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":360} | 

OSC

       => "/Pixera/Resources/ResourceFolder/removeThis" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.Resources.ResourceFolder.removeThisIncludingAssets(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":361, "method":"Pixera.Resources.ResourceFolder.removeThisIncludingAssets", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":361} | 

OSC

       => "/Pixera/Resources/ResourceFolder/removeThisIncludingAssets" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.Resources.ResourceFolder.removeAllContents(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":362, "method":"Pixera.Resources.ResourceFolder.removeAllContents", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":362} | 

OSC

       => "/Pixera/Resources/ResourceFolder/removeAllContents" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.Resources.ResourceFolder.removeAllContentsIncludingAssets(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":363, "method":"Pixera.Resources.ResourceFolder.removeAllContentsIncludingAssets", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":363} | 

OSC

       => "/Pixera/Resources/ResourceFolder/removeAllContentsIncludingAssets" arguments: (Handle or Path)  | 

Doku:
 

Control Example

Pixera.Resources.ResourceFolder.deleteAllContentsAssetsFromLiveSystem(handle 123456789, apEntityLiveSystemHandle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":364, "method":"Pixera.Resources.ResourceFolder.deleteAllContentsAssetsFromLiveSystem", "params":{"handle":123456789, "apEntityLiveSystemHandle":123456789}}

       <= {"jsonrpc":"2.0", "id":364} | 

OSC

       => "/Pixera/Resources/ResourceFolder/deleteAllContentsAssetsFromLiveSystem" arguments: (Handle or Path) 123456789  | 

// Resets distribution targets based on the file distribution settings and if needed distributes resource. 
 

Control Example

Pixera.Resources.ResourceFolder.resetDistributionTargets(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":365, "method":"Pixera.Resources.ResourceFolder.resetDistributionTargets", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":365} | 

OSC

       => "/Pixera/Resources/ResourceFolder/resetDistributionTargets" arguments: (Handle or Path)  | 

// Changes the state of a distribution target of a resource. 
 

Control Example

Pixera.Resources.ResourceFolder.changeDistributionTarget(handle 123456789, apEntityLiveSystemHandle 123456789, shouldDistribute true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":366, "method":"Pixera.Resources.ResourceFolder.changeDistributionTarget", "params":{"handle":123456789, "apEntityLiveSystemHandle":123456789, "shouldDistribute":true}}

       <= {"jsonrpc":"2.0", "id":366} | 

OSC

       => "/Pixera/Resources/ResourceFolder/changeDistributionTarget" arguments: (Handle or Path) 123456789 true  | 

Doku:
 

Control Example

Pixera.Resources.ResourceFolder.replaceResourcesByString(handle 123456789, searchString "Abcd", replaceString "Abcd", path "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":367, "method":"Pixera.Resources.ResourceFolder.replaceResourcesByString", "params":{"handle":123456789, "searchString":"Abcd", "replaceString":"Abcd", "path":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":367} | 

OSC

       => "/Pixera/Resources/ResourceFolder/replaceResourcesByString" arguments: (Handle or Path) "Abcd" "Abcd" "Abcd"  | 

Doku:
 

Control Example

Pixera.Resources.ResourceFolder.getInst(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":368, "method":"Pixera.Resources.ResourceFolder.getInst", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":368, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Resources/ResourceFolder/getInst" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.ResourceFolder.getHandleFromInstancePath(instancePath "Abcd")

TCP/UDP

    => {"jsonrpc":"2.0", "id":369, "method":"Pixera.Resources.ResourceFolder.getHandleFromInstancePath", "params":{"instancePath":"Abcd"}}

    <= {"jsonrpc":"2.0", "id":369, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

    => "/Pixera/Resources/ResourceFolder/getHandleFromInstancePath" arguments: "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.ResourceFolder.getInstancePath(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":370, "method":"Pixera.Resources.ResourceFolder.getInstancePath", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":370, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/ResourceFolder/getInstancePath" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.ResourceFolder.getDmxId(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":371, "method":"Pixera.Resources.ResourceFolder.getDmxId", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":371, "result":1} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/ResourceFolder/getDmxId" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Get DMX Id of both the resource and its parent folder as:

// Folder Id << 16, Resource Id. 
 

Control Example

Pixera.Resources.ResourceFolder.getCombinedDmxId(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":372, "method":"Pixera.Resources.ResourceFolder.getCombinedDmxId", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":372, "result":1} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/ResourceFolder/getCombinedDmxId" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.ResourceFolder.setDmxId(handle 123456789, id 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":373, "method":"Pixera.Resources.ResourceFolder.setDmxId", "params":{"handle":123456789, "id":1}}

       <= {"jsonrpc":"2.0", "id":373} | 

OSC

       => "/Pixera/Resources/ResourceFolder/setDmxId" arguments: (Handle or Path) 1  | 

Doku:
 

Control Example

Pixera.Resources.TranscodingFolder.getUsedTranscodingPreset(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":374, "method":"Pixera.Resources.TranscodingFolder.getUsedTranscodingPreset", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":374, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/TranscodingFolder/getUsedTranscodingPreset" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.TranscodingFolder.setUsedTranscodingPreset(handle 123456789, preset "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":375, "method":"Pixera.Resources.TranscodingFolder.setUsedTranscodingPreset", "params":{"handle":123456789, "preset":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":375} | 

OSC

       => "/Pixera/Resources/TranscodingFolder/setUsedTranscodingPreset" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.Resources.TranscodingFolder.getTranscodeAutomatically(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":376, "method":"Pixera.Resources.TranscodingFolder.getTranscodeAutomatically", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":376, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/TranscodingFolder/getTranscodeAutomatically" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.TranscodingFolder.setTranscodeAutomatically(handle 123456789, autoTranscode true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":377, "method":"Pixera.Resources.TranscodingFolder.setTranscodeAutomatically", "params":{"handle":123456789, "autoTranscode":true}}

       <= {"jsonrpc":"2.0", "id":377} | 

OSC

       => "/Pixera/Resources/TranscodingFolder/setTranscodeAutomatically" arguments: (Handle or Path) true  | 

Doku:
 

Control Example

Pixera.Resources.TranscodingFolder.getUseRxCacheAsDestination(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":378, "method":"Pixera.Resources.TranscodingFolder.getUseRxCacheAsDestination", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":378, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/TranscodingFolder/getUseRxCacheAsDestination" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.TranscodingFolder.setRxCacheAsDestination(handle 123456789, useRxCache true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":379, "method":"Pixera.Resources.TranscodingFolder.setRxCacheAsDestination", "params":{"handle":123456789, "useRxCache":true}}

       <= {"jsonrpc":"2.0", "id":379} | 

OSC

       => "/Pixera/Resources/TranscodingFolder/setRxCacheAsDestination" arguments: (Handle or Path) true  | 

Doku:
 

Control Example

Pixera.Resources.TranscodingFolder.getDestinationDirectory(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":380, "method":"Pixera.Resources.TranscodingFolder.getDestinationDirectory", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":380, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/TranscodingFolder/getDestinationDirectory" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.TranscodingFolder.setDestinationDirectory(handle 123456789, path "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":381, "method":"Pixera.Resources.TranscodingFolder.setDestinationDirectory", "params":{"handle":123456789, "path":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":381} | 

OSC

       => "/Pixera/Resources/TranscodingFolder/setDestinationDirectory" arguments: (Handle or Path) "Abcd"  | 

// Pixera Control self-reference function. 
 

Control Example

Pixera.Resources.Resource.ref(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":382, "method":"Pixera.Resources.Resource.ref", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":382, "result":123456789} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/ref" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Removes the resource. 
 

Control Example

Pixera.Resources.Resource.removeThis(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":383, "method":"Pixera.Resources.Resource.removeThis", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":383} | 

OSC

       => "/Pixera/Resources/Resource/removeThis" arguments: (Handle or Path)  | 

// Permanently removes the assets associated with the resource from all systems 
// on which they are stored. 
 

Control Example

Pixera.Resources.Resource.deleteFilesOnSystems(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":384, "method":"Pixera.Resources.Resource.deleteFilesOnSystems", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":384} | 

OSC

       => "/Pixera/Resources/Resource/deleteFilesOnSystems" arguments: (Handle or Path)  | 

// Removes the resource and permanently removes the assets associated with it from 
// all systems on which they are stored. 
 

Control Example

Pixera.Resources.Resource.removeThisIncludingAssets(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":385, "method":"Pixera.Resources.Resource.removeThisIncludingAssets", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":385} | 

OSC

       => "/Pixera/Resources/Resource/removeThisIncludingAssets" arguments: (Handle or Path)  | 

// Permanently removes the asset from the given live system. 
 

Control Example

Pixera.Resources.Resource.deleteAssetFromLiveSystem(handle 123456789, apEntityLiveSystemHandle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":386, "method":"Pixera.Resources.Resource.deleteAssetFromLiveSystem", "params":{"handle":123456789, "apEntityLiveSystemHandle":123456789}}

       <= {"jsonrpc":"2.0", "id":386} | 

OSC

       => "/Pixera/Resources/Resource/deleteAssetFromLiveSystem" arguments: (Handle or Path) 123456789  | 

// Resets distribution targets based on the file distribution settings and if needed distributes resource. 
 

Control Example

Pixera.Resources.Resource.resetDistributionTargets(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":387, "method":"Pixera.Resources.Resource.resetDistributionTargets", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":387} | 

OSC

       => "/Pixera/Resources/Resource/resetDistributionTargets" arguments: (Handle or Path)  | 

// Changes the state of a distribution target of a resource. 
 

Control Example

Pixera.Resources.Resource.changeDistributionTarget(handle 123456789, apEntityLiveSystemHandle 123456789, shouldDistribute true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":388, "method":"Pixera.Resources.Resource.changeDistributionTarget", "params":{"handle":123456789, "apEntityLiveSystemHandle":123456789, "shouldDistribute":true}}

       <= {"jsonrpc":"2.0", "id":388} | 

OSC

       => "/Pixera/Resources/Resource/changeDistributionTarget" arguments: (Handle or Path) 123456789 true  | 

Doku:
 

Control Example

Pixera.Resources.Resource.getName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":389, "method":"Pixera.Resources.Resource.getName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":389, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.Resource.setName(handle 123456789, name "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":390, "method":"Pixera.Resources.Resource.setName", "params":{"handle":123456789, "name":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":390} | 

OSC

       => "/Pixera/Resources/Resource/setName" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.Resources.Resource.getFps(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":391, "method":"Pixera.Resources.Resource.getFps", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":391, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getFps" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.Resource.getResolution(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":392, "method":"Pixera.Resources.Resource.getResolution", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":392, "result":[1.0, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getResolution" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns the active state of a Live Input Resource 
 

Control Example

Pixera.Resources.Resource.getIsActive(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":393, "method":"Pixera.Resources.Resource.getIsActive", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":393, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getIsActive" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns list of available Video Modes of a Live Input Resource, 
// not all Live Input Resources have a list of modes. 
 

Control Example

Pixera.Resources.Resource.getVideoStreamModes(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":394, "method":"Pixera.Resources.Resource.getVideoStreamModes", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":394, "result":[Efgh, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getVideoStreamModes" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set the Video Mode of a Live Input Resource by it's index. 
 

Control Example

Pixera.Resources.Resource.setVideoStreamMode(handle 123456789, index 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":395, "method":"Pixera.Resources.Resource.setVideoStreamMode", "params":{"handle":123456789, "index":1}}

       <= {"jsonrpc":"2.0", "id":395} | 

OSC

       => "/Pixera/Resources/Resource/setVideoStreamMode" arguments: (Handle or Path) 1  | 

// Returns an id based on the handle. This is currently necessary in some situations 
// because some API implementations can not yet consume handles as parameters. 
 

Control Example

Pixera.Resources.Resource.getId(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":396, "method":"Pixera.Resources.Resource.getId", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":396, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getId" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns the duration of the resource in seconds. 
 

Control Example

Pixera.Resources.Resource.getDuration(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":397, "method":"Pixera.Resources.Resource.getDuration", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":397, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getDuration" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns the type of the resource. 
 

Control Example

Pixera.Resources.Resource.getType(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":398, "method":"Pixera.Resources.Resource.getType", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":398, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getType" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.Resource.setCurrentVersion(handle 123456789, version "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":399, "method":"Pixera.Resources.Resource.setCurrentVersion", "params":{"handle":123456789, "version":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":399} | 

OSC

       => "/Pixera/Resources/Resource/setCurrentVersion" arguments: (Handle or Path) "Abcd"  | 

Doku:
 

Control Example

Pixera.Resources.Resource.getCurrentVersion(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":400, "method":"Pixera.Resources.Resource.getCurrentVersion", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":400, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getCurrentVersion" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.Resource.getVersions(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":401, "method":"Pixera.Resources.Resource.getVersions", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":401, "result":[Efgh, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getVersions" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

//get Version Suffix, First is begin 
 

Control Example

Pixera.Resources.Resource.getVersionSuffix(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":402, "method":"Pixera.Resources.Resource.getVersionSuffix", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":402, "result":[Efgh, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getVersionSuffix" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

//get start suffex for versions 
 

Control Example

Pixera.Resources.Resource.rescanVersions(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":403, "method":"Pixera.Resources.Resource.rescanVersions", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":403} | 

OSC

       => "/Pixera/Resources/Resource/rescanVersions" arguments: (Handle or Path)  | 

// Returns the png thumbnail data of the resource in a base 64 string. This is the 
// image that is shown in the resource tree. Its resolution is currently 256 * 174 
// pixels. 
 

Control Example

Pixera.Resources.Resource.getThumbnailAsBase64(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":404, "method":"Pixera.Resources.Resource.getThumbnailAsBase64", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":404, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getThumbnailAsBase64" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.Resource.getHasPendingTransfer(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":405, "method":"Pixera.Resources.Resource.getHasPendingTransfer", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":405, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getHasPendingTransfer" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns true if the resource is currently referred to in a timeline 
// (via a clip or a dominant value). 
 

Control Example

Pixera.Resources.Resource.getIsInUse(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":406, "method":"Pixera.Resources.Resource.getIsInUse", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":406, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getIsInUse" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns the time the resource was first referred to in a timeline (via a clip or a dominant 
// value) in milliseconds since midnight Jan 1st 1970 UTC. If the time is zero then the resource 
// has not been used yet in any timeline. 
 

Control Example

Pixera.Resources.Resource.getLastUsageBeginTime(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":407, "method":"Pixera.Resources.Resource.getLastUsageBeginTime", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":407, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getLastUsageBeginTime" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns the time the resource was first referred to in a timeline (via a clip or a dominant 
// value) as an ISO-8601 string (using the local timezone). If the string is empty then the resource 
// has not been used yet in any timeline. 
 

Control Example

Pixera.Resources.Resource.getLastUsageBeginTimeAsString(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":408, "method":"Pixera.Resources.Resource.getLastUsageBeginTimeAsString", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":408, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getLastUsageBeginTimeAsString" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns the time the resource was removed from the last timeline (whether from a clip or 
// a dominant value) in milliseconds since midnight Jan 1st 1970 UTC. If the time is zero then 
// the resource was either never used at all or is still in use. 
 

Control Example

Pixera.Resources.Resource.getLastUsageEndTime(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":409, "method":"Pixera.Resources.Resource.getLastUsageEndTime", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":409, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getLastUsageEndTime" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns the time the resource was removed from the last timeline (whether from a clip or 
// a dominant value) as an ISO-8601 string (using the local timezone). If the time is zero then 
// the resource was either never used at all or is still in use. 
 

Control Example

Pixera.Resources.Resource.getLastUsageEndTimeAsString(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":410, "method":"Pixera.Resources.Resource.getLastUsageEndTimeAsString", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":410, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getLastUsageEndTimeAsString" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// get the system filepath 
 

Control Example

Pixera.Resources.Resource.getFilePath(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":411, "method":"Pixera.Resources.Resource.getFilePath", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":411, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getFilePath" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Sets the text of a text input resource. 
 

Control Example

Pixera.Resources.Resource.setText(handle 123456789, text "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":412, "method":"Pixera.Resources.Resource.setText", "params":{"handle":123456789, "text":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":412} | 

OSC

       => "/Pixera/Resources/Resource/setText" arguments: (Handle or Path) "Abcd"  | 

// Returns the text of a text input resource. 
 

Control Example

Pixera.Resources.Resource.getText(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":413, "method":"Pixera.Resources.Resource.getText", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":413, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getText" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.Resource.setFontWithName(handle 123456789, fontName "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":414, "method":"Pixera.Resources.Resource.setFontWithName", "params":{"handle":123456789, "fontName":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":414, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/setFontWithName" arguments: (Handle or Path) "Abcd"  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.Resource.getFontName(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":415, "method":"Pixera.Resources.Resource.getFontName", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":415, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getFontName" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.Resource.setFontWithPath(handle 123456789, fontPath "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":416, "method":"Pixera.Resources.Resource.setFontWithPath", "params":{"handle":123456789, "fontPath":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":416, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/setFontWithPath" arguments: (Handle or Path) "Abcd"  | Warning: OSC does currently not provide any return values.

// 0 : Align Left

// 1 : Align Center

// 2 : Align Right 
 

Control Example

Pixera.Resources.Resource.setHorizontalTextAlignment(handle 123456789, textAlignment 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":417, "method":"Pixera.Resources.Resource.setHorizontalTextAlignment", "params":{"handle":123456789, "textAlignment":1}}

       <= {"jsonrpc":"2.0", "id":417, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/setHorizontalTextAlignment" arguments: (Handle or Path) 1  | Warning: OSC does currently not provide any return values.

// 0 : Align Top

// 1 : Align Center

// 2 : Align Bottom

 

Control Example

Pixera.Resources.Resource.getHorizontalTextAlignment(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":418, "method":"Pixera.Resources.Resource.getHorizontalTextAlignment", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":418, "result":1} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getHorizontalTextAlignment" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.Resource.setVerticalTextAlignment(handle 123456789, textAlignment 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":419, "method":"Pixera.Resources.Resource.setVerticalTextAlignment", "params":{"handle":123456789, "textAlignment":1}}

       <= {"jsonrpc":"2.0", "id":419, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/setVerticalTextAlignment" arguments: (Handle or Path) 1  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.Resource.getVerticalTextAlignment(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":420, "method":"Pixera.Resources.Resource.getVerticalTextAlignment", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":420, "result":1} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getVerticalTextAlignment" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.Resource.setLineHeight(handle 123456789, lineHeight 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":421, "method":"Pixera.Resources.Resource.setLineHeight", "params":{"handle":123456789, "lineHeight":1.0}}

       <= {"jsonrpc":"2.0", "id":421, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/setLineHeight" arguments: (Handle or Path) 1.0  | Warning: OSC does currently not provide any return values.

Doku:
 

Control Example

Pixera.Resources.Resource.getLineHeight(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":422, "method":"Pixera.Resources.Resource.getLineHeight", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":422, "result":1.0} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getLineHeight" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Returns the text-measurements width and height of the rectangle enclosing the text. The first entry of the 
// returned vector represents width, the second one represents height. Unit is pixels. 
 

Control Example

Pixera.Resources.Resource.getTextMeasurementsWidthAndHeight(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":423, "method":"Pixera.Resources.Resource.getTextMeasurementsWidthAndHeight", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":423, "result":[1, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getTextMeasurementsWidthAndHeight" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Sets the url of a web browser resource. 
 

Control Example

Pixera.Resources.Resource.setUrl(handle 123456789, url "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":424, "method":"Pixera.Resources.Resource.setUrl", "params":{"handle":123456789, "url":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":424} | 

OSC

       => "/Pixera/Resources/Resource/setUrl" arguments: (Handle or Path) "Abcd"  | 

// Returns the url of a web browser resource. 
 

Control Example

Pixera.Resources.Resource.getUrl(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":425, "method":"Pixera.Resources.Resource.getUrl", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":425, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getUrl" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Sets the path to a color transformation file to be used with the resource. 
 

Control Example

Pixera.Resources.Resource.setColorTransformPath(handle 123456789, colorTransformPath "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":426, "method":"Pixera.Resources.Resource.setColorTransformPath", "params":{"handle":123456789, "colorTransformPath":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":426} | 

OSC

       => "/Pixera/Resources/Resource/setColorTransformPath" arguments: (Handle or Path) "Abcd"  | 

// Returns the path of the color transformation file be used with the resource. 
 

Control Example

Pixera.Resources.Resource.getColorTransformPath(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":427, "method":"Pixera.Resources.Resource.getColorTransformPath", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":427, "result":"Abcd"} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getColorTransformPath" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Clear the path to a color transformation file. 
 

Control Example

Pixera.Resources.Resource.clearColorTransformPath(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":428, "method":"Pixera.Resources.Resource.clearColorTransformPath", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":428} | 

OSC

       => "/Pixera/Resources/Resource/clearColorTransformPath" arguments: (Handle or Path)  | 

// Reloads the file from disk, distributes changed files and creates new preview. 
 

Control Example

Pixera.Resources.Resource.refresh(handle 123456789, text "Abcd")

TCP/UDP

       => {"jsonrpc":"2.0", "id":429, "method":"Pixera.Resources.Resource.refresh", "params":{"handle":123456789, "text":"Abcd"}}

       <= {"jsonrpc":"2.0", "id":429} | 

OSC

       => "/Pixera/Resources/Resource/refresh" arguments: (Handle or Path) "Abcd"  | 

// Distribute the file to clients. 
 

Control Example

Pixera.Resources.Resource.distribute(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":430, "method":"Pixera.Resources.Resource.distribute", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":430} | 

OSC

       => "/Pixera/Resources/Resource/distribute" arguments: (Handle or Path)  | 

// Get the id used to access the resource through dmx. 
 

Control Example

Pixera.Resources.Resource.getDmxId(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":431, "method":"Pixera.Resources.Resource.getDmxId", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":431, "result":1} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getDmxId" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set the id used to access the resource through dmx. 
 

Control Example

Pixera.Resources.Resource.setDmxId(handle 123456789, id 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":432, "method":"Pixera.Resources.Resource.setDmxId", "params":{"handle":123456789, "id":1}}

       <= {"jsonrpc":"2.0", "id":432} | 

OSC

       => "/Pixera/Resources/Resource/setDmxId" arguments: (Handle or Path) 1  | 

// Remove multiresource item at index 
 

Control Example

Pixera.Resources.Resource.removeMultiresourceIndex(handle 123456789, index 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":433, "method":"Pixera.Resources.Resource.removeMultiresourceIndex", "params":{"handle":123456789, "index":1}}

       <= {"jsonrpc":"2.0", "id":433} | 

OSC

       => "/Pixera/Resources/Resource/removeMultiresourceIndex" arguments: (Handle or Path) 1  | 

// Add multiresource item 
 

Control Example

Pixera.Resources.Resource.addMultiresourceItem(handle 123456789, id 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":434, "method":"Pixera.Resources.Resource.addMultiresourceItem", "params":{"handle":123456789, "id":1.0}}

       <= {"jsonrpc":"2.0", "id":434} | 

OSC

       => "/Pixera/Resources/Resource/addMultiresourceItem" arguments: (Handle or Path) 1.0  | 

// Get multiresource items 
 

Control Example

Pixera.Resources.Resource.getMultiresourceItems(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":435, "method":"Pixera.Resources.Resource.getMultiresourceItems", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":435, "result":[123456789, ...]} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getMultiresourceItems" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// replace multiresource item at index 
 

Control Example

Pixera.Resources.Resource.replaceMultiresourceItemByIndex(handle 123456789, index 1, id 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":436, "method":"Pixera.Resources.Resource.replaceMultiresourceItemByIndex", "params":{"handle":123456789, "index":1, "id":1.0}}

       <= {"jsonrpc":"2.0", "id":436} | 

OSC

       => "/Pixera/Resources/Resource/replaceMultiresourceItemByIndex" arguments: (Handle or Path) 1 1.0  | 

// Set multiresource resolution 
 

Control Example

Pixera.Resources.Resource.setMultiresourceResolution(handle 123456789, width 1, height 1)

TCP/UDP

       => {"jsonrpc":"2.0", "id":437, "method":"Pixera.Resources.Resource.setMultiresourceResolution", "params":{"handle":123456789, "width":1, "height":1}}

       <= {"jsonrpc":"2.0", "id":437} | 

OSC

       => "/Pixera/Resources/Resource/setMultiresourceResolution" arguments: (Handle or Path) 1 1  | 

// Set multiresource items size. (1.0 = full) 
 

Control Example

Pixera.Resources.Resource.setMultiresourceItemSizebyIndex(handle 123456789, index 1, width 1.0, height 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":438, "method":"Pixera.Resources.Resource.setMultiresourceItemSizebyIndex", "params":{"handle":123456789, "index":1, "width":1.0, "height":1.0}}

       <= {"jsonrpc":"2.0", "id":438} | 

OSC

       => "/Pixera/Resources/Resource/setMultiresourceItemSizebyIndex" arguments: (Handle or Path) 1 1.0 1.0  | 

// Set multiresource items position. 
 

Control Example

Pixera.Resources.Resource.setMultiresourceItemPositionbyIndex(handle 123456789, index 1, x 1.0, y 1.0)

TCP/UDP

       => {"jsonrpc":"2.0", "id":439, "method":"Pixera.Resources.Resource.setMultiresourceItemPositionbyIndex", "params":{"handle":123456789, "index":1, "x":1.0, "y":1.0}}

       <= {"jsonrpc":"2.0", "id":439} | 

OSC

       => "/Pixera/Resources/Resource/setMultiresourceItemPositionbyIndex" arguments: (Handle or Path) 1 1.0 1.0  | 

// Sets a color resource to show a gradient between its assigned colors. 
 

Control Example

Pixera.Resources.Resource.setUseGradient(handle 123456789, useGradient true)

TCP/UDP

       => {"jsonrpc":"2.0", "id":440, "method":"Pixera.Resources.Resource.setUseGradient", "params":{"handle":123456789, "useGradient":true}}

       <= {"jsonrpc":"2.0", "id":440} | 

OSC

       => "/Pixera/Resources/Resource/setUseGradient" arguments: (Handle or Path) true  | 

// Get if a color resource uses a gradient. 
 

Control Example

Pixera.Resources.Resource.getUseGradient(handle 123456789)

TCP/UDP

       => {"jsonrpc":"2.0", "id":441, "method":"Pixera.Resources.Resource.getUseGradient", "params":{"handle":123456789}}

       <= {"jsonrpc":"2.0", "id":441, "result":true} | Warning: UDP does currently not provide any return values.

OSC

       => "/Pixera/Resources/Resource/getUseGradient" arguments: (Handle or Path)  | Warning: OSC does currently not provide any return values.

// Set multiple colors for a color resource. 
// Color format is ARGB encoded in one 32 bit integer 
// where a << 24, r << 16, g << 8, b << 0. 
 

Control Example

Pixera.Resources.Resource.setColors(handle 123456789, argbCols [1, ...], positions [1.0, ...], colNames [Efgh, ...], useGradient val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":442, "method":"Pixera.Resources.Resource.setColors", "params":{"handle":123456789, "argbCols":[1, ...], "positions":[1.0, ...], "colNames":[Efgh, ...], "useGradient":val}}

       <= {"jsonrpc":"2.0", "id":442} | 

OSC

       => "/Pixera/Resources/Resource/setColors" arguments: (Handle or Path) [1, ...] [1.0, ...] [Efgh, ...] val  | 

// Set one color of a color resource.

// If index does not exist the color will be appended to the end of the color list. 
 

Control Example

Pixera.Resources.Resource.setColorAtIndex(handle 123456789, index 1, red 1, green 1, blue 1, alpha 1, position 1.0, name "Abcd", useGradient val)

TCP/UDP

       => {"jsonrpc":"2.0", "id":443, "method":"Pixera.Resources.Resource.setColorAtIndex", "params":{"handle":123456789, "index":1, "red":1, "green":1, "blue":1, "alpha":1, "position":1.0, "name":"Abcd", "useGradient":val}}

       <= {"jsonrpc":"2.0", "id":443} |