BleCsRangingParams
class BleCsRangingParams : Parcelable
| kotlin.Any | |
| ↳ | android.ranging.ble.cs.BleCsRangingParams |
BleCsRangingParams encapsulates the parameters required for a bluetooth channel sounding ranging session.
Summary
| Nested classes | |
|---|---|
|
Builder class to create |
|
| Constants | |
|---|---|
| static Int |
Location of the device is indoor. |
| static Int |
Location of the device is outdoor. |
| static Int |
Location of the device is unknown. |
| static Int |
Remote device is in line of sight. |
| static Int |
Remote device is not in line of sight. |
| static Int |
Sight type is unknown. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean | |
| Int |
Returns the location type for the ranging session. |
| String |
Returns the Bluetooth address of the peer device. |
| Int |
Returns the ranging update rate. |
| Int |
Returns the security level for the ranging session. |
| Int |
Returns the sight type for this ranging session. |
| Int |
hashCode() |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<BleCsRangingParams!> | |
Constants
LOCATION_TYPE_INDOOR
static val LOCATION_TYPE_INDOOR: Int
Location of the device is indoor.
Value: 1LOCATION_TYPE_OUTDOOR
static val LOCATION_TYPE_OUTDOOR: Int
Location of the device is outdoor.
Value: 2LOCATION_TYPE_UNKNOWN
static val LOCATION_TYPE_UNKNOWN: Int
Location of the device is unknown.
Value: 0SIGHT_TYPE_LINE_OF_SIGHT
static val SIGHT_TYPE_LINE_OF_SIGHT: Int
Remote device is in line of sight.
Value: 1SIGHT_TYPE_NON_LINE_OF_SIGHT
static val SIGHT_TYPE_NON_LINE_OF_SIGHT: Int
Remote device is not in line of sight.
Value: 2SIGHT_TYPE_UNKNOWN
static val SIGHT_TYPE_UNKNOWN: Int
Sight type is unknown.
Value: 0Public 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
|
equals
fun equals(other: Any?): Boolean
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getLocationType
fun getLocationType(): Int
Returns the location type for the ranging session.
| Return | |
|---|---|
Int |
the location type. Value is one of the following: |
getPeerBluetoothAddress
fun getPeerBluetoothAddress(): String
Returns the Bluetooth address of the peer device.
| Return | |
|---|---|
String |
String representing the Bluetooth address. This value cannot be null. |
getRangingUpdateRate
fun getRangingUpdateRate(): Int
Returns the ranging update rate.
| Return | |
|---|---|
Int |
ranging update rate. Value is one of the following: |
getSecurityLevel
fun getSecurityLevel(): Int
Returns the security level for the ranging session.
| Return | |
|---|---|
Int |
the security level. Value is one of the following: |
getSightType
fun getSightType(): Int
Returns the sight type for this ranging session.
| Return | |
|---|---|
Int |
the sight type. Value is one of the following: |
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:
|