One Logo Pool Ball
CoreMedia · IOS API REFERENCE

CMFormatDescription.Extensions.Key

struct · iOS 13.0+ · SDK 27.1

struct Key

Members (61)

get · iOS 13.0+

verbatimSampleDescription

TypeScript
get verbatimSampleDescription(): CMFormatDescription_Extensions_Key
Swift declaration
static let verbatimSampleDescription: CMFormatDescription.Extensions.Key

Preserves the original SampleDescription data.

get · iOS 13.0+

sampleDescriptionExtensionAtoms

TypeScript
get sampleDescriptionExtensionAtoms(): CMFormatDescription_Extensions_Key
Swift declaration
static let sampleDescriptionExtensionAtoms: CMFormatDescription.Extensions.Key

Sample description extension atoms that were not translated into other entries in the extensions dictionary.

get · iOS 13.0+

metadataKeyTable

TypeScript
get metadataKeyTable(): CMFormatDescription_Extensions_Key
Swift declaration
static let metadataKeyTable: CMFormatDescription.Extensions.Key
get · iOS 13.0+

fieldCount

TypeScript
get fieldCount(): CMFormatDescription_Extensions_Key
Swift declaration
static let fieldCount: CMFormatDescription.Extensions.Key

Number, 1 or 2

get · iOS 13.0+

formatName

TypeScript
get formatName(): CMFormatDescription_Extensions_Key
Swift declaration
static let formatName: CMFormatDescription.Extensions.Key

String

get · iOS 13.0+

gammaLevel

TypeScript
get gammaLevel(): CMFormatDescription_Extensions_Key
Swift declaration
static let gammaLevel: CMFormatDescription.Extensions.Key

Number describing the gamma level, used in absence of (or ignorance of) `transferFunction`

get · iOS 13.0+

iccProfile

TypeScript
get iccProfile(): CMFormatDescription_Extensions_Key
Swift declaration
static let iccProfile: CMFormatDescription.Extensions.Key

Data

get · iOS 13.0+

bytesPerRow

TypeScript
get bytesPerRow(): CMFormatDescription_Extensions_Key
Swift declaration
static let bytesPerRow: CMFormatDescription.Extensions.Key

Number describing the bytes per row of raster pixel data (not used for compressed, planar, tiled or downsampled formats)

get · iOS 13.0+

fieldDetail

TypeScript
get fieldDetail(): CMFormatDescription_Extensions_Key
Swift declaration
static let fieldDetail: CMFormatDescription.Extensions.Key

One of `FieldDetail` values

get · iOS 13.0+

yCbCrMatrix

TypeScript
get yCbCrMatrix(): CMFormatDescription_Extensions_Key
Swift declaration
static let yCbCrMatrix: CMFormatDescription.Extensions.Key

Describes the color matrix for YCbCr->RGB. One of `YCbCrMatrix` values

get · iOS 13.0+

defaultStyle

TypeScript
get defaultStyle(): CMFormatDescription_Extensions_Key
Swift declaration
static let defaultStyle: CMFormatDescription.Extensions.Key

