Skip to main content
Skip table of contents

Video IO API - Calls

SaveImage

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

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". Call "Nodes" to get a list of all active node names. If this is not supplied or empty, it will reply with all nodes images.

Format

STRING OPTIONAL

Optional format, PNG or JPEG, defaults to JPEG.

Scale

FLOAT OPTIONAL

Optional scale value, default is 1.0, which is 100%.

GammaCorrection

BOOL OPTIONAL

Should the request apply gamma correction or not. Default is true.

ITM

BOOL OPTIONAL

Should the request apply inverse tonemap or not. Default depends on State.Pipeline.DynamicRange eing "HDR".

HighlightCentralArea

BOOL OPTIONAL

Should we highlight the center area. Default is false.

CallResult

Image

STRING

A base64-encoded image.

Name

STRING

The name of the node replied with.

RestartVideo

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

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

Health

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

No params.

CallResult

OBJECT LIST

Health/status information for each node.

RebuildNodes

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

Shutdown

The video I/O will of course cease operation.

No arguments - Triggers the pipeline to shut itself down.

No params.

NodeTimes

NodeTimes

These may/will not be accurate.

No arguments - Returns a list of node times.

No params.

SetBMDProfile

SetBMDProfile

The video I/O will rebuild.

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

No params.

StartColorSetup

StartColorSetup

This will disable Engine transfers, and take a few seconds to complete.

No arguments - Begins the diagnostic phase for Color setup.

Params

Name

STRING

The filename of Test Pattern image to be used instead of color patches.

Role

STRING OPTIONAL SOLO, READER, WRITER

One of, the mode of the call. Solo or multiple machines. Defaults to Solo.

ID

STRING OPTIONAL

The UUID of the XR node you would like to interact with, if blank or omitted it will use the first node.

StartColorAnalysis

StartColorAnalysis

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

This will rebuild the VideoIO after it's completed.

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

Params

Name

STRING

The filename of the .cube file created.

Type

STRING OPTIONAL SOLO, READER, WRITER

One of, the mode of the call. Solo or multiple machines. Defaults to Solo.

ID

STRING OPTIONAL

The UUID of the XR node you would like to interact with, if blank or omitted it will use the first node.

GetDiagram

GetDiagram

Send the Chromacity diagram to Director - The .png file is sent in the binary payload object.

Params

Name

STRING

The filename of the .png chromacity diagram generated from the corresponding LUT name

CallResult

Image

STRING

A base64-encoded image.

EnableEventTimers

EnableEventTimers

Enables the debug event timers and begins announcing them over the network. This rebuilds the VideoIO

Params

Enabled

BOOL

true for enabled, false to disable.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.