Added in API level 36

Builder

class Builder
kotlin.Any
   ↳ android.ranging.SessionConfig.Builder

Builder for creating instances of SessionConfig.

Summary

Public constructors

Public methods
SessionConfig

Builds a new SessionConfig instance.
SessionConfig.Builder
setAngleOfArrivalNeeded(isAngleOfArrivalNeeded: Boolean)

Sets whether Angle of Arrival (AoA) is required for the ranging operation.
SessionConfig.Builder

Sets the data notification configuration for this preference.
SessionConfig.Builder
setRangingMeasurementsLimit(rangingMeasurementsLimit: Int)

Sets the maximum number of ranging rounds for this session.
SessionConfig.Builder

Sets the sensor fusion parameters for this preference.

Public constructors

Builder

Added in API level 36
Builder()

Public methods

build

Added in API level 36
fun build(): SessionConfig

Builds a new SessionConfig instance.

Return
SessionConfig the new SessionConfig instance. This value cannot be null.

setAngleOfArrivalNeeded

Added in API level 36
fun setAngleOfArrivalNeeded(isAngleOfArrivalNeeded: Boolean): SessionConfig.Builder

Sets whether Angle of Arrival (AoA) is required for the ranging operation.

Defaults to false

Parameters
isAngleOfArrivalNeeded Boolean: true if AoA data is required; false otherwise.
Return
SessionConfig.Builder The Builder instance. This value cannot be null.

setDataNotificationConfig

Added in API level 36
fun setDataNotificationConfig(config: DataNotificationConfig): SessionConfig.Builder

Sets the data notification configuration for this preference.

Parameters
config DataNotificationConfig: the DataNotificationConfig to use. This value cannot be null.
Return
SessionConfig.Builder the builder instance for chaining. This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if the config is null.

setRangingMeasurementsLimit

Added in API level 36
fun setRangingMeasurementsLimit(rangingMeasurementsLimit: Int): SessionConfig.Builder

Sets the maximum number of ranging rounds for this session. This includes all ranging rounds, irrespective of whether they were successful or not. For 1:many sessions, a round includes ranging to all peers within that round.

By default, when the value is set to 0, the ranging session will run indefinitely.

Parameters
rangingMeasurementsLimit Int: the maximum number of ranging rounds (0 to 65535). Value is between 0 and 65535 inclusive
Return
SessionConfig.Builder this Builder instance. This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if the value is outside the allowed range (0 to 65535).

setSensorFusionParams

Added in API level 36
fun setSensorFusionParams(parameters: SensorFusionParams): SessionConfig.Builder

Sets the sensor fusion parameters for this preference.

Parameters
parameters SensorFusionParams: the SensorFusionParams to use. This value cannot be null.
Return
SessionConfig.Builder the builder instance. This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if the parameters is null.