Skip to main content
Header: spf/api/apm/apm_api.h

Structures

apm_cmd_header_t

In-band : This structure is followed by an in-band payload of type, apm_module_param_data_t Out-of-band : Out of band payload can be extracted from the mem_map_handle, payload_address_lsw and payload_address_msw using the posal api posal_memorymap_get_virtual_addr_from_shmm_handle. Members
uint32_t
Lower 32 bits of the payload address.
uint32_t
Upper 32 bits of the payload address.
uint32_t
Unique identifier for a shared memory address.
uint32_t
Actual size of the variable payload accompanying the message or in shared memory.

apm_module_param_data_t

Payload of the module parameter data structure. Members
uint32_t
Valid instance ID of module @values
uint32_t
Valid ID of the parameter.
uint32_t
Size of the parameter data based upon the module_instance_id/param_id combination.
uint32_t
Error code populated by the entity hosting the module.

apm_module_param_shared_data_t

Payload of the shared persistent module parameter data structure. Members
uint32_t
Valid ID of the parameter.
uint32_t
Size of the parameter data based upon the module_instance_id/param_id combination.

apm_prop_data_t

Payload of the property data structure. Members
uint32_t
Property ID @values
uint32_t
Size of the property ID structure.

apm_module_register_events_t

Payload of the register events data structure. Members
uint32_t
Valid instance ID of module.
uint32_t
Valid event ID of the module.
uint32_t
1 - to register the event 0 - to de-register the event
uint32_t
Error code populated by the entity hosting the module.
uint32_t
Size of the event config data based upon the module_instance_id/event_id combination.
uint32_t
reserved must be set to zero.

apm_module_event_t

Payload of the module event data structure. Members
uint32_t
Valid event ID of the module.
uint32_t
Size of the event data based upon the module_instance_id/eveny_id combination.

apm_cmd_rsp_get_cfg_t

Members
uint32_t

apm_cmd_rsp_get_spf_status_t

Members
uint32_t
spf status.

apm_path_defn_for_delay_t

This struct defines the start and end of path for which delay is queried. Members
uint32_t
Source module instance ID input parameter.
uint32_t
Source port-ID.
uint32_t
Destination module instance ID.
uint32_t
Destination port-ID.
uint32_t
Microsecond delay This is an output parameter.

apm_param_id_path_delay_t

defines the main payload for the APM_PARAM_ID_PATH_DELAY query Members
uint32_t
apm_path_defn_for_delay_t
number of paths to be queried

apm_param_id_satellite_pd_info_t

Members
uint32_t
Number of satellite proc domain ids.
uint32_t
List of atellite proc domain IDs.

Type Definitions

apm_cmd_header_t

apm_module_param_data_t

apm_module_param_shared_data_t

apm_prop_data_t

apm_module_register_events_t

apm_module_event_t

apm_cmd_rsp_get_cfg_t

apm_cmd_rsp_get_spf_status_t

apm_path_defn_for_delay_t

apm_param_id_path_delay_t

apm_param_id_satellite_pd_info_t

Macros

APM_MODULE_INSTANCE_ID

Instance ID of the Audio Processing Manager module.

APM_CMD_GRAPH_OPEN

APM_CMD_GRAPH_PREPARE

Prepares one or more sub-graph ID’s that have been configured Graph prepare command is issued against APM module instance iD.

APM_CMD_GRAPH_START

Starts one or more sub-graph ID’s that have been configured using the APM_CMD_GRAPH_OPEN.

APM_CMD_GRAPH_STOP

Stops one or more sub-graph ID’s that have been configured using the APM_CMD_GRAPH_OPEN.

APM_CMD_GRAPH_CLOSE

Closes one or more sub-graph ID’s, data and control links that have been configured using the APM_CMD_GRAPH_OPEN command.

APM_CMD_CLOSE_ALL

This command is used by the client for cleaning up all the allocated resources within the framework including.

APM_CMD_GRAPH_FLUSH

Flushes one or more sub-graph ID’s that have been configured Graph flush command is issued against APM module instance iD.

APM_CMD_SET_CFG

Configures one or more parameter ID’s for one more module instances present in the graph.

APM_CMD_GET_CFG

This parameter is used for querying one or more configuration/calibration parameter ID corresponding to any module instance ID.

APM_CMD_RSP_GET_CFG

The response code returned as an acknowledgment for the APM_CMD_GET_CFG command.

APM_CMD_REGISTER_CFG

This command is used for registering persistent calibration/configuration data corresponding to one or more parameter ID’s for one ore more data/control processing modules.

APM_CMD_DEREGISTER_CFG

This command is used for de-registering persistent calibration/configuration data corresponding to one or more parameter ID’s for one or more data/control processing modules.

APM_CMD_REGISTER_SHARED_CFG

This command is used for registering shared persistent calibration/configuration data corresponding to one parameter ID’s for any data/control processing modules.

APM_CMD_DEREGISTER_SHARED_CFG

This command is used for registering shared persistent calibration/configuration data corresponding to one parameter ID’s for any data/control processing modules.

APM_CMD_REGISTER_MODULE_EVENTS

Registers/de-registers one or more event ID’s for one or more module instances present in the graph.

APM_CMD_GET_SPF_STATE

This parameter is used for querying SPF status.

APM_SPF_STATE_NOT_READY

Definition for the spf Not-Ready State.

APM_SPF_STATE_READY

Definition for the spf Ready State.

APM_CMD_RSP_GET_SPF_STATE

The response code returned as an acknowledgment for the APM_CMD_GET_SPF_STATE command.

APM_EVENT_MODULE_TO_CLIENT

Event raised by module to client, if the event is registered by the client.

APM_PARAM_ID_PATH_DELAY

Parameter ID for getting path delay from APM.

APM_CMD_GRAPH_SUSPEND

APM_PARAM_ID_SATELLITE_PD_INFO

This parameter is used for setting satellite proc domain info to the master APM.