verbatimSampleDescription
TypeScriptget verbatimSampleDescription(): CMFormatDescription_Extensions_KeySwift declarationstatic let verbatimSampleDescription: CMFormatDescription.Extensions.KeyPreserves the original SampleDescription data.
struct · iOS 13.0+ · SDK 27.1
struct Keyget verbatimSampleDescription(): CMFormatDescription_Extensions_KeySwift declarationstatic let verbatimSampleDescription: CMFormatDescription.Extensions.KeyPreserves the original SampleDescription data.
get sampleDescriptionExtensionAtoms(): CMFormatDescription_Extensions_KeySwift declarationstatic let sampleDescriptionExtensionAtoms: CMFormatDescription.Extensions.KeySample description extension atoms that were not translated into other entries in the extensions dictionary.
get metadataKeyTable(): CMFormatDescription_Extensions_KeySwift declarationstatic let metadataKeyTable: CMFormatDescription.Extensions.Keyget fieldCount(): CMFormatDescription_Extensions_KeySwift declarationstatic let fieldCount: CMFormatDescription.Extensions.KeyNumber, 1 or 2
get formatName(): CMFormatDescription_Extensions_KeySwift declarationstatic let formatName: CMFormatDescription.Extensions.KeyString
get gammaLevel(): CMFormatDescription_Extensions_KeySwift declarationstatic let gammaLevel: CMFormatDescription.Extensions.KeyNumber describing the gamma level, used in absence of (or ignorance of) `transferFunction`
get iccProfile(): CMFormatDescription_Extensions_KeySwift declarationstatic let iccProfile: CMFormatDescription.Extensions.KeyData
get bytesPerRow(): CMFormatDescription_Extensions_KeySwift declarationstatic let bytesPerRow: CMFormatDescription.Extensions.KeyNumber describing the bytes per row of raster pixel data (not used for compressed, planar, tiled or downsampled formats)
get fieldDetail(): CMFormatDescription_Extensions_KeySwift declarationstatic let fieldDetail: CMFormatDescription.Extensions.KeyOne of `FieldDetail` values
get yCbCrMatrix(): CMFormatDescription_Extensions_KeySwift declarationstatic let yCbCrMatrix: CMFormatDescription.Extensions.KeyDescribes the color matrix for YCbCr->RGB. One of `YCbCrMatrix` values
get defaultStyle(): CMFormatDescription_Extensions_KeySwift declarationstatic let defaultStyle: CMFormatDescription.Extensions.KeyUse `qtTextDefaultStyle(startChar:height:ascent:localFontID:fontFace:fontSize:foregroundColor:defaultFontName:)` or `mobile3GPPTextDefaultStyle(startChar:endChar:localFontID:fontFace:fontSize:foregroundColor:)
get displayFlags(): CMFormatDescription_Extensions_KeySwift declarationstatic let displayFlags: CMFormatDescription.Extensions.KeyUse `textDisplayFlags(_:)`
get cleanAperture(): CMFormatDescription_Extensions_KeySwift declarationstatic let cleanAperture: CMFormatDescription.Extensions.KeyUse `.cleanAperture(width:height:horizontalOffet:verticalOffset:)`
get revisionLevel(): CMFormatDescription_Extensions_KeySwift declarationstatic let revisionLevel: CMFormatDescription.Extensions.KeyNumber
get colorPrimaries(): CMFormatDescription_Extensions_KeySwift declarationstatic let colorPrimaries: CMFormatDescription.Extensions.KeyDescribes the color primaries. One of `ColorPrimaries` values
get defaultTextBox(): CMFormatDescription_Extensions_KeySwift declarationstatic let defaultTextBox: CMFormatDescription.Extensions.KeyUse `textRect(top:left:bottom:right:)`
get fullRangeVideo(): CMFormatDescription_Extensions_KeySwift declarationstatic let fullRangeVideo: CMFormatDescription.Extensions.KeyBoolean; by default, `false` for YCbCr-based compressed formats, indicating that pixel values are video-range rather than full-range
get projectionKind(): CMFormatDescription_Extensions_KeySwift 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 spatialQuality(): CMFormatDescription_Extensions_KeySwift declarationstatic let spatialQuality: CMFormatDescription.Extensions.KeyNumber
get backgroundColor(): CMFormatDescription_Extensions_KeySwift declarationstatic let backgroundColor: CMFormatDescription.Extensions.KeyUse `qtTextColor(red:green:blue:alpha:)` or `mobile3GPPTextColor(red:green:blue:alpha:)
get defaultFontName(): CMFormatDescription_Extensions_KeySwift declarationstatic let defaultFontName: CMFormatDescription.Extensions.KeyString
get temporalQuality(): CMFormatDescription_Extensions_KeySwift declarationstatic let temporalQuality: CMFormatDescription.Extensions.KeyNumber
get viewPackingKind(): CMFormatDescription_Extensions_KeySwift declarationstatic let viewPackingKind: CMFormatDescription.Extensions.KeyIndicates the packing type of stereoscopic video frames.
get alphaChannelMode(): CMFormatDescription_Extensions_KeySwift declarationstatic let alphaChannelMode: CMFormatDescription.Extensions.KeyOne of `AlphaChannelMode` values
get bitsPerComponent(): CMFormatDescription_Extensions_KeySwift declarationstatic let bitsPerComponent: CMFormatDescription.Extensions.KeyNumber (such as 8, 10, 12, 16, etc).
get pixelAspectRatio(): CMFormatDescription_Extensions_KeySwift declarationstatic let pixelAspectRatio: CMFormatDescription.Extensions.KeyUse `.pixelAspectRatio(horizontalSpacing:verticalSpacing:)`
get transferFunction(): CMFormatDescription_Extensions_KeySwift declarationstatic let transferFunction: CMFormatDescription.Extensions.KeyDescribes the transfer function. One of `TransferFunction` values
get auxiliaryTypeInfo(): CMFormatDescription_Extensions_KeySwift declarationstatic let auxiliaryTypeInfo: CMFormatDescription.Extensions.KeyString (Auxiliary type URN)
get textJustification(): CMFormatDescription_Extensions_KeySwift declarationstatic let textJustification: CMFormatDescription.Extensions.KeyUse `textJustification(_:)`. Specific to `.qt`
get contentColorVolume(): CMFormatDescription_Extensions_KeySwift 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 hasAdditionalViews(): CMFormatDescription_Extensions_KeySwift 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 logTransferFunction(): CMFormatDescription_Extensions_KeySwift 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 sourceReferenceName(): CMFormatDescription_Extensions_KeySwift declarationstatic let sourceReferenceName: CMFormatDescription.Extensions.KeyUse `sourceReferenceName(value:langCode:)`
get containsAlphaChannel(): CMFormatDescription_Extensions_KeySwift declarationstatic let containsAlphaChannel: CMFormatDescription.Extensions.KeyBoolean; used to signal the presence of alpha channel in the bitstream
get hasLeftStereoEyeView(): CMFormatDescription_Extensions_KeySwift 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 stereoCameraBaseline(): CMFormatDescription_Extensions_KeySwift 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 contentLightLevelInfo(): CMFormatDescription_Extensions_KeySwift declarationstatic let contentLightLevelInfo: CMFormatDescription.Extensions.KeyData(4 bytes); big-endian structure; same as `kCVImageBufferContentLightLevelInfoKey`
get hasRightStereoEyeView(): CMFormatDescription_Extensions_KeySwift 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 horizontalFieldOfView(): CMFormatDescription_Extensions_KeySwift 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 verticalJustification(): CMFormatDescription_Extensions_KeySwift declarationstatic let verticalJustification: CMFormatDescription.Extensions.KeyUse `textJustification(_:)`. Specific to `.mobile3GPP`
get chromaLocationTopField(): CMFormatDescription_Extensions_KeySwift declarationstatic let chromaLocationTopField: CMFormatDescription.Extensions.KeyChroma siting information. For progressive images, only the TopField value is used. One of `ChromaLocation` values
get verbatimISOSampleEntry(): CMFormatDescription_Extensions_KeySwift declarationstatic let verbatimISOSampleEntry: CMFormatDescription.Extensions.KeyPreserves the original ISOSampleEntry data.
get horizontalJustification(): CMFormatDescription_Extensions_KeySwift declarationstatic let horizontalJustification: CMFormatDescription.Extensions.KeyUse `textJustification(_:)`. Specific to `.mobile3GPP`
get ambientViewingEnvironment(): CMFormatDescription_Extensions_KeySwift declarationstatic let ambientViewingEnvironment: CMFormatDescription.Extensions.KeyData(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 chromaLocationBottomField(): CMFormatDescription_Extensions_KeySwift declarationstatic let chromaLocationBottomField: CMFormatDescription.Extensions.KeyChroma siting information. For progressive images, only the TopField value is used. One of `ChromaLocation` values
get conformsToMPEG2VideoProfile(): CMFormatDescription_Extensions_KeySwift declarationstatic let conformsToMPEG2VideoProfile: CMFormatDescription.Extensions.KeyOne of `MPEG2VideoProfile` values
get masteringDisplayColorVolume(): CMFormatDescription_Extensions_KeySwift declarationstatic let masteringDisplayColorVolume: CMFormatDescription.Extensions.KeyData (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 originalCompressionSettings(): CMFormatDescription_Extensions_KeySwift declarationstatic let originalCompressionSettings: CMFormatDescription.Extensions.KeyThis extension contains a media-type-specific dictionary of settings used to produce a compressed media buffer.
get horizontalDisparityAdjustment(): CMFormatDescription_Extensions_KeySwift 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 protectedContentOriginalFormat(): CMFormatDescription_Extensions_KeySwift 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 alternativeTransferCharacteristics(): CMFormatDescription_Extensions_KeySwift declarationstatic let alternativeTransferCharacteristics: CMFormatDescription.Extensions.KeyString (usually `TransferFunction.itu_R_2100_HLG` when used); corresponds to D.2.38 Alternative Transfer Characteristics SEI message
get convertedFromExternalSphericalTags(): CMFormatDescription_Extensions_KeySwift declarationstatic let convertedFromExternalSphericalTags: CMFormatDescription.Extensions.KeyIndicates 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 cameraCalibrationDataLensCollection(): CMFormatDescription_Extensions_KeySwift declarationstatic let cameraCalibrationDataLensCollection: CMFormatDescription.Extensions.KeySpecifies intrinsic and extrinsic parameters for single or multiple lenses. The value for this key is represented by ``Value/CameraCalibrationDataLensCollection`` type.
get depth(): CMFormatDescription_Extensions_KeySwift declarationstatic let depth: CMFormatDescription.Extensions.KeyNumber with depth value as directed by http://developer.apple.com/qa/qa2001/qa1183.html
get vendor(): CMFormatDescription_Extensions_KeySwift declarationstatic let vendor: CMFormatDescription.Extensions.KeyString of fourCC
get heroEye(): CMFormatDescription_Extensions_KeySwift 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 version(): CMFormatDescription_Extensions_KeySwift declarationstatic let version: CMFormatDescription.Extensions.KeyNumber
init(rawValue: _CoreFoundation_CFString): CMFormatDescription_Extensions_KeySwift declarationinit(rawValue: CFString)Creates a new `Key` backed by `rawValue`
getRawValue($self: CMFormatDescription_Extensions_Key): _CoreFoundation_CFStringSwift declarationvar rawValue: CFStringThe 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"
setRawValue($self: CMFormatDescription_Extensions_Key, value: _CoreFoundation_CFString): voidSwift declarationvar rawValue: CFStringThe 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 fontTable(): CMFormatDescription_Extensions_KeySwift declarationstatic let fontTable: CMFormatDescription.Extensions.KeyUse `fontTable(_:)`. Specific to `.mobile3GPP`
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'