Contents

CMAudioFormatDescriptionCreateSummary(allocator:formatDescriptionArray:flags:formatDescriptionOut:)

Creates a summary audio format description from an array of descriptions.

Declaration

func CMAudioFormatDescriptionCreateSummary(allocator: CFAllocator?, formatDescriptionArray: CFArray, flags: UInt32, formatDescriptionOut: UnsafeMutablePointer<CMAudioFormatDescription?>) -> OSStatus

Parameters

  • allocator:

    The allocator to use. Pass kCFAllocatorDefault or NULL to use the default allocator.

  • formatDescriptionArray:

    The array of format descriptions to summarize.

  • flags:

    Pass 0.

  • formatDescriptionOut:

    On output, returns the newly created audio format description.

Return Value

A result code.

Discussion

To kCFAllocatorDefault or NULL to use the default allocator.

The summary format description will be canonical LPCM and deep enough in sample rate, channel layout and channel count to sensibly contain the result of decoding and mixing the constituent format descriptions.

See Also

Working with Audio Descriptions