Added in Android Baklava

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

BleCsRangingParams

---

Kotlin |Java

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 BleCsRangingParams instances.

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

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<BleCsRangingParams>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
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.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
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

LOCATION_TYPE_INDOOR

Added in Android Baklava

public static final int LOCATION_TYPE_INDOOR

Location of the device is indoor.

Constant Value: 1 (0x00000001)

LOCATION_TYPE_OUTDOOR

Added in Android Baklava

public static final int LOCATION_TYPE_OUTDOOR

Location of the device is outdoor.

Constant Value: 2 (0x00000002)

LOCATION_TYPE_UNKNOWN

Added in Android Baklava

public static final int LOCATION_TYPE_UNKNOWN

Location of the device is unknown.

Constant Value: 0 (0x00000000)

SIGHT_TYPE_LINE_OF_SIGHT

Added in Android Baklava

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

Added in Android Baklava

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

Added in Android Baklava

public static final int SIGHT_TYPE_UNKNOWN

Sight type is unknown.

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in Android Baklava

public static final Creator<BleCsRangingParams> CREATOR

Public methods

describeContents

Added in Android Baklava

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

getLocationType

Added in Android Baklava

public int getLocationType ()

Returns the location type for the ranging session.

Returns
int	the location type. Value is LOCATION_TYPE_UNKNOWN, LOCATION_TYPE_INDOOR, or LOCATION_TYPE_OUTDOOR

getPeerBluetoothAddress

Added in Android Baklava

public String getPeerBluetoothAddress ()

Returns the Bluetooth address of the peer device.

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

getRangingUpdateRate

Added in Android Baklava

public int getRangingUpdateRate ()

Returns the ranging update rate.

Returns
int	ranging update rate. Value is RawRangingDevice.UPDATE_RATE_NORMAL, RawRangingDevice.UPDATE_RATE_INFREQUENT, or RawRangingDevice.UPDATE_RATE_FREQUENT

getSecurityLevel

Added in Android Baklava

public int getSecurityLevel ()

Returns the security level for the ranging session.

Returns
int	the security level Value is BleCsRangingCapabilities.CS_SECURITY_LEVEL_ONE, or BleCsRangingCapabilities.CS_SECURITY_LEVEL_FOUR

getSightType

Added in Android Baklava

public int getSightType ()

Returns the sight type for this ranging session.

Returns
int	the sight type Value is SIGHT_TYPE_UNKNOWN, SIGHT_TYPE_LINE_OF_SIGHT, or SIGHT_TYPE_NON_LINE_OF_SIGHT

writeToParcel

Added in Android Baklava

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