enum PeerState (Niantic.ARDK.AR.Networking.PeerState)

Overview

Possible states of local or remote peers in an ARNetworking session. More…

enum PeerState {
    Unknown,
    Initializing,
    WaitingForLocalizationData,
    Localizing,
    Stabilizing,
    Stable,
    Limited,
    Failed,
};

Detailed Documentation

Possible states of local or remote peers in an ARNetworking session.

Enum Values

Unknown

Initial state. Peers will exit this state after connecting to the server.

Initializing

Currently unused. Peers will never reach this state.

WaitingForLocalizationData

Mapper: Trying to create a map. Non-Mapper: Waiting to receive localization data.

Localizing

Mapper: Will not reach this state. Non-Mapper: Has received map data from the server and is attempting to localize.

Stabilizing

State is only reached when using MarkerSync (i.e. when IARNetworking.InitializeForMarkerScanning has been called). Mapper: Enters this state after exiting Unknown. Non-Mapper: Has successfully localized through MarkerSync.

Stable

Mapper: Has successfully created at least one map. Non-Mapper: Has successfully localized against a map.

Limited

Currently unused. Peers will never reach this state.

Failed

Mapper: Will not reach this state. Non-Mapper: If the mapper has left the ARNetworking session before publishing any maps, all non-mapper peers that join afterward will enter this state after exiting Unknown.