AudioConverterNew(_:_:_:)

Declaration

func AudioConverterNew(_ inSourceFormat: UnsafePointer<AudioStreamBasicDescription>, _ inDestinationFormat: UnsafePointer<AudioStreamBasicDescription>, _ outAudioConverter: UnsafeMutablePointer<AudioConverterRef?>) -> OSStatus

Parameters

• inSourceFormat:

  The format of the source audio to be converted.

• inDestinationFormat:

  The destination format to which the audio is to be converted.

• outAudioConverter:

  On return, a new audio converter object.

Return Value

A result code.

Discussion

For a pair of linear PCM formats, the following conversions are supported:

• Addition and removal of channels, when the input and output format mChannelsPerFrame fields do not match. Channels may also be reordered and removed using the kAudioConverterChannelMap property.

• Sample rate conversion.

• Interleaving and deinterleaving, when the input and output format (mFormatFlags & kAudioFormatFlagIsNonInterleaved) values do not match.

• Conversion between any pair of the following formats:

• 8-bit integer, signed or unsigned.

• 16-, 24-, or 32-bit integer, big- or little-endian. Other integral bit depths, if high-aligned and nonpacked, are also supported

• 32- and 64-bit floating point, big- or little-endian.

Encoding and decoding between linear PCM and compressed formats is supported. Functions in Audio Format Services (AudioToolbox/AudioFormat.h) return information about the formats supported on a system. When using a codec, you can use any supported PCM format. The converter object performs any necessary additional conversion between your PCM format and the one created or consumed by the codec.

See Also

Managing Audio Converter Objects

• AudioConverterNewSpecific(_:_:_:_:_:)
• AudioConverterReset(_:)
• AudioConverterDispose(_:)