<!--
{
  "availability" : [
    "macOS: 26.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "ImmersiveMediaSupport",
  "identifier" : "/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "Immersive Media Support"
    ],
    "preciseIdentifier" : "s:21ImmersiveMediaSupport0aB19RemotePreviewSenderC"
  },
  "title" : "ImmersiveMediaRemotePreviewSender"
}
-->

# 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.

```
class ImmersiveMediaRemotePreviewSender
```

## Overview

Applications have to implement the protocol [`ImmersiveMediaPreviewMessagingProtocol`](/documentation/ImmersiveMediaSupport/ImmersiveMediaPreviewMessagingProtocol) so that messages exchanged
between sender and receivers are in the correct format for processing. Applications need to provide this as custom protocol when
establishing the network connection between the sender and the receivers.

It’s also important to configure the NWParameters to be secure by adding TLS security options as the example below.

```swift
func setupNWParameters() -> NWParameters {
    let tcpOptions = NWProtocolTCP.Options()
    let tls = /* setup TLS security options */

    let ret = NWParameters(tls: tls, tcp: tcpOptions)

    let options = NWProtocolFramer.Options(definition: ImmersiveMediaPreviewMessagingProtocol.definition)
    ret.defaultProtocolStack.applicationProtocols.insert(options, at: 0)

    return ret
}
```

```swift
let parameters = setupNWParameters()
let browser = NWBrowser(for: .bonjour(type: serviceType, domain: nil), using: parameters)
```

```swift
let parameters = setupNWParameters()
let listener = try NWListener(using: parameters)
```

## Topics

### Initializers

[`init(networkParameters: NWParameters?) async throws`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/init(networkParameters:))

Creates a preview sender using the specified network parameters, if any.

### Instance Properties

[`var connectedReceiverNames: [String]`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/connectedReceiverNames)

An array with the names of all receives currently receiving data from this instance.
When a receiver goes offline, this array will be automatically updated.

[`var isReadyToSendData: Bool`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/isReadyToSendData)

A Boolean value that indicates whether this preview sender is ready to send data.

[`var preferredFrameRate: Int`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/preferredFrameRate)

The preferred frame rate to use when sending and previewing frames.
This is optional; a value of `-1` enables the system to decide the best framerate based on network quality.

[`var preferredVideoHeight: Int`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/preferredVideoHeight)

The preferred video height to be used when sending and previewing frames.
This is optional; a value of `-1` enables the system to decide the best resolution.

[`var preferredVideoWidth: Int`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/preferredVideoWidth)

The preferred video width to use when sending and previewing frames.
This is optional; a value of `-1` enables the system to decide the best resolution.

### Instance Methods

[`func connectReceiver(name: String, endpoint: NWEndpoint) async throws`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/connectReceiver(name:endpoint:))

Adds an [`ImmersiveMediaRemotePreviewReceiver`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewReceiver) to the sender as an active participant of the network preview. Any updates
on the sender will be propagated to all active receivers (frames, camera information, static metadata).

[`func disconnectReceiver(name: String) async`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/disconnectReceiver(name:))

Disconnects a specific remote preview receiver associated with the name provided when [`connectReceiver(name:endpoint:)`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/connectReceiver(name:endpoint:)) was called.

[`func send(audioBuffer: CMSampleBuffer) async throws`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/send(audioBuffer:))

Sends an audio frame to all connected receivers.

[`func send(taggedBuffers: [CMTaggedBuffer], presentationTimeStamp: CMTime, frameDuration: CMTime) async throws`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/send(taggedBuffers:presentationTimeStamp:frameDuration:))

Sends a video frame to all the connected receivers using its tagged buffers representation.

[`func send(venueDescriptor: VenueDescriptor) async throws`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/send(venueDescriptor:))

Sends a venue descriptor to all connected receivers.

[`func send(videoBuffer: CMSampleBuffer) async throws`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/send(videoBuffer:))

Sends the video frame to the receivers.

[`func send(videoFrame: ImmersiveVideoFrame, presentationTimeStamp: CMTime, frameDuration: CMTime, metadata: [PresentationCommand]) async throws`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/send(videoFrame:presentationTimeStamp:frameDuration:metadata:))

Sends a video frame to all the connected receivers using its sample buffer representation.

[`func sendVenueDescriptor(at: URL) async throws`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/sendVenueDescriptor(at:))

Sends an AIME to all connected receivers.

[`func start() async`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/start())

Starts the sender.

[`func stop() async`](/documentation/ImmersiveMediaSupport/ImmersiveMediaRemotePreviewSender/stop())

Stops the sender - all current connected receivers will be disconnected and streaming will stop.

## Relationships

### Conforms To

[`SendableMetatype`](/documentation/Swift/SendableMetatype)

[`Escapable`](/documentation/Swift/Escapable)

[`Sendable`](/documentation/Swift/Sendable)

[`Copyable`](/documentation/Swift/Copyable)

[`Observable`](/documentation/Observation/Observable)

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)