> ## Documentation Index > Fetch the complete documentation index at: https://dragonwingdocs-staging.qualcomm.com/llms.txt > Use this file to discover all available pages before exploring further. # Amdb API > API header for AMDB. **Header:** `spf/api/modules/amdb_api.h` ## Structures ### `amdb_module_reg_info_t` Payload for AMDB\_CMD\_REGISTER\_MODULES. **Members** Type of the module interface. Version of the module interface. ### `amdb_capi_module_reg_info_t` Payload for AMDB\_CMD\_REGISTER\_MODULES. **Members** Type of module. ID for the module. Length of the SO filename (in bytes). Length of tag in bytes. Result of the module registration. ### `amdb_module_registration_t` Payload for AMDB\_CMD\_REGISTER\_MODULES. **Members** ID for the processor domain in which the AMDB is running. Number of modules being registered. Version of the amdb\_module\_reg\_info\_t structure. Array of registration information for num\_modules (of type reg\_info\[num\_modules]). ### `amdb_module_deregistration_t` Payload for AMDB\_CMD\_DEREGISTER\_MODULES. **Members** ID for the processor domain in which the AMDB is running. Number of modules being registered. Array of module IDs for num\_modules (module\_id\[num\_modules]). ### `amdb_load_unload_info_t` Payload for AMDB\_CMD\_LOAD\_MODULES, AMDB\_CMD\_RSP\_LOAD\_MODULES, and AMDB\_CMD\_UNLOAD\_MODULES. **Members** ID for the module. Lower 32 bits of the 64-bit handle to the module. Upper 32 bits of the 64-bit handle to the module. ### `amdb_module_load_unload_t` Payload for AMDB\_CMD\_LOAD\_MODULES, AMDB\_CMD\_RSP\_LOAD\_MODULES, and AMDB\_CMD\_UNLOAD\_MODULES. **Members** ID for the processor domain in which the AMDB is running. Result of module loading. Number of modules being registered. Array of load or unload information for num\_modules (of type load\_unload\_info\[num\_modules]). ### `amdb_param_id_module_version_info_t` Payload for AMDB\_PARAM\_ID\_MODULE\_VERSION\_INFO. **Members** ID for the processor domain. Number of modules in the array. ### `amdb_module_build_ts_info_t` **Members** Year that the build was produced. month the build was produced day the build was produced hour the build was produced minute the build was produced second the build was produced ### `amdb_module_version_info_payload_t` **Members** Requested module id, to be filled in by the client. Indicates whether an error has occurred loading the module. 1 if and only if the module is present and not stubbed in the AMDB. Major version of the requested module. Minor version of the requested module. Indicates the time at which the build for the given module was created. ## Type Definitions ### `amdb_module_reg_info_t` ```cpp theme={null} typedef struct amdb_module_reg_info_t amdb_module_reg_info_t ``` ### `amdb_capi_module_reg_info_t` ```cpp theme={null} typedef struct amdb_capi_module_reg_info_t amdb_capi_module_reg_info_t ``` ### `amdb_module_registration_t` ```cpp theme={null} typedef struct amdb_module_registration_t amdb_module_registration_t ``` ### `amdb_module_deregistration_t` ```cpp theme={null} typedef struct amdb_module_deregistration_t amdb_module_deregistration_t ``` ### `amdb_load_unload_info_t` ```cpp theme={null} typedef struct amdb_load_unload_info_t amdb_load_unload_info_t ``` ### `amdb_module_load_unload_t` ```cpp theme={null} typedef struct amdb_module_load_unload_t amdb_module_load_unload_t ``` ### `amdb_param_id_module_version_info_t` ```cpp theme={null} typedef struct amdb_param_id_module_version_info_t amdb_param_id_module_version_info_t ``` ### `amdb_module_build_ts_info_t` ```cpp theme={null} typedef struct amdb_module_build_ts_info_t amdb_module_build_ts_info_t ``` ### `amdb_module_version_info_payload_t` ```cpp theme={null} typedef struct amdb_module_version_info_payload_t amdb_module_version_info_payload_t ``` ## Macros ### `AMDB_MODULE_REG_STRUCT_V1` ```c theme={null} #define AMDB_MODULE_REG_STRUCT_V1 1 ``` ### `AMDB_INTERFACE_TYPE_CAPI` Interface type is the Common Audio Processor Interface. ```c theme={null} #define AMDB_INTERFACE_TYPE_CAPI 2 ``` ### `AMDB_INTERFACE_VERSION_CAPI_V3` Interface version is the Common Audio Processor Interface version 3. ```c theme={null} #define AMDB_INTERFACE_VERSION_CAPI_V3 3 ``` ### `AMDB_MODULE_TYPE_GENERIC` Module is generic, such as a preprocessor, postprocessor, and so on. ```c theme={null} #define AMDB_MODULE_TYPE_GENERIC 2 ``` ### `AMDB_MODULE_TYPE_DECODER` Module is a decoder. ```c theme={null} #define AMDB_MODULE_TYPE_DECODER 3 ``` ### `AMDB_MODULE_TYPE_ENCODER` Module is an encoder. ```c theme={null} #define AMDB_MODULE_TYPE_ENCODER 4 ``` ### `AMDB_MODULE_TYPE_CONVERTER` Module is a converter. ```c theme={null} #define AMDB_MODULE_TYPE_CONVERTER 5 ``` ### `AMDB_MODULE_TYPE_PACKETIZER` Module is a packetizer. ```c theme={null} #define AMDB_MODULE_TYPE_PACKETIZER 6 ``` ### `AMDB_MODULE_TYPE_DEPACKETIZER` Module is a de-packetizer. ```c theme={null} #define AMDB_MODULE_TYPE_DEPACKETIZER 7 ``` ### `AMDB_MODULE_TYPE_DETECTOR` Module is a detector (such as DTMF, VoiceUI). ```c theme={null} #define AMDB_MODULE_TYPE_DETECTOR 8 ``` ### `AMDB_MODULE_TYPE_GENERATOR` Module is a generator (such as DTMF, Ultrasound). ```c theme={null} #define AMDB_MODULE_TYPE_GENERATOR 9 ``` ### `AMDB_MODULE_TYPE_PP` Module is a pre or post-processor (such as filters). ```c theme={null} #define AMDB_MODULE_TYPE_PP 10 ``` ### `AMDB_MODULE_TYPE_END_POINT` Module is a an end point (software or hardware end point, such as I2S source or sink). ```c theme={null} #define AMDB_MODULE_TYPE_END_POINT 11 ``` ### `AMDB_MODULE_INSTANCE_ID` Instance ID for the AMDB module. ```c theme={null} #define AMDB_MODULE_INSTANCE_ID 0x00000003 ``` ### `AMDB_CMD_REGISTER_MODULES` Registers a module with the AMDB to enable the module for dynamic loading. ```c theme={null} #define AMDB_CMD_REGISTER_MODULES 0x0100101E ``` ### `AMDB_CMD_DEREGISTER_MODULES` Deregisters one or more registered modules. ```c theme={null} #define AMDB_CMD_DEREGISTER_MODULES 0x0100101F ``` ### `AMDB_CMD_LOAD_MODULES` Loads one or more modules if they were successfully registered with the AMDB. ```c theme={null} #define AMDB_CMD_LOAD_MODULES 0x01001020 ``` ### `AMDB_CMD_RSP_LOAD_MODULES` Sent in response to an AMDB\_CMD\_LOAD\_MODULES command. ```c theme={null} #define AMDB_CMD_RSP_LOAD_MODULES 0x02001008 ``` ### `AMDB_CMD_UNLOAD_MODULES` Unloads a module that was loaded via the AMDB\_CMD\_LOAD\_MODULES command. ```c theme={null} #define AMDB_CMD_UNLOAD_MODULES 0x01001022 ``` ### `AMDB_PARAM_ID_MODULE_VERSION_INFO` Identifier for the parameter that gets the module version info. ```c theme={null} #define AMDB_PARAM_ID_MODULE_VERSION_INFO 0x080013D6 ``` ### `AMDB_MODULE_INFO_OK` ```c theme={null} #define AMDB_MODULE_INFO_OK 0 ``` ### `AMDB_MODULE_INFO_ERR_FILE_NOT_FOUND` ```c theme={null} #define AMDB_MODULE_INFO_ERR_FILE_NOT_FOUND 1 ``` ### `AMDB_MODULE_INFO_ERR_DYNAMIC_LINK` ```c theme={null} #define AMDB_MODULE_INFO_ERR_DYNAMIC_LINK 2 ``` ### `AMDB_MODULE_INFO_ERR_GENERAL` ```c theme={null} #define AMDB_MODULE_INFO_ERR_GENERAL 0xFFFFFFFF ```