Contents

SystemCoordinator

A type you use to coordinate your interface’s behavior when an active SharePlay session supports spatial placement of content.

Declaration

final class SystemCoordinator

Mentioned in

Overview

A SystemCoordinator object helps you coordinate the presentation of your app’s content when spatial placement is active. In visionOS, the system can present a SharePlay activity as if the participants were together in the same room with the content. Each participant views the content from a particular vantage point, and sees the changes that others make. The system handles the placement of each participant’s spatial Persona relative to the content, but you handle any changes to the content itself with the help of the SystemCoordinator object.

You don’t create a SystemCoordinator object directly. After you receive a GroupSession object for an activity, retrieve the system coordinator from the session’s systemCoordinator property. When you first retrieve the object, update its configuration property to tell the system how you want to arrange participants in the scene. After that, use the information in the system coordinator’s properties to keep your app’s interface up to date. When participants support spatial placement, send additional data to synchronize your content for those participants. For example, when one person scrolls the contents of a window, update the scroll position in the window of other spatially aware participants to preserve the shared context for everyone.

You choose what information to share among participants, and you choose how to manage the corresponding updates. A system coordinator object only helps you know when to make those changes. Observe the object’s published properties to receive automatic updates when the values change.

Topics

Configuring the system coordinator

Getting the participant state

Getting the current immersion level

Assigning the local participant role

Structures

See Also

Spatial activities