Use `qtTextDefaultStyle(startChar:height:ascent:localFontID:fontFace:fontSize:foregroundColor:defaultFontName:)` or `mobile3GPPTextDefaultStyle(startChar:endChar:localFontID:fontFace:fontSize:foregroundColor:)

get · iOS 13.0+

displayFlags

TypeScript
get displayFlags(): CMFormatDescription_Extensions_Key
Swift declaration
static let displayFlags: CMFormatDescription.Extensions.Key

Use `textDisplayFlags(_:)`

get · iOS 13.0+

cleanAperture

TypeScript
get cleanAperture(): CMFormatDescription_Extensions_Key
Swift declaration
static let cleanAperture: CMFormatDescription.Extensions.Key

Use `.cleanAperture(width:height:horizontalOffet:verticalOffset:)`

get · iOS 13.0+

revisionLevel

TypeScript
get revisionLevel(): CMFormatDescription_Extensions_Key
Swift declaration
static let revisionLevel: CMFormatDescription.Extensions.Key

Number

get · iOS 13.0+

colorPrimaries

TypeScript
get colorPrimaries(): CMFormatDescription_Extensions_Key
Swift declaration
static let colorPrimaries: CMFormatDescription.Extensions.Key

Describes the color primaries. One of `ColorPrimaries` values

get · iOS 13.0+

defaultTextBox

TypeScript
get defaultTextBox(): CMFormatDescription_Extensions_Key
Swift declaration
static let defaultTextBox: CMFormatDescription.Extensions.Key

Use `textRect(top:left:bottom:right:)`

get · iOS 13.0+

fullRangeVideo

TypeScript
get fullRangeVideo(): CMFormatDescription_Extensions_Key
Swift declaration
static let fullRangeVideo: CMFormatDescription.Extensions.Key

Boolean; by default, `false` for YCbCr-based compressed formats, indicating that pixel values are video-range rather than full-range

get · iOS 18.0+

projectionKind

TypeScript
get projectionKind(): CMFormatDescription_Extensions_Key
Swift declaration
@backDeployed(before: macOS 26.0, iOS 26.0, visionOS 26.0)
static var projectionKind: CMFormatDescription.Extensions.Key { get }

Indicates the projection that should be applied to presented decoded video frames.

get · iOS 13.0+

spatialQuality

TypeScript
get spatialQuality(): CMFormatDescription_Extensions_Key
Swift declaration
static let spatialQuality: CMFormatDescription.Extensions.Key

Number

get · iOS 13.0+

backgroundColor

TypeScript
get backgroundColor(): CMFormatDescription_Extensions_Key
Swift declaration
static let backgroundColor: CMFormatDescription.Extensions.Key

Use `qtTextColor(red:green:blue:alpha:)` or `mobile3GPPTextColor(red:green:blue:alpha:)

get · iOS 13.0+

defaultFontName

TypeScript
get defaultFontName(): CMFormatDescription_Extensions_Key
Swift declaration
static let defaultFontName: CMFormatDescription.Extensions.Key

String

get · iOS 13.0+

temporalQuality

TypeScript
get temporalQuality(): CMFormatDescription_Extensions_Key
Swift declaration
static let temporalQuality: CMFormatDescription.Extensions.Key

Number

get · iOS 26.0+

viewPackingKind

TypeScript
get viewPackingKind(): CMFormatDescription_Extensions_Key
Swift declaration
static let viewPackingKind: CMFormatDescription.Extensions.Key

Indicates the packing type of stereoscopic video frames.

get · iOS 13.0+

alphaChannelMode

TypeScript
get alphaChannelMode(): CMFormatDescription_Extensions_Key
Swift declaration
static let alphaChannelMode: CMFormatDescription.Extensions.Key

One of `AlphaChannelMode` values

get · iOS 15.0+

bitsPerComponent

TypeScript
get bitsPerComponent(): CMFormatDescription_Extensions_Key
Swift declaration
static let bitsPerComponent: CMFormatDescription.Extensions.Key

Number (such as 8, 10, 12, 16, etc).

get · iOS 13.0+

pixelAspectRatio

TypeScript
get pixelAspectRatio(): CMFormatDescription_Extensions_Key
Swift declaration
static let pixelAspectRatio: CMFormatDescription.Extensions.Key

Use `.pixelAspectRatio(horizontalSpacing:verticalSpacing:)`

get · iOS 13.0+

transferFunction

TypeScript
get transferFunction(): CMFormatDescription_Extensions_Key
Swift declaration
static let transferFunction: CMFormatDescription.Extensions.Key

Describes the transfer function. One of `TransferFunction` values

get · iOS 13.0+

auxiliaryTypeInfo

TypeScript
get auxiliaryTypeInfo(): CMFormatDescription_Extensions_Key
Swift declaration
static let auxiliaryTypeInfo: CMFormatDescription.Extensions.Key

String (Auxiliary type URN)

get · iOS 13.0+

textJustification

TypeScript
get textJustification(): CMFormatDescription_Extensions_Key
Swift declaration
static let textJustification: CMFormatDescription.Extensions.Key

