PowerManager.GetThermalHeadroom(Int32) Method

Reference

Definition

Namespace:: Android.OS

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides an estimate of how much thermal headroom the device currently has before hitting severe throttling.

[Android.Runtime.Register("getThermalHeadroom", "(I)F", "GetGetThermalHeadroom_IHandler", ApiSince=30)]
public virtual float GetThermalHeadroom (int forecastSeconds);

[<Android.Runtime.Register("getThermalHeadroom", "(I)F", "GetGetThermalHeadroom_IHandler", ApiSince=30)>]
abstract member GetThermalHeadroom : int -> single
override this.GetThermalHeadroom : int -> single

Parameters

forecastSeconds: Int32

how many seconds in the future to forecast. Given that device conditions may change at any time, forecasts from further in the future will likely be less accurate than forecasts in the near future.

Returns

Single

a value greater than or equal to 0.0 where 1.0 indicates the SEVERE throttling threshold, as described above. Returns NaN if the device does not support this functionality or if this function is called significantly faster than once per second.

Attributes: RegisterAttribute

Remarks

Java documentation for android.os.PowerManager.getThermalHeadroom(int).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to