classHOutputInfo 02
Member Function Documentation
| String HOutputInfo::GetApplicationID |
( |
|
) |
|
|
|
|
| |
Returns a string containing "Hash Animation:Master vn" where vn is the A:M version number. |
| int HOutputInfo::GetAudioFrequency |
( |
|
) |
|
|
|
|
| |
Returns the audio sampling frequency in samples per second. |
| String HOutputInfo::GetEmail |
( |
|
) |
|
|
|
|
| |
Returns a string containing the user email address. |
| int HOutputInfo::GetEndTime |
( |
|
) |
|
|
| |
Returns the "Output option" -> "Range" -> "End" setting in Frame number.
The first frame being frame 0. |
| int HOutputInfo::GetFPS |
( |
|
) |
|
|
|
|
| |
Returns choreography Frame Per Seconds setting. |
| int HOutputInfo::GetGammaPreset |
( |
|
) |
|
|
| |
One of the Gamma presets, the most characteristic being sRGB (or NTSC).
- See also:
-
GetOutputGamma()
GammaType for a description of the different Gamma presets.
|
| BOOL HOutputInfo::GetIsAlpha |
( |
|
) |
|
|
|
|
| |
Returns TRUE if user requested that the alpha channel be saved in the file. |
| BOOL HOutputInfo::GetIsAudioStereo |
( |
|
) |
|
|
|
|
| |
Returns TRUE if the audio recording is in stereo. This my be used by movie file IO such as QuickTime, AVI etc. |
| String HOutputInfo::GetOrganization |
( |
|
) |
|
|
|
|
| |
Returns a string containing the user organisation (company, institution, etc). |
| float HOutputInfo::GetOutputGamma |
( |
|
) |
|
|
| |
Returns the Gamma value for image data correction prior to storing to file.
The Gamma value returned by GetOutputGamma() will match the preset. However, except for GAMMA_CUSTOM, the Gamma presets follow relatively specific ways of correcting the image data. For instance, although GetOutputGamma() will return 2.2 for GAMMA_NTSC, this only an approximation. The actual correction should follow the CIE Rec 709.
- See also:
-
GammaType for a description of the different Gamma presets.
|
| int HOutputInfo::GetStartTime |
( |
|
) |
|
|
| |
Returns the "Output option" -> "Range" -> "Start" setting in Frame number.
The first frame being frame 0. |
| int HOutputInfo::GetStep |
( |
|
) |
|
|
| |
Returns the "Output option" -> "Range" -> "Step" setting.
Thi represent the difference between the rendered frame numbers. |
| int HOutputInfo::GetTime |
( |
|
) |
|
|
|
|
| |
Returns the currently rendered frame number. |
| String HOutputInfo::GetURL |
( |
|
) |
|
|
|
|
| |
Returns a string containing the user URL (web page). |
| String HOutputInfo::GetUser |
( |
|
) |
|
|
|
|
| |
Returns A string containing the user name to be store as metadata in output files. |
| float HOutputInfo::GetViewGamma |
( |
|
) |
|
|
| |
Gamma value of the user display setting.
- Note:
-
This functionality is currently not implemented.
|
The documentation for this class was generated from the following files:
This A:M SDK v12.0 documentation is maintained by Hash Inc. Please address any comments concerning this documentation to AMReports. If yo