hwISession CaptureAnimationByAreaPercentage

Syntax

hwISession_handle CaptureAnimationByAreaPercentage type, filename, left, top, right, bottom, [dimension_type, width, height]

Application

Tcl

Description

This command captures the screen to a movie file, first requiring you to specify or resize a window region to be captured. This version takes percentages as parameters for the corners, expressed as decimals between 0 and 1.

Inputs

type

The file type that you want the captured movie to be saved as. The file types available 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 name that you want to give the captured movie.

left

The left side coordinate of the captured region in terms of screen percentage (a decimal between 0 and 1).

top

The top side coordinate of the captured region in terms of screen percentage (a decimal between 0 and 1).

right

The right side coordinate of the captured region in terms of screen percentage (a decimal between 0 and 1).

bottom

The bottom side coordinate of the captured region in terms of 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.

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

sess CaptureAnimationByAreaPercentage amf MyVideo.amf .25 .25. .25 .25;
sess CaptureAnimationByAreaPercentage gif MyVideo.gif .25 .25 .75 .75 percent 150 150;
sess CaptureAnimationByAreaPercentage gif MyVideo.gif .25 .25 .75 .75 pixels 1280 960;

Error

Returns success (0) or an error code.

Keywords

Tcl

Create