hwISession CaptureAnimationByWindow

Creates a video file of a window on the current page.

Syntax

hwISession_handle CaptureAnimationByWindow win_id, type, filename, left, top, right, bottom, dimension_type, width, height

Application

HyperWorks Tcl Query

Inputs

win_id
The ID of the window which needs to be captured.
type
The type of file that you want the captured movie to be saved as. The available file types are: AVI, AMF, and GIF (one file contains the entire animation) or PNG, JPEG, BMP, and TIFF (a numbered series of still image files comprising the entire animation).
filename
The file name of the captured video.
left
The coordinate of the left side of the capture region, in screen percentage (a decimal between 0 and 1).
top
The coordinate of the top of the capture region, in screen percentage (a decimal between 0 and 1).
right
The coordinate of the right side of the capture region, in screen percentage (a decimal between 0 and 1).
bottom
The coordinate of the bottom of the capture region, in screen percentage (a decimal between 0 and 1).
dimension_type
Specifies the width and height units of the final animation, which can be in percent or pixels.
width
The width of the captured video in percent/pixels.
height
The height of the captured video in percent/pixels.

Example

hwi GetSessionHandle sess
sess CaptureAnimationByWindow 0 gif Video.gif 0.1 0.1 0.9 0.9 percent 150 150;
sess CaptureAnimationByWindow 0 avi Video.avi 0.2 0.2 0.8 0.8 pixels 1280 960; 
sess CaptureAnimationByWindow 1 png Video.png 0 0 1 1 pixels 800 600;

Error

Success (0) or an error code.