ImmersiveMediaSupport · IOS API REFERENCE

ImmersiveCameraCalibration

struct · iOS 26.4+ · SDK 27.1

struct ImmersiveCameraCalibration

Mesh geometry for AIV can be generated using different camera lens calibration types. An enumeration 'CalibrationType' represents camera calibration type for video geometry. The type 'usdzMesh' is used for calibration performed by camera lens provider using usdz. The type 'meiRives' is used for calibration performed using MeiRives lens calibration algorithm. This data includes calibration type, calibration name, calibration file name, lens definition, mask data, camera origin, and other relevant data.

Members (14)

get · iOS 26.4+

positionable

TypeScript

get positionable(): boolean

Swift declaration

var positionable: Bool

A Boolean value that indicates whether to anchor this calibration in mixed reality 3D space rather than centering it on the person's eye position.

set · iOS 26.4+

positionable

TypeScript

set positionable(value: boolean)

Swift declaration

var positionable: Bool

A Boolean value that indicates whether to anchor this calibration in mixed reality 3D space rather than centering it on the person's eye position.

get · iOS 26.4+

textureMapping

TypeScript

get textureMapping(): ImmersiveCameraCalibration_CameraTextureMapping

Swift declaration

var textureMapping: ImmersiveCameraCalibration.CameraTextureMapping

Texture mapping that describes how each section of the video frame maps into the calibration.

set · iOS 26.4+

textureMapping

TypeScript

set textureMapping(value: ImmersiveCameraCalibration_CameraTextureMapping)

Swift declaration

var textureMapping: ImmersiveCameraCalibration.CameraTextureMapping

Texture mapping that describes how each section of the video frame maps into the calibration.

get · iOS 26.4+

environmentFilename

TypeScript

get environmentFilename(): (string) | null

Swift declaration

var environmentFilename: String?

The USDZ filename of a backdrop to use for this calibration.

set · iOS 26.4+

environmentFilename

TypeScript

set environmentFilename(value: (string) | null)

Swift declaration

var environmentFilename: String?

The USDZ filename of a backdrop to use for this calibration.

get · iOS 26.4+

mask

TypeScript

get mask(): (ImmersiveCameraMask) | null

Swift declaration

var mask: ImmersiveCameraMask?

Immersive camera mask that needs to be used for this calibration.

set · iOS 26.4+

mask

TypeScript

set mask(value: (ImmersiveCameraMask) | null)

Swift declaration

var mask: ImmersiveCameraMask?

Immersive camera mask that needs to be used for this calibration.

init · iOS 26.4+

init

TypeScript

static init(name: string, type: ImmersiveCameraCalibration_CalibrationType, mask?: (ImmersiveCameraMask) | null, positionable?: boolean, origin?: ImmersiveCameraCalibration_CameraOrigin, textureMapping?: ImmersiveCameraCalibration_CameraTextureMapping, environmentFilename?: (string) | null): ImmersiveCameraCalibration

Swift declaration

init(name: String, type: ImmersiveCameraCalibration.CalibrationType, mask: ImmersiveCameraMask? = nil, positionable: Bool = false, origin: ImmersiveCameraCalibration.CameraOrigin = .zero, textureMapping: ImmersiveCameraCalibration.CameraTextureMapping = .identity, environmentFilename: String? = nil)

Creates a mesh based calibration from USDZ data and a image-based mask. - Parameters: - name: The name to identify the calibration. - type: The calibration type providing data to be used as the camera calibration for each eye. - mask: Optional override mask definition describing the mask to be used for this calibration. If no mask is provided, the one inside LensParameters will be used. - positionable: A flag that indicates whether to anchor this calibration in mixed reality 3D space rather than centering it on the person's eye position. - origin: The position information, in meters, that represents the origin from which to render the calibration in 3D space relative to the person's eye. - textureMapping: The texture mapping that describes how each section of the video frame maps into the calibration. - environmentFilename: The USDZ filename for calibrations with a backdrop.

get · iOS 26.4+

name

TypeScript

get name(): string

Swift declaration

var name: String

A string identifying this calibration.

set · iOS 26.4+

name

TypeScript

set name(value: string)

Swift declaration

var name: String

A string identifying this calibration.

get · iOS 26.4+

type

TypeScript

get type(): ImmersiveCameraCalibration_CalibrationType

Swift declaration

var type: ImmersiveCameraCalibration.CalibrationType { get }

The type of this calibration.

get · iOS 26.4+

origin

TypeScript

get origin(): ImmersiveCameraCalibration_CameraOrigin

Swift declaration

var origin: ImmersiveCameraCalibration.CameraOrigin

Position information, in meters, that represents the origin from which to render the calibration in 3D space relative to the person's eye.

set · iOS 26.4+

origin

TypeScript

set origin(value: ImmersiveCameraCalibration_CameraOrigin)

Swift declaration

var origin: ImmersiveCameraCalibration.CameraOrigin

Position information, in meters, that represents the origin from which to render the calibration in 3D space relative to the person's eye.

Skipped declarations

No declarations were skipped in this snapshot.

All ImmersiveMediaSupport types →