QueryServer API - Calls | Pixotope Help Center

CalculateXRARLatency [CALL]

CalculateXRARLatency

Spawns XRARSyncHandler actors on connected XR and AR machines to calculate latency.

No params.

Result

Success	BOOLEAN	The success.
Description	STRING	The description.

Example - CalculateXRARLatency

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "CalculateXRARLatency",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "CalculateXRARLatency",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Success": true,
    "Description": "XRAR_SYNC_HANDLER_SPAWNED"
  }
}

ClearDigitalTwin [CALL]

ClearDigitalTwin

Clears all digital twins (DigitalTwins) from the store.

No params.

Result

Result

NULL

The result.

Example - ClearDigitalTwin

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ClearDigitalTwin",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ClearDigitalTwin",
  "ID": "<ID>"
}

JSON

{
  "Result": null
}

DispatchMetaCall [CALL]

DispatchMetaCall

Dispatches a given method to a given service on the target machines.

Params

TargetMachines OPTIONAL	STRING[]	The target machines.
Service OPTIONAL	STRING	The service.
Endpoint OPTIONAL	STRING	The endpoint.
Params OPTIONAL	STRING	The params.
IsAsync OPTIONAL (default: False)	BOOLEAN	The is async.

Result

Result

OBJECT[]

The result.

Example - DispatchMetaCall

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "DispatchMetaCall",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "TargetMachines": [
      "<TargetMachines1>"
    ],
    "Service": "<Service>",
    "Endpoint": "<Endpoint>",
    "Params": "<Params>",
    "IsAsync": true
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "DispatchMetaCall",
  "ID": "<ID>"
}

JSON

{
  "Result": [
    {}
  ]
}

DuplicateCurrentShow [CALL]

DuplicateCurrentShow

Duplicates the current show.

No params.

Result

Result

OBJECT

The result.

Example - DuplicateCurrentShow

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "DuplicateCurrentShow",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "DuplicateCurrentShow",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

GetAliveIP [CALL]

GetAliveIP

Gets the IP address of the first connected CLIENT machine, or SERVER if no clients available.

No params.

Result

Result

STRING

The result.

Example - GetAliveIP

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "GetAliveIP",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "GetAliveIP",
  "ID": "<ID>"
}

JSON

{
  "Result": "result"
}

GetFromRole [CALL]

GetFromRole

Gets a specified field from all connected clients of a given role.

Params

Role	STRING	The role.
Name	STRING	The name.

Result

Result

OBJECT[]

The result.

Example - GetFromRole

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "GetFromRole",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Role": "<Role>",
    "Name": "<Name>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "GetFromRole",
  "ID": "<ID>"
}

JSON

{
  "Result": [
    {}
  ]
}

GetImageForRouting [CALL]

GetImageForRouting

Returns an image from the corresponding routing ID by asking the VideoIO that has it routed.

Params

RoutingID	STRING	The routing id.
Scale	STRING	The scale.

Result

Result

OBJECT

The result.

Example - GetImageForRouting

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "GetImageForRouting",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "RoutingID": "<RoutingID>",
    "Scale": "<Scale>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "GetImageForRouting",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

GetImportShowState [CALL]

GetImportShowState

Retrieves the state of a show including TrackMen, DigitalTwins, Machines, Cameras, CameraSets, and other configurations.

Params

ShowName

STRING

The show name.

Result

TrackMen

STRING

The track men.

Example - GetImportShowState

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "GetImportShowState",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "ShowName": "<ShowName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "GetImportShowState",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

GetMachineNames [CALL]

GetMachineNames

Returns list of connected machine names.

No params.

Result

Result

STRING[]

The result.

Example - GetMachineNames

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "GetMachineNames",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "GetMachineNames",
  "ID": "<ID>"
}

JSON

{
  "Result": [
    "item1",
    "item2"
  ]
}

GetSystemDump [CALL]

GetSystemDump

Gets a comprehensive health dump from the network including connected clients, pipelines, daemons, store, and director states.

No params.

Result

Result

OBJECT

The result.

Example - GetSystemDump

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "GetSystemDump",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "GetSystemDump",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

GetVideoIONodes [CALL]

GetVideoIONodes

Gets video IO nodes from all connected pipelines.

No params.

Result

Result

OBJECT[]

The result.

Example - GetVideoIONodes

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "GetVideoIONodes",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "GetVideoIONodes",
  "ID": "<ID>"
}

JSON

{
  "Result": []
}

SetCalibratedLag [CALL]

SetCalibratedLag

Modifies tracking and video delays by an input lag for a specific camera component.

Params

Lag	NUMBER	The lag.
Machine	STRING	The machine.
Component	STRING	The component.

Result

Result

NULL

The result.

Example - SetCalibratedLag

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SetCalibratedLag",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Lag": 0,
    "Machine": "<Machine>",
    "Component": "<Component>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SetCalibratedLag",
  "ID": "<ID>"
}

JSON

{
  "Result": null
}

SetRenderGroup [CALL]

SetRenderGroup

Sets the default render group for a machine. Adds or removes the machine from the specified group type (AR, VS, ARVS, XR, or none), leaving other machines untouched.

Params

Group

OPTIONAL

(default: "Default")

STRING

The group.

Type

STRING

The type.

MachineName

STRING

The machine name.

Result

Result

BOOLEAN

The result.

Example - SetRenderGroup

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SetRenderGroup",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Group": "<Group>",
    "Type": "<Type>",
    "MachineName": "<MachineName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SetRenderGroup",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ShutdownPipelines [CALL]

ShutdownPipelines

Shuts down all connected pipelines.

No params.

Result

Result

NULL

The result.

Example - ShutdownPipelines

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ShutdownPipelines",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ShutdownPipelines",
  "ID": "<ID>"
}

JSON

{
  "Result": null
}

SwitchCameraGroup [CALL]

SwitchCameraGroup

Sets active cameras to the content of a specified camera group.

Params

Group

STRING

The group.

Result

Result

OBJECT

The result.

Example - SwitchCameraGroup

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SwitchCameraGroup",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Group": "<Group>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SwitchCameraGroup",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

SyncChanges [CALL]

SyncChanges

Bakes or saves changes from a machine, pushes to AssetHub, and restarts the level.

Params

ReadFrom	STRING	The read from.
Action	STRING	The action.

Result

Error	BOOLEAN	The error.
Reason	OBJECT	The reason.

Example - SyncChanges

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SyncChanges",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "ReadFrom": "<ReadFrom>",
    "Action": "<Action>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SyncChanges",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Error": false,
    "Reason": null
  }
}

WaitForPipelinesToFinishBuilding [CALL]

WaitForPipelinesToFinishBuilding

Waits for all connected pipelines to finish building and become active.

No params.

Result

Result

BOOLEAN

The result.

Example - WaitForPipelinesToFinishBuilding

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "WaitForPipelinesToFinishBuilding",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "WaitForPipelinesToFinishBuilding",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ClearRoutingsAndCameras [CALL]

ClearRoutingsAndCameras

Clears all routings, cameras, and resets colorspace to Rec.709. Shared setup/teardown helper used by VideoIO tests.

No params.

Example - ClearRoutingsAndCameras

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ClearRoutingsAndCameras",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

DebugNormalMapNodes [CALL]

DebugNormalMapNodes

Debug helper: lists pipeline nodes and NormalGeneration/DepthGeneration state.

