Control soft video tape recording features for a 2D Graphics window
SoftVTR2D <ScenarioPath> {SoftVTROption} <Value> [{SoftVTROption} <Value>...]
The SoftVTR2D command allows you to set the options for and control the recording of the view in a 2D Graphics window.
{SoftVTROption} and <Parameters> can be:
Note: {SoftVTROptions} can be specified in any order and any number of option can be included in a single command.
| {SoftVTROption} | <Parameters> | Description |
|---|---|---|
| Record | On | Frames will be captured once every animation time step during animation. |
| Off | No frames are recorded and saved during animation. | |
| 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 | BMP | The format in which the files are to be
saved. AVI uses only the prefix and not the numbers, since it
creates only one file.
Note: If file format is <AVI>, Connect does NOT compress the resulting file. |
| RAS | ||
| TIF | ||
| AVI | ||
| WMV | ||
| JPEG | ||
| 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.
Note: 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 |
|---|---|
| WmvCodec "<CodecValue>" | Specify a valid Codec name. For supported Codec names, use the SoftVTR2D_R command. |
| 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. |
To turn recording On:
SoftVTR2D * Record On
To record animation frames in BMP format starting at number 68:
SoftVTR2D * Record On FileFormat BMP StartFromNumber 68
To capture the active 2D Graphics window and save it to the location specified with the prefix specified:
SoftVTR2D * SnapWindow OutputDir "c:\MyTemp" Prefix TestC
To turn off recording:
SoftVTR2D * Record Off
If activated, Connect returns an acknowledgement message.
This command belongs to the following group(s):
7.1
STK Programming Interface 11.0.1