hwIAVIExportOptions SetFrameRate

Sets the frame rate used when exporting AVI files.

Syntax

hwIAVIExportOptions_handle SetFrameRate value

Application

Tcl Modify

Description

This parameter is used when exporting AVI files from either the video or animation clients during HTML export.

Inputs

value
The frame rate (frames per second) to be used when exporting AVI files.

Example

To set the current value of the frame rate used when exporting AVI files:
hwi GetSessionHandle mySessionName
mySessionName GetAVIExportOptionsHandle myAviOptions
myAviOptions SetFrameRate 25.0

Error

Success (0) or an error code (see below).
HW_InvalidHandle
The handle used to invoke the method is no longer valid.
HW_InvalidArgs
The value for the frame rate is out of the valid range (must be greater than 0).