No params.

Result

Machine	STRING	The machine name.
InputRouting	STRING	The input routing key.
NormalGenerationState	OBJECT	The normal generation state.
DepthGenerationState	OBJECT	The depth generation state.

Example - DebugNormalMapNodes

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "DebugNormalMapNodes",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "DebugNormalMapNodes",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Machine": "",
    "InputRouting": "",
    "NormalGenerationState": {},
    "DepthGenerationState": {}
  }
}

GetFirstMachineAndInputNode [CALL]

GetFirstMachineAndInputNode

Returns the first online machine name and the input node routing ID. Shared helper used by VideoIO tests.

Params

CameraName

OPTIONAL

(default: TestCamera)

STRING

The camera name to search for.

FindBy

OPTIONAL

(default: Name)

STRING

How to find the routing: "Name" matches by camera name, "IOType" matches by IOType.

Result

Machine	STRING	The first online machine name.
InputNode	STRING	The routing ID for the matched input.

Example - GetFirstMachineAndInputNode

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "GetFirstMachineAndInputNode",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

SaveImageWithRetry [CALL]

SaveImageWithRetry

Saves an image from a pipeline node with retry logic. Returns the base64-encoded image data (without the data URI prefix), or null on failure.

Params

Machine	STRING	The machine name.
Node	STRING	The pipeline node to capture.
MaxAttempts OPTIONAL (default: 5)	NUMBER	Maximum number of retry attempts.
RetryDelay OPTIONAL (default: 2)	NUMBER	Seconds to wait between retries.

Result

The base64 image data, or null if all attempts failed.

STRING|NULL

Example - SaveImageWithRetry

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SaveImageWithRetry",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Machine": "Tob",
    "Node": "some_node"
  }
}

SetupTestVideoColorMatchingOutput [CALL]

SetupTestVideoColorMatchingOutput

Sets up test video output with color matching profile for automated testing.

Params

ProfileName OPTIONAL	STRING	The color matching profile name.
ExpectedMetric OPTIONAL	NUMBER	The expected metric value.

Result

Passed	BOOLEAN	Whether the test passed.
Data	OBJECT[]	The per-profile comparison results.

Example - SetupTestVideoColorMatchingOutput

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SetupTestVideoColorMatchingOutput",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "ProfileName": "<ProfileName>",
    "ExpectedMetric": 0
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SetupTestVideoColorMatchingOutput",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Passed": true,
    "Data": []
  }
}

SetupTestVideoColorMatchingXROutput [CALL]

SetupTestVideoColorMatchingXROutput

Tests XR color matching profile applied to video output.

No params.

Result

Passed	BOOLEAN	Whether the test passed.
Data	OBJECT[]	The per-profile comparison results.

Example - SetupTestVideoColorMatchingXROutput

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SetupTestVideoColorMatchingXROutput",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SetupTestVideoColorMatchingXROutput",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Passed": true,
    "Data": []
  }
}

TestAIMapGeneration [CALL]

TestAIMapGeneration

Shared implementation for AI map generation tests (normal/depth).

Params

FilterKey	STRING	Store key to enable the filter, e.g. "NormalGeneration".
NodeSuffix	STRING	Pipeline node suffix, e.g. "_AINormals".
OutputName	STRING	Label used in results and log, e.g. "NormalMap".
ImagePrefix	STRING	Prefix for saved test images, e.g. "normal_map".
ExpectedBaseMetric	NUMBER	Expected metric for the base (input) image.
ExpectedOutputMetric	NUMBER	Expected metric for the filter output image.
Tolerance OPTIONAL (default: 20)	NUMBER	Max allowed deviation from expected.

Result

Passed	BOOLEAN	Whether the test passed.
Data	OBJECT[]	The per-stage comparison results.

Example - TestAIMapGeneration

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "TestAIMapGeneration",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "FilterKey": "<FilterKey>",
    "NodeSuffix": "<NodeSuffix>",
    "OutputName": "<OutputName>",
    "ImagePrefix": "<ImagePrefix>",
    "ExpectedBaseMetric": 0,
    "ExpectedOutputMetric": 0
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "TestAIMapGeneration",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Passed": true,
    "Data": []
  }
}

TestColorMatchingXROnlyRed [CALL]

TestColorMatchingXROnlyRed

Single-machine XR-only color matching smoke test. Sets up a file-in/ ndi-out routing on the first connected pipeline, launches the XR writer, captures the output during the WARMUP red phase, verifies red-dominance.

No params.

TestDepthKeyer [CALL]

TestDepthKeyer

Automated test for depth keyer enable/disable/re-enable cycle. Tests that enabling the depth keyer works, and that disabling then re-enabling it does not crash VideoIO (regression test for CP-3472 and CP-3498).

No params.

Result

Passed	BOOLEAN	Whether the test passed.
Data	OBJECT[]	The per-stage results.

Example - TestDepthKeyer

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "TestDepthKeyer",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "TestDepthKeyer",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Passed": true,
    "Data": []
  }
}

TestDepthMap [CALL]

TestDepthMap

Automated test for depth map generation filter functionality.

No params.

Result

Passed	BOOLEAN	Whether the test passed.
Data	OBJECT[]	The per-stage comparison results.

Example - TestDepthMap

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "TestDepthMap",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "TestDepthMap",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Passed": true,
    "Data": []
  }
}

TestNormalMap [CALL]

TestNormalMap

Automated test for normal map generation filter functionality.

No params.

Result

Passed	BOOLEAN	Whether the test passed.
Data	OBJECT[]	The per-stage comparison results.

Example - TestNormalMap

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "TestNormalMap",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "TestNormalMap",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Passed": true,
    "Data": []
  }
}

RenameCamera [CALL]

RenameCamera

Renames a camera and updates associated chromakey data.

Params

CameraId	STRING	The camera id.
NewName	STRING	The new name.

Result

Result

NULL

The result.

Example - RenameCamera

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RenameCamera",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "CameraId": "<CameraId>",
    "NewName": "<NewName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RenameCamera",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

AddCameraGroup [CALL]

AddCameraGroup

Creates a new camera switching group with default empty camera sets. Does nothing if the group already exists.

Params

Group

STRING

Key of the new camera switching group.

Result

Result

BOOLEAN

True if the group was added.

Example - AddCameraGroup

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "AddCameraGroup",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Group": "AR"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "AddCameraGroup",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

AddCameraSet [CALL]

AddCameraSet

Appends a new empty camera set at the next available index within a group.

Params

Group

STRING

Key of the camera switching group.

Result

Result

BOOLEAN

True if a camera set was added.

Example - AddCameraSet

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "AddCameraSet",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Group": "AR"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "AddCameraSet",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

MigrateCameraGroup [CALL]

MigrateCameraGroup

Moves camera switching state from a source group into a target group, then removes the source group.

Params

SourceGroup	STRING	Key of the camera switching group to migrate from.
TargetGroup	STRING	Key of the camera switching group to migrate into.

Result

Result

BOOLEAN

True if the group was migrated.

Example - MigrateCameraGroup

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "MigrateCameraGroup",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "SourceGroup": "AR",
    "TargetGroup": "MyCustomGroup"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "MigrateCameraGroup",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RemoveCameraGroup [CALL]

RemoveCameraGroup

Removes an existing camera switching group. If it was the last group, re-creates the default "All" group.

Params

Group

STRING

Key of the camera switching group to remove.

