UwbComplexChannel

class UwbComplexChannel : Parcelable
kotlin.Any
   ↳ android.ranging.uwb.UwbComplexChannel

A Class representing the complex channel for UWB which comprises channel and preamble index negotiated between peer devices out of band before ranging.

PRF (Pulse Repetition Frequency) supported:

  • BPRF - Base Pulse Repetition Frequency.
  • HPRF - Higher Pulse Repetition Frequency.
See

Summary

Nested classes

Builder for creating instances of UwbComplexChannel.
Constants
static Int

UWB channel 10
static Int

UWB channel 12
static Int

UWB channel 13
static Int

UWB channel 14
static Int

UWB channel 5
static Int

UWB channel 6
static Int

UWB channel 8
static Int

UWB channel 9
static Int

UWB preamble code index 10 (PRF mode - BPRF).
static Int

UWB preamble code index 11 (PRF mode - BPRF).
static Int

UWB preamble code index 12 (PRF mode - BPRF).
static Int

UWB preamble code index 25 (PRF mode - HPRF).
static Int

UWB preamble code index 26 (PRF mode - HPRF).
static Int

UWB preamble code index 27 (PRF mode - HPRF).
static Int

UWB preamble code index 28 (PRF mode - HPRF).
static Int

UWB preamble code index 29 (PRF mode - HPRF).
static Int

UWB preamble code index 30 (PRF mode - HPRF).
static Int

UWB preamble code index 31 (PRF mode - HPRF).
static Int

UWB preamble code index 32 (PRF mode - HPRF).
static Int

UWB preamble code index 9 (PRF mode - BPRF).
Inherited constants
Public methods
Int

Boolean
equals(other: Any?)
Int

Gets the UWB channel associated with this configuration.
Int

Gets the UWB preamble index associated with this configuration.
Int

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<UwbComplexChannel!>

Constants

UWB_CHANNEL_10

Added in API level Baklava
static val UWB_CHANNEL_10: Int

UWB channel 10

Value: 10

UWB_CHANNEL_12

Added in API level Baklava
static val UWB_CHANNEL_12: Int

UWB channel 12

Value: 12

UWB_CHANNEL_13

Added in API level Baklava
static val UWB_CHANNEL_13: Int

UWB channel 13

Value: 13

UWB_CHANNEL_14

Added in API level Baklava
static val UWB_CHANNEL_14: Int

UWB channel 14

Value: 14

UWB_CHANNEL_5

Added in API level Baklava
static val UWB_CHANNEL_5: Int

UWB channel 5

Value: 5

UWB_CHANNEL_6

Added in API level Baklava
static val UWB_CHANNEL_6: Int

UWB channel 6

Value: 6

UWB_CHANNEL_8

Added in API level Baklava
static val UWB_CHANNEL_8: Int

UWB channel 8

Value: 8

UWB_CHANNEL_9

Added in API level Baklava
static val UWB_CHANNEL_9: Int

UWB channel 9

Value: 9

UWB_PREAMBLE_CODE_INDEX_10

Added in API level Baklava
static val UWB_PREAMBLE_CODE_INDEX_10: Int

UWB preamble code index 10 (PRF mode - BPRF).

Value: 10

UWB_PREAMBLE_CODE_INDEX_11

Added in API level Baklava
static val UWB_PREAMBLE_CODE_INDEX_11: Int

UWB preamble code index 11 (PRF mode - BPRF).

Value: 11

UWB_PREAMBLE_CODE_INDEX_12

Added in API level Baklava
static val UWB_PREAMBLE_CODE_INDEX_12: Int

UWB preamble code index 12 (PRF mode - BPRF).

Value: 12

UWB_PREAMBLE_CODE_INDEX_25

Added in API level Baklava
static val UWB_PREAMBLE_CODE_INDEX_25: Int

UWB preamble code index 25 (PRF mode - HPRF).

Value: 25

UWB_PREAMBLE_CODE_INDEX_26

Added in API level Baklava
static val UWB_PREAMBLE_CODE_INDEX_26: Int

UWB preamble code index 26 (PRF mode - HPRF).

Value: 26

UWB_PREAMBLE_CODE_INDEX_27

