GetAudioFolioInfo
Get system-wide audio settings.
Synopsis
Err GetAudioFolioInfo (TagArg *tagList)
Description
Queries Audio folio for certain system-wide settings. It takes a tag list with the ta_Tag fields set to parameters to query and fills in the ta_Arg field of each TagArg with the parameter requested by that TagArg.
For normal multiplayers, these settings are set to the described normal values during startup. Other kinds of hardware or execution environments (e.g. cable) may have different settings.
None of these parameters can be set directly by an application.
Arguments
- tagList
- Pointer to tag list containing AF_TAG_ tags to query. The ta_Arg fields of each matched tag is filled in with the corresponding setting from the Audio folio.
Tags
- AF_TAG_SAMPLE_RATE
- (frac16) Returns the DSP's sample rate in samples/second expressed as a 16.16 value. Normally this is 44,100 samples/second. For certain cable applications this can be 48,000 samples/second. When the sample rate is something other than 44,100, substitute this to everywhere in the audio documentation that specifies the sample rate as 44,100 samples/second. If your application needs to cope with variable DSP sample rate and you have need the sample rate for something, then you should read this value from here rather than hardcoding 44,100, or any other sample rate, into your code.
- AF_TAG_AMPLITUDE
- (uint32) Returns the Audio folio's master volume level. Normally this is 0x7fff.
Return Value
The function returns a non-negative value if successful or an error code (a negative value) if an error occurs.
Returns AF_ERR_BADTAG if this function is passed any tag that is not listed above.
Additional Results
Fills in the ta_Arg field of each matched TagArg in tagList with the corresponding setting from the Audio folio.
Implementation
Folio call implemented in Audio folio V24.
Associated Files
audio.h
See Also
GetAudioItemInfo()