Documentation Center

AI Terminal User Guide

Version 1.0 | Published August 30, 2023 ©

Input

Shared Memory Input

A shared memory input is used to integrate with applications that can send video frame via shared memory (SMURF), for example Viz Engine. This input requires a Shared Memory Sync created and assigned to the same tool.

Parameters

Name

Type

Explanation

Key

Text

Specifies the shared memory key.

Graphics Device

Text

Specifies the graphics device for texture sharing.

Data

Type

Comments

Image

Supported formats:

  • RGBA (8-bit, SDR).

Time-Code

Name:

  • retraceCounter.

Type:

  • Sequential.

Errors and Warnings

Severity

Text

Potential Fixes

Error

Setup has failed. Check that a Shared Memory Sync is created and assigned to the same tool.

Create a Shared Memory Sync adapter and assign it to the same tool.

Error

Initialization has failed. Revisit this inputs' configuration.

Restart the computer.

Error

No input is received. Make sure the specified key is correct.

Check that the specified shared memory key matches the key which is setup in the integrated application (for example, Viz Engine).

Check that the selected graphics device matches the device which is used in the integrated application (for example, Viz Engine).

Error

Input did not contain all required data.

Check that the input contains all assigned data formatted as specified in the table above.

NDI Input

Use this input to integrate an NDI source.

Parameters

Name

Type

Explanation

NDI Source

Text

Specifies the name of the NDI source.

Data

Type

Comments

Image

Supported formats:

  • RGBA (8-bit, SDR).

Time-Code

-

Errors and Warnings

Severity

Text

Potential Fixes

Error

Setup has failed. Revisit this inputs' configuration.

Restart the computer.

Error

Could not connect to the specified NDI source. Make sure the NDI source exists.

Use the NDI Studio Monitor to verify that the specified NDI source exists.

Error

No input is received.

Use the NDI Studio Monitor to verify that the specified NDI source exists and provides a running video signal.

Error

Unsupported color format.

Check that the input contains all assigned data formatted as specified in the table above.

Tracking Hub Input

Use this input to integrate with a Tracking Hub.

Parameters

Name

Type

Explanation

Port

Number

Specifies the port to receive the tracking data.

Data

Type

Comments

Tracking-Data

-

Errors and Warnings

Severity

Text

Potential Fixes

Error

Setup has failed. Revisit this inputs' configuration.

Restart the computer.

Error

Initialization has failed. Could not bind to the specified port.

The specified port is already used by another application. Try another port and adapt the setting correspondingly in the Tracking Hub.

Error

No input is received. Verify the specified port and check corresponding settings on the Tracking Hub.

Check that the Tracking Hub is sending data to the specified port.

Error

Input did not contain all required data.

Check that this version of AI Terminal is compatible with the installed version of Tracking Hub.

Webcam

Use this input to integrate with a webcam.

Parameters

Name

Type

Explanation

Camera index

Number

Specifies which camera to use (automatically detects how many available webcams are on the computer).

Data

Type

Comments

Image

-

Errors and Warnings

Severity

Text

Potential Fixes

Error

Setup has failed. Revisit this inputs' configuration.

Restart the computer.

Error

Failed to initialize. Make sure the webcam is not used in another application.

Check that the webcam is connected to the computer and accessible by the Camera app pre-installed on most Windows systems.

The webcam might be already in use by another application. Close this other application.

Error

No input is received.

Restart the tool.

Error

Input did not contain all required data.

Restart the tool.