Header: spf/api/apm/apm_api.hStructures 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 Lower 32 bits of the payload address.
Upper 32 bits of the payload address.
Unique identifier for a shared memory address.
Actual size of the variable payload accompanying the message or in shared memory.
apm_module_param_data_tPayload of the module parameter data structure.
Members Valid instance ID of module @values
Valid ID of the parameter.
Size of the parameter data based upon the module_instance_id/param_id combination.
Error code populated by the entity hosting the module.
apm_module_param_shared_data_tPayload of the shared persistent module parameter data structure.
Members Valid ID of the parameter.
Size of the parameter data based upon the module_instance_id/param_id combination.
apm_prop_data_tPayload of the property data structure.
Members Size of the property ID structure.
apm_module_register_events_tPayload of the register events data structure.
Members Valid instance ID of module.
Valid event ID of the module.
1 - to register the event 0 - to de-register the event
Error code populated by the entity hosting the module.
event_config_payload_size Size of the event config data based upon the module_instance_id/event_id combination.
reserved must be set to zero.
apm_module_event_tPayload of the module event data structure.
Members Valid event ID of the module.
Size of the event data based upon the module_instance_id/eveny_id combination.
apm_cmd_rsp_get_cfg_tMembers apm_cmd_rsp_get_spf_status_tMembers apm_path_defn_for_delay_tThis struct defines the start and end of path for which delay is queried.
Members Source module instance ID input parameter.
Destination module instance ID.
Microsecond delay This is an output parameter.
apm_param_id_path_delay_tdefines the main payload for the APM_PARAM_ID_PATH_DELAY query
Members paths apm_path_defn_for_delay_t
number of paths to be queried
apm_param_id_satellite_pd_info_tMembers Number of satellite proc domain ids.
List of atellite proc domain IDs.
Type Definitions apm_module_param_data_tapm_module_param_shared_data_tapm_prop_data_tapm_module_register_events_tapm_module_event_tapm_cmd_rsp_get_cfg_tapm_cmd_rsp_get_spf_status_tapm_path_defn_for_delay_tapm_param_id_path_delay_tapm_param_id_satellite_pd_info_tMacros APM_MODULE_INSTANCE_IDInstance ID of the Audio Processing Manager module.
APM_CMD_GRAPH_OPENAPM_CMD_GRAPH_PREPAREPrepares one or more sub-graph ID’s that have been configured Graph prepare command is issued against APM module instance iD.
APM_CMD_GRAPH_STARTStarts one or more sub-graph ID’s that have been configured using the APM_CMD_GRAPH_OPEN.
APM_CMD_GRAPH_STOPStops one or more sub-graph ID’s that have been configured using the APM_CMD_GRAPH_OPEN.
APM_CMD_GRAPH_CLOSECloses 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_ALLThis command is used by the client for cleaning up all the allocated resources within the framework including.
APM_CMD_GRAPH_FLUSHFlushes one or more sub-graph ID’s that have been configured Graph flush command is issued against APM module instance iD.
APM_CMD_SET_CFGConfigures one or more parameter ID’s for one more module instances present in the graph.
APM_CMD_GET_CFGThis parameter is used for querying one or more configuration/calibration parameter ID corresponding to any module instance ID.
APM_CMD_RSP_GET_CFGThe response code returned as an acknowledgment for the APM_CMD_GET_CFG command.
APM_CMD_REGISTER_CFGThis 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_CFGThis 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_CFGThis 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_CFGThis 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_EVENTSRegisters/de-registers one or more event ID’s for one or more module instances present in the graph.
APM_CMD_GET_SPF_STATEThis parameter is used for querying SPF status.
APM_SPF_STATE_NOT_READYDefinition for the spf Not-Ready State.
APM_SPF_STATE_READYDefinition for the spf Ready State.
APM_CMD_RSP_GET_SPF_STATEThe response code returned as an acknowledgment for the APM_CMD_GET_SPF_STATE command.
APM_EVENT_MODULE_TO_CLIENTEvent raised by module to client, if the event is registered by the client.
APM_PARAM_ID_PATH_DELAYParameter ID for getting path delay from APM.
APM_CMD_GRAPH_SUSPENDAPM_PARAM_ID_SATELLITE_PD_INFOThis parameter is used for setting satellite proc domain info to the master APM.