Result

Result

BOOLEAN

True if the group was removed.

Example - RemoveCameraGroup

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RemoveCameraGroup",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Group": "AR"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RemoveCameraGroup",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RemoveCameraSet [CALL]

RemoveCameraSet

Removes the last camera set in a group. If the removed set was active, ActiveCameraSet is cleared.

Params

Group

STRING

Key of the camera switching group.

Result

Result

BOOLEAN

True if a camera set was removed.

Example - RemoveCameraSet

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RemoveCameraSet",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Group": "AR"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RemoveCameraSet",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

SetCameraSet [CALL]

SetCameraSet

Activates a camera set by group key and index number.

Params

Group	STRING	Key of the camera switching group.
Number	NUMBER	Index of the camera set to activate within the group.

Result

Result

BOOLEAN

True if the camera set was activated.

Example - SetCameraSet

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SetCameraSet",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Group": "AR",
    "Number": 2
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SetCameraSet",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

UpdateCameraSet [CALL]

UpdateCameraSet

Updates a camera set in a group and keeps ActiveCameraSet consistent when sets are filled or emptied.

Params

Group	STRING	Key of the camera switching group.
SetIndex	STRING	Index of the camera set to update.
Cameras	STRING[]	Camera ids to store in the camera set.

Result

Result

BOOLEAN

True if the camera set was updated.

Example - UpdateCameraSet

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "UpdateCameraSet",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Group": "AR",
    "SetIndex": "0",
    "Cameras": [
      "CameraA",
      "CameraB"
    ]
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "UpdateCameraSet",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

CancelComputeJobs [CALL]

CancelComputeJobs

Cancels ongoing cloud async compute jobs.

No params.

Result

Result

BOOLEAN

The result.

Example - CancelComputeJobs

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "CancelComputeJobs",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "CancelComputeJobs",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ImportComputedMesh [CALL]

ImportComputedMesh

Imports computed mesh from cloud to target machine by launching engine and unpacking zip.

Params

TargetMachine OPTIONAL	STRING	The target machine.
LevelLocation OPTIONAL	STRING	The level location.
ZipLocation OPTIONAL	STRING	The zip location.
ProjectLocation OPTIONAL	STRING	The project location.

Result

Success

BOOLEAN

The success.

Example - ImportComputedMesh

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ImportComputedMesh",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "TargetMachine": "<TargetMachine>",
    "LevelLocation": "<LevelLocation>",
    "ZipLocation": "<ZipLocation>",
    "ProjectLocation": "<ProjectLocation>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ImportComputedMesh",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Success": true
  }
}

CancelColorMatching [CALL]

CancelColorMatching

Cancels ongoing color matching process and restarts pipelines.

No params.

Result

Result

OBJECT

The result.

Example - CancelColorMatching

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "CancelColorMatching",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "CancelColorMatching",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

ColorMatching [CALL]

ColorMatching

Runs color matching on the network based on current configuration.

No params.

Result

Result

OBJECT

The result.

Example - ColorMatching

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ColorMatching",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ColorMatching",
  "ID": "<ID>"
}

JSON

{
  "Result": null
}

GetColorDiagram [CALL]

GetColorDiagram

Gets color diagram for a specific profile from a pipeline.

Params

Machine OPTIONAL	STRING	The machine.
Name	STRING	The name.

Result

Result

OBJECT

The result.

Example - GetColorDiagram

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "GetColorDiagram",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Machine": "<Machine>",
    "Name": "<Name>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "GetColorDiagram",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

RestartPipelines [CALL]

RestartPipelines

Restarts all connected pipeline services.

No params.

Result

Result

BOOLEAN

The result.

Example - RestartPipelines

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RestartPipelines",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RestartPipelines",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

StartXRColorAnalysisWriter [CALL]

StartXRColorAnalysisWriter

Test helper: launches StartColorAnalysis(Writer) on the first connected pipeline. No AR Reader, no LUT generation. Pipeline enters WARMUP and outputs solid red per XR_CalibrationNode.cpp:102-104.

No params.

EncoderDetectStart [CALL]

EncoderDetectStart

Initiates encoder limit detection on a camera.

Params

ChainId

STRING

The chain id.

Result

Result

OBJECT

The result.

Example - EncoderDetectStart

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "EncoderDetectStart",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "ChainId": "<ChainId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "EncoderDetectStart",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

EncoderDetectStop [CALL]

EncoderDetectStop

Stops encoder limit detection on a camera.

Params

ChainId

STRING

The chain id.

Result

Result

OBJECT

The result.

Example - EncoderDetectStop

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "EncoderDetectStop",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "ChainId": "<ChainId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "EncoderDetectStop",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

CancelCaptureImage [CALL]

CancelCaptureImage

Cancels an ongoing image capture process.

No params.

Result

Success

STRING

The success.

Example - CancelCaptureImage

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "CancelCaptureImage",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "CancelCaptureImage",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

CaptureCameraImages [CALL]

CaptureCameraImages

Captures multiple images from a camera for calibration or analysis purposes.

Params

Camera	STRING	The camera.
NumberOfImages	STRING	The number of images.
MachineName	STRING	The machine name.

Result

Status	STRING	The status.
Path	STRING	The path.

Example - CaptureCameraImages

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "CaptureCameraImages",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Camera": "<Camera>",
    "NumberOfImages": "<NumberOfImages>",
    "MachineName": "<MachineName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "CaptureCameraImages",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

CloudAsyncGeometry [CALL]

CloudAsyncGeometry

Captures camera images and submits them to cloud for async geometry processing.

Params

NumberOfImages	STRING	The number of images.
CustomFolder	STRING	The custom folder.
MachineName	STRING	The machine name.
Camera	STRING	The camera.

Result

Status

STRING

The status.

Example - CloudAsyncGeometry

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "CloudAsyncGeometry",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "NumberOfImages": "<NumberOfImages>",
    "CustomFolder": "<CustomFolder>",
    "MachineName": "<MachineName>",
    "Camera": "<Camera>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "CloudAsyncGeometry",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Status": "Succcess"
  }
}

DetermineBlurrinessOfB64 [CALL]

DetermineBlurrinessOfB64

Determines the blurriness of a base64-encoded image using Laplacian variance.

Params

Image

STRING

The image.

Result

Result

NUMBER

The result.

Example - DetermineBlurrinessOfB64

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "DetermineBlurrinessOfB64",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Image": "<Image>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "DetermineBlurrinessOfB64",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

DetermineBrightnessOfB64 [CALL]

DetermineBrightnessOfB64

Calculates the average brightness of a base64-encoded image.

Params

Image

STRING

The image.

Result

Result

NUMBER

The result.

Example - DetermineBrightnessOfB64

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "DetermineBrightnessOfB64",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Image": "<Image>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "DetermineBrightnessOfB64",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

ReopenLevels [CALL]

ReopenLevels

Reopens all levels on all connected engines.

No params.

Result

Result

OBJECT

The result.

Example - ReopenLevels

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ReopenLevels",
  "ID": "<ID>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ReopenLevels",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

RestartLevels [CALL]

RestartLevels

Restarts the Engine service (PX_Engine) on all connected engine machines via their Daemon.

No params.

Result

Result

BOOLEAN

The result.

Example - RestartLevels

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RestartLevels",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RestartLevels",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

SyncRenderMapping [CALL]

SyncRenderMapping

