One Logo Pool Ball
ImmersiveMediaSupport · IOS API REFERENCE

ParametricImmersiveAssetInfo

class · iOS 26.4+ · SDK 27.1

class ParametricImmersiveAssetInfo

An object that assists the app with converting the original wide field of view video asset into a parametric immersive asset. This initializer function generates the `CMFormatDescription` for uplifting the original asset to a `ParametricImmersive` asset, for presentation in the immersive style for playback with AVKit or RealityKit on visionOS.

Members (5)

get · iOS 26.4+

isAssetConvertible

TypeScript
get isAssetConvertible(): boolean
Swift declaration
var isAssetConvertible: Bool { get }

A result Boolean value that indicates whether the asset can be converted to parametric immersive. If opt-out `computeFormatDescription` in the initializer, this Boolean indicates whether the asset is convertible.

static · iOS 26.4+

isParametricImmersive

TypeScript
static isParametricImmersive(asset: _AVFoundation_AVURLAsset): Promise<boolean>
Swift declaration
class func isParametricImmersive(asset: AVURLAsset) async -> Bool

Checks asynchronously whether the asset is already in the parametric immersive format. - Parameters: - asset: original AVURLAsset.

get · iOS 26.4+

conversionResult

TypeScript
get conversionResult(): (SDKHandle) | null
Swift declaration
var conversionResult: Result<CMFormatDescription, ParametricImmersiveAssetInfo.Error>? { get }

The result object of the parametric immersive format conversion.

get · iOS 26.4+

requiredFormatDescription

TypeScript
get requiredFormatDescription(): (_CoreMedia_CMFormatDescription) | null
Swift declaration
var requiredFormatDescription: CMFormatDescription? { get }

A result format descriptor for overriding a mutable video track that's used to convert the asset to parametric immersive asset. Use `replaceFormatDescription` to replace the format description on the `AVMutableMovieTrack`.

init · iOS 26.4+

init

TypeScript
static init(asset: _AVFoundation_AVURLAsset, computeFormatDescription?: boolean): Promise<ParametricImmersiveAssetInfo>
Swift declaration
init(asset: AVURLAsset, computeFormatDescription: Bool = true) async throws

Creates an instance using the passed asset and computes the format description for converting the asset to parametric immersive asset, if requested. Use `ParametricImmersiveAssetInfo.isParametricImmersive` to check whether the asset is already parametric immersive. - Parameters: - asset: The original `AVURLAsset`. - computeFormatDescription: A flag that indicates whether to run the calculation for converting the `ParametricImmersive` asset. Opt-out for a quick check if the content is convertible, result is stored in isAssetConvertible.

Skipped declarations

No declarations were skipped in this snapshot.

All ImmersiveMediaSupport types →