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

Structures

sdz_version_t

Members
uint32_t
uint32_t

param_id_sdz_input_threshold_t

Members
uint32_t
} ms

param_id_sdz_input_threshold_v2_t

Members
uint32_t
This API provide the input threshold requirement of each client. The lowest threshold will be chosen as the operating threshold.}
uint32_t
} ms

param_id_sdz_output_config_t

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

param_id_sdz_output_config_v2_base_t

Members
uint32_t
This API allow multiple clients to have unique configurations.}
uint32_t
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.}
uint32_t
}
uint32_t
}

param_id_sdz_output_config_v2_t

Members
uint32_t
param_id_sdz_output_config_v2_base_t

param_id_sdz_force_output_t

Members
uint32_t
}

param_id_sdz_force_output_v2_t

Members
uint32_t
This allows forcing output for a specific client independently.}
uint32_t
}

event_id_sdz_output_reg_cfg_t

Members
uint32_t
QUERY - Client queries the output via getparam upon receiving SDZ output event.

event_id_sdz_output_reg_cfg_v2_t

Members
uint32_t
}
uint32_t
QUERY - Client queries the output via getparam upon receiving SDZ output event.

sdz_speaker_info_t

Members
uint32_t
uint32_t
}
uint32_t
}
uint32_t
}
uint32_t
}

sdz_speaker_segment_t

Members
uint32_t
uint32_t
uint32_t
uint32_t
float
float
uint8_t
uint8_t
int32_t
uint32_t

sdz_output_status_t

Members
uint32_t
uint32_t
}

sdz_output_status_v2_t

Members
uint32_t

event_id_sdz_output_event_t

Members
uint32_t
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 }
uint32_t
This is used to query the corresponding output payload. If not configured or invalid, Payload corresponds to next output buffer is sent.}
uint32_t
uint32_t
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
uint32_t
This must match the client_id used in PARAM_ID_SDZ_OUTPUT_CONFIG_V2. Allows multiple clients to independently query their own output buffers.}
uint32_t
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 }
uint32_t
This is used to query the corresponding output payload. If not configured or invalid, Payload corresponds to next output buffer is sent.}
uint32_t
uint32_t
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
uint32_t
This must match the client_id used in PARAM_ID_SDZ_OUTPUT_CONFIG_V2. Allows multiple clients to independently query their own output buffers.}
uint32_t
This is used to query the corresponding output payload. If not configured or invalid, Payload corresponds to next output buffer is sent.}
uint32_t
uint32_t
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
uint32_t
uint32_t
uint32_t

param_id_sdz_voice_profile_t

Members
uint32_t
(reserved for future use, currently not being utilized)}
uint32_t
uint8_t

param_id_sdz_ts_fmt_t

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

sdz_version_t

param_id_sdz_input_threshold_t

param_id_sdz_input_threshold_v2_t

sdz_output_mode_t

param_id_sdz_output_config_t

param_id_sdz_output_config_v2_base_t

param_id_sdz_output_config_v2_t

param_id_sdz_force_output_t

param_id_sdz_force_output_v2_t

event_id_sdz_output_reg_cfg_t

event_id_sdz_output_reg_cfg_v2_t

sdz_speaker_info_t

sdz_speaker_segment_t

sdz_output_status_t

sdz_output_status_v2_t

event_id_sdz_output_event_t

param_id_sdz_output_t

event_id_sdz_output_event_v2_t

param_id_sdz_output_v2_t

param_id_sdz_model_t

param_id_sdz_voice_profile_t

param_id_sdz_ts_fmt_t

sdz_client_id_t

Enumerations

sdz_output_mode_t

Values

sdz_client_id_t

Values

Macros

PARAM_ID_SDZ_VERSION

PARAM_ID_SDZ_INPUT_THRESHOLD

PARAM_ID_SDZ_INPUT_THRESHOLD_V2

PARAM_ID_SDZ_OUTPUT_CONFIG

PARAM_ID_SDZ_OUTPUT_CONFIG_V2

PARAM_ID_SDZ_FORCE_OUTPUT

PARAM_ID_SDZ_FORCE_OUTPUT_V2

EVENT_ID_SDZ_OUTPUT

EVENT_ID_SDZ_OUTPUT_V2

PARAM_ID_SDZ_OUTPUT

PARAM_ID_SDZ_OUTPUT_V2

PARAM_ID_SDZ_MODEL

PARAM_ID_SDZ_VOICE_PROFILE

PARAM_ID_SDZ_TIMESTAMP_FORMAT

CAPI_SDZ_MAX_INPUT_PORTS

CAPI_SDZ_MAX_OUTPUT_PORTS

SDZ_STACK_SIZE

SDZ_SPEAKER_INFO_SPEAKER_NAME_SIZE

SDZ_SPEAKER_INFO_SPEAKER_UUID_SIZE

MODULE_ID_SDZ