Added in API level 36

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

RttRangingParams

Kotlin |Java

public final class RttRangingParams
extends Object implements Parcelable

java.lang.Object
↳	android.ranging.wifi.rtt.RttRangingParams

Represents the parameters required to perform Wi-Fi Round Trip Time (RTT) ranging.

Summary

Nested classes
`class`	`RttRangingParams.Builder` Builder class for `RttRangingParams`.

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<RttRangingParams>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`byte[]`	`getMatchFilter()` Returns the match filter for this ranging session.
`int`	`getRangingUpdateRate()` Returns the ranging update rate.
`String`	`getServiceName()` Returns the service name associated with this RTT ranging session.
`boolean`	`isPeriodicRangingHwFeatureEnabled()` Returns whether the periodic ranging hardware feature was enabled.
`String`	`toString()` Returns a string representation of the object.
`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.

Fields

CREATOR

Added in API level 36

public static final Creator<RttRangingParams> CREATOR

Public methods

describeContents

Added in API level 36

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`

getMatchFilter

Added in API level 36

public byte[] getMatchFilter ()

Returns the match filter for this ranging session.

Returns
`byte[]`	a byte array representing the match filter. This value may be `null`.

See also:

getRangingUpdateRate

Added in API level 36

public int getRangingUpdateRate ()

Returns the ranging update rate.

Returns

Returns
`int`	ranging update rate. Possible values: `ERROR(RangingUpdateRate.UPDATE_RATE_NORMAL/android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_NORMAL RangingUpdateRate.UPDATE_RATE_NORMAL)` `ERROR(RangingUpdateRate.UPDATE_RATE_INFREQUENT/android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_INFREQUENT RangingUpdateRate.UPDATE_RATE_INFREQUENT)` `ERROR(RangingUpdateRate.UPDATE_RATE_FREQUENT/android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_FREQUENT RangingUpdateRate.UPDATE_RATE_FREQUENT)` Value is `RawRangingDevice.UPDATE_RATE_NORMAL`, `RawRangingDevice.UPDATE_RATE_INFREQUENT`, or `RawRangingDevice.UPDATE_RATE_FREQUENT`

int

ranging update rate.

Possible values: ERROR(RangingUpdateRate.UPDATE_RATE_NORMAL/android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_NORMAL RangingUpdateRate.UPDATE_RATE_NORMAL) ERROR(RangingUpdateRate.UPDATE_RATE_INFREQUENT/android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_INFREQUENT RangingUpdateRate.UPDATE_RATE_INFREQUENT) ERROR(RangingUpdateRate.UPDATE_RATE_FREQUENT/android.ranging.raw.RawRangingDevice.RangingUpdateRate#UPDATE_RATE_FREQUENT RangingUpdateRate.UPDATE_RATE_FREQUENT) Value is RawRangingDevice.UPDATE_RATE_NORMAL, RawRangingDevice.UPDATE_RATE_INFREQUENT, or RawRangingDevice.UPDATE_RATE_FREQUENT

getServiceName

Added in API level 36

public String getServiceName ()

Returns the service name associated with this RTT ranging session.

Returns
`String`	the service name as a `String`. This value cannot be `null`.

See also:

isPeriodicRangingHwFeatureEnabled

Added in API level 36

public boolean isPeriodicRangingHwFeatureEnabled ()

Returns whether the periodic ranging hardware feature was enabled.

Returns
`boolean`	returns `true` if periodic ranging hardware feature was enabled, `false` otherwise

toString

Added in API level 36

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 36

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

RttRangingParams

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

getMatchFilter

getRangingUpdateRate

getServiceName

isPeriodicRangingHwFeatureEnabled

toString

writeToParcel