Skip to main content
Header: spf/api/modules/asr_module_calibration_api.h

Structures

asr_version_t

Members
uint32_t
uint32_t

param_id_asr_config_t

Members
uint32_t
uint32_t
}
uint32_t
}
uint32_t
}
uint32_t
}
uint32_t
}
uint32_t
}
uint32_t
uint32_t
} ms

param_id_asr_input_threshold_t

Members
uint32_t

param_id_asr_input_threshold_v2_t

Members
uint32_t
uint32_t
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
uint32_t

param_id_asr_force_output_v2_t

Members
uint32_t
uint32_t
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
uint32_t
uint32_t
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.}
uint32_t
} // ASR engine controlled default if not configured

param_id_asr_output_config_v2_base_t

Members
uint32_t
uint32_t
This API allow multiple clients to have unique configurations ASR_CLIENT_HLOS - Client is HLOS. ASR_CLIENT_LLS - Client is Sensor.}
uint32_t
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.}
uint32_t
} // ASR engine controlled default if not configured

param_id_asr_output_config_v2_t

Members
uint32_t

event_id_asr_output_reg_cfg_t

@parameter @description @toolPolicy Members
uint32_t
QUERY - Client queries the output via getparam upon receiving ASR output event.

event_id_asr_output_reg_cfg_v2_t

@parameter @description @toolPolicy Members
uint32_t
ASR_CLIENT_HLOS - Client is HLOS.
uint32_t
QUERY - Client queries the output via getparam upon receiving ASR output event.

asr_output_status_t

Members
uint32_t
uint32_t
uint32_t
uint32_t
uint8_t

asr_model_param_t

Members
uint32_t
uint32_t
uint32_t
uint8_t

event_id_asr_output_event_t

Members
uint32_t
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 }
uint32_t
This can be used by clients to query the payload param in ‘Getparam’ mode}
uint32_t
uint32_t
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
uint32_t
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.}
uint32_t
uint32_t
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
uint32_t

asr_word_status_t

Members
uint32_t
uint32_t
(Not including the NULL character)}
uint8_t
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}
uint32_t
}
uint32_t
}
uint32_t
}
uint32_t
}

asr_output_status_v2_t

Members
uint32_t
uint32_t
uint32_t
uint32_t
uint8_t
uint32_t
}
uint32_t
}
uint32_t
}
uint32_t
}
uint32_t
this is variable payload based on num_words field above.}

param_id_asr_output_v2_t

Members
uint32_t
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.}
uint32_t
uint32_t
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
uint32_t
This must match the client_id used in PARAM_ID_ASR_OUTPUT_CONFIG_V2. Allows multiple clients to independently query their own output buffers.}
uint32_t
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.}
uint32_t
uint32_t
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
uint32_t
Note: the this will only work with timestamp enabled modes.}
uint32_t
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.}
uint32_t
Currently only TIME_USEC is supported}

Type Definitions

asr_version_t

param_id_asr_config_t

param_id_asr_input_threshold_t

param_id_asr_input_threshold_v2_t

param_id_asr_force_output_t

param_id_asr_force_output_v2_t

param_id_asr_output_config_t

param_id_asr_output_config_v2_t

event_id_asr_output_reg_cfg_t

event_id_asr_output_reg_cfg_v2_t

asr_output_status_t

asr_model_param_t

event_id_asr_output_event_t

param_id_asr_output_t

param_id_asr_algo_max_inference_time_t

asr_output_status_v2_t

param_id_asr_output_v2_t

param_id_asr_output_v3_t

param_id_asr_ts_fmt_t

asr_client_id_t

asr_output_mode_t

ASR_LANGUAGE_CODE_t

Enumerations

asr_output_status_value

Values

asr_client_id_t

Values

asr_output_mode_t

Values

ASR_LANGUAGE_CODE_t

Values

Macros

ASR_ENPU_RELEASE_VERSION_MAJOR

ASR_ENPU_RELEASE_VERSION_MINOR

PARAM_ID_ASR_VERSION

PARAM_ID_ASR_CONFIG

PARAM_ID_ASR_INPUT_THRESHOLD

PARAM_ID_ASR_INPUT_THRESHOLD_V2

PARAM_ID_ASR_FORCE_OUTPUT

PARAM_ID_ASR_FORCE_OUTPUT_V2

PARAM_ID_ASR_OUTPUT_CONFIG

PARAM_ID_ASR_OUTPUT_CONFIG_V2

EVENT_ID_ASR_OUTPUT

EVENT_ID_ASR_OUTPUT_V2

MAX_TRANSCRIPTION_CHAR_SIZE

PARAM_ID_ASR_LLM

PARAM_ID_ASR_OUTPUT

PARAM_ID_ASR_ALGO_MAX_INFERENCE_TIME

MAX_WORD_SIZE

PARAM_ID_ASR_OUTPUT_V2

PARAM_ID_ASR_OUTPUT_V3

PARAM_ID_ASR_TIMESTAMP_FORMAT

MODULE_ID_ASR