Syncs render machine routings with videohub updates.

No params.

Result

Result

OBJECT

The result.

Example - SyncRenderMapping

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SyncRenderMapping",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SyncRenderMapping",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

FailoverMachineSwitch [CALL]

FailoverMachineSwitch

Switches between main and backup machines in a failover group with videohub routing.

Params

GroupId	STRING	The group id.
MainMachineName	STRING	The main machine name.

Result

Result

OBJECT

The result.

Example - FailoverMachineSwitch

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "FailoverMachineSwitch",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "GroupId": "<GroupId>",
    "MainMachineName": "<MainMachineName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "FailoverMachineSwitch",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

FailoverMachineSwitched [CALL]

FailoverMachineSwitched

Sends event notification when automatic failover machine switch occurs.

Params

SwitchedMachines

STRING[]

The switched machines.

Result

Result

BOOLEAN

The result.

Example - FailoverMachineSwitched

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "FailoverMachineSwitched",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "SwitchedMachines": [
      "<SwitchedMachines1>"
    ]
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "FailoverMachineSwitched",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

AddMachineGroup [CALL]

AddMachineGroup

Adds a new machine group for render backup configuration.

No params.

Result

Result

BOOLEAN

The result.

Example - AddMachineGroup

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "AddMachineGroup",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "AddMachineGroup",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RemoveMachineGroup [CALL]

RemoveMachineGroup

Removes a machine group from render backup configuration.

Params

MachineGroupId

STRING

The machine group id.

Result

Result

BOOLEAN

The result.

Example - RemoveMachineGroup

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RemoveMachineGroup",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineGroupId": "<MachineGroupId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RemoveMachineGroup",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RenameMachineGroup [CALL]

RenameMachineGroup

Renames a machine group if the new name is available.

Params

MachineGroupId	STRING	The machine group id.
NewName	STRING	The new name.

Result

Result

BOOLEAN

The result.

Example - RenameMachineGroup

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RenameMachineGroup",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineGroupId": "<MachineGroupId>",
    "NewName": "<NewName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RenameMachineGroup",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

UpdateMachineGroupSelection [CALL]

UpdateMachineGroupSelection

Updates the machine selection (main or backup) for a machine group.

Params

MachineGroupId	STRING	The machine group id.
MachinesType	STRING[]	The machines type.
Machines	STRING[]	The machines.

Result

Result

BOOLEAN

The result.

Example - UpdateMachineGroupSelection

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "UpdateMachineGroupSelection",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineGroupId": "<MachineGroupId>",
    "MachinesType": [
      "<MachinesType1>"
    ],
    "Machines": [
      "<Machines1>"
    ]
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "UpdateMachineGroupSelection",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ClearMachineGroupsMapping [CALL]

ClearMachineGroupsMapping

Clears all IO mappings from machine groups.

No params.

Result

Result

BOOLEAN

The result.

Example - ClearMachineGroupsMapping

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ClearMachineGroupsMapping",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ClearMachineGroupsMapping",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

UpdateMachineGroupMapping [CALL]

UpdateMachineGroupMapping

Updates IO mapping for a machine in a machine group and syncs videohub routing.

Params

MachineGroupId	STRING	The machine group id.
MachineName	STRING	The machine name.
MachinesType	STRING[]	The machines type.
IOType	STRING	The iotype.
IOIndex	NUMBER	The ioindex.
IOValue	STRING	The iovalue.

Result

Result

BOOLEAN

The result.

Example - UpdateMachineGroupMapping

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "UpdateMachineGroupMapping",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineGroupId": "<MachineGroupId>",
    "MachineName": "<MachineName>",
    "MachinesType": [
      "<MachinesType1>"
    ],
    "IOType": "<IOType>",
    "IOIndex": 0,
    "IOValue": "<IOValue>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "UpdateMachineGroupMapping",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

CleanServerBackups [CALL]

CleanServerBackups

Cleans server backups by disabling all active servers and removing backup network configurations.

No params.

Result

Result

BOOLEAN

The result.

Example - CleanServerBackups

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "CleanServerBackups",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "CleanServerBackups",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

DisableServerBackup [CALL]

DisableServerBackup

Disables server backup for a machine and removes backup network configuration.

Params

MachineName

STRING

The machine name.

Result

Result

BOOLEAN

The result.

Example - DisableServerBackup

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "DisableServerBackup",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "DisableServerBackup",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

SwitchServerBackup [CALL]

SwitchServerBackup

Switches server backup to a specified machine and configures backup network info.

Params

MachineName	STRING	The machine name.
IPAddress	STRING	The ipaddress.

Result

Result

BOOLEAN

The result.

Example - SwitchServerBackup

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SwitchServerBackup",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "IPAddress": "<IPAddress>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SwitchServerBackup",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ConnectToVideohub [CALL]

ConnectToVideohub

Connects to a Videohub device at specified IP address.

Params

IP	STRING	The ip.
Reconnect	STRING	The reconnect.

Result

Result

BOOLEAN

The result.

Example - ConnectToVideohub

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ConnectToVideohub",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "IP": "<IP>",
    "Reconnect": "<Reconnect>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ConnectToVideohub",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

DisableVideohubAutoconnect [CALL]

DisableVideohubAutoconnect

Disables Videohub auto-connect and disconnects from current Videohub.

No params.

Result

Result

OBJECT

The result.

Example - DisableVideohubAutoconnect

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "DisableVideohubAutoconnect",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "DisableVideohubAutoconnect",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

DisconnectFromVideohub [CALL]

DisconnectFromVideohub

Disconnects from currently connected Videohub if connected.

No params.

Result

Result

BOOLEAN

The result.

Example - DisconnectFromVideohub

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "DisconnectFromVideohub",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "DisconnectFromVideohub",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

LockRenderMachineRow [CALL]

LockRenderMachineRow

Locks or unlocks a Videohub output row for a render machine.

Params

OutputIndex	NUMBER	The output index.
ShouldLock	BOOLEAN	The should lock.

Result

Failure	BOOLEAN	The failure.
Reason	STRING	The reason.

Example - LockRenderMachineRow

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "LockRenderMachineRow",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "OutputIndex": 0,
    "ShouldLock": true
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "LockRenderMachineRow",
  "ID": "<ID>"
}

JSON

{
  "Result": {
    "Failure": true,
    "Reason": "No daemon found"
  }
}

VideohubTestConnection [CALL]

VideohubTestConnection

Tests Videohub connection with stored connection info.

No params.

Result

Result

BOOLEAN

The result.

Example - VideohubTestConnection

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "VideohubTestConnection",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "VideohubTestConnection",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

NetworkHealthCheck [CALL]

NetworkHealthCheck

Checks network latency and stats by measuring response times to all connected daemons.

Params

Target

STRING

The target.

Result

Result

OBJECT

The result.

Example - NetworkHealthCheck

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "NetworkHealthCheck",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Target": "<Target>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "NetworkHealthCheck",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

NetworkInstall [CALL]

NetworkInstall

Copies installer file to networked folder, unzips it, syncs config, and executes installer on all machines.

Params

LaunchPixotope

OPTIONAL

(default: True)

BOOLEAN

The launch pixotope.

Path

STRING

The path.

Result

success	BOOLEAN	The success.
message	STRING	The message.
copied_file	STRING	The copied file.
extracted	BOOLEAN	The extracted.