Use `textJustification(_:)`. Specific to `.qt`

get · iOS 17.0+

contentColorVolume

TypeScript
get contentColorVolume(): CMFormatDescription_Extensions_Key
Swift declaration
@backDeployed(before: macOS 26.0, iOS 26.0, tvOS 26.0, watchOS 26.0, visionOS 26.0)
static var contentColorVolume: CMFormatDescription.Extensions.Key { get }

Matches payload of ITU-T-H.265:11/2019, D.2.40 Content Colour Volume SEI message. The value of this key is of ``Value/ContentColorVolume`` type.

get · iOS 17.0+

hasAdditionalViews

TypeScript
get hasAdditionalViews(): CMFormatDescription_Extensions_Key
Swift declaration
@backDeployed(before: macOS 26.0, iOS 26.0, visionOS 26.0)
static var hasAdditionalViews: CMFormatDescription.Extensions.Key { get }

A boolean indicating that one or more additional views may be present beyond stereo left and stereo right eyes (e.g,. a “centerline” view).

get · iOS 17.2+

logTransferFunction

TypeScript
get logTransferFunction(): CMFormatDescription_Extensions_Key
Swift declaration
@backDeployed(before: macOS 26.0, iOS 26.0, tvOS 26.0, watchOS 26.0, visionOS 26.0)
static var logTransferFunction: CMFormatDescription.Extensions.Key { get }

Indicates that the transfer function or gamma of the content is a log format and identifies the specific log curve.

get · iOS 13.0+

sourceReferenceName

TypeScript
get sourceReferenceName(): CMFormatDescription_Extensions_Key
Swift declaration
static let sourceReferenceName: CMFormatDescription.Extensions.Key

Use `sourceReferenceName(value:langCode:)`

get · iOS 13.0+

containsAlphaChannel

TypeScript
get containsAlphaChannel(): CMFormatDescription_Extensions_Key
Swift declaration
static let containsAlphaChannel: CMFormatDescription.Extensions.Key

Boolean; used to signal the presence of alpha channel in the bitstream

get · iOS 17.0+

hasLeftStereoEyeView

TypeScript
get hasLeftStereoEyeView(): CMFormatDescription_Extensions_Key
Swift declaration
@backDeployed(before: macOS 26.0, iOS 26.0, visionOS 26.0)
static var hasLeftStereoEyeView: CMFormatDescription.Extensions.Key { get }

A boolean indicating the stereo left eye is present in video frames.

get · iOS 17.0+

stereoCameraBaseline

TypeScript
get stereoCameraBaseline(): CMFormatDescription_Extensions_Key
Swift declaration
@backDeployed(before: macOS 26.0, iOS 26.0, visionOS 26.0)
static var stereoCameraBaseline: CMFormatDescription.Extensions.Key { get }

Indicates the distance between centers of the lenses of the camera system. The value is a CFNumber holding an unsigned 32-bit integer that is interpreted in micrometers or thousandths of a millimeter (e.g., 63123 is 63.123 millimeters). This property is optional and should only be specified if the distance is known.

get · iOS 13.0+

contentLightLevelInfo

TypeScript
get contentLightLevelInfo(): CMFormatDescription_Extensions_Key
Swift declaration
static let contentLightLevelInfo: CMFormatDescription.Extensions.Key

Data(4 bytes); big-endian structure; same as `kCVImageBufferContentLightLevelInfoKey`

get · iOS 17.0+

hasRightStereoEyeView

TypeScript
get hasRightStereoEyeView(): CMFormatDescription_Extensions_Key
Swift declaration
@backDeployed(before: macOS 26.0, iOS 26.0, visionOS 26.0)
static var hasRightStereoEyeView: CMFormatDescription.Extensions.Key { get }

A boolean indicating the stereo right eye is present in video frames.

get · iOS 15.0+

horizontalFieldOfView

TypeScript
get horizontalFieldOfView(): CMFormatDescription_Extensions_Key
Swift declaration
@backDeployed(before: macOS 26.0, iOS 26.0, tvOS 26.0, watchOS 26.0, visionOS 26.0)
static var horizontalFieldOfView: CMFormatDescription.Extensions.Key { get }

