RecordMovie2D
Control movie recording features for a 2D Graphics window
Syntax
RecordMovie2D <ScenarioPath> {MovieOption} <Value> [{MovieOption} <Value>...]
Related commands
Description
The RecordMovie2D command allows you to set the options for and control the recording of the view in a 2D Graphics window.
{MovieOptions} can be specified in any order and any number of options can be included in a single command.
| {MovieOption} | <Parameters> | Description |
|---|---|---|
| Record | {On | Off | Parallel} | On indicates frames will be captured once every animation time step during animation.
Off indicates no frames are recorded and saved during animation. Using the Parallel option begins recording the movie using STK Parallel Computing. |
| OutputDir | "<DirectoryPath>" | The directory in which images of individual frames will be saved. |
| Prefix | <String> | A string that will prefix each image's file name. |
| StartFromNumber | <Number> | The first number in the file sequence. The frame number increases incrementally for each subsequent frame saved. This number follows the prefix in the file name. |
| FileFormat | The format in which the files are to be saved. H264, WMV, and ProRes use only the prefix and not the numbers, since they generate a video file instead of individual image files. | |
| PNG | ||
| BMP | ||
| TIF | ||
| JPEG | ||
| H264 | ||
| WMV | ||
| ProRes | ||
| MinDigits | <NumDigits> | The minimum number of digits to be used when naming a file. For instance, if the <NumDigits> is 2, file names are saved with the prefix plus a number from 01 to 99. When 99 is reached, STK begins overwriting files from 01 again. |
| SnapWindow | N/A | Saves a picture of the current 2D Graphics window using the file naming options set here.
If the SnapWindow option is included in the command with other recording options, recording options will be set before the window is snapped. |
| WindowID | <WinNumber> | Enter the number of the 2D Graphics window to which the changes should be applied. |
The following options are available if the FileFormat is WMV (Windows Media Video).
| Option | Description |
|---|---|
| FrameRate <Rate> | Enter the value in frames per second. <Rate> is an integer greater than 0. |
| BitRate <Rate> | Enter the value in kilobits per second. <Rate> is an integer greater than 0. |
Examples
To turn recording On:
To record animation frames in BMP format starting at number 68:
To capture the active 2D Graphics window and save it to the location specified with the prefix specified:
To turn off recording:
Return message
Group membership
This command belongs to the following group(s):
Version
11.5