Example - NetworkInstall

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "NetworkInstall",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "LaunchPixotope": true,
    "Path": "<Path>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "NetworkInstall",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

PhaseOffsetDetection [CALL]

PhaseOffsetDetection

Starts phase offset detection on the network.

Params

SaveImages

BOOLEAN

Whether to save images.

Result

Result

BOOLEAN

The result.

Example - PhaseOffsetDetection

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "PhaseOffsetDetection",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "SaveImages": "<SaveImages>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "PhaseOffsetDetection",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

PixotopeSpaceCuePreset [CALL]

PixotopeSpaceCuePreset

Cues a Pixotope Space preset for an entity.

Params

EntityId	STRING	The entity id.
PresetId	STRING	The preset id.

Result

Result

BOOLEAN

The result.

Example - PixotopeSpaceCuePreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "PixotopeSpaceCuePreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "EntityId": "<EntityId>",
    "PresetId": "<PresetId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "PixotopeSpaceCuePreset",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

PixotopeSpaceGetPreset [CALL]

PixotopeSpaceGetPreset

Gets a specific Pixotope Space preset by entity and preset ID.

Params

EntityId	STRING	The entity id.
PresetId	STRING	The preset id.

Result

Result

OBJECT

The result.

Example - PixotopeSpaceGetPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "PixotopeSpaceGetPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "EntityId": "<EntityId>",
    "PresetId": "<PresetId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "PixotopeSpaceGetPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

PixotopeSpaceGetPresets [CALL]

PixotopeSpaceGetPresets

Gets all Pixotope Space presets for an entity.

Params

EntityId

STRING

The entity id.

Result

Result

OBJECT[]

The result.

Example - PixotopeSpaceGetPresets

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "PixotopeSpaceGetPresets",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "EntityId": "<EntityId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "PixotopeSpaceGetPresets",
  "ID": "<ID>"
}

JSON

{
  "Result": []
}

PixotopeSpacePlayLoopPreset [CALL]

PixotopeSpacePlayLoopPreset

Plays a Pixotope Space preset in loop mode.

Params

EntityId	STRING	The entity id.
PresetId	STRING	The preset id.

Result

Result

BOOLEAN

The result.

Example - PixotopeSpacePlayLoopPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "PixotopeSpacePlayLoopPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "EntityId": "<EntityId>",
    "PresetId": "<PresetId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "PixotopeSpacePlayLoopPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

PixotopeSpacePlayPreset [CALL]

PixotopeSpacePlayPreset

Plays a Pixotope Space preset.

Params

EntityId	STRING	The entity id.
PresetId	STRING	The preset id.

Result

Result

BOOLEAN

The result.

Example - PixotopeSpacePlayPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "PixotopeSpacePlayPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "EntityId": "<EntityId>",
    "PresetId": "<PresetId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "PixotopeSpacePlayPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

PixotopeSpaceStopPreset [CALL]

PixotopeSpaceStopPreset

Stops a Pixotope Space preset.

Params

EntityId	STRING	The entity id.
PresetId	STRING	The preset id.

Result

Result

BOOLEAN

The result.

Example - PixotopeSpaceStopPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "PixotopeSpaceStopPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "EntityId": "<EntityId>",
    "PresetId": "<PresetId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "PixotopeSpaceStopPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

TestIOBotConnection [CALL]

TestIOBotConnection

Tests IOBot connection to Pixotope Space, connects or disconnects based on connection info.

No params.

Result

Result

BOOLEAN

The result.

Example - TestIOBotConnection

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "TestIOBotConnection",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "TestIOBotConnection",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

AdjustmentPreset [CALL]

AdjustmentPreset

Adjusts a preset on the engine.

Params

Engine	STRING	The engine.
GroupName	STRING	The group name.
Preset	STRING	The preset.
Panel	STRING	The panel.
Type	STRING	The type.
Method	STRING	The method.

Result

Result

STRING

The result.

Example - AdjustmentPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "AdjustmentPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Engine": "<Engine>",
    "GroupName": "<GroupName>",
    "Preset": "<Preset>",
    "Panel": "<Panel>",
    "Type": "<Type>",
    "Method": "<Method>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "AdjustmentPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": "PRESET_CREATED"
}

ClearAllKeyerPresets [CALL]

ClearAllKeyerPresets

Clears all video keyer presets of a specific type (Quick or Named).

Params

Type

STRING

The type.

Result

Result

BOOLEAN

The result.

Example - ClearAllKeyerPresets

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ClearAllKeyerPresets",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Type": "<Type>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ClearAllKeyerPresets",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ClearKeyerPreset [CALL]

ClearKeyerPreset

Clears a specific video keyer preset by preset ID and removes it from all last applied references.

Params

Preset

STRING

The preset.

Result

Result

BOOLEAN

The result.

Example - ClearKeyerPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ClearKeyerPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Preset": "<Preset>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ClearKeyerPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

LoadKeyerPreset [CALL]

LoadKeyerPreset

Loads a keyer preset and applies it to the specified VideoIO.

Params

Preset	STRING	The preset.
VideoIOName	STRING	The video ioname.
Machine	STRING	The machine.

Result

Result

BOOLEAN

The result.

Example - LoadKeyerPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "LoadKeyerPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Preset": "<Preset>",
    "VideoIOName": "<VideoIOName>",
    "Machine": "<Machine>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "LoadKeyerPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RenameKeyerPreset [CALL]

RenameKeyerPreset

Renames a keyer preset and updates all references to it.

Params

Preset	STRING	The preset.
NewName	STRING	The new name.

Result

Result

BOOLEAN

The result.

Example - RenameKeyerPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RenameKeyerPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Preset": "<Preset>",
    "NewName": "<NewName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RenameKeyerPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ResetKeyerParameters [CALL]

ResetKeyerParameters

Resets keyer parameters to defaults while preserving background and foreground picks.

Params

Name

STRING

The name.

Result

Result

BOOLEAN

The result.

Example - ResetKeyerParameters

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ResetKeyerParameters",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Name": "<Name>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ResetKeyerParameters",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

SaveKeyerPreset [CALL]

SaveKeyerPreset

Saves current keyer settings as a preset and marks it as last applied.

Params

Preset	STRING	The preset.
VideoIOName	STRING	The video ioname.
Machine	STRING	The machine.

Result

Result

BOOLEAN

The result.

Example - SaveKeyerPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SaveKeyerPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Preset": "<Preset>",
    "VideoIOName": "<VideoIOName>",
    "Machine": "<Machine>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SaveKeyerPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

AddIOMedia [CALL]

AddIOMedia

Adds IO media (Input/Output) to specified machines with auto-generated unique names.

Params

Type OPTIONAL (default: "Input")	STRING	The type.
CustomID OPTIONAL	STRING	The custom id.
Machines OPTIONAL	STRING[]	The machines.
InputType OPTIONAL	STRING	The input type.

Result

Result

BOOLEAN

The result.

Example - AddIOMedia

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "AddIOMedia",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Type": "<Type>",
    "CustomID": "<CustomID>",
    "Machines": [
      "<Machines1>"
    ],
    "InputType": "<InputType>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "AddIOMedia",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

CleanRoutings [CALL]

CleanRoutings

Cleans all routings, timecode, and local chains for a specified machine.

Params

MachineName

STRING

The machine name.

Result

Result

BOOLEAN

The result.

