vidIVideo ToggleOverlayState
Sets a specified overlay to toggle between on and off.
Syntax
vidIVideo_handle ToggleOverlayState idx
Application
Tcl Modify
Description
This command sets a specified overlay to toggle between on and off.
Inputs
- idx
- The index (position) of the overlay that you want to toggle, within the Overlay Panel list. This input determines which overlay to flip.
Example
hwi GetSessionHandle sess;
sess GetProjectHandle proj;
proj GetPageHandle p1 1;
p1 GetWindowHandle w1 1;
w1 GetClientHandle Video;
Video ToggleOverlayState 2;
Error
Success (0) or an error message is returned.
Keywords
- Tcl
- Video
- Modify