Receiving Parameter Values

Navigation:  Pandoras Box > External Control (DMX,Midi,...) > SDK > Examples >

Receiving Parameter Values

 prev main next

Navigation:  Pandoras Box > External Control (DMX,Midi,...) > SDK > Examples >

Receiving Parameter Values

 prev main next

Loading...

Show/Hide hidden text

The following examples show you how to request information from Pandoras Box using the SDK and how to handle incoming values.
The examples require a working connection to Pandoras Box (see Connect SDK to Pandoras Box). If you would like to know how to send values yourself, please go back to the topic Sending Parameter Values )

hmtoggle_arrow1Visual Basic

' Get the Y position of layer 1 of site 2
Dim y_pos As Double = AutoGetParam(2, 1, Param.Position.Y)

' Get the "Left" parameter value of effect "Crop Edges" on layer 3 of site 1
Dim crop_edges_left As Double = AutoGetParam(1, 3, "Crop Edges|Left")

' Get the transport mode of sequence 2 (Play/Stop/Pause)
Dim sequence_status As TransportMode = AutoGetSequenceTransportMode(2)

' Get the current time position of sequence 1 and extract the number of seconds
Dim sequence_time As TimeType
AutoGetSequenceTime(1, sequence_time)
Dim sequence_seconds As Integer = sequence_time.Seconds

hmtoggle_arrow1C#

// Get the Y position of layer 1 of site 2
double y_pos = AutoGetParam(2, 1, "Pos Y")

// Get the "Left" parameter value of effect "Crop Edges" on layer 3 of site 1
double crop_edges_left As Double = AutoGetParam(1, 3, "Crop Edges|Left")

// Get the transport mode of sequence 2 (Play/Stop/Pause)
TransportMode sequence_status = Auto.GetSequenceTransportMode(2);

// Get the current time position of sequence 1 and extract the number of seconds
TimeType sequence_time = new TimeType();
Auto.GetSequenceTime(1, ref sequence_time);
int sequence_seconds = sequence_time.Seconds;

If you are not familiar with Pandoras Box "vocabulary", please follow the links. In short, a site refers to a Client e.g. a Server, in the Device Tree tab. A site has many devices, also called layers, e.g. Video Layers. A Video Layer has many parameters, e.g. position on the X-axis. If a new value is applied to the parameters position / rotation / scaling, the layer would abruptly jump to it, which, does not look nice. Therefore, "Smoothing" applies a delay. It can be set up in the Device Inspector. Other examples above refer to parameters "effects", more information about effects can be found in the tab Aeon FX and FX on Layers, including an illustrated FX List with all available effects. A list with all parameter names can be found here.

The next topic, Error Handling, covers the way the SDK reports problems.