Example - CleanRoutings

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "CleanRoutings",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "CleanRoutings",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ClearRoutings [CALL]

ClearRoutings

Clears all routing configurations for all machines and cameras.

No params.

Result

Result

NULL

The result.

Example - ClearRoutings

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ClearRoutings",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ClearRoutings",
  "ID": "<ID>"
}

JSON

{
  "Result": null
}

DeleteMedia [CALL]

DeleteMedia

Removes local camera chain and/or routing IO entries on a machine. Supply CameraId and/or VideoIOId; each present id is cleared.

Params

MachineName	STRING	Target machine name.
CameraId OPTIONAL	STRING	If set, removes the local camera chain for this id.
VideoId OPTIONAL	STRING	If set, removes the routing IO entry for this id.

Result

Result

BOOLEAN

Always true when the call completes.

Example - DeleteMedia

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "DeleteMedia",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "CameraId": "<CameraId>",
    "VideoId": "<VideoIOId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "DeleteMedia",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

GetCameraSystems [CALL]

GetCameraSystems

Gets comprehensive camera systems information including video IOs, tracking, and camera details for all machines.

Params

Machines	STRING[]	The machines.
Cameras	STRING	The cameras.
TrackingStatuses	STRING	The tracking statuses.

Result

Result

OBJECT

The result.

Example - GetCameraSystems

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "GetCameraSystems",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Machines": [
      "<Machines1>"
    ],
    "Cameras": "<Cameras>",
    "TrackingStatuses": "<TrackingStatuses>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "GetCameraSystems",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

GetDefaultVideoInput [CALL]

GetDefaultVideoInput

Gets the default video input for a machine, returns SRT port if mobile, empty string otherwise.

Params

Machine

OPTIONAL

STRING

The machine.

IsMobile

OPTIONAL

(default: False)

BOOLEAN

The is mobile.

Result

Result

STRING

The result.

Example - GetDefaultVideoInput

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "GetDefaultVideoInput",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Machine": "<Machine>",
    "IsMobile": true
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "GetDefaultVideoInput",
  "ID": "<ID>"
}

JSON

{
  "Result": ""
}

RenameMedia [CALL]

RenameMedia

Renames a video media item and updates associated chromakey data.

Params

MachineName	STRING	The machine name.
VideoId	STRING	The video id.
NewName	STRING	The new name.

Result

Result

BOOLEAN

The result.

Example - RenameMedia

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RenameMedia",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "VideoId": "<VideoId>",
    "NewName": "<NewName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RenameMedia",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ResetRoutingToProtocolDefaults [CALL]

ResetRoutingToProtocolDefaults

Resets routing source configuration to tracking protocol defaults for a camera on specified machines.

Params

CameraId OPTIONAL	STRING	The camera id.
Machines OPTIONAL	STRING[]	The machines.
Protocol OPTIONAL	STRING	The protocol.

Result

Result

BOOLEAN

The result.

Example - ResetRoutingToProtocolDefaults

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ResetRoutingToProtocolDefaults",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "CameraId": "<CameraId>",
    "Machines": [
      "<Machines1>"
    ],
    "Protocol": "<Protocol>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ResetRoutingToProtocolDefaults",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ResetTimecode [CALL]

ResetTimecode

Resets timecode configuration for a machine to defaults (PTP or standard).

Params

MachineName	STRING	The machine name.
IsPTP	BOOLEAN	The is ptp.

Result

Result

BOOLEAN

The result.

Example - ResetTimecode

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ResetTimecode",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "IsPTP": true
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ResetTimecode",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RouteCameraSystem [CALL]

RouteCameraSystem

Routes a camera system to specified machines with mobile or local video configuration.

Params

Name OPTIONAL	STRING	The name.
CameraId OPTIONAL	STRING	The camera id.
IsMobile OPTIONAL (default: False)	BOOLEAN	The is mobile.
Machines OPTIONAL	STRING[]	The machines.

Result

Result

BOOLEAN

The result.

Example - RouteCameraSystem

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RouteCameraSystem",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Name": "<Name>",
    "CameraId": "<CameraId>",
    "IsMobile": true,
    "Machines": [
      "<Machines1>"
    ]
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RouteCameraSystem",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RouteLocalCamera [CALL]

RouteLocalCamera

Routes a local camera to specified machines and resets routing to protocol defaults.

Params

CameraId OPTIONAL	STRING	The camera id.
Machines OPTIONAL	STRING[]	The machines.

Result

Result

BOOLEAN

The result.

Example - RouteLocalCamera

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RouteLocalCamera",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "CameraId": "<CameraId>",
    "Machines": [
      "<Machines1>"
    ]
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RouteLocalCamera",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RouteZoneCamera [CALL]

RouteZoneCamera

Routes a zone camera system to specified machines using a camera id.

Params

Name OPTIONAL	STRING	The camera name.
CameraId OPTIONAL	STRING	The camera id.
Machines OPTIONAL	STRING[]	The machines.

Result

Result

BOOLEAN

The result.

Example - RouteZoneSystem

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RouteZoneSystem",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "CameraId": "<CameraId>",
    "Machines": [
      "<Machines1>"
    ]
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RouteZoneSystem",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

SetTimecode [CALL]

SetTimecode

Sets timecode configuration for specified machines with PTP support if applicable.

Params

Enabled OPTIONAL (default: False)	BOOLEAN	The enabled.
AutoReset OPTIONAL (default: True)	BOOLEAN	The auto reset.
AnyVideoIsST2110 OPTIONAL (default: False)	BOOLEAN	The any video is st2110.
Machines OPTIONAL	STRING[]	The machines.

Result

Result

BOOLEAN

The result.

Example - SetTimecode

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SetTimecode",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Enabled": true,
    "AutoReset": true,
    "AnyVideoIsST2110": true,
    "Machines": [
      "<Machines1>"
    ]
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SetTimecode",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RestartMachines [CALL]

RestartMachines

Restarts specified machines, with current machine restarting last.

Params

Machines

STRING[]

The machines.

Result

Result

BOOLEAN

The result.

Example - RestartMachines

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RestartMachines",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Machines": [
      "<Machines1>"
    ]
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RestartMachines",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

StartingEngines [CALL]

StartingEngines

Validates that engines are starting correctly.

Params

Machines

STRING[]

The machines.

Result

Result

BOOLEAN

The result.

Example - StartingEngines

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "StartingEngines",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Machines": [
      "<Machines1>"
    ]
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "StartingEngines",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

WaitForEnginesToBeReady [CALL]

WaitForEnginesToBeReady

Waits for all connected engines to be ready with a timeout.

No params.

Result

Result

NULL

The result.

Example - WaitForEnginesToBeReady

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "WaitForEnginesToBeReady",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "WaitForEnginesToBeReady",
  "ID": "<ID>"
}

JSON

{
  "Result": null
}

ClearAllSyncingPresets [CALL]

ClearAllSyncingPresets

Clears all syncing presets of a specific type (Quick or Named).

Params

Type

STRING

The type.

Result

Result

BOOLEAN

The result.

Example - ClearAllSyncingPresets

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ClearAllSyncingPresets",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Type": "<Type>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ClearAllSyncingPresets",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ClearSyncingPreset [CALL]

ClearSyncingPreset

Clears a specific syncing preset by preset ID and removes it from all last applied references.

Params

Preset

STRING

The preset.

Result

Result

BOOLEAN

The result.

