CoreVideo · IOS API REFERENCE

CVImageCleanAperture

struct · iOS 27.0+ · SDK 27.1

@frozen struct CVImageCleanAperture

An image’s clean aperture is a region of video to display. This represents a rectangle within the image that’s free from transition artifacts caused by the encoding of the signal.

Members (11)

get · iOS 27.0+

verticalOffset

TypeScript

get verticalOffset(): number

Swift declaration

var verticalOffset: Float

Vertical offset from the center of the image buffer. A positive value of this property will move the center of clean aperture downwards.

set · iOS 27.0+

verticalOffset

TypeScript

set verticalOffset(value: number)

Swift declaration

var verticalOffset: Float

Vertical offset from the center of the image buffer. A positive value of this property will move the center of clean aperture downwards.

get · iOS 27.0+

horizontalOffset

TypeScript

get horizontalOffset(): number

Swift declaration

var horizontalOffset: Float

Horizontal offset from the center of the image buffer. A positive value of this property will move the center of clean aperture towards right side.

set · iOS 27.0+

horizontalOffset

TypeScript

set horizontalOffset(value: number)

Swift declaration

var horizontalOffset: Float

Horizontal offset from the center of the image buffer. A positive value of this property will move the center of clean aperture towards right side.

static · iOS 27.0+

makeFromRawAttachmentValue

TypeScript

static makeFromRawAttachmentValue(repr: CVAttachmentRawValue): (CVImageCleanAperture) | null

Swift declaration

static func makeFromRawAttachmentValue(_ repr: CVAttachmentRawValue) -> CVImageCleanAperture?

get · iOS 27.0+

rawAttachmentValueRepresentation

TypeScript

get rawAttachmentValueRepresentation(): CVAttachmentRawValue

Swift declaration

var rawAttachmentValueRepresentation: CVAttachmentRawValue { get }

init · iOS 27.0+

init

TypeScript

static init(width: number, height: number, horizontalOffset: number, verticalOffset: number): CVImageCleanAperture

Swift declaration

init(width: Float, height: Float, horizontalOffset: Float, verticalOffset: Float)

get · iOS 27.0+

width

TypeScript

get width(): number

Swift declaration

var width: Float

Width of the clean aperture.

set · iOS 27.0+

width

TypeScript

set width(value: number)

Swift declaration

var width: Float

Width of the clean aperture.

get · iOS 27.0+

height

TypeScript

get height(): number

Swift declaration

var height: Float

Height of the clean aperture.

set · iOS 27.0+

height

TypeScript

set height(value: number)

Swift declaration

var height: Float

Height of the clean aperture.

Skipped declarations

No declarations were skipped in this snapshot.

All CoreVideo types →