ARCollaborationData

Inherits: RefCounted < Object

Collaboration data for multi-peer AR sessions.

Description

Encapsulates spatial data that can be exchanged between devices for shared AR experiences. Received via the ARSession.collaboration_data_received signal and sent to peers via ARSession.update_with_collaboration_data(). Use serialize() and deserialize() to transmit over a network transport (e.g. MultipeerConnectivity). iOS 13+ only. Requires isCollaborationEnabled on the configuration. On visionOS/macOS, this type exists for API consistency but serialize/deserialize are no-ops.

Properties

int

priority

1

Methods

ARCollaborationData	deserialize(data: PackedByteArray) static
PackedByteArray	serialize()

---

Enumerations

enum Priority: 🔗

Priority CRITICAL = 0

This packet is essential for accurate shared-session synchronization.

Priority OPTIONAL = 1

This packet improves shared-session quality but may be dropped if needed.

---

Property Descriptions

int priority = 1 🔗

• void set_priority(value: int)

• int get_priority()

Indicates whether this collaboration packet is optional or critical to session convergence.

---

Method Descriptions

ARCollaborationData deserialize(data: PackedByteArray) static 🔗

Creates an ARCollaborationData instance from serialized network data.

---

PackedByteArray serialize() 🔗

Serializes this collaboration packet into a PackedByteArray so it can be sent to another peer.