vidIVideo ShowTimestep

IMPORTANT: This API is now obsolete. Please refer to the vidivideo GetMediaInfoNoteHandle API to achieve this functionality. Sets whether the time step is shown.

Syntax

vidIVideo_handle ShowTimestep on

Application

HyperWorks Tcl Modify

Description

This command sets whether the timestep is shown in the video or not. The timestep shows the time stamp of the video, which is displayed within the annotation note. It will be shown in the annotation note with the frame number and filename, if they are also turned on.

Inputs

on
A true or false value.
True
Timestep turned on.
False
Timestep turned off.

Example

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

Errors

Success (0) or an error message is returned.

Keywords

  • HyperWorks
  • Tcl
  • Video
  • Modify