vidIVideo ShowFilename

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

Syntax

vidIVideo_handle ShowFilename on

Application

HyperWorks Tcl Modify

Description

This command sets whether the filename is shown in the video or not. The filename is displayed within the annotation note. It is shown in the annotation box with the frame number and time step, if they are also turned on.

Inputs

on
A true or false value.
True
Filename turned on.
False
Filename not turned on.

Example

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

Errors

Success (0) or an error message is returned.

Keywords

  • HyperWorks
  • Tcl
  • Video
  • Modify