Horizontal field of view in thousandths of a degree (i.e., 123456 is 123.456 degrees).

get · iOS 13.0+

verticalJustification

TypeScript
get verticalJustification(): CMFormatDescription_Extensions_Key
Swift declaration
static let verticalJustification: CMFormatDescription.Extensions.Key

Use `textJustification(_:)`. Specific to `.mobile3GPP`

get · iOS 13.0+

chromaLocationTopField

TypeScript
get chromaLocationTopField(): CMFormatDescription_Extensions_Key
Swift declaration
static let chromaLocationTopField: CMFormatDescription.Extensions.Key

Chroma siting information. For progressive images, only the TopField value is used. One of `ChromaLocation` values

get · iOS 13.0+

verbatimISOSampleEntry

TypeScript
get verbatimISOSampleEntry(): CMFormatDescription_Extensions_Key
Swift declaration
static let verbatimISOSampleEntry: CMFormatDescription.Extensions.Key

Preserves the original ISOSampleEntry data.

get · iOS 13.0+

horizontalJustification

TypeScript
get horizontalJustification(): CMFormatDescription_Extensions_Key
Swift declaration
static let horizontalJustification: CMFormatDescription.Extensions.Key

Use `textJustification(_:)`. Specific to `.mobile3GPP`

get · iOS 15.0+

ambientViewingEnvironment

TypeScript
get ambientViewingEnvironment(): CMFormatDescription_Extensions_Key
Swift declaration
static let ambientViewingEnvironment: CMFormatDescription.Extensions.Key

Data(8 bytes); big-endian structure; same as kCVImageBufferAmbientViewingEnvironmentKey; matches payload of ISO/IEC 23008-2:2017, D.2.39 ambient viewing environment SEI message

get · iOS 13.0+

chromaLocationBottomField

TypeScript
get chromaLocationBottomField(): CMFormatDescription_Extensions_Key
Swift declaration
static let chromaLocationBottomField: CMFormatDescription.Extensions.Key

Chroma siting information. For progressive images, only the TopField value is used. One of `ChromaLocation` values

get · iOS 13.0+

conformsToMPEG2VideoProfile

TypeScript
get conformsToMPEG2VideoProfile(): CMFormatDescription_Extensions_Key
Swift declaration
static let conformsToMPEG2VideoProfile: CMFormatDescription.Extensions.Key

One of `MPEG2VideoProfile` values

get · iOS 13.0+

masteringDisplayColorVolume

TypeScript
get masteringDisplayColorVolume(): CMFormatDescription_Extensions_Key
Swift declaration
static let masteringDisplayColorVolume: CMFormatDescription.Extensions.Key

Data (24 bytes); big-endian structure; same as `kCVImageBufferMasteringDisplayColorVolumeKey`; matches payload of ISO/IEC 23008-2:2015(E), D.2.28 Mastering display colour volume SEI message

get · iOS 13.0+

originalCompressionSettings

TypeScript
get originalCompressionSettings(): CMFormatDescription_Extensions_Key
Swift declaration
static let originalCompressionSettings: CMFormatDescription.Extensions.Key

This extension contains a media-type-specific dictionary of settings used to produce a compressed media buffer.

get · iOS 17.0+

horizontalDisparityAdjustment

TypeScript
get horizontalDisparityAdjustment(): CMFormatDescription_Extensions_Key
Swift declaration
@backDeployed(before: macOS 26.0, iOS 26.0, visionOS 26.0)
static var horizontalDisparityAdjustment: CMFormatDescription.Extensions.Key { get }

Indicates a relative shift of the left and right images, which changes the zero parallax plane. The value encoded in normalized image space is a signed 32-bit integer measured over the range of -10000 to 10000 mapping to the uniform range [-1.0...1.0]. The interval of 0.0 to 1.0 or 0 to 10000 maps onto the stereo eye view image width. The negative interval 0.0 to -1.0 or 0 to -10000 similarly maps onto the stereo eye view image width. The default value of 0 is interpreted if this property is not set. If the property is not set, NULL may be set and retrieved. The NULL value should be interpreted as meaning 0. This property is optional and should only be specified if a disparity adjustment including 0 is known.

