Technologies›AR & Spatial

ImmersiveMediaSupport

iOSmacOStvOSwatchOSvisionOS

ImmersiveMediaSupport validates and processes Apple Immersive Video (AIVU) files together with the static and dynamic metadata they require for immersive media playback on iOS, macOS, and visionOS. Use AIVUValidator to check that a file carries the necessary metadata, and read presentation information with PresentationDescriptor and PresentationDescriptorReader. Work with the camera and frame model through types such as ImmersiveCamera, ImmersiveCameraCalibration, ImmersiveCameraLensDefinition, and ImmersiveVideoFrame, and describe masks and venues with ImmersiveVideoMask, ImmersiveDynamicMask, and VenueDescriptor. Drive presentation behavior with commands like PresentationCommand, FadeCommand, SetCameraCommand, and ShotFlipCommand, and preview content across devices using ImmersiveMediaRemotePreviewSender and ImmersiveMediaRemotePreviewReceiver.

Validation 1

Verify that an Apple Immersive Video file carries the static and dynamic metadata required for immersive playback.

  • St
    AIVUValidatoriOS 26.4+
    A type for validating existing AIVU files to ensure that they meet minimum requirements for AIV.

Presentation Information 3

Read and describe the presentation metadata that drives immersive media playback.

  • St
    PresentationDescriptoriOS 26.4+
    This type represents dynamic metadata that is used during playback or when outputting the metadata track for
  • Cl
    PresentationDescriptorReaderiOS 26.4+
    An object that provides an app the functionality it needs to understand and process immersive presentation commands.
  • Cl
    ParametricImmersiveAssetInfoiOS 26.4+
    An object that assists the app with converting the original wide field of view video asset into a parametric immersive asset.

Camera and Frame Model 6

Model the immersive camera, its lens and calibration, and the individual video frames of the experience.

  • St
    ImmersiveCameraiOS 26.4+
    A type that holds all the information for an immersive media camera needed to process and render immersive media video frames.
  • St
    ImmersiveCameraCalibrationiOS 26.4+
    Mesh geometry for AIV can be generated using different camera lens calibration types. An enumeration 'CalibrationType'
  • Cl
    ImmersiveCameraMeshCalibrationiOS 26.4+
    Calibration mesh geometry based on USDZ data.
  • St
    ImmersiveCameraLensDefinitioniOS 26.4+
    This type holds the ILPD lens configuration parameters to generate camera calibration type instance.
  • St
    ImmersiveCameraViewModeliOS 26.4+
    A view model that holds all the resources needed to render an immersive camera view.
  • St
    ImmersiveVideoFrame
    A type that represents an immersive video frame.

Masks and Venues 5

Describe spatial masks and the physical venue associated with immersive content.

  • St
    ImmersiveVideoMaskiOS 26.4+
    A video mask to smooth the edges of the mesh during video rendering.
  • St
    ImmersiveDynamicMaskiOS 26.4+
    A type that holds all the information needed to dynamically generate immersive media mask during load time.
  • Cl
    ImmersiveImageMaskiOS 26.4+
    An object that holds all the information needed to load immersive media masks from image data or from a file.
  • En
    ImmersiveCameraMaskiOS 26.4+
    A value that represents an immersive camera mask.
  • Ac
    VenueDescriptoriOS 26.4+
    The Apple Immersive Media Venue Descriptor is a collection of static metadata necessary

Presentation Commands 6

Issue commands that change camera, fades, and shot orientation during immersive playback.

  • En
    PresentationCommandiOS 26.4+
    A value that represents the type of presentation command.
  • St
    FadeCommandiOS 26.4+
    A command type for color fading during immersive media playback.
  • St
    FadeEnvironmentCommandiOS 26.4+
    A command type for opacity fading environment backdrops during immersive media playback.
  • St
    SetCameraCommandiOS 26.4+
    A command type for immersive camera switching during playback.
  • St
    ShotFlipCommandiOS 27.0+
    A command type to flip the video frames vertically during playback for the duration of the command.
  • St
    ShotFlopCommandiOS 26.4+
    A command type to flip the video frames horizontally during playback for the duration of the command.

Remote Preview 3

Send and receive immersive media previews across devices for review and playback.

  • Cl
    ImmersiveMediaRemotePreviewSender
    An observable object that helps an app send the required data to all connected receiver applications to help facilitate the complete preview of the immersive media playback.
  • Cl
    ImmersiveMediaRemotePreviewReceiver
    An observable object that helps applications handle receiving commands and data sent from an immersive media remote preview sender object.
  • Cl
    ImmersiveMediaPreviewMessagingProtocol
    A messaging protocol used by immersive media remote preview sender and receiver objects to establish the remote preview link.

Classes 1

  • Cl
    ImmersivePreviewRenderer
    An object that renders an immersive video frame into a texture and exposes the command buffer for presentation.
← AR & Spatial