Home
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
Tcl/Tk Commands
The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk Commands
Tcl/Tk classes for the following Altair HyperWorks applications.
Framework
hwIAMFExportOptions Class
hwIAMFExportOptions SetQuality
Sets the quality used when exporting AMF files using the JPEG encoder.

Welcome
What's New
View new features for version 2024.1.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover product functionality with interactive tutorials.
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
- Extensions
  Extensions are programs integrated with the application to enhance or extend the user experience.
- External Readers and Altair Binary Format
  Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
- Generic ASCII Reader
  A generic ASCII reader is now available which allows you to bring custom results directly into HyperView. The Altair ASCII format is useful for reading the results of any in-house or propriety codes which are saved in a generic format.
- Batch Mode
  Batch mode allows you perform a series of operations outside the program interface.
- External Resources
  External resources can be registered in preference files, session files, or Templex files. If an external resource is registered in a program session, it is automatically registered in the session file when the session is saved.
- Python API
  The Python API documentation for HyperMesh applications.
- Tcl/Tk Commands
  The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
  - Program with APIs for Beginners
    APIs can be used to perform various actions in an application. For example, the AddPage API can be used to add a page within the project.
  - Object Hierarchy
    Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, MotionView, MediaView and TextView.
  - Tcl/Tk Classes
    Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
  - Script Use Cases
    Examples of script uses cases.
  - Tcl/Tk Example
    Learn more about Tcl/Tk with this basic example.
  - Program with Tcl/Tk Command Tutorials
    Learn more about programming with Tcl/Tk commands with this tutorial.
  - Tcl/Tk Commands
    Tcl/Tk classes for the following Altair HyperWorks applications.
    - Framework
      - amfIMarker Class
      - amfIMeasure Class
      - amfIMovie Class
      - hwi Class
      - hwI2DViewControl Class
      - hwI3DViewControl Class
      - hwIAMFExportOptions Class
        hwIAMFExportOptions GetEncoder
        Gets the type of encoding used when exporting AMF video files.
        hwIAMFExportOptions GetQuality
        Gets the quality used when exporting AMF files using JPEG encoding.
        hwIAMFExportOptions GetPalette
        Gets the palette used when exporting AMF files.
        hwIAMFExportOptions GetSize
        Gets the relative size (percent) used when exporting AMF files.
        hwIAMFExportOptions SetEncoder
        Sets the type of encoding used when exporting AMF video files.
        hwIAMFExportOptions SetPalette
        Sets the palette used when exporting AMF files.
        hwIAMFExportOptions SetQuality
        Sets the quality used when exporting AMF files using the JPEG encoder.
        hwIAMFExportOptions SetSize
        Sets the relative image size (percent) used when exporting AMF files.
      - hwIAnimator Class
      - hwIAnimator AtModelStep
      - hwIAVIExportOptions Class
      - hwIClientInfo Class
      - hwIDataFile Class
      - hwIFont Class
      - hwIH3DExportOptions Class
      - hwIHWC Class
      - hwIJPGExportOptions Class
      - hwILayer Class
      - hwIMessageLog Class
      - hwIObject Class
      - hwIPage Class
      - hwIPPTPublish Class
      - hwIPPTPublishOption Class
      - hwIPreferenceManager Class
      - hwIProject Class
      - hwIReportTemplate Class
      - hwISession Class
      - hwITemplex Class
      - hwIViewControl Class
      - hwIWindow Class
      - hwIXMLFile Class
    - MotionView
    - HyperView
    - HyperGraph 2D
    - HyperGraph 3D
    - MediaView
    - TextView
    - HgTrans
    - TableView
    - Postquery Commands
    - Context Commands
    - Framework Commands
- Translators
  Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
- Result Math
  XML commands in the Result Math Module.
- HWC Console
  Record playback workflows in the application.
- HyperMesh Report
- Task Manager
  Use the Task Manager to load an XML file that defines tasks and their attributes.
- HyperMesh
- MotionView
- Templex and Math Reference Guide
- Script and Model Library
  The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.

hwIAMFExportOptions SetQuality

Sets the quality used when exporting AMF files using the JPEG encoder.

Syntax

hwIAMFExportOptions_handle SetQuality quality

Application

HyperView Tcl Modify

Description

This command sets the quality used when exporting AMF files using the JPEG encoder.

Note: This parameter is used when exporting JPEG encoded AMF files from any client during video capture.

Inputs

quality: The quality to be used when exporting JPEG encoded AMF files. This must be between 0 and 100 (exclusive).

Example

To set the current quality used when exporting JPEG encoded AMF files:

hwi GetSessionHandle mySessionName
mySessionName GetAMFExportOptionsHandle myAmfOptions
myAmfOptions SetQuality 90

Errors

Returns 0 if successful, or an error code (3 = HW_InvalidHandle) - if the handle used to invoke the method is no longer valid or

(HW_InvalidArgs) - if the value of the argument quality is not in the range listed above.