vdcp Object

In ogScript, use the vdcp object to communicate with BlackStorm video servers. Functions in the vdcp object are typically set through a user interface.

To call a general-purpose function, use:

vdcp.function name (parameters);

For example:

vdcp.setHost (Server01);

The following table lists the functions of the vdcp object.

Function

Parameters

Returns

Description

setHost

String [Host]

N/A

Set a default host to use for VDCP commands where no host has been defined.

getHost

N/A

String

Get the default host previously defined.

setPort

Integer [Port]

N/A

Set a default port to use for VDCP commands where no host has been defined.

getPort

N/A

Integer

Get the default port previously defined.

activeClip

String [Host], Int [Port], Int [Channel], Function [Callback]

N/A

Fetch the active clip ID for the provided channel from the server at the provided host/port. Invoke the callback with the active clip ID when done.

Callback function signature:

Function (Boolean success, String sentCommand, String resultString, Exception javaException)

clipDuration

String [Host], Int [Port], Int [Channel], String [ClipID], Function [Callback]

N/A

Fetch the duration [HH:MM:SS:FF] of the clip with the given ID. Invoke the callback with the clip duration when done.

Callback function signature:

Function (Boolean success, String sentCommand, String resultString, Exception javaException)

continuePlay

String [Host], Int [Port], Int [Channel]

N/A

Sends the vdcp continuePlay

command.

cueClip

String [Host], Int [Port], Int [Channel]

N/A

 

cueClip

String [Host], Int [Port], Int [Channel], Function [Callback]

N/A

 

fastForward

String [Host], Int [Port], Int [Channel]

N/A

 

fastForward

String [Host], Int [Port], Int [Channel], Function [Callback]

N/A

 

listClips

String [Host], Int [Port], Int [Channel], Function [Callback]

N/A

 

pause

String [Host], Int [Port], Int [Channel]

N/A

 

pause

String [Host], Int [Port], Int [Channel], Function [Callback]

N/A

 

play

String [Host], Int [Port], Int [Channel]

N/A

Sends the vdcp variPlay command.

rewind

String [Host], Int [Port], Int [Channel]

N/A

 

rewind

String [Host], Int [Port], Int [Channel], Function [Callback]

N/A

 

stop

String [Host], Int [Port], Int [Channel]

N/A

 

stop

String [Host], Int [Port],Int [Channel], Function [Callback]

N/A