> ## 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. # SDZ API **Header:** `spf/api/modules/sdz_api.h` ## Structures ### `sdz_version_t` **Members** ### `param_id_sdz_input_threshold_t` **Members** } ms ### `param_id_sdz_input_threshold_v2_t` **Members** This API provide the input threshold requirement of each client. The lowest threshold will be chosen as the operating threshold.} } ms ### `param_id_sdz_output_config_t` **Members** SDZ\_NON\_BUFFERED - Output of each SDZ algo process is immediately sent to client. SDZ\_BUFFERED - Output of each SDZ algo process is buffered and sent to client intermittently.} } } ### `param_id_sdz_output_config_v2_base_t` **Members** This API allow multiple clients to have unique configurations.} SDZ\_NON\_BUFFERED - Output of each SDZ algo process is immediately sent to client. SDZ\_BUFFERED - Output of each SDZ algo process is buffered and sent to client intermittently.} } } ### `param_id_sdz_output_config_v2_t` **Members** ### `param_id_sdz_force_output_t` **Members** } ### `param_id_sdz_force_output_v2_t` **Members** This allows forcing output for a specific client independently.} } ### `event_id_sdz_output_reg_cfg_t` **Members** QUERY - Client queries the output via getparam upon receiving SDZ output event. ### `event_id_sdz_output_reg_cfg_v2_t` **Members** } QUERY - Client queries the output via getparam upon receiving SDZ output event. ### `sdz_speaker_info_t` **Members** } } } } ### `sdz_speaker_segment_t` **Members** ### `sdz_output_status_t` **Members** } ### `sdz_output_status_v2_t` **Members** ### `event_id_sdz_output_event_t` **Members** Query = Client will query via getparam upon receiving this event, using the output\_token provided as part of this payload. Inband = SDZ output payload follows inband after the payload\_size field } This is used to query the corresponding output payload. If not configured or invalid, Payload corresponds to next output buffer is sent.} Following this field is the payload of this size. Payload is variable array of type sdz\_output\_status\_t} ### `event_id_sdz_output_event_v2_t` **Members** This must match the client\_id used in PARAM\_ID\_SDZ\_OUTPUT\_CONFIG\_V2. Allows multiple clients to independently query their own output buffers.} Query = Client will query via getparam upon receiving this event, using the output\_token provided as part of this payload. Inband = SDZ output payload follows inband after the payload\_size field } This is used to query the corresponding output payload. If not configured or invalid, Payload corresponds to next output buffer is sent.} Following this field is the payload of this size. Payload is variable array of type sdz\_output\_status\_v2\_t} ### `param_id_sdz_output_v2_t` **Members** This must match the client\_id used in PARAM\_ID\_SDZ\_OUTPUT\_CONFIG\_V2. Allows multiple clients to independently query their own output buffers.} This is used to query the corresponding output payload. If not configured or invalid, Payload corresponds to next output buffer is sent.} Following this field is the payload of this size. Payload is variable array of type sdz\_output\_status\_v2\_t} ### `param_id_sdz_model_t` **Members** ### `param_id_sdz_voice_profile_t` **Members** (reserved for future use, currently not being utilized)} ### `param_id_sdz_ts_fmt_t` **Members** 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 ### `sdz_version_t` ```cpp theme={null} typedef struct sdz_version_t sdz_version_t ``` ### `param_id_sdz_input_threshold_t` ```cpp theme={null} typedef struct param_id_sdz_input_threshold_t param_id_sdz_input_threshold_t ``` ### `param_id_sdz_input_threshold_v2_t` ```cpp theme={null} typedef struct param_id_sdz_input_threshold_v2_t param_id_sdz_input_threshold_v2_t ``` ### `sdz_output_mode_t` ```cpp theme={null} typedef enum sdz_output_mode_t sdz_output_mode_t ``` ### `param_id_sdz_output_config_t` ```cpp theme={null} typedef struct param_id_sdz_output_config_t param_id_sdz_output_config_t ``` ### `param_id_sdz_output_config_v2_base_t` ```cpp theme={null} typedef struct param_id_sdz_output_config_v2_base_t param_id_sdz_output_config_v2_base_t ``` ### `param_id_sdz_output_config_v2_t` ```cpp theme={null} typedef struct param_id_sdz_output_config_v2_t param_id_sdz_output_config_v2_t ``` ### `param_id_sdz_force_output_t` ```cpp theme={null} typedef struct param_id_sdz_force_output_t param_id_sdz_force_output_t ``` ### `param_id_sdz_force_output_v2_t` ```cpp theme={null} typedef struct param_id_sdz_force_output_v2_t param_id_sdz_force_output_v2_t ``` ### `event_id_sdz_output_reg_cfg_t` ```cpp theme={null} typedef struct event_id_sdz_output_reg_cfg_t event_id_sdz_output_reg_cfg_t ``` ### `event_id_sdz_output_reg_cfg_v2_t` ```cpp theme={null} typedef struct event_id_sdz_output_reg_cfg_v2_t event_id_sdz_output_reg_cfg_v2_t ``` ### `sdz_speaker_info_t` ```cpp theme={null} typedef struct sdz_speaker_info_t sdz_speaker_info_t ``` ### `sdz_speaker_segment_t` ```cpp theme={null} typedef struct sdz_speaker_segment_t sdz_speaker_segment_t ``` ### `sdz_output_status_t` ```cpp theme={null} typedef struct sdz_output_status_t sdz_output_status_t ``` ### `sdz_output_status_v2_t` ```cpp theme={null} typedef struct sdz_output_status_v2_t sdz_output_status_v2_t ``` ### `event_id_sdz_output_event_t` ```cpp theme={null} typedef struct event_id_sdz_output_event_t event_id_sdz_output_event_t ``` ### `param_id_sdz_output_t` ```cpp theme={null} typedef event_id_sdz_output_event_t param_id_sdz_output_t ``` ### `event_id_sdz_output_event_v2_t` ```cpp theme={null} typedef struct event_id_sdz_output_event_v2_t event_id_sdz_output_event_v2_t ``` ### `param_id_sdz_output_v2_t` ```cpp theme={null} typedef struct param_id_sdz_output_v2_t param_id_sdz_output_v2_t ``` ### `param_id_sdz_model_t` ```cpp theme={null} typedef struct param_id_sdz_model_t param_id_sdz_model_t ``` ### `param_id_sdz_voice_profile_t` ```cpp theme={null} typedef struct param_id_sdz_voice_profile_t param_id_sdz_voice_profile_t ``` ### `param_id_sdz_ts_fmt_t` ```cpp theme={null} typedef struct param_id_sdz_ts_fmt_t param_id_sdz_ts_fmt_t ``` ### `sdz_client_id_t` ```cpp theme={null} typedef enum sdz_client_id_t sdz_client_id_t ``` ## Enumerations ### `sdz_output_mode_t` #### Values | Name | Value | Description | | ------------------ | ----- | ----------- | | `SDZ_NON_BUFFERED` | = 0 | | | `SDZ_BUFFERED` | | | ### `sdz_client_id_t` #### Values | Name | Value | Description | | -------------------- | --------------------- | ----------- | | `SDZ_CLIENT_INVALID` | = 0 | | | `SDZ_CLIENT_HLOS` | = 1 | | | `SDZ_CLIENT_SENSOR` | = 2 | | | `SDZ_CLIENT_MAX` | = SDZ\_CLIENT\_SENSOR | | ## Macros ### `PARAM_ID_SDZ_VERSION` ```c theme={null} #define PARAM_ID_SDZ_VERSION 0x08001B08 ``` ### `PARAM_ID_SDZ_INPUT_THRESHOLD` ```c theme={null} #define PARAM_ID_SDZ_INPUT_THRESHOLD 0x08001B09 ``` ### `PARAM_ID_SDZ_INPUT_THRESHOLD_V2` ```c theme={null} #define PARAM_ID_SDZ_INPUT_THRESHOLD_V2 0x08001BC7 ``` ### `PARAM_ID_SDZ_OUTPUT_CONFIG` ```c theme={null} #define PARAM_ID_SDZ_OUTPUT_CONFIG 0x08001B0D ``` ### `PARAM_ID_SDZ_OUTPUT_CONFIG_V2` ```c theme={null} #define PARAM_ID_SDZ_OUTPUT_CONFIG_V2 0x08001BDA ``` ### `PARAM_ID_SDZ_FORCE_OUTPUT` ```c theme={null} #define PARAM_ID_SDZ_FORCE_OUTPUT 0x08001B0E ``` ### `PARAM_ID_SDZ_FORCE_OUTPUT_V2` ```c theme={null} #define PARAM_ID_SDZ_FORCE_OUTPUT_V2 0x08001BDB ``` ### `EVENT_ID_SDZ_OUTPUT` ```c theme={null} #define EVENT_ID_SDZ_OUTPUT 0x08001B0A ``` ### `EVENT_ID_SDZ_OUTPUT_V2` ```c theme={null} #define EVENT_ID_SDZ_OUTPUT_V2 0x08001BC8 ``` ### `PARAM_ID_SDZ_OUTPUT` ```c theme={null} #define PARAM_ID_SDZ_OUTPUT 0x08001B0C ``` ### `PARAM_ID_SDZ_OUTPUT_V2` ```c theme={null} #define PARAM_ID_SDZ_OUTPUT_V2 0x08001BA7 ``` ### `PARAM_ID_SDZ_MODEL` ```c theme={null} #define PARAM_ID_SDZ_MODEL 0x08001B0B ``` ### `PARAM_ID_SDZ_VOICE_PROFILE` ```c theme={null} #define PARAM_ID_SDZ_VOICE_PROFILE 0x08001BA5 ``` ### `PARAM_ID_SDZ_TIMESTAMP_FORMAT` ```c theme={null} #define PARAM_ID_SDZ_TIMESTAMP_FORMAT 0x08001B84 ``` ### `CAPI_SDZ_MAX_INPUT_PORTS` ```c theme={null} #define CAPI_SDZ_MAX_INPUT_PORTS 1 ``` ### `CAPI_SDZ_MAX_OUTPUT_PORTS` ```c theme={null} #define CAPI_SDZ_MAX_OUTPUT_PORTS 0 ``` ### `SDZ_STACK_SIZE` ```c theme={null} #define SDZ_STACK_SIZE 2048 ``` ### `SDZ_SPEAKER_INFO_SPEAKER_NAME_SIZE` ```c theme={null} #define SDZ_SPEAKER_INFO_SPEAKER_NAME_SIZE 64 ``` ### `SDZ_SPEAKER_INFO_SPEAKER_UUID_SIZE` ```c theme={null} #define SDZ_SPEAKER_INFO_SPEAKER_UUID_SIZE 40 ``` ### `MODULE_ID_SDZ` ```c theme={null} #define MODULE_ID_SDZ 0x0702C000 ```