Added in API level 36

BleCsRangingParams

---

Kotlin |Java

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 Builder class to create BleCsRangingParams instances.

Constants
static Int	LOCATION_TYPE_INDOOR Location of the device is indoor.
static Int	LOCATION_TYPE_OUTDOOR Location of the device is outdoor.
static Int	LOCATION_TYPE_UNKNOWN Location of the device is unknown.
static Int	SIGHT_TYPE_LINE_OF_SIGHT Remote device is in line of sight.
static Int	SIGHT_TYPE_NON_LINE_OF_SIGHT Remote device is not in line of sight.
static Int	SIGHT_TYPE_UNKNOWN Sight type is unknown.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Boolean	equals(other: Any?) Indicates whether some other object is "equal to" this one.
Int	getLocationType() Returns the location type for the ranging session.
String	getPeerBluetoothAddress() Returns the Bluetooth address of the peer device.
Int	getRangingUpdateRate() Returns the ranging update rate.
Int	getSecurityLevel() Returns the security level for the ranging session.
Int	getSightType() Returns the sight type for this ranging session.
Int	hashCode() Returns a hash code value for the object.
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<BleCsRangingParams!>	CREATOR

Constants

LOCATION_TYPE_INDOOR

Added in API level 36

static val LOCATION_TYPE_INDOOR: Int

Location of the device is indoor.

Value: 1

LOCATION_TYPE_OUTDOOR

Added in API level 36

static val LOCATION_TYPE_OUTDOOR: Int

Location of the device is outdoor.

Value: 2

LOCATION_TYPE_UNKNOWN

Added in API level 36

static val LOCATION_TYPE_UNKNOWN: Int

Location of the device is unknown.

Value: 0

SIGHT_TYPE_LINE_OF_SIGHT

Added in API level 36

static val SIGHT_TYPE_LINE_OF_SIGHT: Int

Remote device is in line of sight.

Value: 1

SIGHT_TYPE_NON_LINE_OF_SIGHT

Added in API level 36

static val SIGHT_TYPE_NON_LINE_OF_SIGHT: Int

Remote device is not in line of sight.

Value: 2

SIGHT_TYPE_UNKNOWN

Added in API level 36

static val SIGHT_TYPE_UNKNOWN: Int

Sight type is unknown.

Value: 0

Public methods

describeContents

Added in API level 36

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(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 CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 36

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

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

Added in API level 36

fun getLocationType(): Int

Returns the location type for the ranging session.

Return
Int	the location type. Value is one of the following: LOCATION_TYPE_UNKNOWN LOCATION_TYPE_INDOOR LOCATION_TYPE_OUTDOOR

getPeerBluetoothAddress

Added in API level 36

fun getPeerBluetoothAddress(): String

Returns the Bluetooth address of the peer device.

Return
String	String representing the Bluetooth address. This value cannot be null.

getRangingUpdateRate

Added in API level 36

fun getRangingUpdateRate(): Int

Returns the ranging update rate.

Return
Int	ranging update rate.

getSecurityLevel

Added in API level 36

fun getSecurityLevel(): Int

Returns the security level for the ranging session.

Return
Int	the security level

getSightType

Added in API level 36

fun getSightType(): Int

Returns the sight type for this ranging session.

Return
Int	the sight type. Value is one of the following: SIGHT_TYPE_UNKNOWN SIGHT_TYPE_LINE_OF_SIGHT SIGHT_TYPE_NON_LINE_OF_SIGHT

hashCode

Added in API level 36

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Return
Int	a hash code value for this object.

writeToParcel

Added in API level 36

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: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

Added in API level 36

static val CREATOR: Parcelable.Creator<BleCsRangingParams!>