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

Structures

param_id_detection_engine_config_t

Members
uint16_t
}
uint16_t
If custom_payload_size is not 4-byte aligned, the caller must fill padding bytes to ensure that the entire calibration is 4-byte aligned.Immediately following this variable is the custom configuration payload of size custom_payload_size.}

param_id_detection_gain_t

Members
int16_t
}
uint16_t
}

param_id_detection_engine_register_multi_sound_model_t

Members
uint32_t
uint32_t
Sound model payload follows this variable}
uint8_t
}

param_id_detection_engine_deregister_multi_sound_model_t

Members
uint32_t

param_id_best_ch_enable_t

Members
uint32_t
}

param_id_detection_engine_generic_event_cfg_t

Members
uint32_t
Set this field only if the event_type variable is set to 1.}

event_id_detection_engine_generic_info_t

Members
uint16_t
Status sent by the Detection Engine module to the client.
uint16_t
Actual size of the parameter data payload that follows this structure.

detection_event_info_header_t

Members
detection_engine_event_key_id_info_t
Different key_ids @values.
uint32_t
Size of a specific key payload.

confidence_level_info_t

Members
uint32_t
}
uint8_t
This array is of size DETECTION_ENGINE_MAX_REGISTERED_MODELS. Each element is 1 byte long.Assuming N keywords and M active user models are included in the model, the first N elements of this parameter correspond to the confidence of N keywords. The N+1 to N+M elements control the confidence level of the M active user model. Each element maps confidence values for entries (keyword or user specific keyword) whose order is specified in the sound model.}

keyword_position_info_t

Members
uint32_t
(in us).}
uint32_t
(in us).}
uint32_t
(in us).}
uint32_t
(in us).}

detection_timestamp_info_t

Members
uint32_t
(in milliseconds).}
uint32_t
}

ftrt_data_info_t

Members
uint32_t
}

best_ch_idx_info_t

Members
uint32_t

voice_ui_multi_model_result_info_t

Members
uint32_t
If 3 models are registered with STAGE1_SVA5 and detected happened for 2 models, then this value will be set to 2 Following this will be num_detected_models number of model_stats_t type payloads each containing the result statistics for each detected model}

model_stats_t

Members
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
(in us).}
uint32_t
(in us).}
uint32_t
(in us).}
uint32_t
(in us).}
uint32_t
(in milliseconds).}
uint32_t
}

batch_drain_complete_info_t

Members
uint32_t
Always set to 1.}

param_id_detection_engine_buffering_config_t

Members
uint32_t
The duration is limited by the memory available in the system.}
uint32_t
}

param_id_detection_engine_multi_model_buffering_config_t

Members
uint32_t
uint32_t
The duration is limited by the memory available in the system.}
uint32_t
}

param_id_detection_engine_per_model_reset_t

Members
uint32_t

Type Definitions

param_id_detection_engine_config_t

param_id_detection_gain_t

param_id_detection_engine_register_multi_sound_model_t

param_id_detection_engine_deregister_multi_sound_model_t

param_id_best_ch_enable_t

param_id_detection_engine_generic_event_cfg_t

event_id_detection_engine_generic_info_t

detection_engine_event_key_id_info_t

IDs for keyword index information and confidence value information in the detection engine generic event payload.

param_id_detection_engine_buffering_config_t

param_id_detection_engine_multi_model_buffering_config_t

param_id_detection_engine_per_model_reset_t

Enumerations

detection_engine_event_key_id_info_t

IDs for keyword index information and confidence value information in the detection engine generic event payload.

Values

Macros

DETECTION_ENGINE_MAX_REGISTERED_MODELS

DETECTION_STATUS_SUCCESS

Status (Detected) sent to notify that the detection engine has detected a keyword.

DETECTION_STATUS_FAILURE

Status (Rejected) sent to notify the that a detection module has rejected a keyword.

MAX_MODELS_SUPPORTED

MAX_KEYWORDS_SUPPORTED

PARAM_ID_DETECTION_ENGINE_CONFIG

PARAM_ID_DETECTION_GAIN

PARAM_ID_DETECTION_ENGINE_SOUND_MODEL

PARAM_ID_DETECTION_ENGINE_REGISTER_MULTI_SOUND_MODEL

PARAM_ID_DETECTION_ENGINE_DEREGISTER_MULTI_SOUND_MODEL

PARAM_ID_BEST_CH_ENABLE

PARAM_ID_DETECTION_ENGINE_GENERIC_EVENT_CFG

EVENT_ID_DETECTION_ENGINE_GENERIC_INFO

PARAM_ID_DETECTION_ENGINE_RESET

PARAM_ID_DETECTION_ENGINE_BUFFERING_CONFIG

PARAM_ID_DETECTION_ENGINE_MULTI_MODEL_BUFFERING_CONFIG

PARAM_ID_DETECTION_ENGINE_PER_MODEL_RESET