Thermal
#include <thermal.h>
Summary
Enumerations |
|
---|---|
AThermalStatus{
|
enum |
Typedefs |
|
---|---|
AThermalManager
|
typedefstruct AThermalManager
An opaque type representing a handle to a thermal manager. |
AThermal_StatusCallback)(void *data, AThermalStatus status)
|
typedefvoid(*
Prototype of the function that is called when thermal status changes. |
Functions |
|
---|---|
AThermal_acquireManager()
|
Acquire an instance of the thermal manager.
|
AThermal_getCurrentThermalStatus(AThermalManager *manager)
|
Gets the current thermal status.
|
AThermal_registerThermalStatusListener(AThermalManager *manager, AThermal_StatusCallback callback, void *data)
|
int
Register the thermal status listener for thermal status change.
|
AThermal_releaseManager(AThermalManager *manager)
|
void
Release the thermal manager pointer acquired via AThermal_acquireManager.
|
AThermal_unregisterThermalStatusListener(AThermalManager *manager, AThermal_StatusCallback callback, void *data)
|
int
Unregister the thermal status listener previously resgistered.
|
Enumerations
AThermalStatus
AThermalStatus
Typedefs
AThermalManager
struct AThermalManager AThermalManager
An opaque type representing a handle to a thermal manager.
An instance of thermal manager must be acquired prior to using thermal status APIs and must be released after use.
To use:
- Create a new thermal manager instance by calling the AThermal_acquireManager function.
- Get current thermal status with AThermal_getCurrentThermalStatus.
- Register a thermal status listener with AThermal_registerThermalStatusListener.
- Unregister a thermal status listener with AThermal_unregisterThermalStatusListener.
- Release the thermal manager instance with AThermal_releaseManager.
AThermal_StatusCallback
void(* AThermal_StatusCallback)(void *data, AThermalStatus status)
Prototype of the function that is called when thermal status changes.
It's passed the updated thermal status as parameter, as well as the pointer provided by the client that registered a callback.
Functions
AThermal_acquireManager
AThermalManager * AThermal_acquireManager()
Acquire an instance of the thermal manager.
This must be freed using AThermal_releaseManager.
Available since API level 30.
Details | |
---|---|
Returns |
manager instance on success, nullptr on failure.
|
AThermal_getCurrentThermalStatus
AThermalStatus AThermal_getCurrentThermalStatus( AThermalManager *manager )
Gets the current thermal status.
Available since API level 30.
Details | |||
---|---|---|---|
Parameters |
|
||
Returns |
current thermal status, ATHERMAL_STATUS_ERROR on failure.
|
AThermal_registerThermalStatusListener
int AThermal_registerThermalStatusListener( AThermalManager *manager, AThermal_StatusCallback callback, void *data )
Register the thermal status listener for thermal status change.
Available since API level 30.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Returns |
0 on success EINVAL if the listener and data pointer were previously added and not removed. EPERM if the required permission is not held. EPIPE if communication with the system service has failed.
|
AThermal_releaseManager
void AThermal_releaseManager( AThermalManager *manager )
Release the thermal manager pointer acquired via AThermal_acquireManager.
Available since API level 30.
Details | |||
---|---|---|---|
Parameters |
|
AThermal_unregisterThermalStatusListener
int AThermal_unregisterThermalStatusListener( AThermalManager *manager, AThermal_StatusCallback callback, void *data )
Unregister the thermal status listener previously resgistered.
Available since API level 30.
Details | |||||||
---|---|---|---|---|---|---|---|
Parameters |
|
||||||
Returns |
0 on success EINVAL if the listener and data pointer were not previously added. EPERM if the required permission is not held. EPIPE if communication with the system service has failed.
|