get · iOS 14.0+

protectedContentOriginalFormat

TypeScript
get protectedContentOriginalFormat(): CMFormatDescription_Extensions_Key
Swift declaration
@backDeployed(before: macOS 26.0, iOS 26.0, tvOS 26.0, watchOS 26.0, visionOS 26.0)
static var protectedContentOriginalFormat: CMFormatDescription.Extensions.Key { get }

FourCharCode number representing the original format

get · iOS 13.0+

alternativeTransferCharacteristics

TypeScript
get alternativeTransferCharacteristics(): CMFormatDescription_Extensions_Key
Swift declaration
static let alternativeTransferCharacteristics: CMFormatDescription.Extensions.Key

String (usually `TransferFunction.itu_R_2100_HLG` when used); corresponds to D.2.38 Alternative Transfer Characteristics SEI message

get · iOS 26.0+

convertedFromExternalSphericalTags

TypeScript
get convertedFromExternalSphericalTags(): CMFormatDescription_Extensions_Key
Swift declaration
static let convertedFromExternalSphericalTags: CMFormatDescription.Extensions.Key

Indicates that the image description contains projected media data converted from an external format. This format description extension is included if boxes containing external stereoscopic or spherical projection information were parsed.

get · iOS 26.0+

cameraCalibrationDataLensCollection

TypeScript
get cameraCalibrationDataLensCollection(): CMFormatDescription_Extensions_Key
Swift declaration
static let cameraCalibrationDataLensCollection: CMFormatDescription.Extensions.Key

Specifies intrinsic and extrinsic parameters for single or multiple lenses. The value for this key is represented by ``Value/CameraCalibrationDataLensCollection`` type.

get · iOS 13.0+

depth

TypeScript
get depth(): CMFormatDescription_Extensions_Key
Swift declaration
static let depth: CMFormatDescription.Extensions.Key

Number with depth value as directed by http://developer.apple.com/qa/qa2001/qa1183.html

get · iOS 13.0+

vendor

TypeScript
get vendor(): CMFormatDescription_Extensions_Key
Swift declaration
static let vendor: CMFormatDescription.Extensions.Key

String of fourCC

get · iOS 17.0+

heroEye

TypeScript
get heroEye(): CMFormatDescription_Extensions_Key
Swift declaration
@backDeployed(before: macOS 26.0, iOS 26.0, visionOS 26.0)
static var heroEye: CMFormatDescription.Extensions.Key { get }

Indicates which of the two eyes should be used as the primary when rendering in 2D. It is usually perpendicular to the target image surface.

get · iOS 13.0+

version

TypeScript
get version(): CMFormatDescription_Extensions_Key
Swift declaration
static let version: CMFormatDescription.Extensions.Key

Number

init · iOS 13.0+

init

TypeScript
init(rawValue: _CoreFoundation_CFString): CMFormatDescription_Extensions_Key
Swift declaration
init(rawValue: CFString)

Creates a new `Key` backed by `rawValue`

get · iOS 13.0+

rawValue

TypeScript
getRawValue($self: CMFormatDescription_Extensions_Key): _CoreFoundation_CFString
Swift declaration
var rawValue: CFString

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

set · iOS 13.0+

rawValue

TypeScript
setRawValue($self: CMFormatDescription_Extensions_Key, value: _CoreFoundation_CFString): void
Swift declaration
var rawValue: CFString

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

get · iOS 13.0+

fontTable

TypeScript
get fontTable(): CMFormatDescription_Extensions_Key
Swift declaration
static let fontTable: CMFormatDescription.Extensions.Key

Use `fontTable(_:)`. Specific to `.mobile3GPP`

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

CMFormatDescription.Extensions.Key

The iOS SDK compiler rejected this binding: type 'CMFormatDescription.Extensions.Key' does not conform to protocol 'OneSDKNamedConstants'

All CoreMedia types →