vidIVideo GetOverlayStateList

Syntax

vidIVideo_handle GetOverlayStateList

Application

HyperWorks Tcl Query

Description

This command returns a list of overlay states in the order they should be displayed on the Overlay Panel. Each state will be either a 1 or 0, with a 1 stating the overlay is on, or a 0 stating that the overlay is off.

Example

hwi GetSessionHandle sess;
sess GetProjectHandle proj;
proj GetPageHandle p1 1;
p1 GetWindowHandle w1 1;	
w1 GetClientHandle Video;
Video GetOverlayStateList;

Errors

Success (the states list) or an error message is returned.

Keywords