Pixotope Pipeline (VideoIO) - API

Description

Pixotope Pipeline (VideoIO) is a service responsible for processing incoming and outgoing video data including video keying.

Name

[MachineName]-Pipeline for example "RenderMachine1-Pipeline"

The Pipeline service is equivalent to the VideoIO service PX_VideoIO.exe

State

TYPESCRIPT

{
  "State": {
    "Refsource" : string; // Reference source, external, internal, sdi0, …
    "Routing" : {
      "[VideoIO_object_id]" : {
      	"Timecode": string; // Timecode source
      	"Video": string; // SDI#, File name, or NDI source name
      },
      ...
    },
    "Visualizer" : {
      "Enabled": boolean; // Requires ID to be valid too
      "ID": string; // The ID of the VideoIO object
      "ShowStatus": boolean; // Default disabled - Shows things such as build information, node health status information
      "ShowVisualizers": boolean; // Default enabled - Shows the graphical visualizers
      "ShowLogs": boolean; // Default disabled - Shows the logs on video
      "ShowTimecode": boolean; // Default disabled - Prints the timecode on the video
    }
  }
}

RPC

SaveImage

Requests that the Pipeline (VideoIO) captures and sends a frame.

Format	STRING	`"PNG" \| "JPEG"` - if this is omitted or invalid, JPEG will be sent
Nodes	STRING ARRAY	`["NodeToSave", "NodeToSave_Vis", …]` - if this is omitted, all nodes are sent
Scale	FLOAT	If this is omitted, a scale of 1.0 (100%) will be used

Response

Image	STRING	Base64 encoded PNG or JPEG image
Name	STRING	The name of the node itself

Nodes

Requests an array of current nodes in the Pipeline (VideoIO).

Response

Nodes

STRING ARRAY

["NodeName", "NodeName_Vis", …]

RebuildNodes

Requests that the Pipeline (VideoIO) rebuilds itself.

Response

Responded

BOOLEAN

Returns true if the service is running

Shutdown

Requests that the Pipeline (VideoIO) shut itself down.

Response

Responded

BOOLEAN

Returns true if the service is running

Health

Requests a status update on the node’s health.

Response

Result

OBJECT

JSON object of diagnostic information

SetBMDProfile

Assigns a BMD profile to the BMD hardware.

Not all BMD hardware has profile support, or support for all profiles and can behave differently.

Rebuilds the Pipeline.

Profile

STRING

"bmdProfileOneSubDeviceFullDuplex" |"bmdProfileOneSubDeviceHalfDuplex" |"bmdProfileTwoSubDevicesFullDuplex" |"bmdProfileTwoSubDevicesHalfDuplex" |"bmdProfileFourSubDevicesHalfDuplex" - Suggested and most similar to how AJA works

Response

Responded

BOOLEAN

Returns true if the service is running