RttRangingParams
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 |
Inherited constants | ||||
---|---|---|---|---|
|
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 | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
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 CONTENTS_FILE_DESCRIPTOR |
getMatchFilter
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 . |
getRangingUpdateRate
public int getRangingUpdateRate ()
Returns the ranging update rate.
getServiceName
public String getServiceName ()
Returns the service name associated with this RTT ranging session.
isPeriodicRangingHwFeatureEnabled
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
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the 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 Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |