An API (Application Programming Interface) is available for VidBlasterX. The API enables other applications to exchange data with VidBlasterX using TCP, consequently the other application can be located on the same PC, on the same network, or in fact anywhere on the internet. The API requires the TCP Server module to be loaded. The API is a powerful feature enabling you to control VidBlasterX's operation from any application anywhere in the world.

From an API point of view, VidBlasterX is a collection of modules where each module can have one or more pins. A pin can be input and/or output and exchange data in various formats. The following API commands are available to get information about the API, obtain a list of available modules and access each module:

apiabout

apilist

apilist2

apiread

apiwrite

When a command is recognized, 200 Ok will be returned, optionally followed by the requested value or an error message.

Almost all modules have pins that can be accessed through the API:

Audio Player

Camera

Effect

IP Decoder

Macro

Output

Overlay

Player

Powerpoint

Recorder

Replay I & II

Replay Controller

Replay Source

Scoreboard

Still Store

Streamer

Switcher