Contents

kAudioFormatProperty_ValidateChannelLayout

The validity of an audio channel layout structure.

Declaration

var kAudioFormatProperty_ValidateChannelLayout: AudioFormatPropertyID { get }

Discussion

Indicates the validity of the AudioChannelLayout struct provided as the specifier. The property value and size are not used and must be set to NULL. This is useful if the layout has come from an untrusted source such as a file. It returns noErr if the AudioChannelLayout is OK, kAudio_ParamError if there is a structural problem with the layout, or kAudioFormatUnknownFormatError for unrecognized layout tags or channel labels.

If the layout tag is kAudioChannelLayoutTag_UseChannelDescriptions it returns the number of channel descriptions.

See Also

Constants