Spatial Preview

Overview

Use Spatial Preview to work with spatial content from a macOS app to a connected visionOS device in real time. The framework centers on two abstractions: SpatialPreviewEndpoint, which identifies the target visionOS device, and SpatialPreviewSession, which manages the active preview connection and the flow of content. The USDPreviewSession and DocumentPreviewSession objects adopt SpatialPreviewSession and support visionOS previews of Universal Scene Description (USD) content and general file content, respectively. USDKit is recommended for Spatial Preview because it works without any additional setup. If you want to use your own OpenUSD library, see the documentation below on how to bridge OpenUSD to USDKit.

Topics

Essentials

• Working with content from your Mac app using Spatial Preview
• Bridging an external USD runtime to Spatial Preview

Nearby devices

• SpatialPreviewEndpoint
• SpatialPreviewDevicePicker
• ConnectedSpatialEndpointObserver

Preview sessions

• SpatialPreviewSession
• DocumentPreviewSession
• USDPreviewSession

Session state and errors

• SpatialPreviewSessionState
• SpatialPreviewSessionError
• ConnectedSpatialEndpointObserver.UnavailableError
• USDPreviewSession.Error
• USDPreviewSession.Event