Example - ClearSyncingPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ClearSyncingPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Preset": "<Preset>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ClearSyncingPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

LoadSyncingPreset [CALL]

LoadSyncingPreset

Loads a syncing preset and applies it

Params

Preset	STRING	The preset.
Machine	STRING	The machine.

Result

Result

BOOLEAN

The result.

Example - LoadSyncingPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "LoadSyncingPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Preset": "<Preset>",
    "CameraId": "<CameraId>",
    "Machine": "<Machine>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "LoadSyncingPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RenameSyncingPreset [CALL]

RenameSyncingPreset

Renames a syncing preset and updates all references to it.

Params

Preset	STRING	The preset.
NewName	STRING	The new name.

Result

Result

BOOLEAN

The result.

Example - RenameSyncingPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RenameSyncingPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Preset": "<Preset>",
    "NewName": "<NewName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RenameSyncingPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ResetSyncingParameters [CALL]

ResetSyncingParameters

Resets syncing settings to default values

No params.

Result

Result

BOOLEAN

The result.

Example - ResetSyncingParameters

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ResetSyncingParameters",
  "ID": "<ID>"
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ResetSyncingParameters",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

SaveSyncingPreset [CALL]

SaveSyncingPreset

Saves current syncing settings as a preset and marks it as last applied.

Params

Preset	STRING	The preset.
Machine	STRING	The machine.

Result

Result

BOOLEAN

The result.

Example - SaveSyncingPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SaveSyncingPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "CameraId": "<CameraId>",
    "Preset": "<Preset>",
    "Machine": "<Machine>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SaveSyncingPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

SetTrackingProtocol [CALL]

SetTrackingProtocol

Sets the tracking protocol for a specific camera and resets routing to protocol defaults.

Params

Camera	STRING	The camera.
Protocol	STRING	The protocol.

Result

Result

NULL

The result.

Example - SetTrackingProtocol

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SetTrackingProtocol",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Camera": "<Camera>",
    "Protocol": "<Protocol>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SetTrackingProtocol",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

CreateZoneTrackingCheckpoint [CALL]

CreateZoneTrackingCheckpoint

Creates a new zone checkpoint for a specific machine.

Params

MachineName

STRING

The machine name.

Result

Result

BOOLEAN

The result.

Example - CreateZoneTrackingCheckpoint

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "CreateZoneTrackingCheckpoint",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "CreateZoneTrackingCheckpoint",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

DeleteZoneTrackingCheckpoint [CALL]

DeleteZoneTrackingCheckpoint

Deletes a zone checkpoint for a specific machine.

Params

CheckpointId	STRING	The checkpoint name/key.
MachineName	STRING	The machine name.

Result

Result

OBJECT

The updated checkpoints.

Example - DeleteZoneTrackingCheckpoint

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "DeleteZoneCheckpoint",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "CheckpointId": "<CheckpointId>",
    "MachineName": "<MachineName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "DeleteZoneCheckpoint",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

GetZoneTrackingTemplates [CALL]

GetZoneTrackingTemplates

Gets the zone tracking templates.

No params.

Result

Result

OBJECT[]

The result.

Example - GetZoneTrackingTemplates

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "GetZoneTrackingTemplates",
  "ID": "<ID>"
}

JSON

{
  "Params": {}
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "GetZoneTrackingTemplates",
  "ID": "<ID>"
}

JSON

{
  "Result": [
    {}
  ]
}

LoadZoneTrackingCheckpoint [CALL]

LoadZoneTrackingCheckpoint

Loads the tracking state for a specific machine and checkpoint.

Params

MachineName	STRING	The machine name.
CheckpointId	STRING	The checkpoint name/key.

Result

Result

BOOLEAN

The result.

Example - LoadTrackingState

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "LoadTrackingState",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "CheckpointId": "<CheckpointId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "LoadTrackingState",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RenameZoneCheckpoint [CALL]

RenameZoneCheckpoint

Renames a zone checkpoint for a specific machine.

Params

MachineName	STRING	The machine name.
CheckpointId	STRING	The current checkpoint name/key.
NewName	STRING	The new checkpoint name.

Result

Result

BOOLEAN

The result.

Example - RenameZoneCheckpoint

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RenameZoneCheckpoint",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "CheckpointId": "<CheckpointId>",
    "NewName": "<NewName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RenameZoneCheckpoint",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ResetZoneTrackingTemplate [CALL]

ResetZoneTrackingTemplate

Resets the tracking template for a specific checkpoint.

Params

MachineName	STRING	The machine name.
CheckpointId	STRING	The checkpoint key.

Result

Result

BOOLEAN

The result.

Example - ResetZoneTrackingTemplate

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ResetZoneTrackingTemplate",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "CheckpointId": "<CheckpointId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ResetZoneTrackingTemplate",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

SaveZoneTrackingCheckpoint [CALL]

SaveZoneTrackingCheckpoint

Saves a zone checkpoint for a specific machine.

Params

MachineName	STRING	The machine name.
CheckpointId	STRING	The checkpoint name/key.

Result

Result

BOOLEAN

The result.

Example - SaveZoneTrackingCheckpoint

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SaveZoneTrackingCheckpoint",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "CheckpointId": "<CheckpointId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SaveZoneTrackingCheckpoint",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

SaveZoneTrackingTemplate [CALL]

SaveZoneTrackingTemplate

Saves the tracking template for a specific checkpoint.

Params

MachineName	STRING	The machine name.
CheckpointId	STRING	The checkpoint key.
SportType	STRING	The sport type.
TemplateType	STRING	The template type.
TemplateLength	STRING	The template length.
TemplateWidth	STRING	The template width.
KeyframeIndex	NUMBER	The selected keyframe index.
Keyframes	ARRAY	The keyframe nodes.

Result

Result

BOOLEAN

The result.

Example - SaveZoneTrackingTemplate

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SaveZoneTrackingTemplate",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "CheckpointId": "<CheckpointId>",
    "SportType": "<SportType>",
    "TemplateType": "<TemplateType>",
    "TemplateLength": "<TemplateLength>",
    "TemplateWidth": "<TemplateWidth>",
    "KeyframeIndex": "<KeyframeIndex>",
    "Keyframes": "<Keyframes>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SaveZoneTrackingTemplate",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

SetZoneServiceState [CALL]

SetZoneServiceState

Sets the tracking state for a specific machine.

Params

MachineName	STRING	The machine name.
State	STRING	The state name. One of: "Inactive", "SelectImageSource", "TrackInitialization", "TrackNormal", "Shutdown".

Result

Result

BOOLEAN

The result.

Example - SetZoneTrackingState

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SetZoneTrackingState",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "State": "<State>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SetZoneTrackingState",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ToggleLockZoneScreen [CALL]

ToggleLockZoneScreen

Toggles the lock zone screen for a specific machine.

Params

MachineName	STRING	The machine name.
ShouldLock	BOOLEAN	The should lock.

Result

Result

BOOLEAN

The result.

Example - ToggleLockZoneScreen

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ToggleLockZoneScreen",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "ShouldLock": true
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ToggleLockZoneScreen",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ClearAllTrackingPresets [CALL]

ClearAllTrackingPresets

Clears all video keyer presets of a specific type (Quick or Named).

Params

Type

STRING

The type.

Result

Result

BOOLEAN

The result.

