Function

CMFormatDescriptionGetExtension

Returns the specified extension of a CMFormatDescription.

Declaration

CFPropertyListRef CMFormatDescriptionGetExtension(CMFormatDescriptionRef desc, CFStringRef extensionKey);

Parameters

desc

CMFormatDescription being interrogated.

extensionKey

Key of extension to be returned. Cannot be NULL.

Return Value

The specified extension of the CMFormatDescription. May be NULL.

Discussion

If the named extension does not exist, NULL is returned. The extension is always a valid property list object. This means that it will be either a CFNumber, CFString, CFBoolean, CFArray, CFDictionary, CFDate, or CFData. If it is a CFDictionary, the keys will all be CFStrings. The returned extension is not retained by this call, so it is only valid as long as the CMFormatDescription is valid. Clients are required to retain it if they need to keep it longer.

See Also

Common Functions

CMFormatDescriptionCreate

Creates a generic CMFormatDescription object. You should not call this method for the media types that has specific create functions such as audio, video, text, muxed, metaData and timeCode.

CMFormatDescriptionEqual

Compares two CMFormatDescription objects for equality.

CMFormatDescriptionEqualIgnoringExtensionKeys

Compares two CMFormatDescription objects for equality, ignoring differences in the specified lists of format description extension keys and sample description extension keys.

CMFormatDescriptionGetExtensions

Returns an immutable dictionary containing all the extensions of a CMFormatDescription.

CMFormatDescriptionGetMediaSubType

Returns the media subtype of a CMFormatDescription.

CMFormatDescriptionGetMediaType

Returns the media type of a CMFormatDescription.

CMFormatDescriptionGetTypeID

Returns the CFTypeID of CMFormatDescription objects.