CloudXR Framework

CloudXR Framework is NVIDIA’s native Swift framework for building Apple native clients that stream XR experiences from OpenXR compatible server applications (built with CloudXR Runtime). It uses native stream protocol and provides a modern SwiftUI-based API for integrating XR streaming into your visionOS and iOS applications.

Supported Platforms

• visionOS

  • Apple Vision Pro running visionOS 2.4 or later

  • Full immersive XR streaming support

  • Native SwiftUI and RealityKit integration

• iOS/iPadOS

  • iPhone and iPad devices with ARKit support

  • iOS 18.0 or later

  • AR streaming capabilities

Development Requirements

To develop Apple native clients using CloudXR Framework, you need:

• macOS with Xcode 16.4 or later

• Swift 5.9 or later

• visionOS 2.4 SDK (for Vision Pro development)

• iOS 18.0 SDK (for iPhone/iPad development)

• CloudXR Runtime version 5.0.0 or later on the server

Quick Start

For a step-by-step tutorial on building your first Apple native client, refer to Your First CloudXR Client for visionOS.

Key Capabilities

• Session Management: A simple API for connecting to server applications (built with CloudXR Runtime) and managing streaming sessions with automatic state management.

• Secure Connections: TLS-encrypted connections with client token authentication for secure streaming. Works with Stream Manager for credential management. Refer to Secure Connection Mode.

• Message Channels: Bidirectional communication channels for custom data exchange between client and server. Refer to Message Channel API.

• Telemetry: Optional anonymous telemetry collection for service improvement. Refer to CloudXR Framework Telemetry.

• SwiftUI Integration: Native SwiftUI views and components designed for modern Apple development practices.

• RealityKit Rendering: Seamless integration with Apple’s RealityKit for high-performance 3D rendering of streamed content.

Resources

• GitHub Repository: NVIDIA/cloudxr-framework

• Package Manager: Swift Package Manager support

• API Documentation: The API documentation is provided as a DocC-generated doccarchive, available in the GitHub repository.

Documentation Contents

Contents:

• Your First CloudXR Client for visionOS
  • System Requirements
  • Make Your Project
  • Import the CloudXR Swift Package
  • Enter Your IP Address
  • Add a Connect Button
  • Set Up the CloudXR Session
  • Register Systems
  • Connecting to a Server
  • Streaming Content from a Server
  • Complete Source Files
• Secure Connection Mode
  • Overview
  • Server Setup Options
  • Client Connection Types
  • Configuring the Client
  • Session States
  • Error Handling
  • Best Practices
  • Network Requirements
  • Troubleshooting
  • See Also
• Message Channel API
  • Overview
  • Key Concepts
  • API Usage
  • A Complete Example
  • Best Practices
  • Advanced Usage
  • Troubleshooting
• CloudXR Framework Telemetry
  • Overview