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 | Selection | Specifies the graphics device for texture sharing. |
Sequential Timecode | Selection | Specifies which sequential timecode to read. |
SMPTE Timecode | Selection | Specifies which SMPTE timecode to read. |
Data
Type | Comments |
|---|---|
Image | Supported formats:
|
Audio | Experimental |
Sequential Timecode | - |
SMPTE Timecode | - |
Number | Count that goes up whenever a new image is read. |
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 and assign it to the same tool. |
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 | Selection | Specifies the name of the NDI source. |
Data
Type | Comments |
|---|---|
Image | All formats support by NDI are allowed, but are converted to RGBA / RGBX (8-bit, SDR). |
Sequential Timecode | - |
Number | Count that goes up whenever a new image is read. |
Errors and Warnings
Severity | Text | Potential Fixes |
|---|---|---|
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 | Input did not contain all required data. | Check that the input contains all assigned data formatted as specified in the table above. |
Socket Receiver
Use this input to integrate a TCP or UDP data stream over network.
Parameters
Name | Type | Explanation |
|---|---|---|
Hostname | Text | Specifies the host interface to listen. |
Port | Number | Specifies the network port to listen. |
Socket Type | Selection | Specifies the network protocol (TCP or UDP). |
Data
Type | Comments |
|---|---|
Binary Data | - |
Errors and Warnings
Severity | Text | Potential Fixes |
|---|---|---|
Error | Initialization has failed. Revisit this inputs' configuration. | Check that the specified port is free. |
Error | No input is received. | Check whether a connection was made from the other end. |
Sync Count Relayer Input
This propagates the sync count from the active synchronization adapter.
Data
Type | Comments |
|---|---|
Number | Count that goes up on each sync. |
Timecode Input
Use this input to generate a running timecode.
Parameters
Name | Type | Explanation |
|---|---|---|
Drop Frames | Toggle | Whether the generated timecode contains drop frames. |
Frequency | Selection | Select the timecode frequency. |
Actions
Name | Explanation |
|---|---|
Set Timecode | Sets the current timecode to the specified one. |
Set Timecode Offset | Specifies an offset to apply to the internal timecode. |
Data
Type | Comments |
|---|---|
Sequential Timecode | - |
SMPTE Timecode | - |
Text | The SMPTE timecode as text. |
Number | Count that goes up whenever a new timecode is generated. |
Tracking Hub Input
Use this input to integrate with a Tracking Hub.
Parameters
Name | Type | Explanation |
|---|---|---|
Image Height | Number | Specifies the image width to interpret the data. |
Image Width | Number | Specifies the image height to interpret the data. |
Port | Number | Specifies the port to receive the tracking data. |
Render Scale | Number | Specifies the render scale to interpret the data. |
Data
Type | Comments |
|---|---|
Camera Data | - |
Errors and Warnings
Severity | Text | Potential Fixes |
|---|---|---|
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. |
Viz Engine Input
A shared memory input is used to integrate with Viz Engine using the SHM Sync Master Mode key. It receives video frames via shared memory (SMURF). This input requires a Viz Engine Sync Input assigned to the same tool.
Parameters
Name | Type | Explanation |
|---|---|---|
Video Input Channel | Text | Specifies the live channel to read the video from via shared memory. |
Graphics Device | Selection | Specifies the graphics device for texture sharing. |
General Communication Port | Number | Specifies the port to communicate with the Viz Engine. |
Sequential Timecode | Selection | Specifies which sequential timecode to read. |
SMPTE Timecode | Selection | Specifies which SMPTE timecode to read. |
Data
Type | Comments |
|---|---|
Image | Supported formats:
|
Audio | Experimental |
Sequential Timecode | - |
SMPTE Timecode | - |
Number | Count that goes up whenever a new image is read. |
Errors and Warnings
Severity | Text | Potential Fixes |
|---|---|---|
Error | Setup has failed. Check that the Viz Engine is running and accessible, and that a Viz Engine Sync is created and assigned to the same tool. | Create a Viz Engine Sync and assign it to the same tool. Check that the Viz Engine is running and accessible via the configured port. |
Error | No input is received. Make sure the selected input channel holds valid data. | Check that the configured input channel holds valid data (for example, by displaying it within the 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. |
Webcam
Use this input to integrate with a webcam.
Parameters
Name | Type | Explanation |
|---|---|---|
Camera | Selection | Specifies which camera to use. |
Data
Type | Comments |
|---|---|
Image | - |
Errors and Warnings
Severity | Text | Potential Fixes |
|---|---|---|
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. |