Skip to main content

​
Functions

​
tuneResources

Tune Resource Values for finite or finite duration.
Parameters
​
int64_t
Duration (in milliseconds) to provision the Resources for. A value of -1 denotes infinite duration.
​
A 32 bit signed Integer storing the Properties of the Request. The last 8 bits [25 - 32] store the Request Priority (HIGH / LOW) The Next 8 bits [17 - 24] represent a Boolean Flag, which indicates if the Request should be processed in the background (in case of Display Off or Doze Mode).
​
int32_t
Number of Resources to be tuned as part of the Request
​
SysResource *
List of Resources to be provisioned as part of the Request
Returns int64_t: A Positive Integer Handle which uniquely identifies the issued Request. The handle is used for future retune / untune APIs. -1: If the Request could not be sent to the server.

​
retuneResources

Modify the duration of a previously issued Tune Request.
Parameters
​
int64_t
Request Handle, returned by tuneResources.
​
int64_t
The new duration for the previously issued Tune request. A value of -1 denotes infinite duration.
Returns int8_t: 0: If the Request was successfully submitted to the server. -1: Otherwise.

​
untuneResources

Release (or free) the Request with the given handle.
Parameters
​
int64_t
Request Handle, returned by the tuneResources API call.
Returns int8_t: 0: If the Request was successfully submitted to the server. -1: Otherwise

​
getProp

Gets a property from the Config Store.
Parameters
​
const char *
Name of the Property to be fetched.
​
char *
A buffer to hold the result, i.e. the property value corresponding to the specified name.
​
size_t
Size of the buffer
​
const char *
Value to return in case a property with the specified Name is not found in the Config Store
Returns int8_t: 0: If the Request was successfully Submitted to the Server. -1: Otherwise

​
tuneSignal

Tune the signal with the given ID.
Parameters
​
uint32_t
A uniqued 32-bit (unsigned) identifier for the Signal The last 16 bits (17-32) are used to specify the SigID The next 8 bits (9-16) are used to specify the Signal Category In addition for Custom Signals, the MSB must be set to 1 as well
​
uint32_t
Type of the signal, useful for use-case based signal filtering and selection, i.e. in situations where multiple variants of the same core signal (with minor changes) need to exist to support different use-case scenarios. If no such filtering is needed, pass this field as 0. In addition for Custom Signals, the MSB must be set to 1 as well
​
int64_t
Duration (in milliseconds) to provision the Resources for. A value of -1 denotes infinite duration.
​
int32_t
A 32 bit signed Integer storing the Properties of the Request. The last 8 bits [25 - 32] store the Request Priority (HIGH / LOW). Defaults to HIGH (0) The Next 8 bits [17 - 24] represent a Bitmask, which indicates The Device modes in which the Request should be processed (Modes: display on / dispaly off / doze), If the device is currently in one of the modes specified via the mask, only then will the request be processed. Defaults to DISPLAY_ON (0)
​
const char *
Name of the Application that is issuing the Request
​
const char *
Name of the Scenario that is issuing the Request
​
int32_t
Number of Additional Arguments to be passed as part of the Request
​
uint32_t *
List of Additional Arguments to be passed as part of the Request
Returns int64_t: A Positive Unique Handle to identify the issued Request. The handle is used for freeing the Provisioned signal later. -1: If the Request could not be sent to the server.

​
relaySignal

Relay the signal to all the features subscribed to the signal with the given ID.
Parameters
​
uint32_t
A uniqued 32-bit (unsigned) identifier for the Signal The last 16 bits (17-32) are used to specify the SigID The next 8 bits (9-16) are used to specify the Signal Category In addition for Custom Signals, the MSB must be set to 1 as well
​
uint32_t
Type of the signal, useful for use-case based signal filtering and selection, i.e. in situations where multiple variants of the same core signal (with minor changes) need to exist to support different use-case scenarios. If no such filtering is needed pass this field as 0.
​
int64_t
Duration (in milliseconds)
​
int32_t
A 32 bit signed Integer storing the Properties of the Request. The last 8 bits [25 - 32] store the Request Priority (HIGH / LOW). Defaults to HIGH (0) The Next 8 bits [17 - 24] represent a Bitmask, which indicates The Device modes in which the Request should be processed (Modes: display on / dispaly off / doze), If the device is currently in one of the modes specified via the mask, only then will the request be processed. Defaults to DISPLAY_ON (0)
​
const char *
Name of the Application that is issuing the Request
​
const char *
Name of the Scenario that is issuing the Request
​
int32_t
Number of Additional Arguments to be passed as part of the Request
​
uint32_t *
List of Additional Arguments to be passed as part of the Request
Returns int8_t: 0: If the Request was successfully sent to the server. -1: Otherwise

​
untuneSignal

Release (or free) the signal with the given handle.
Parameters
​
int64_t
Request Handle, returned by the tuneSignal API call.
Returns int8_t: 0: If the Request was successfully sent to the server. -1: Otherwise

​
retuneSignal

Modify the duration of a previously issued Tune Signal (tuneSignal).
Parameters
​
int64_t
Request Handle, returned by tuneSignal API call.
​
int64_t
The new duration for the previously issued Tune request. A value of -1 denotes infinite duration.
Returns int8_t: 0: If the Request was successfully submitted to the server. -1: Otherwise.