BleCsRangingParams
public
final
class
BleCsRangingParams
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.ranging.ble.cs.BleCsRangingParams |
BleCsRangingParams encapsulates the parameters required for a bluetooth channel sounding ranging session.
Summary
Nested classes | |
|---|---|
class |
BleCsRangingParams.Builder
Builder class to create |
Constants | |
|---|---|
int |
LOCATION_TYPE_INDOOR
Location of the device is indoor. |
int |
LOCATION_TYPE_OUTDOOR
Location of the device is outdoor. |
int |
LOCATION_TYPE_UNKNOWN
Location of the device is unknown. |
int |
SIGHT_TYPE_LINE_OF_SIGHT
Remote device is in line of sight. |
int |
SIGHT_TYPE_NON_LINE_OF_SIGHT
Remote device is not in line of sight. |
int |
SIGHT_TYPE_UNKNOWN
Sight type is unknown. |
Inherited constants |
|---|
Fields | |
|---|---|
public
static
final
Creator<BleCsRangingParams> |
CREATOR
|
Public methods | |
|---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object o)
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. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Constants
LOCATION_TYPE_INDOOR
public static final int LOCATION_TYPE_INDOOR
Location of the device is indoor.
Constant Value: 1 (0x00000001)
LOCATION_TYPE_OUTDOOR
public static final int LOCATION_TYPE_OUTDOOR
Location of the device is outdoor.
Constant Value: 2 (0x00000002)
LOCATION_TYPE_UNKNOWN
public static final int LOCATION_TYPE_UNKNOWN
Location of the device is unknown.
Constant Value: 0 (0x00000000)
SIGHT_TYPE_LINE_OF_SIGHT
public static final int SIGHT_TYPE_LINE_OF_SIGHT
Remote device is in line of sight.
Constant Value: 1 (0x00000001)
SIGHT_TYPE_NON_LINE_OF_SIGHT
public static final int SIGHT_TYPE_NON_LINE_OF_SIGHT
Remote device is not in line of sight.
Constant Value: 2 (0x00000002)
SIGHT_TYPE_UNKNOWN
public static final int SIGHT_TYPE_UNKNOWN
Sight type is unknown.
Constant Value: 0 (0x00000000)
Fields
Public methods
describeContents
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
|
equals
public boolean equals (Object o)
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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 | |
|---|---|
o |
Object: the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getLocationType
public int getLocationType ()
Returns the location type for the ranging session.
| Returns | |
|---|---|
int |
the location type.
Value is one of the following: |
getPeerBluetoothAddress
public String getPeerBluetoothAddress ()
Returns the Bluetooth address of the peer device.
| Returns | |
|---|---|
String |
String representing the Bluetooth address.
This value cannot be null. |
getRangingUpdateRate
public int getRangingUpdateRate ()
Returns the ranging update rate.
| Returns | |
|---|---|
int |
ranging update rate.
Value is one of the following: |
getSecurityLevel
public int getSecurityLevel ()
Returns the security level for the ranging session.
| Returns | |
|---|---|
int |
the security level.
Value is one of the following: |
getSightType
public int getSightType ()
Returns the sight type for this ranging session.
| Returns | |
|---|---|
int |
the sight type.
Value is one of the following: |
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Returns | |
|---|---|
int |
a hash code value for this object. |
writeToParcel
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 the following:
|
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2026-02-13 UTC.