Added in API level Baklava
static val UWB_PREAMBLE_CODE_INDEX_27: Int

UWB preamble code index 27 (PRF mode - HPRF).

Value: 27

UWB_PREAMBLE_CODE_INDEX_28

Added in API level Baklava
static val UWB_PREAMBLE_CODE_INDEX_28: Int

UWB preamble code index 28 (PRF mode - HPRF).

Value: 28

UWB_PREAMBLE_CODE_INDEX_29

Added in API level Baklava
static val UWB_PREAMBLE_CODE_INDEX_29: Int

UWB preamble code index 29 (PRF mode - HPRF).

Value: 29

UWB_PREAMBLE_CODE_INDEX_30

Added in API level Baklava
static val UWB_PREAMBLE_CODE_INDEX_30: Int

UWB preamble code index 30 (PRF mode - HPRF).

Value: 30

UWB_PREAMBLE_CODE_INDEX_31

Added in API level Baklava
static val UWB_PREAMBLE_CODE_INDEX_31: Int

UWB preamble code index 31 (PRF mode - HPRF).

Value: 31

UWB_PREAMBLE_CODE_INDEX_32

Added in API level Baklava
static val UWB_PREAMBLE_CODE_INDEX_32: Int

UWB preamble code index 32 (PRF mode - HPRF).

Value: 32

UWB_PREAMBLE_CODE_INDEX_9

Added in API level Baklava
static val UWB_PREAMBLE_CODE_INDEX_9: Int

UWB preamble code index 9 (PRF mode - BPRF).

Value: 9

Public methods

describeContents

Added in API level Baklava
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level Baklava
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getChannel

Added in API level Baklava
fun getChannel(): Int

Gets the UWB channel associated with this configuration.

Return
Int The channel number, which is one of the predefined UWB channels: Value is android.ranging.uwb.UwbComplexChannel#UWB_CHANNEL_5, android.ranging.uwb.UwbComplexChannel#UWB_CHANNEL_6, android.ranging.uwb.UwbComplexChannel#UWB_CHANNEL_8, android.ranging.uwb.UwbComplexChannel#UWB_CHANNEL_9, android.ranging.uwb.UwbComplexChannel#UWB_CHANNEL_10, android.ranging.uwb.UwbComplexChannel#UWB_CHANNEL_12, android.ranging.uwb.UwbComplexChannel#UWB_CHANNEL_13, or android.ranging.uwb.UwbComplexChannel#UWB_CHANNEL_14

getPreambleIndex

Added in API level Baklava
fun getPreambleIndex(): Int

Gets the UWB preamble index associated with this configuration.

Return
Int The preamble index, which is one of the predefined UWB preamble indices: See android.ranging.uwb.UwbComplexChannel#UWB_PREAMBLE_CODE_INDEX_9, android.ranging.uwb.UwbComplexChannel#UWB_PREAMBLE_CODE_INDEX_10, android.ranging.uwb.UwbComplexChannel#UWB_PREAMBLE_CODE_INDEX_11, android.ranging.uwb.UwbComplexChannel#UWB_PREAMBLE_CODE_INDEX_12, android.ranging.uwb.UwbComplexChannel#UWB_PREAMBLE_CODE_INDEX_25, android.ranging.uwb.UwbComplexChannel#UWB_PREAMBLE_CODE_INDEX_26, android.ranging.uwb.UwbComplexChannel#UWB_PREAMBLE_CODE_INDEX_27, android.ranging.uwb.UwbComplexChannel#UWB_PREAMBLE_CODE_INDEX_28, android.ranging.uwb.UwbComplexChannel#UWB_PREAMBLE_CODE_INDEX_29, android.ranging.uwb.UwbComplexChannel#UWB_PREAMBLE_CODE_INDEX_30, android.ranging.uwb.UwbComplexChannel#UWB_PREAMBLE_CODE_INDEX_31, or android.ranging.uwb.UwbComplexChannel#UWB_PREAMBLE_CODE_INDEX_32

hashCode

Added in API level Baklava
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level Baklava
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level Baklava
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level Baklava
static val CREATOR: Parcelable.Creator<UwbComplexChannel!>