GetAudioItemInfo

Gets information about an audio item.

Synopsis

Err GetAudioItemInfo (Item audioItem, TagArg *tagList)

Description

This function queries settings of several kinds of audio items. 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.

SetAudioItemInfo() can be used to set audio item parameters.

Arguments

audioItem: Item number of an audio item to query.

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 item. See each audio Item pages for list of tags that are supported by each item type.

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 item.

Implementation

Folio call implemented in Audio folio V20.

Caveats

Not all audio Item types support being queried in this way. Those that don't support it, return AF_ERR_UNIMPLEMENTED.

Associated Files

audio.h