Added in API level Baklava
Builder
class Builder
| kotlin.Any | |
| ↳ | android.os.CpuHeadroomParams.Builder |
Summary
| Public constructors | |
|---|---|
Builder() |
|
Builder(params: CpuHeadroomParams)Returns a new builder copy with the same values as the params. |
|
| Public methods | |
|---|---|
| CpuHeadroomParams |
build()Builds the |
| CpuHeadroomParams.Builder |
setCalculationType(calculationType: Int)Sets the headroom calculation type. |
| CpuHeadroomParams.Builder |
setCalculationWindowMillis(windowMillis: Int)Sets the headroom calculation window size in milliseconds. |
| CpuHeadroomParams.Builder |
Sets the thread TIDs to track. |
Public constructors
Builder
Added in API level Baklava
Builder(params: CpuHeadroomParams)
Returns a new builder copy with the same values as the params.
| Parameters | |
|---|---|
params |
CpuHeadroomParams: This value cannot be null. |
Public methods
build
Added in API level Baklava
fun build(): CpuHeadroomParams
Builds the CpuHeadroomParams object.
| Return | |
|---|---|
CpuHeadroomParams |
This value cannot be null. |
setCalculationType
Added in API level Baklava
fun setCalculationType(calculationType: Int): CpuHeadroomParams.Builder
Sets the headroom calculation type.
| Parameters | |
|---|---|
calculationType |
Int: Value is android.os.CpuHeadroomParams#CPU_HEADROOM_CALCULATION_TYPE_MIN, or android.os.CpuHeadroomParams#CPU_HEADROOM_CALCULATION_TYPE_AVERAGE |
| Return | |
|---|---|
CpuHeadroomParams.Builder |
This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the type is invalid. |
setCalculationWindowMillis
Added in API level Baklava
fun setCalculationWindowMillis(windowMillis: Int): CpuHeadroomParams.Builder
Sets the headroom calculation window size in milliseconds.
| Parameters | |
|---|---|
windowMillis |
Int: the window size in milliseconds ranges from SystemHealthManager.getCpuHeadroomCalculationWindowRange(). The smaller the window size, the larger fluctuation in the headroom value should be expected. The default value can be retrieved from the CpuHeadroomParams.getCalculationWindowMillis. The device will try to use the closest feasible window size to this param. Value is 1 or greater |
| Return | |
|---|---|
CpuHeadroomParams.Builder |
This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the window is invalid. |
setTids
Added in API level Baklava
fun setTids(vararg tids: Int): CpuHeadroomParams.Builder
Sets the thread TIDs to track.
The TIDs should belong to the same of the process that will make the headroom call. And they should not have different core affinity.
If not set or set to empty, the headroom will be based on the PID of the process making the call.
| Parameters | |
|---|---|
tids |
Int: non-null list of TIDs, where maximum size can be read from SystemHealthManager.getMaxCpuHeadroomTidsSize(). |
| Return | |
|---|---|
CpuHeadroomParams.Builder |
This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
if the TID is not positive. |