vidIVideo ShowFramenumber
IMPORTANT: This API is now obsolete. Please refer to the vidivideo GetMediaInfoNoteHandle API to achieve this functionality. Sets whether the frame number is shown.
Syntax
vidIVideo_handle ShowFramenumber on
Application
HyperWorks Tcl Modify
Description
This command sets whether the frame number is shown in the video or not. The frame number shows the specific frame number of the video, which is displayed within the annotation note. It is shown in the annotation note with the timestep and filename, if they are also turned on.
Inputs
- on
- A true or false value.
- True
- Frame number on.
- False
- Frame number turned off.
Example
hwi GetSessionHandle sess;
sess GetProjectHandle proj;
proj GetPageHandle p1 1;
p1 GetWindowHandle w1 1;
w1 GetClientHandle Video;
Video ShowFramenumber true;
Errors
Success (0) or an error message is returned.
Keywords
- HyperWorks
- Tcl
- Video
- Modify