Added in API level 36

OobInitiatorRangingConfig

Kotlin |Java

public final class OobInitiatorRangingConfig
extends RangingConfig implements Parcelable

java.lang.Object
↳	android.ranging.RangingConfig
	↳	android.ranging.oob.OobInitiatorRangingConfig

Represents the configuration for an Out-of-Band (OOB) initiator in a ranging session. This class includes configuration options such as device handles, security level, ranging mode, and interval range for setting up an OOB initiator ranging session.

Summary

Nested classes
`class`	`OobInitiatorRangingConfig.Builder` Builder class for creating instances of `OobInitiatorRangingConfig`.

Constants
`int`	`RANGING_MODE_AUTO` Automatic ranging mode.
`int`	`RANGING_MODE_FUSED` Starts ranging with all the ranging technologies both devices support.
`int`	`RANGING_MODE_HIGH_ACCURACY` High accuracy ranging mode.
`int`	`RANGING_MODE_HIGH_ACCURACY_PREFERRED` High accuracy ranging mode.
`int`	`SECURITY_LEVEL_BASIC` Basic security level for the ranging session.
`int`	`SECURITY_LEVEL_SECURE` Basic security level for the ranging session.

Inherited constants

From class android.ranging.RangingConfig

`int`	`RANGING_SESSION_OOB` Ranging session with the out-of-band negotiations performed by the ranging API.
`int`	`RANGING_SESSION_RAW` Ranging session with the out-of-band negotiations performed by the app.

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<OobInitiatorRangingConfig>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`List<DeviceHandle>`	`getDeviceHandles()` Returns the list of DeviceHandles associated with the OOB initiator.
`Duration`	`getFastestRangingInterval()` Returns the fastest requested ranging interval.
`Range<Duration>`	`getRangingIntervalRange()` Returns the ranging interval range configuration.
`int`	`getRangingMode()` Returns the ranging mode for the session.
`Set<Integer>`	`getRangingTechnologyFilter()` Returns the set of ranging technologies that can be used for the session.
`int`	`getSecurityLevel()` Returns the security level set for the ranging session.
`Duration`	`getSlowestRangingInterval()` Returns the slowest acceptable ranging.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          android.ranging.RangingConfig

`int`	`getRangingSessionType()` Gets the ranging session type `ERROR(RangingSessionType/android.ranging.RangingConfig.RangingSessionType RangingSessionType)`
`String`	`toString()` Returns a string representation of the object.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

RANGING_MODE_AUTO

Added in API level 36

public static final int RANGING_MODE_AUTO

Automatic ranging mode. Allows the system to choose the best mode.

Constant Value: 0 (0x00000000)

RANGING_MODE_FUSED

Added in API level 36

public static final int RANGING_MODE_FUSED

Starts ranging with all the ranging technologies both devices support.

Constant Value: 3 (0x00000003)

RANGING_MODE_HIGH_ACCURACY

Added in API level 36

public static final int RANGING_MODE_HIGH_ACCURACY

High accuracy ranging mode. No fallback allowed.

Constant Value: 1 (0x00000001)

RANGING_MODE_HIGH_ACCURACY_PREFERRED

Added in API level 36

public static final int RANGING_MODE_HIGH_ACCURACY_PREFERRED

High accuracy ranging mode. Fallback to lower accuracy if high accuracy ranging is not supported by all devices.

Constant Value: 2 (0x00000002)

SECURITY_LEVEL_BASIC

Added in API level 36

public static final int SECURITY_LEVEL_BASIC

Basic security level for the ranging session.

Example usage: UWB: Static-STS BLE-CS: Security level one

Constant Value: 0 (0x00000000)

SECURITY_LEVEL_SECURE

Added in API level 36

public static final int SECURITY_LEVEL_SECURE

Basic security level for the ranging session.

Example usage: UWB: Provisioned-STS BLE-CS: Security level four

Constant Value: 1 (0x00000001)

Fields

CREATOR

Added in API level 36

public static final Creator<OobInitiatorRangingConfig> CREATOR

Public methods

describeContents

Added in API level 36

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getDeviceHandles

Added in API level 36

public List<DeviceHandle> getDeviceHandles ()

Returns the list of DeviceHandles associated with the OOB initiator.

Returns
`List<DeviceHandle>`	A list of DeviceHandle objects. This value cannot be `null`.

getFastestRangingInterval

Added in API level 36

public Duration getFastestRangingInterval ()

Returns the fastest requested ranging interval.

Returns
`Duration`	The fastest interval. This value cannot be `null`.

getRangingIntervalRange

Added in API level 36

public Range<Duration> getRangingIntervalRange ()

Returns the ranging interval range configuration.

Returns
`Range<Duration>`	The `Range` associated with this OOB initiator. This value cannot be `null`.

getRangingMode

Added in API level 36

public int getRangingMode ()

Returns the ranging mode for the session.

Returns
`int`	the ranging mode. Possible values: `RANGING_MODE_AUTO` `RANGING_MODE_HIGH_ACCURACY` `RANGING_MODE_HIGH_ACCURACY_PREFERRED` `RANGING_MODE_FUSED` Value is `RANGING_MODE_AUTO`, `RANGING_MODE_HIGH_ACCURACY`, `RANGING_MODE_HIGH_ACCURACY_PREFERRED`, or `RANGING_MODE_FUSED`

getRangingTechnologyFilter

Added in version 36.1

public Set<Integer> getRangingTechnologyFilter ()

Returns the set of ranging technologies that can be used for the session. If empty, the system may use any available technology.

Returns
`Set<Integer>`	A non-null, possibly empty, `Set` of Ranging Technology integers.

getSecurityLevel

Added in API level 36

public int getSecurityLevel ()

Returns the security level set for the ranging session.

Returns
`int`	the security level. Possible values: `SECURITY_LEVEL_BASIC` `SECURITY_LEVEL_SECURE` Value is `SECURITY_LEVEL_BASIC`, or `SECURITY_LEVEL_SECURE`

getSlowestRangingInterval

Added in API level 36

public Duration getSlowestRangingInterval ()

Returns the slowest acceptable ranging.

Returns
`Duration`	The slowest interval. This value cannot be `null`.

toString

Added in API level 36

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 36

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

OobInitiatorRangingConfig

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

RANGING_MODE_AUTO

RANGING_MODE_FUSED

RANGING_MODE_HIGH_ACCURACY

RANGING_MODE_HIGH_ACCURACY_PREFERRED

SECURITY_LEVEL_BASIC

SECURITY_LEVEL_SECURE

Fields

CREATOR

Public methods

describeContents

getDeviceHandles

getFastestRangingInterval

getRangingIntervalRange

getRangingMode

getRangingTechnologyFilter

getSecurityLevel

getSlowestRangingInterval

toString

writeToParcel