One Logo Pool Ball
CoreVideo · IOS API REFERENCE

CVProResRawMetadata

struct · iOS 27.0+ · SDK 27.1

struct CVProResRawMetadata

Metadata associated with ProRes RAW images.

Members (23)

static · iOS 27.0+

makeFromRawAttachmentValue

TypeScript
static makeFromRawAttachmentValue(repr: CVAttachmentRawValue): (CVProResRawMetadata) | null
Swift declaration
static func makeFromRawAttachmentValue(_ repr: CVAttachmentRawValue) -> CVProResRawMetadata?
get · iOS 27.0+

blackLevel

TypeScript
get blackLevel(): number
Swift declaration
var blackLevel: Int32

The sensel level corresponding to no light exposure.

set · iOS 27.0+

blackLevel

TypeScript
set blackLevel(value: number)
Swift declaration
var blackLevel: Int32

The sensel level corresponding to no light exposure.

get · iOS 27.0+

extensions

TypeScript
get extensions(): (ArrayBuffer) | null
Swift declaration
var extensions: Data?

ProRes RAW metadata extensions. This Data contains a big-endian UInt32 representing the size of the item in bytes followed by a 4-character code ('psim') followed by a variable-length pascal string identifying the metadata (like a key string) followed by the metadata payload.

set · iOS 27.0+

extensions

TypeScript
set extensions(value: (ArrayBuffer) | null)
Swift declaration
var extensions: Data?

ProRes RAW metadata extensions. This Data contains a big-endian UInt32 representing the size of the item in bytes followed by a 4-character code ('psim') followed by a variable-length pascal string identifying the metadata (like a key string) followed by the metadata payload.

get · iOS 27.0+

gainFactor

TypeScript
get gainFactor(): SDKHandle
Swift declaration
var gainFactor: Float32

The overall gain factor for raw conversion.

set · iOS 27.0+

gainFactor

TypeScript
set gainFactor(value: SDKHandle)
Swift declaration
var gainFactor: Float32

The overall gain factor for raw conversion.

get · iOS 27.0+

whiteLevel

TypeScript
get whiteLevel(): number
Swift declaration
var whiteLevel: Int32

The sensel level corresponding to sensor (or camera A-to-D converter) saturation.

set · iOS 27.0+

whiteLevel

TypeScript
set whiteLevel(value: number)
Swift declaration
var whiteLevel: Int32

The sensel level corresponding to sensor (or camera A-to-D converter) saturation.

get · iOS 27.0+

colorMatrix

TypeScript
get colorMatrix(): SDKHandle
Swift declaration
var colorMatrix: InlineArray<9, Float32>

This is a 3x3 matrix which transforms linear RGB pixel values in the camera native color space to CIE 1931 XYZ values relative to the D65 illuminant, where the matrix entries are stored in row-major order.

set · iOS 27.0+

colorMatrix

TypeScript
set colorMatrix(value: SDKHandle)
Swift declaration
var colorMatrix: InlineArray<9, Float32>

This is a 3x3 matrix which transforms linear RGB pixel values in the camera native color space to CIE 1931 XYZ values relative to the D65 illuminant, where the matrix entries are stored in row-major order.

get · iOS 27.0+

recommendedCrop

TypeScript
get recommendedCrop(): CVProResRawMetadata_RecommendedCrop
Swift declaration
var recommendedCrop: CVProResRawMetadata.RecommendedCrop

The recommended number of: pixels to discard from the start (left) of each row of the image; pixels to discard from the end (right) of each row of the image; rows of pixels to discard from the top of the image; and rows of pixels to discard from the bottom of the image. Pixels/rows are discarded after raw conversion.

set · iOS 27.0+

recommendedCrop

TypeScript
set recommendedCrop(value: CVProResRawMetadata_RecommendedCrop)
Swift declaration
var recommendedCrop: CVProResRawMetadata.RecommendedCrop

The recommended number of: pixels to discard from the start (left) of each row of the image; pixels to discard from the end (right) of each row of the image; rows of pixels to discard from the top of the image; and rows of pixels to discard from the bottom of the image. Pixels/rows are discarded after raw conversion.

get · iOS 27.0+

whiteBalanceCCT

TypeScript
get whiteBalanceCCT(): (SDKHandle) | null
Swift declaration
var whiteBalanceCCT: Float32?

The illuminant correlated color temperature (CCT), in kelvins, selected at the time of capture. If not present, the CCT is considered unknown or unspecified.

set · iOS 27.0+

whiteBalanceCCT

TypeScript
set whiteBalanceCCT(value: (SDKHandle) | null)
Swift declaration
var whiteBalanceCCT: Float32?

The illuminant correlated color temperature (CCT), in kelvins, selected at the time of capture. If not present, the CCT is considered unknown or unspecified.

init · iOS 27.0+

init

TypeScript
static init(senselSitingOffsets: CVSenselSitingOffsets, blackLevel: number, whiteLevel: number, whiteBalanceCCT: (SDKHandle) | null, whiteBalanceRedFactor: SDKHandle, whiteBalanceBlueFactor: SDKHandle, colorMatrix: SDKHandle, gainFactor: SDKHandle, recommendedCrop?: CVProResRawMetadata_RecommendedCrop, extensions?: (ArrayBuffer) | null): CVProResRawMetadata
Swift declaration
init(senselSitingOffsets: CVSenselSitingOffsets = .zero, blackLevel: Int32, whiteLevel: Int32, whiteBalanceCCT: Float32? = nil, whiteBalanceRedFactor: Float32, whiteBalanceBlueFactor: Float32, colorMatrix: InlineArray<9, Float32>, gainFactor: Float32, recommendedCrop: CVProResRawMetadata.RecommendedCrop = .zero, extensions: Data? = nil)
get · iOS 27.0+

senselSitingOffsets

TypeScript
get senselSitingOffsets(): CVSenselSitingOffsets
Swift declaration
var senselSitingOffsets: CVSenselSitingOffsets

Siting offsets, relative to pixel center, of individual sensels/components constituting each pixel.

set · iOS 27.0+

senselSitingOffsets

TypeScript
set senselSitingOffsets(value: CVSenselSitingOffsets)
Swift declaration
var senselSitingOffsets: CVSenselSitingOffsets

Siting offsets, relative to pixel center, of individual sensels/components constituting each pixel.

get · iOS 27.0+

whiteBalanceRedFactor

TypeScript
get whiteBalanceRedFactor(): SDKHandle
Swift declaration
var whiteBalanceRedFactor: Float32

The white balance multiplication factor for red-filtered sensels.

set · iOS 27.0+

whiteBalanceRedFactor

TypeScript
set whiteBalanceRedFactor(value: SDKHandle)
Swift declaration
var whiteBalanceRedFactor: Float32

The white balance multiplication factor for red-filtered sensels.

get · iOS 27.0+

whiteBalanceBlueFactor

TypeScript
get whiteBalanceBlueFactor(): SDKHandle
Swift declaration
var whiteBalanceBlueFactor: Float32

The white balance multiplication factor for blue-filtered sensels.

set · iOS 27.0+

whiteBalanceBlueFactor

TypeScript
set whiteBalanceBlueFactor(value: SDKHandle)
Swift declaration
var whiteBalanceBlueFactor: Float32

The white balance multiplication factor for blue-filtered sensels.

get · iOS 27.0+

rawAttachmentValueRepresentation

TypeScript
get rawAttachmentValueRepresentation(): CVAttachmentRawValue
Swift declaration
var rawAttachmentValueRepresentation: CVAttachmentRawValue { get }

Skipped declarations

No declarations were skipped in this snapshot.

All CoreVideo types →