Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#nestedclasses) \| [Constants](https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#constants) \| [Inherited Constants](https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#inhconstants) \| [Fields](https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#lfields) \| [Methods](https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#inhmethods)

# BleCsRangingParams

*** ** * ** ***

` public final class BleCsRangingParams `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.ranging.ble.cs.BleCsRangingParams |

<br />

*** ** * ** ***

BleCsRangingParams encapsulates the parameters required for a bluetooth channel sounding ranging session.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams.Builder` Builder class to create `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams` instances. |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_INDOOR` Location of the device is indoor. |
| `int` | `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_OUTDOOR` Location of the device is outdoor. |
| `int` | `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_UNKNOWN` Location of the device is unknown. |
| `int` | `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_LINE_OF_SIGHT` Remote device is in line of sight. |
| `int` | `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_NON_LINE_OF_SIGHT` Remote device is not in line of sight. |
| `int` | `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_UNKNOWN` Sight type is unknown. |

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams>` | `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#CREATOR` <br /> |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` int` | ` https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#getLocationType()() ` Returns the location type for the ranging session. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#getPeerBluetoothAddress()() ` Returns the Bluetooth address of the peer device. |
| ` int` | ` https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#getRangingUpdateRate()() ` Returns the ranging update rate. |
| ` int` | ` https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#getSecurityLevel()() ` Returns the security level for the ranging session. |
| ` int` | ` https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#getSightType()() ` Returns the sight type for this ranging session. |
| ` int` | ` https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#hashCode()() ` Returns a hash code value for the object. |
| ` void` | ` https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Constants

### LOCATION_TYPE_INDOOR

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int LOCATION_TYPE_INDOOR
```

Location of the device is indoor.

<br />

Constant Value: 1 (0x00000001)

### LOCATION_TYPE_OUTDOOR

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int LOCATION_TYPE_OUTDOOR
```

Location of the device is outdoor.

<br />

Constant Value: 2 (0x00000002)

### LOCATION_TYPE_UNKNOWN

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int LOCATION_TYPE_UNKNOWN
```

Location of the device is unknown.

<br />

Constant Value: 0 (0x00000000)

### SIGHT_TYPE_LINE_OF_SIGHT

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SIGHT_TYPE_LINE_OF_SIGHT
```

Remote device is in line of sight.

<br />

Constant Value: 1 (0x00000001)

### SIGHT_TYPE_NON_LINE_OF_SIGHT

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SIGHT_TYPE_NON_LINE_OF_SIGHT
```

Remote device is not in line of sight.

<br />

Constant Value: 2 (0x00000002)

### SIGHT_TYPE_UNKNOWN

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SIGHT_TYPE_UNKNOWN
```

Sight type is unknown.

<br />

Constant Value: 0 (0x00000000)

## Fields

### CREATOR

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<BleCsRangingParams> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 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.

<br />

| Parameters ||
|---|---|
| `o` | `Object`: the reference object with which to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getLocationType

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getLocationType ()
```

Returns the location type for the ranging session.

<br />

| Returns ||
|---|---|
| `int` | the location type. Value is one of the following: - `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_UNKNOWN` - `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_INDOOR` - `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#LOCATION_TYPE_OUTDOOR` |

### getPeerBluetoothAddress

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getPeerBluetoothAddress ()
```

Returns the Bluetooth address of the peer device.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | String representing the Bluetooth address. This value cannot be `null`. <br /> |

### getRangingUpdateRate

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getRangingUpdateRate ()
```

Returns the ranging update rate.

<br />

| Returns ||
|---|---|
| `int` | ranging update rate. <br /> |

### getSecurityLevel

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSecurityLevel ()
```

Returns the security level for the ranging session.

<br />

| Returns ||
|---|---|
| `int` | the security level <br /> |

### getSightType

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSightType ()
```

Returns the sight type for this ranging session.

<br />

| Returns ||
|---|---|
| `int` | the sight type. Value is one of the following: - `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_UNKNOWN` - `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_LINE_OF_SIGHT` - `https://developer.android.com/reference/android/ranging/ble/cs/BleCsRangingParams#SIGHT_TYPE_NON_LINE_OF_SIGHT` |

### hashCode

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### writeToParcel

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |