hwISession CaptureAnimation

Creates a movie file by animating the current page.

Syntax

hwISession_handle CaptureAnimation filetype, filename, [dimension_type, width, height]

Application

Tcl Query

Description

This command uses the current values for options found in the hwIAVIExportOptions or hwIAMFExportOptions object.

Inputs

filetype
Indicates the format of the output file. The animated formats can be "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 name of the file to be created.
dimension_type
Specifies the width and height units of the final animation, which can be in percent or pixels.
Note: If you specify a dimension_type, you MUST specify BOTH width and height (see below).
width
The number of width units of the final captured animation.
height
The number of height units of the final captured animation.

Example

To determine if the current plot is drawn with a uniform aspect ratio (i.e. equal width and height):
hwi GetSessionHandle mySessionName
mySessionName GetAVIExportOptionsHandle myAVI
myAVI SetSize 33
myAVI SetPalette reduced
mySessionName CaptureAnimation avi c:/temp/fun.avi
mySessionName CaptureAnimation avi c:/temp/fun_75.avi percent 75 75
mySessionName CaptureAnimation avi c:/temp/fun_1280x960.avi pixels 1280 960

Error

Success (0) or an error code.