RangingResult

Artifact: androidx.core.uwb:uwb

View Source

Added in 1.0.0-alpha11

---

Kotlin |Java

public sealed class RangingResult

Known direct subclasses

RangingResult.RangingResultFailure, RangingResult.RangingResultInitialized, RangingResult.RangingResultPeerDisconnected, RangingResult.RangingResultPosition

RangingResult.RangingResultFailure	A ranging result indicating failure or suspension of a ranging session.
RangingResult.RangingResultInitialized	A ranging result when a ranging session is initialized with peer device.
RangingResult.RangingResultPeerDisconnected	A ranging result with peer disconnected status update.
RangingResult.RangingResultPosition	A ranging result with the device position update.

---

Class for UWB ranging result update.

Summary

Nested types
public final class RangingResult.RangingResultFailure extends RangingResult A ranging result indicating failure or suspension of a ranging session.
public final class RangingResult.RangingResultInitialized extends RangingResult A ranging result when a ranging session is initialized with peer device.
public final class RangingResult.RangingResultPeerDisconnected extends RangingResult A ranging result with peer disconnected status update.
public final class RangingResult.RangingResultPosition extends RangingResult A ranging result with the device position update.

Constants
static final int	RANGING_FAILURE_REASON_BAD_PARAMETERS = 1 Ranging failed due to bad or invalid parameters.
static final int	RANGING_FAILURE_REASON_FAILED_TO_START = 2 Generic failure to start the ranging session.
static final int	RANGING_FAILURE_REASON_MAX_RR_RETRY_REACHED = 6 Ranging stopped because the maximum number of ranging round retries was reached.
static final int	RANGING_FAILURE_REASON_STOPPED_BY_LOCAL = 4 The ranging session was stopped by a local request.
static final int	RANGING_FAILURE_REASON_STOPPED_BY_PEER = 3 The ranging session was stopped by the peer device.
static final int	RANGING_FAILURE_REASON_SYSTEM_POLICY = 5 Ranging stopped or failed due to system policy.
static final int	RANGING_FAILURE_REASON_UNKNOWN = 0 Unknown failure reason.

Protected constructors
RangingResult()

Public methods
abstract @NonNull UwbDevice	getDevice()

Constants

RANGING_FAILURE_REASON_BAD_PARAMETERS

public static final int RANGING_FAILURE_REASON_BAD_PARAMETERS = 1

Ranging failed due to bad or invalid parameters.

RANGING_FAILURE_REASON_FAILED_TO_START

public static final int RANGING_FAILURE_REASON_FAILED_TO_START = 2

Generic failure to start the ranging session.

RANGING_FAILURE_REASON_MAX_RR_RETRY_REACHED

public static final int RANGING_FAILURE_REASON_MAX_RR_RETRY_REACHED = 6

Ranging stopped because the maximum number of ranging round retries was reached.

RANGING_FAILURE_REASON_STOPPED_BY_LOCAL

public static final int RANGING_FAILURE_REASON_STOPPED_BY_LOCAL = 4

The ranging session was stopped by a local request.

RANGING_FAILURE_REASON_STOPPED_BY_PEER

public static final int RANGING_FAILURE_REASON_STOPPED_BY_PEER = 3

The ranging session was stopped by the peer device.

RANGING_FAILURE_REASON_SYSTEM_POLICY

public static final int RANGING_FAILURE_REASON_SYSTEM_POLICY = 5

Ranging stopped or failed due to system policy.

RANGING_FAILURE_REASON_UNKNOWN

public static final int RANGING_FAILURE_REASON_UNKNOWN = 0

Unknown failure reason.

Protected constructors

RangingResult

protected RangingResult()

Public methods

getDevice

Added in 1.0.0-alpha11

public abstract @NonNull UwbDevice getDevice()