> ## 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. # Asr Module Calibration API **Header:** `spf/api/modules/asr_module_calibration_api.h` ## Structures ### `asr_version_t` **Members** ### `param_id_asr_config_t` **Members** } } } } } } } ms ### `param_id_asr_input_threshold_t` **Members** ### `param_id_asr_input_threshold_v2_t` **Members** This API allows multiple clients to have unique input threshold configurations. ASR\_CLIENT\_HLOS - Client is HLOS. ASR\_CLIENT\_LLS - Client is Sensor.} ### `param_id_asr_force_output_t` **Members** ### `param_id_asr_force_output_v2_t` **Members** This API allows forcing output for a specific client in multi-client scenarios. ASR\_CLIENT\_HLOS - Force output for HLOS client. ASR\_CLIENT\_LLS - Force output for Sensor client.} ### `param_id_asr_output_config_t` **Members** ASR\_NON\_BUFFERED - Output of each ASR algo process is immediately sent to client. ASR\_BUFFERED - Output of each ASR algo process is buffered and sent to client intermittently. ASR\_LOGGER - Output of each ASR algo process is stored and sent to client on demand. ASR\_TS\_NON\_BUFFERED - Output of each ASR algo process is immediately sent to client with timestamps. ASR\_TS\_BUFFERED - Output of each ASR algo process is buffered and sent to client intermittently with timestamps. ASR\_TS\_LOGGER - Output of each ASR algo process is stored and sent to client on demand with timestamps.} } // ASR engine controlled default if not configured ### `param_id_asr_output_config_v2_base_t` **Members** This API allow multiple clients to have unique configurations ASR\_CLIENT\_HLOS - Client is HLOS. ASR\_CLIENT\_LLS - Client is Sensor.} ASR\_NON\_BUFFERED - Output of every process input frame is immediately sent to client. ASR\_BUFFERED - Output of every process input frame is buffered and sent to client intermittently. ASR\_LOGGER - Output of every process input frame is stored and sent to client on demand. ASR\_TS\_NON\_BUFFERED - Output of every process input frame is immediately sent to client with timestamps. ASR\_TS\_BUFFERED - Output of every process input frame is buffered and sent to client intermittently with timestamps. ASR\_TS\_LOGGER - Output of every process input frame is stored and sent to client on demand with timestamps.} } // ASR engine controlled default if not configured ### `param_id_asr_output_config_v2_t` **Members** ### `event_id_asr_output_reg_cfg_t` @parameter @description @toolPolicy **Members** QUERY - Client queries the output via getparam upon receiving ASR output event. ### `event_id_asr_output_reg_cfg_v2_t` @parameter @description @toolPolicy **Members** ASR\_CLIENT\_HLOS - Client is HLOS. QUERY - Client queries the output via getparam upon receiving ASR output event. ### `asr_output_status_t` **Members** ### `asr_model_param_t` **Members** ### `event_id_asr_output_event_t` **Members** Default mode is Query. QUERY = Client will query via getparam upon receiving this event, using the output\_token provided as part of this payload. Inband = ASR output payload follows inband after the payload\_size field } This can be used by clients to query the payload param in 'Getparam' mode} Following this field is the payload of this size. Payload is variable array of type asr\_output\_status\_t . Size '0' indicates this is an event generated without any valid output, for example : in response to a force output param set by client. } ### `param_id_asr_output_t` **Members** This can be used by clients to query the corresponding payload. If not configured or invalid, Payload corresponds to output buffers in sequential order as produced by ASR engine.} Following this field is the payload of this size. Payload is variable array of type asr\_output\_status\_t . Size '0' indicates this is an event generated without any valid output, for example : in response to a force output param set by client. } ### `param_id_asr_algo_max_inference_time_t` **Members** ### `asr_word_status_t` **Members** (Not including the NULL character)} MAX\_WORD\_SIZE to be a multiple of 4. Client should read only word\_size from this array for the actual word which does not include any null term char} } } } } ### `asr_output_status_v2_t` **Members** } } } } this is variable payload based on num\_words field above.} ### `param_id_asr_output_v2_t` **Members** This can be used by clients to query the corresponding payload. If not configured or invalid, Payload corresponds to output buffers in sequential order as produced by ASR engine.} Following this field is the payload of this size. Payload is variable array of type asr\_output\_status\_v2\_t . Size '0' indicates this is an event generated without any valid output, for example : in response to a force output param set by client. } ### `param_id_asr_output_v3_t` **Members** This must match the client\_id used in PARAM\_ID\_ASR\_OUTPUT\_CONFIG\_V2. Allows multiple clients to independently query their own output buffers.} This can be used by clients to query the corresponding payload. If not configured or invalid, Payload corresponds to output buffers in sequential order as produced by ASR engine.} Following this field is the payload of this size. Payload is variable array of type asr\_output\_status\_v2\_t . Size '0' indicates this is an event generated without any valid output, for example : in response to a force output param set by client. } ### `param_id_asr_ts_fmt_t` **Members** Note: the this will only work with timestamp enabled modes.} Note: '0' means module latches to UTC time only at the beginning of the usecase and doesn't periodically sync to UTC time for dynamic changes. For non-zero values say 'x' seconds, the module will dynamically sync and update the UTC time at every x seconds. The maximum reset period allowed is a day.} Currently only TIME\_USEC is supported} ## Type Definitions ### `asr_version_t` ```cpp theme={null} typedef struct asr_version_t asr_version_t ``` ### `param_id_asr_config_t` ```cpp theme={null} typedef struct param_id_asr_config_t param_id_asr_config_t ``` ### `param_id_asr_input_threshold_t` ```cpp theme={null} typedef struct param_id_asr_input_threshold_t param_id_asr_input_threshold_t ``` ### `param_id_asr_input_threshold_v2_t` ```cpp theme={null} typedef struct param_id_asr_input_threshold_v2_t param_id_asr_input_threshold_v2_t ``` ### `param_id_asr_force_output_t` ```cpp theme={null} typedef struct param_id_asr_force_output_t param_id_asr_force_output_t ``` ### `param_id_asr_force_output_v2_t` ```cpp theme={null} typedef struct param_id_asr_force_output_v2_t param_id_asr_force_output_v2_t ``` ### `param_id_asr_output_config_t` ```cpp theme={null} typedef struct param_id_asr_output_config_t param_id_asr_output_config_t ``` ### `param_id_asr_output_config_v2_t` ```cpp theme={null} typedef struct param_id_asr_output_config_v2_t param_id_asr_output_config_v2_t ``` ### `event_id_asr_output_reg_cfg_t` ```cpp theme={null} typedef struct event_id_asr_output_reg_cfg_t event_id_asr_output_reg_cfg_t ``` ### `event_id_asr_output_reg_cfg_v2_t` ```cpp theme={null} typedef struct event_id_asr_output_reg_cfg_v2_t event_id_asr_output_reg_cfg_v2_t ``` ### `asr_output_status_t` ```cpp theme={null} typedef struct asr_output_status_t asr_output_status_t ``` ### `asr_model_param_t` ```cpp theme={null} typedef struct asr_model_param_t asr_model_param_t ``` ### `event_id_asr_output_event_t` ```cpp theme={null} typedef struct event_id_asr_output_event_t event_id_asr_output_event_t ``` ### `param_id_asr_output_t` ```cpp theme={null} typedef struct param_id_asr_output_t param_id_asr_output_t ``` ### `param_id_asr_algo_max_inference_time_t` ```cpp theme={null} typedef struct param_id_asr_algo_max_inference_time_t param_id_asr_algo_max_inference_time_t ``` ### `asr_output_status_v2_t` ```cpp theme={null} typedef struct asr_output_status_v2_t asr_output_status_v2_t ``` ### `param_id_asr_output_v2_t` ```cpp theme={null} typedef struct param_id_asr_output_v2_t param_id_asr_output_v2_t ``` ### `param_id_asr_output_v3_t` ```cpp theme={null} typedef struct param_id_asr_output_v3_t param_id_asr_output_v3_t ``` ### `param_id_asr_ts_fmt_t` ```cpp theme={null} typedef struct param_id_asr_ts_fmt_t param_id_asr_ts_fmt_t ``` ### `asr_client_id_t` ```cpp theme={null} typedef enum asr_client_id_t asr_client_id_t ``` ### `asr_output_mode_t` ```cpp theme={null} typedef enum asr_output_mode_t asr_output_mode_t ``` ### `ASR_LANGUAGE_CODE_t` ```cpp theme={null} typedef enum ASR_LANGUAGE_CODE_t ASR_LANGUAGE_CODE_t ``` ## Enumerations ### `asr_output_status_value` #### Values | Name | Value | Description | | ------------- | ----- | ----------- | | `ASR_SUCCESS` | = 0 | | | `ASR_FAIL` | = 1 | | | `ASR_TIMEOUT` | = 12 | | ### `asr_client_id_t` #### Values | Name | Value | Description | | -------------------- | ----- | ----------- | | `ASR_CLIENT_INVALID` | = 0 | | | `ASR_CLIENT_HLOS` | = 1 | | | `ASR_CLIENT_LLS` | = 2 | | ### `asr_output_mode_t` #### Values | Name | Value | Description | | --------------------- | ----- | ----------- | | `ASR_NON_BUFFERED` | = 0 | | | `ASR_BUFFERED` | | | | `ASR_LOGGER` | | | | `ASR_TS_NON_BUFFERED` | | | | `ASR_TS_BUFFERED` | | | | `ASR_TS_LOGGER` | | | ### `ASR_LANGUAGE_CODE_t` #### Values | Name | Value | Description | | --------------------- | ----- | ----------- | | `en_US` | =0 | | | `zh_CN` | | | | `hi_IN` | | | | `es_US` | | | | `ko_KR` | | | | `ja_JP` | | | | `language_code_end_1` | | | ## Macros ### `ASR_ENPU_RELEASE_VERSION_MAJOR` ```c theme={null} #define ASR_ENPU_RELEASE_VERSION_MAJOR 0x00000001 ``` ### `ASR_ENPU_RELEASE_VERSION_MINOR` ```c theme={null} #define ASR_ENPU_RELEASE_VERSION_MINOR 0x00000000 ``` ### `PARAM_ID_ASR_VERSION` ```c theme={null} #define PARAM_ID_ASR_VERSION 0x08001AA3 ``` ### `PARAM_ID_ASR_CONFIG` ```c theme={null} #define PARAM_ID_ASR_CONFIG 0x08001AA4 ``` ### `PARAM_ID_ASR_INPUT_THRESHOLD` ```c theme={null} #define PARAM_ID_ASR_INPUT_THRESHOLD 0x08001AA5 ``` ### `PARAM_ID_ASR_INPUT_THRESHOLD_V2` ```c theme={null} #define PARAM_ID_ASR_INPUT_THRESHOLD_V2 0x08001BC5 ``` ### `PARAM_ID_ASR_FORCE_OUTPUT` ```c theme={null} #define PARAM_ID_ASR_FORCE_OUTPUT 0x08001AA6 ``` ### `PARAM_ID_ASR_FORCE_OUTPUT_V2` ```c theme={null} #define PARAM_ID_ASR_FORCE_OUTPUT_V2 0x08001BC6 ``` ### `PARAM_ID_ASR_OUTPUT_CONFIG` ```c theme={null} #define PARAM_ID_ASR_OUTPUT_CONFIG 0x08001AA7 ``` ### `PARAM_ID_ASR_OUTPUT_CONFIG_V2` ```c theme={null} #define PARAM_ID_ASR_OUTPUT_CONFIG_V2 0x08001BC3 ``` ### `EVENT_ID_ASR_OUTPUT` ```c theme={null} #define EVENT_ID_ASR_OUTPUT 0x08001AA8 ``` ### `EVENT_ID_ASR_OUTPUT_V2` ```c theme={null} #define EVENT_ID_ASR_OUTPUT_V2 0x08001BCA ``` ### `MAX_TRANSCRIPTION_CHAR_SIZE` ```c theme={null} #define MAX_TRANSCRIPTION_CHAR_SIZE 1024 ``` ### `PARAM_ID_ASR_LLM` ```c theme={null} #define PARAM_ID_ASR_LLM 0x08001AA9 ``` ### `PARAM_ID_ASR_OUTPUT` ```c theme={null} #define PARAM_ID_ASR_OUTPUT 0x08001AAA ``` ### `PARAM_ID_ASR_ALGO_MAX_INFERENCE_TIME` ```c theme={null} #define PARAM_ID_ASR_ALGO_MAX_INFERENCE_TIME 0x08001B06 ``` ### `MAX_WORD_SIZE` ```c theme={null} #define MAX_WORD_SIZE 28 ``` ### `PARAM_ID_ASR_OUTPUT_V2` ```c theme={null} #define PARAM_ID_ASR_OUTPUT_V2 0x08001B04 ``` ### `PARAM_ID_ASR_OUTPUT_V3` ```c theme={null} #define PARAM_ID_ASR_OUTPUT_V3 0x08001BCB ``` ### `PARAM_ID_ASR_TIMESTAMP_FORMAT` ```c theme={null} #define PARAM_ID_ASR_TIMESTAMP_FORMAT 0x08001B83 ``` ### `MODULE_ID_ASR` ```c theme={null} #define MODULE_ID_ASR 0x7001176 ```