Class XRParticipantSubsystem

Subsystem for managing the participants in a multi-user collaborative session.

Inheritance
Object
Subsystem
Subsystem<XRParticipantSubsystemDescriptor>
XRSubsystem<XRParticipantSubsystemDescriptor>
TrackingSubsystem<XRParticipant, XRParticipantSubsystemDescriptor>
XRParticipantSubsystem
Inherited Members
Namespace: UnityEngine.XR.ARSubsystems
Syntax
public abstract class XRParticipantSubsystem : TrackingSubsystem<XRParticipant, XRParticipantSubsystemDescriptor>, ISubsystem

Constructors

XRParticipantSubsystem()

Do not call this directly. Call create on a valid XRParticipantSubsystemDescriptor instead.

Declaration
public XRParticipantSubsystem()

Properties

provider

The provider created by the implementation that contains the required participant functionality.

Declaration
protected XRParticipantSubsystem.Provider provider { get; }
Property Value
Type Description
XRParticipantSubsystem.Provider

Methods

CreateProvider()

Implement this to provide this class with an interface to platform specific implementations.

Declaration
protected abstract XRParticipantSubsystem.Provider CreateProvider()
Returns
Type Description
XRParticipantSubsystem.Provider

An implementation specific provider.

GetChanges(Allocator)

Get the changed (added, updated, and removed) participants since the last call to GetChanges(Allocator).

Declaration
public override TrackableChanges<XRParticipant> GetChanges(Allocator allocator)
Parameters
Type Name Description
Allocator allocator

An Allocator to use when allocating the returned NativeArrays.
Returns
Type Description
TrackableChanges<XRParticipant>

TrackableChanges<T> describing the participants that have been added, updated, and removed since the last call to GetChanges(Allocator). The caller owns the memory allocated with Allocator.
Overrides
UnityEngine.XR.ARSubsystems.TrackingSubsystem<UnityEngine.XR.ARSubsystems.XRParticipant, UnityEngine.XR.ARSubsystems.XRParticipantSubsystemDescriptor>.GetChanges(Unity.Collections.Allocator)

OnDestroyed()

Destroys the participant subsystem.

Declaration
protected sealed override void OnDestroyed()
Overrides
UnityEngine.XR.ARSubsystems.XRSubsystem<UnityEngine.XR.ARSubsystems.XRParticipantSubsystemDescriptor>.OnDestroyed()

OnStart()

Starts the participant subsystem.

Declaration
protected sealed override void OnStart()
Overrides
UnityEngine.XR.ARSubsystems.XRSubsystem<UnityEngine.XR.ARSubsystems.XRParticipantSubsystemDescriptor>.OnStart()

OnStop()

Stops the participant subsystem.

Declaration
protected sealed override void OnStop()
Overrides
UnityEngine.XR.ARSubsystems.XRSubsystem<UnityEngine.XR.ARSubsystems.XRParticipantSubsystemDescriptor>.OnStop()