Video IO API - Calls

SaveImage

Requests node(s) frames to be sent over the DH2 network. Generates up to X responses, each image in it's own response.

Params

Nodes	STRING LIST OPTIONAL	Optional list of node names. These are generally the UUID for the I/O nodes. Or the node type appended onto the UUID, eg. "UUID_Chr"
Format	STRING OPTIONAL	Optional format, PNG or JPEG, defaults to JPEG.
Scale	FLOAT OPTIONAL	Optional scale value, default is 1.0, which is 100%.

CallResult

Image	STRING	A base64-encoded image.
Name	STRING	The name of the node replied with.

RestartVideo

Requests a video input node to restart itself.

Params

Node

STRING

The node name, either blank for all, friendly name, or UUID of the input.

Nodes

No arguments - Send an array of nodes back over the network.

No params.

CallResult

Nodes	STRING LIST	A list of unique node names.
FriendlyNodes	OBJECT LIST	A list of objects with `Friendly` and `Raw` components.

Health

No arguments - Send an array of each node->healthStatus() result back.

No params.

CallResult

OBJECT LIST

Health/status information for each node.

RebuildNodes

This does cause the video I/O to briefly suspend.

No arguments - Triggers the Pipeline to rebuild all of the nodes, essentially a soft restart.

No params.

Shutdown

The video I/O will of course cease operation.

No arguments - Triggers the pipeline to shut itself down.

No params.

NodeTimes

These may/will not be accurate.

No arguments - Returns a list of node times.

No params.

SetBMDProfile

The video I/O will rebuild.

String Profile - Rebuilds the Pipeline, and sets the BMD profile to Profile.

No params.

StartColorAnalysis

This will disable Engine transfers, and take a very long period of time.

No arguments - Begins the XR calibration if XR is active.

No params.