RealityFoundation · IOS API REFERENCE

SynchronizationComponent

struct · iOS 13.0+ · SDK 27.1

struct SynchronizationComponent

A component that synchronizes an entity between processes and networked applications. An entity acquires a ``SynchronizationComponent`` instance by adopting the ``HasSynchronization`` protocol. All entities have this component because the ``Entity`` base class adopts the protocol.

Members (5)

get · iOS 13.0+

identifier

TypeScript

get identifier(): number

Swift declaration

var identifier: UInt64 { get }

A unique identifier of an entity within a network session.

get · iOS 13.0+

ownershipTransferMode

TypeScript

get ownershipTransferMode(): SynchronizationComponent_OwnershipTransferMode

Swift declaration

var ownershipTransferMode: SynchronizationComponent.OwnershipTransferMode

The entity’s transfer ownership mode. By default, the transfer mode is ``SynchronizationComponent/OwnershipTransferMode-swift.enum/autoAccept``. You can set it to ``SynchronizationComponent/OwnershipTransferMode-swift.enum/manual`` to require explicit confirmation of the request by your app.

set · iOS 13.0+

ownershipTransferMode

TypeScript

set ownershipTransferMode(value: SynchronizationComponent_OwnershipTransferMode)

Swift declaration

var ownershipTransferMode: SynchronizationComponent.OwnershipTransferMode

get · iOS 13.0+

isOwner

TypeScript

get isOwner(): boolean

Swift declaration

var isOwner: Bool { get }

A Boolean that indicates whether the calling process owns the entity.

init · iOS 13.0+

init

TypeScript

static init(): SynchronizationComponent

Swift declaration

init()

Creates a synchronization component.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →