OobInitiatorRangingConfig
class OobInitiatorRangingConfig : RangingConfig, Parcelable
| kotlin.Any | ||
| ↳ | 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 | |
|---|---|
|
Builder class for creating instances of |
|
| Constants | |
|---|---|
| static Int |
Automatic ranging mode. |
| static Int |
Starts ranging with all the ranging technologies both devices support. |
| static Int | |
| static Int |
High accuracy ranging mode. |
| static Int |
Basic security level for the ranging session. |
| static Int |
Basic security level for the ranging session. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| MutableList<DeviceHandle!> |
Returns the list of DeviceHandles associated with the OOB initiator. |
| Duration |
Returns the fastest requested ranging interval. |
| Range<Duration!> |
Returns the ranging interval range configuration. |
| Int |
Returns the ranging mode for the session. |
| MutableSet<Int!> |
Returns the set of ranging technologies that can be used for the session. |
| Int |
Returns the security level set for the ranging session. |
| Duration |
Returns the slowest acceptable ranging. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Inherited functions | |
|---|---|
| Properties | |
|---|---|
| static Parcelable.Creator<OobInitiatorRangingConfig!> | |
Constants
RANGING_MODE_AUTO
static val RANGING_MODE_AUTO: Int
Automatic ranging mode. Allows the system to choose the best mode.
Value: 0RANGING_MODE_FUSED
static val RANGING_MODE_FUSED: Int
Starts ranging with all the ranging technologies both devices support.
Value: 3RANGING_MODE_HIGH_ACCURACY
static val RANGING_MODE_HIGH_ACCURACY: Int
Value: 1RANGING_MODE_HIGH_ACCURACY_PREFERRED
static val RANGING_MODE_HIGH_ACCURACY_PREFERRED: Int
High accuracy ranging mode. Fallback to lower accuracy if high accuracy ranging is not supported by all devices.
Value: 2SECURITY_LEVEL_BASIC
static val SECURITY_LEVEL_BASIC: Int
Basic security level for the ranging session.
Example usage: UWB: Static-STS BLE-CS: Security level one
Value: 0SECURITY_LEVEL_SECURE
static val SECURITY_LEVEL_SECURE: Int
Basic security level for the ranging session.
Example usage: UWB: Provisioned-STS BLE-CS: Security level four
Value: 1Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
getDeviceHandles
fun getDeviceHandles(): MutableList<DeviceHandle!>
Returns the list of DeviceHandles associated with the OOB initiator.
| Return | |
|---|---|
MutableList<DeviceHandle!> |
A list of DeviceHandle objects. This value cannot be null. |
getFastestRangingInterval
fun getFastestRangingInterval(): Duration
Returns the fastest requested ranging interval.
| Return | |
|---|---|
Duration |
The fastest interval. This value cannot be null. |
getRangingIntervalRange
fun getRangingIntervalRange(): Range<Duration!>
Returns the ranging interval range configuration.
| Return | |
|---|---|
Range<Duration!> |
The Range associated with this OOB initiator. This value cannot be null. |
getRangingMode
fun getRangingMode(): Int
Returns the ranging mode for the session.
| Return | |
|---|---|
Int |
the ranging mode.
Possible values: |
getRangingTechnologyFilter
fun getRangingTechnologyFilter(): MutableSet<Int!>
Returns the set of ranging technologies that can be used for the session. If empty, the system may use any available technology.
| Return | |
|---|---|
MutableSet<Int!> |
A non-null, possibly empty, Set of Ranging Technology integers. |
getSecurityLevel
fun getSecurityLevel(): Int
Returns the security level set for the ranging session.
| Return | |
|---|---|
Int |
the security level.
Possible values: |
getSlowestRangingInterval
fun getSlowestRangingInterval(): Duration
Returns the slowest acceptable ranging.
| Return | |
|---|---|
Duration |
The slowest interval. This value cannot be null. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|