> ## 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.
# Vocoder CMN API
> This file contains vocoder modules' commmon APIs.
**Header:** `spf/api/modules/vocoder_cmn_api.h`
## Structures
### `param_id_vocoder_enable_dtx_mode_t`
**Members**
### `param_id_vocoder_minmax_rate_param_t`
**Members**
### `param_id_vocoder_enc_rate_param_t`
**Members**
The exact interpretation of the value and valid range depends on the type of encoder}
### `param_id_vocoder_rate_modulation_param_t`
**Members**
### `param_id_tty_mode_t`
**Members**
### `event_id_vocoder_operating_mode_t`
**Members**
## Type Definitions
### `vocoder_client_id_t`
```cpp theme={null}
typedef enum vocoder_client_id_t vocoder_client_id_t
```
### `tty_cdma_vocoder_type_t`
```cpp theme={null}
typedef enum tty_cdma_vocoder_type_t tty_cdma_vocoder_type_t
```
### `param_id_vocoder_enable_dtx_mode_t`
```cpp theme={null}
typedef struct param_id_vocoder_enable_dtx_mode_t param_id_vocoder_enable_dtx_mode_t
```
### `param_id_vocoder_minmax_rate_param_t`
```cpp theme={null}
typedef struct param_id_vocoder_minmax_rate_param_t param_id_vocoder_minmax_rate_param_t
```
### `param_id_vocoder_enc_rate_param_t`
```cpp theme={null}
typedef struct param_id_vocoder_enc_rate_param_t param_id_vocoder_enc_rate_param_t
```
### `param_id_vocoder_rate_modulation_param_t`
```cpp theme={null}
typedef struct param_id_vocoder_rate_modulation_param_t param_id_vocoder_rate_modulation_param_t
```
### `param_id_tty_mode_t`
```cpp theme={null}
typedef struct param_id_tty_mode_t param_id_tty_mode_t
```
### `event_id_vocoder_operating_mode_t`
```cpp theme={null}
typedef struct event_id_vocoder_operating_mode_t event_id_vocoder_operating_mode_t
```
## Enumerations
### `vocoder_client_id_t`
#### Values
| Name | Value | Description |
| -------------- | ----- | ----------- |
| `AUDIO_CLIENT` | = 0x0 | |
| `VOICE_CLIENT` | = 0x1 | |
### `tty_cdma_vocoder_type_t`
#### Values
| Name | Value | Description |
| ----------------- | ----- | ----------- |
| `TTY_CDMA_V13K` | = 0 | |
| `TTY_CDMA_EVRC` | | |
| `TTY_CDMA_FOURGV` | | |
## Macros
### `VOICE_TTY_MODE_OFF`
```c theme={null}
#define VOICE_TTY_MODE_OFF 0 /* TTY OFF or disabled */
```
### `VOICE_TTY_MODE_HCO`
```c theme={null}
#define VOICE_TTY_MODE_HCO 1 /* Hearing carry over mode. */
```
### `VOICE_TTY_MODE_VCO`
```c theme={null}
#define VOICE_TTY_MODE_VCO 2 /* Voice carry over mode. */
```
### `VOICE_TTY_MODE_FULL`
```c theme={null}
#define VOICE_TTY_MODE_FULL 3 /* FULL mode. */
```
### `VOCODER_OPERATING_MODE_NB`
```c theme={null}
#define VOCODER_OPERATING_MODE_NB 0 /* Vocoder bandwidth mode is 8 kHz. */
```
### `VOCODER_OPERATING_MODE_WB`
```c theme={null}
#define VOCODER_OPERATING_MODE_WB 1 /* Vocoder bandwidth mode is 16 kHz. */
```
### `VOCODER_OPERATING_MODE_SWB`
```c theme={null}
#define VOCODER_OPERATING_MODE_SWB 2 /* Vocoder bandwidth mode is 32 kHz. */
```
### `VOCODER_OPERATING_MODE_FB`
```c theme={null}
#define VOCODER_OPERATING_MODE_FB 3 /* Vocoder bandwidth mode is 48 kHz. */
```
### `VOCODER_OPERATING_MODE_NONE`
```c theme={null}
#define VOCODER_OPERATING_MODE_NONE 0xffffffff
```
### `PARAM_ID_VOCODER_ENABLE_DTX_MODE`
```c theme={null}
#define PARAM_ID_VOCODER_ENABLE_DTX_MODE 0x08001123
```
### `PARAM_ID_VOCODER_MINMAX_RATE`
ID of the parameter used to configure the encoder minimum and maximum rates.
```c theme={null}
#define PARAM_ID_VOCODER_MINMAX_RATE 0x08001124
```
### `PARAM_ID_VOCODER_ENC_RATE`
ID of the parameter used to configure the encoding rate.
```c theme={null}
#define PARAM_ID_VOCODER_ENC_RATE 0x080011B1
```
### `PARAM_ID_VOCODER_RATE_MODULATION`
ID of the parameter used to configure the encoding rate for modulation.
```c theme={null}
#define PARAM_ID_VOCODER_RATE_MODULATION 0x08001125
```
### `PARAM_ID_TTY_MODE`
ID of the parameter used to set the TTY mode.
```c theme={null}
#define PARAM_ID_TTY_MODE 0x08001127
```
### `PARAM_ID_VOCODER_RESET`
Parameter to reset voice encoder/decoder.
```c theme={null}
#define PARAM_ID_VOCODER_RESET 0x08001128
```
### `EVENT_ID_VOCODER_OPERATING_MODE`
Event ID that is raised by the vocoder when client registers for operating mode updates with the vocoder.
```c theme={null}
#define EVENT_ID_VOCODER_OPERATING_MODE 0x08001197
```