Vicon Shogun banner

Description

Sets the time value of the time box user control that is specified by userControlID. The time value should be specified in frames.

Functional area

User Window

Command syntax

Syntax

setTimeBoxTime userControlID frame

Arguments

NameTypeRequiredComments
timeValintyesTime value, in frames.
userControlIdintyesID of user control to operate on.

Flags

None

Return value

void

Examples

// Get the time value of a Time Box User Control
int $windowId;
int $controlId;
int $time;

// First create a User Window to place the Controls on
$windowId = `createWindow "MyWindow"`;

// Create the User Control on the Window.
$controlId = `createTimeBox $windowId`;

// Set the time to some arbitrary frame
setTimeBoxTime $controlId 125;

// Get the time we just set
$time = `getTimeBoxTime $controlId`;
print $time;

Additional information

Related commands