Example - ClearAllTrackingPresets

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ClearAllTrackingPresets",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Type": "<Type>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ClearAllTrackingPresets",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ClearTrackingPreset [CALL]

ClearTrackingPreset

Clears a specific video keyer preset by preset ID and removes it from all last applied references.

Params

Preset

STRING

The preset.

Result

Result

BOOLEAN

The result.

Example - ClearTrackingPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ClearTrackingPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Preset": "<Preset>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ClearTrackingPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

LoadTrackingPreset [CALL]

LoadTrackingPreset

Loads a tracking offsets preset and applies it to the specified Camera.

Params

Preset	STRING	The preset.
CameraId	STRING	The camera id.
Machine	STRING	The machine.

Result

Result

BOOLEAN

The result.

Example - LoadTrackingPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "LoadTrackingPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Preset": "<Preset>",
    "CameraId": "<CameraId>",
    "Machine": "<Machine>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "LoadTrackingPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RenameTrackingPreset [CALL]

RenameTrackingPreset

Renames a tracking offsets preset and updates all references to it.

Params

Preset	STRING	The preset.
NewName	STRING	The new name.

Result

Result

BOOLEAN

The result.

Example - RenameTrackingPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RenameTrackingPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Preset": "<Preset>",
    "NewName": "<NewName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RenameTrackingPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ResetTrackingParameters [CALL]

ResetTrackingParameters

Saves current tracking offsets settings as a preset and marks it as last applied.

Params

CameraId

STRING

The camera id.

Result

Result

BOOLEAN

The result.

Example - ResetTrackingParameters

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "ResetTrackingParameters",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "CameraId": "<CameraId>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "ResetTrackingParameters",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

SaveTrackingPreset [CALL]

SaveTrackingPreset

Saves current tracking offsets settings as a preset and marks it as last applied.

Params

CameraId	STRING	The camera id.
Preset	STRING	The preset.
Machine	STRING	The machine.

Result

Result

BOOLEAN

The result.

Example - SaveTrackingPreset

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "SaveTrackingPreset",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "CameraId": "<CameraId>",
    "Preset": "<Preset>",
    "Machine": "<Machine>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "SaveTrackingPreset",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

PauseDedicatedVideo [CALL]

PauseDedicatedVideo

Pauses a dedicated video recording routing on specified machine.

Params

MachineName	STRING	The machine name.
RoutingID	STRING	The routing id.

Result

Result

BOOLEAN

The result.

Example - PauseDedicatedVideo

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "PauseDedicatedVideo",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "RoutingID": "<RoutingID>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "PauseDedicatedVideo",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

PauseVideo [CALL]

PauseVideo

Pauses video playback on a routing.

Params

MachineName	STRING	The machine name.
RoutingID	STRING	The routing id.

Result

Result

BOOLEAN

The result.

Example - PauseVideo

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "PauseVideo",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "RoutingID": "<RoutingID>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "PauseVideo",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

PlayVideo [CALL]

PlayVideo

Plays video on a routing.

Params

MachineName	STRING	The machine name.
RoutingID	STRING	The routing id.

Result

Result

BOOLEAN

The result.

Example - PlayVideo

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "PlayVideo",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "RoutingID": "<RoutingID>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "PlayVideo",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RecordDedicatedVideo [CALL]

RecordDedicatedVideo

Records video from a routing to a file with dedicated output.

Params

MachineName	STRING	The machine name.
RoutingID	STRING	The routing id.
FileFolder	STRING	The file folder.
FileName	STRING	The file name.

Result

Result

BOOLEAN

The result.

Example - RecordDedicatedVideo

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RecordDedicatedVideo",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "RoutingID": "<RoutingID>",
    "FileFolder": "<FileFolder>",
    "FileName": "<FileName>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RecordDedicatedVideo",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RecordVideo [CALL]

RecordVideo

Starts recording video and calls PlayVideo.

Params

MachineName	STRING	The machine name.
RoutingID	STRING	The routing id.

Result

Result

BOOLEAN

The result.

Example - RecordVideo

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RecordVideo",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "RoutingID": "<RoutingID>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RecordVideo",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

RestartVideo [CALL]

RestartVideo

Restarts video playback by stopping and restarting the video pipeline node.

Params

MachineName	STRING	The machine name.
RoutingID	STRING	The routing id.
Record	STRING	The record.

Result

Result

BOOLEAN

The result.

Example - RestartVideo

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "RestartVideo",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "RoutingID": "<RoutingID>",
    "Record": "<Record>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "RestartVideo",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

StopDedicatedVideo [CALL]

StopDedicatedVideo

Stops a dedicated video recording and removes the routing.

Params

MachineName	STRING	The machine name.
RoutingID	STRING	The routing id.

Result

Result

OBJECT

The result.

Example - StopDedicatedVideo

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "StopDedicatedVideo",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "RoutingID": "<RoutingID>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "StopDedicatedVideo",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

StopVideo [CALL]

StopVideo

Stops video playback and optionally stops recording.

Params

MachineName	STRING	The machine name.
RoutingID	STRING	The routing id.
Record	STRING	The record.

Result

Result

OBJECT

The result.

Example - StopVideo

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "QueryServer",
  "RespondTo": "<Service>",
  "Method": "StopVideo",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "MachineName": "<MachineName>",
    "RoutingID": "<RoutingID>",
    "Record": "<Record>"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "QueryServer",
  "Method": "StopVideo",
  "ID": "<ID>"
}

JSON

{
  "Result": {}
}

Queries

CalculateXRARLatency

ClearDigitalTwin

DispatchMetaCall

DuplicateCurrentShow

GetAliveIP

GetFromRole

GetImageForRouting

GetImportShowState

GetMachineNames

GetSystemDump

GetVideoIONodes

SetCalibratedLag

SetRenderGroup

ShutdownPipelines

SwitchCameraGroup

SyncChanges

WaitForPipelinesToFinishBuilding

Automatic Tests

ClearRoutingsAndCameras

DebugNormalMapNodes

GetFirstMachineAndInputNode

SaveImageWithRetry

SetupTestVideoColorMatchingOutput

SetupTestVideoColorMatchingXROutput

TestAIMapGeneration

TestColorMatchingXROnlyRed

TestDepthKeyer

TestDepthMap

TestNormalMap

Camera

RenameCamera

Camera Switching

AddCameraGroup

AddCameraSet

MigrateCameraGroup

RemoveCameraGroup

RemoveCameraSet

SetCameraSet

UpdateCameraSet

Cloud Async Compute

CancelComputeJobs

ImportComputedMesh

Color Matching

CancelColorMatching

ColorMatching

GetColorDiagram

RestartPipelines

StartXRColorAnalysisWriter

Encoder Detection

EncoderDetectStart

EncoderDetectStop

Image

CancelCaptureImage

CaptureCameraImages

CloudAsyncGeometry

DetermineBlurrinessOfB64

DetermineBrightnessOfB64

Level

ReopenLevels

RestartLevels

Machine Backup

SyncRenderMapping

FailoverMachineSwitch

FailoverMachineSwitched

AddMachineGroup

RemoveMachineGroup

RenameMachineGroup

UpdateMachineGroupSelection

ClearMachineGroupsMapping

UpdateMachineGroupMapping

Server Backup

CleanServerBackups

DisableServerBackup

SwitchServerBackup

Videohub

ConnectToVideohub

DisableVideohubAutoconnect

DisconnectFromVideohub

LockRenderMachineRow