> ## 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.
# Agm API
**Header:** `service/inc/public/agm/agm_api.h`
## Structures
### `agm_key_value`
A single entry of a Key Vector.
**Members**
key
value
### `prop_data`
**Members**
### `agm_cshm_info`
**Members**
memID of the memory allocated
type of the memory allocated
fd of the memory allocated
### `agm_msg_config`
**Members**
memID of the memory allocated
offset of memory allocated
Size of the chunk of memory.
module ID to which msg is sent
Flags to provide additional information, if it is a release memory or not.
### `agm_extern_alloc_buff_info`
**Members**
unique handle identifying extern mem allocation
size of external allocation
offset of buffer within extern allocation
### `agm_buff`
**Members**
timestamp in micro-secs
bitmasked flags for e.g.
size of buffer in bytes
data buffer
size of metadata blob
Blob for metadata.
holds info for extern buff
### `agm_session_aac_dec`
AAC decoder parameters.
**Members**
AAC format flag.
AAC obj type.
AAC obj type.
PCE bits size.
Sample rate.
### `agm_session_aac_enc_cfg`
AAC encoder parameters.
**Members**
AAC encoder mode.
AAC format flag.
### `agm_session_aac_enc`
**Members**
### `agm_session_flac_dec`
FLAC decoder parameters.
**Members**
Number of channels.
Sample size.
Minimum block size.
Maximum block size.
Sample rate.
Minimum frame size.
Maximum frame size.
### `agm_session_alac_dec`
ALAC decoder parameters.
**Members**
Frame length.
Version.
bit depth
tuning parameters
tuning parameters
tuning parameters
Number of channels.
Max run.
Max Frame bytes.
avg bit rate
sample rate
Channel layout tag.
### `agm_session_ape_dec`
APE decoder parameters.
**Members**
Version.
Compression Level.
Format flags.
Blocks per frame.
Final frame blocks.
Total frames.
Bit width.
Number of channels.
Sample rate.
Seek table present.
### `agm_session_wma_dec`
WMA decoder parameters.
**Members**
Format Tag.
Number of channels.
Sample rate.
Avg bytes per sec.
Block align.
Bits per sample.
Channel mask.
Encoder options.
reserved
### `agm_session_wmapro_dec`
WMA Pro decoder parameters.
**Members**
Format Tag.
Number of channels.
Sample rate.
Avg bytes per sec.
Block align.
Bits per sample.
Channel mask.
Encoder options.
Adv encoder options.
Adv encoder options2.
### `agm_session_opus_dec`
OPUS decoder parameters.
**Members**
### `agm_session_codec`
Session encoder/decoder parameters.
**Members**
AAC decoder config.
AAC encoder config.
Flac decoder config.
Alac decoder config.
APE decoder config.
WMA decoder config.
WMAPro decoder config.
OPUS decoder config.
### `agm_buf_info`
Shared memory buffer info 211.
**Members**
### `agm_media_config`
Media Config.
**Members**
sample rate
number of channels
format
data format
### `agm_group_media_config`
**Members**
slot\_mask for TDM
### `aif_info`
AIF Info.
**Members**
AIF name
direction
### `agm_session_config`
Session Config.
**Members**
TX or RX.
indicates mode of agm sesison, non-tunnel, or hostless
start\_threshold: number of buffers \* buffer size
stop\_th6reshold: number of buffers \* buffer size
codec configuration
compress format ID
pass session specific flags e.g enable inband SRCM event
### `agm_buffer_config`
Buffer Config.
**Members**
number of buffers
size of each buffer
max metadata size a client attaches to a buffer
### `agm_module_id_iid_map`
Maps the modules instance id to module id for a single module.
**Members**
module id
globally unique module instance id
### `agm_tag_info`
Structure which holds tag and corresponding modules tagged with tag id.
**Members**
tag id
number of modules matching the tag\_id
agm\_module\_id\_iid\_map list
### `agm_tag_module_info_list`
Structure which holds tag info of a given graph.
**Members**
number of tags
variable payload of type struct agm\_tag\_module\_info
### `agm_tag_config`
Structure which holds tag config for setparams.
**Members**
tag id
num of tag key values
tag key vector
### `agm_cal_config`
**Members**
num of tag key values
tag key vector
### `agm_acdb_param`
**Members**
number of ckv or tkv
kv size + payload size
kv + payload
### `agm_acdb_tunnel_param`
**Members**
number of gkv
number of ckv or tkv
gkv size + t/ckv size + payload size
gkv + t/ckv + payload
### `agm_event_read_write_done_payload`
**Members**
tag that was used to read/write this buffer
data buffer status as defined in ar\_osal\_error.h
meta-data status as defined in ar\_osal\_error.h
buffer that was passed to agm\_read/agm\_write
### `agm_event_reg_cfg`
Event registration structure.
**Members**
Valid instance ID of module.
Valid event ID of the module.
Size of the event config data based upon the module\_instance\_id/event\_id combination.
1 - to register the event 0 - to de-register the event
module specifc event registration payload
### `agm_event_cb_params`
data that will be passed to client in the event callback
**Members**
identifies the module which generated event
size of payload below
payload associated with the event if any
### `agm_dump_info`
Data passed by the client when requesting dump.
**Members**
identifies the signal received by client
identifies client uid
## Functions
### `agm_init`
Initialize agm.
```cpp theme={null}
int agm_init()
```
**Returns**
0 on success, error code on failure.
### `agm_deinit`
De-Initialize agm.
```cpp theme={null}
int agm_deinit()
```
**Returns**
0 on success, error code on failure.
### `agm_aif_set_media_config`
Set media configuration for an audio interface.
```cpp theme={null}
int agm_aif_set_media_config(uint32_t aif_id, struct agm_media_config *media_config)
```
**Parameters**
* Valid audio interface id
* valid media configuration for the audio interafce.
**Returns**
0 on success, error code on failure. If the audio interface is already in use and the new media\_config is different from previous, api will return failure.
### `agm_aif_set_metadata`
Set metadata for an audio interface.
```cpp theme={null}
int agm_aif_set_metadata(uint32_t aif_id, uint32_t size, uint8_t *metadata)
```
**Parameters**
* Valid audio interface id
* size of metadata in bytes
* valid metadata for the audio interface.
**Returns**
0 on success, error code on failure. If the audio interface is already in use and the new meta data is set, api will return failure.
### `agm_session_set_metadata`
Set metadata for the session.
```cpp theme={null}
int agm_session_set_metadata(uint32_t session_id, uint32_t size, uint8_t *metadata)
```
**Parameters**
* Valid audio session id
* size of metadata in bytes
* valid metadata for the session.
**Returns**
0 on success, error code on failure. If the session is already opened and the new meta data is set, api will return failure.
### `agm_session_aif_set_metadata`
Set metadata for the session, audio intf pair.
```cpp theme={null}
int agm_session_aif_set_metadata(uint32_t session_id, uint32_t aif_id, uint32_t size, uint8_t *metadata)
```
**Parameters**
* Valid session id
* Valid audio interface id
* size of metadata in bytes
* valid metadata for the session and audio\_intf.
**Returns**
0 on success, error code on failure. If the session is already opened and the new meta data is set, api will return failure.
### `agm_session_aif_connect`
Set metadata for the session, audio intf pair.
```cpp theme={null}
int agm_session_aif_connect(uint32_t session_id, uint32_t aif_id, bool state)
```
**Parameters**
* Valid audio session id
* Valid audio interface id
* Connect or Disconnect AIF to Session
**Returns**
0 on success, error code on failure. If the session is already opened and the new meta data is set, api will return failure.
### `agm_session_aif_get_tag_module_info`
Set metadata for the session, audio intf pair.
```cpp theme={null}
int agm_session_aif_get_tag_module_info(uint32_t session_id, uint32_t aif_id, void *payload, size_t *size)
```
**Parameters**
* Valid audio session id
* Valid audio interface id
* payload containing tag module info list in the graph. The memory for this pointer is allocated by client.
size of the payload. if the value of size is zero, AGM will update required module info list of a given graph. if size equal or greater than the required size, AGM will copy the module info.
**Returns**
0 on success, error code on failure.
### `agm_aif_set_params`
Set parameters for modules in audio interface.
```cpp theme={null}
int agm_aif_set_params(uint32_t aif_id, void *payload, size_t size)
```
**Parameters**
* Valid audio interface id
* payload
* payload size in bytes
**Returns**
0 on success, error code on failure.
### `agm_session_aif_set_params`
Set parameters for modules in b/w stream and audio interface.
```cpp theme={null}
int agm_session_aif_set_params(uint32_t session_id, uint32_t aif_id, void *payload, size_t size)
```
**Parameters**
* Valid audio session id
* Valid audio interface id
* payload
* payload size in bytes
**Returns**
0 on success, error code on failure. If the session is already opened and the new meta data is set, api will return failure.
### `agm_session_aif_set_cal`
Set calibration for modules in b/w stream and audio interface.
```cpp theme={null}
int agm_session_aif_set_cal(uint32_t session_id, uint32_t aif_id, struct agm_cal_config *cal_config)
```
**Parameters**
* Valid audio session id
* Valid audio interface id
* calibration key vector
**Returns**
0 on success, error code on failure.
### `agm_session_set_params`
Set parameters for modules in stream.
```cpp theme={null}
int agm_session_set_params(uint32_t session_id, void *payload, size_t size)
```
**Parameters**
* Valid audio session id
* payload
* payload size in bytes
**Returns**
0 on success, error code on failure. If the session is already opened and the new meta data is set, api will return failure.
### `agm_session_get_params`
Get parameters of the modules of a given session.
```cpp theme={null}
int agm_session_get_params(uint32_t session_id, void *payload, size_t size)
```
**Parameters**
* Valid audio session id
* payload
* payload size in bytes
**Returns**
0 on success, error code on failure. If the session is not opened, api will return failure.
### `agm_get_params_from_acdb_tunnel`
Get parameters for modules at acdb without session.
```cpp theme={null}
int agm_get_params_from_acdb_tunnel(void *payload, size_t *size)
```
**Parameters**
* payload with tag and calibration date
* size of payload
**Returns**
0 on success, error code on failure.
### `agm_set_params_with_tag`
Set parameters for modules in b/w stream and audio interface.
```cpp theme={null}
int agm_set_params_with_tag(uint32_t session_id, uint32_t aif_id, struct agm_tag_config *tag_config)
```
**Parameters**
* Valid audio session id
* valid audio interface id
* tag config structure with tag id and tag key vector
**Returns**
0 on success, error code on failure. If the session is already opened and the new meta data is set, api will return failure.
### `agm_set_params_with_tag_to_acdb`
Set parameters for modules in b/w stream and audio interface.
```cpp theme={null}
int agm_set_params_with_tag_to_acdb(uint32_t session_id, uint32_t aif_id, void *payload, size_t size)
```
**Parameters**
* Valid audio session id
* valid audio interface id
* payload with tag and calibration date
* size of payload
**Returns**
0 on success, error code on failure. If the session is already opened and the new meta data is set, api will return failure.
### `agm_set_params_to_acdb_tunnel`
Set parameters for modules at acdb without session.
```cpp theme={null}
int agm_set_params_to_acdb_tunnel(void *payload, size_t size)
```
**Parameters**
* payload with tag and calibration date
* size of payload
**Returns**
0 on success, error code on failure.
### `agm_session_register_cb`
Open the session with specified session id.
```cpp theme={null}
int agm_session_register_cb(uint32_t session_id, agm_event_cb cb, enum event_type evt_type, void *client_data)
```
**Parameters**
* Valid audio session id
* callback function to be invoked when an event occurs.
* event type that
* client data.
**Returns**
0 on success, error code otherwise
### `agm_session_register_for_events`
Register for events from Modules.
Not needed for data path events.
```cpp theme={null}
int agm_session_register_for_events(uint32_t session_id, struct agm_event_reg_cfg *evt_reg_cfg)
```
**Parameters**
* Valid audio session id
* event specific configuration.
**Returns**
0 on success, error code otherwise
### `agm_session_open`
Open the session with specified session id.
```cpp theme={null}
int agm_session_open(uint32_t session_id, enum agm_session_mode sess_mode, uint64_t *handle)
```
**Parameters**
* Valid audio session id
* Mode in which this agm session is to be opened
* updated with valid session handle if the operation is successful.
**Returns**
0 on success, error code otherwise
### `agm_session_set_config`
Set Session config.
```cpp theme={null}
int agm_session_set_config(uint64_t hndl, struct agm_session_config *session_config, struct agm_media_config *media_config, struct agm_buffer_config *buffer_config)
```
**Parameters**
* Valid session handle obtained from agm\_session\_open
* valid stream configuration of the sessions
* valid media configuration of the session.
* buffer configuration for the session. Null if hostless
**Returns**
0 on success, error code otherwise
### `agm_session_close`
Close the session.
```cpp theme={null}
int agm_session_close(uint64_t hndl)
```
**Parameters**
* Valid session handle obtained from agm\_session\_open
**Returns**
0 on success, error code otherwise
### `agm_session_prepare`
prepare the session.
```cpp theme={null}
int agm_session_prepare(uint64_t hndl)
```
**Parameters**
* Valid session handle obtained from agm\_session\_open
**Returns**
0 on success, error code otherwise
### `agm_session_start`
Start the session.
```cpp theme={null}
int agm_session_start(uint64_t hndl)
```
**Parameters**
* Valid session handle obtained from agm\_session\_open
**Returns**
0 on success, error code otherwise
### `agm_session_stop`
Stop the session.
session must be in started/paused state before stopping.
```cpp theme={null}
int agm_session_stop(uint64_t hndl)
```
**Parameters**
* Valid session handle obtained from agm\_session\_open
**Returns**
0 on success, error code otherwise
### `agm_session_pause`
Pause the session.
session must be in started state before resuming.
```cpp theme={null}
int agm_session_pause(uint64_t hndl)
```
**Parameters**
* Valid session handle obtained from agm\_session\_open
**Returns**
0 on success, error code otherwise
### `agm_session_flush`
flush the session.
session must be in pause state before flushing.
```cpp theme={null}
int agm_session_flush(uint64_t hndl)
```
**Parameters**
* Valid session handle obtained from agm\_session\_open
**Returns**
0 on success, error code otherwise
### `agm_sessionid_flush`
flush the session.
session must be in pause state before flushing.
```cpp theme={null}
int agm_sessionid_flush(uint32_t session_id)
```
**Parameters**
* Valid audio session id
**Returns**
0 on success, error code otherwise
### `agm_session_resume`
Resume the session.
session must be in paused state before resuming.
```cpp theme={null}
int agm_session_resume(uint64_t hndl)
```
**Parameters**
* Valid session handle obtained from agm\_session\_open
**Returns**
0 on success, error code otherwise
### `agm_session_suspend`
suspend the session.
session must be in started state before suspending.
```cpp theme={null}
int agm_session_suspend(uint64_t hndl)
```
**Parameters**
* Valid session handle obtained from agm\_session\_open
**Returns**
0 on success, error code otherwise
### `agm_session_read`
Read data buffers.from session.
```cpp theme={null}
int agm_session_read(uint64_t handle, void *buff, size_t *count)
```
**Parameters**
session handle returned from agm\_session\_open
buffer where data will be copied to
number of bytes requested to fill into the buffer. AGM will update the count with actual number of bytes filled.
**Returns**
0 on success, error code otherwise
### `agm_session_write`
Write data buffers.to session.
```cpp theme={null}
int agm_session_write(uint64_t hndl, void *buff, size_t *count)
```
**Parameters**
session handle returned from agm\_session\_open
buffer where data will be copied from
actual number of bytes in the buffer. AGM will update the count with number of bytes consumed/written.
**Returns**
0 on success, error code otherwise
### `agm_get_hw_processed_buff_cnt`
Get count of Buffer processed by h/w.
```cpp theme={null}
size_t agm_get_hw_processed_buff_cnt(uint64_t hndl, enum direction dir)
```
**Parameters**
session handle returned from agm\_session\_open
indicates whether to return the write or read buffer count
**Returns**
: An increasing count of buffers, value wraps back to zero once it reaches SIZE\_MAX
### `agm_get_aif_info_list`
Get list of AIF info objects.
```cpp theme={null}
int agm_get_aif_info_list(struct aif_info *aif_list, size_t *num_aif_info)
```
**Parameters**
list of aif\_info objects
number of aif info items in the list. if num\_aif\_info value is listed as zero, AGM will update num\_aif\_info with the number of aif info items in AGM. if num\_aif\_info is greater than zero, AGM will copy client specified num\_aif\_info of items into aif\_list.
**Returns**
: 0 on success, error code otherwise
### `agm_session_set_loopback`
Set loopback between capture and playback sessions.
```cpp theme={null}
int agm_session_set_loopback(uint32_t capture_session_id, uint32_t playback_session_id, bool state)
```
**Parameters**
: a non zero capture session id
playback session id.
: flag to indicate to enable(true) or disable(false) loopback
**Returns**
: 0 on success, error code otherwise
### `agm_session_set_ec_ref`
Set ec reference on capture session.
```cpp theme={null}
int agm_session_set_ec_ref(uint32_t capture_session_id, uint32_t aif_id, bool state)
```
**Parameters**
: a non zero capture session id
aif\_id on RX path.
: flag to indicate to enable(true) or disable(false) ec\_ref
**Returns**
: 0 on success, error code otherwise
### `agm_session_eos`
send eos of the session.
```cpp theme={null}
int agm_session_eos(uint64_t handle)
```
**Parameters**
* Valid session handle obtained from agm\_session\_open
**Returns**
0 on success, error code otherwise
### `agm_get_session_time`
get timestamp of the session.
```cpp theme={null}
int agm_get_session_time(uint64_t handle, uint64_t *timestamp)
```
**Parameters**
* Valid session handle obtained from agm\_session\_open
* updated with valid timestamp if the operation is successful.
**Returns**
0 on success, error code otherwise
### `agm_get_buffer_timestamp`
get timestamp of last read buffer.
```cpp theme={null}
int agm_get_buffer_timestamp(uint32_t session_id, uint64_t *timestamp)
```
**Parameters**
* Valid audio session id
* updated with valid timestamp if the operation is successful.
**Returns**
0 on success, error code otherwise
### `agm_session_get_buf_info`
Get shared memory buf\_info of a given session.
```cpp theme={null}
int agm_session_get_buf_info(uint32_t session_id, struct agm_buf_info *buf_info, uint32_t flag)
```
**Parameters**
* Valid audio session id
* agm\_buf\_info structure with dma\_buf\_fd
* flag to determine data buf/pos buf
**Returns**
0 on success, error code on failure. If the session is not opened, api will return failure.
### `agm_register_service_crash_callback`
This api is a no-op if agm runs in clients context.
In scenarios where AGM runs in its own process context and clients talk to AGM over IPC, this api could be used by clients to register a callback with the agm client wrapper implentation, which is then responsible to trigger this callback when the agm service crashes. Once the callback is invoked clients then can decide on the approach they want to take with respect to clean up of the agm sesisons
```cpp theme={null}
int agm_register_service_crash_callback(agm_service_crash_cb cb, uint64_t cookie)
```
**Parameters**
* Callback passed by clients
* Cookie that client expect to be passed during the invocation of the callback.
**Returns**
0 on success, error code otherwise
### `agm_set_gapless_session_metadata`
set gapless metadata of the session.
```cpp theme={null}
int agm_set_gapless_session_metadata(uint64_t handle, enum agm_gapless_silence_type type, uint32_t silence)
```
**Parameters**
* Valid session handle obtained from agm\_session\_open
* Silence Type (Initial or Trailing)
* Initial/Trailing silence samples to be removed
**Returns**
0 on success, error code otherwise
### `agm_session_write_with_metadata`
Write data buffers with metadata to session.
```cpp theme={null}
int agm_session_write_with_metadata(uint64_t hndl, struct agm_buff *buff, size_t *consumed_size)
```
**Parameters**
session handle returned from agm\_session\_open
agm\_buffer where data will be copied from
size: Actual number of bytes that were consumed by AGM
**Returns**
0 on success, error code otherwise
### `agm_session_read_with_metadata`
Read data buffers with metadata to session.
```cpp theme={null}
int agm_session_read_with_metadata(uint64_t hndl, struct agm_buff *buff, uint32_t *captured_size)
```
**Parameters**
session handle returned from agm\_session\_open
agm\_buffer where data will be copied to
Actual number of bytes that were captured
**Returns**
0 on success, error code otherwise
### `agm_session_set_non_tunnel_mode_config`
Helps set config for non tunnel mode (rx and tx path)
```cpp theme={null}
int agm_session_set_non_tunnel_mode_config(uint64_t hndl, struct agm_session_config *session_config, struct agm_media_config *in_media_config, struct agm_media_config *out_media_config, struct agm_buffer_config *in_buffer_config, struct agm_buffer_config *out_buffer_config)
```
**Parameters**
session handle returned from agm\_session\_open
* valid stream configuration of the sessions
* valid media configuration of the input data.
* buffer configuration for the input data path.
* valid media configuration of the output data.
* buffer configuration for the output data path.
**Returns**
0 on success, error code otherwise
### `agm_get_group_aif_info_list`
Get list of group AIF objects.
```cpp theme={null}
int agm_get_group_aif_info_list(struct aif_info *aif_list, size_t *num_groups)
```
**Parameters**
list of group aif\_info objects
number of group aif items in the list. if num\_groups value is listed as zero, AGM will update num\_groups with the number of group aif items in AGM. if num\_groups is greater than zero, AGM will copy client specified num\_groups of items into aif\_list.
**Returns**
: 0 on success, error code otherwise
### `agm_aif_group_set_media_config`
Set media configuration for a group AIF.
```cpp theme={null}
int agm_aif_group_set_media_config(uint32_t aif_group_id, struct agm_group_media_config *media_config)
```
**Parameters**
* Valid group id
* valid media configuration for the audio interafce.
**Returns**
0 on success, error code on failure. If the audio interface is already in use and the new media\_config is different from previous, api will return failure.
### `agm_session_write_datapath_params`
Write buffers containing codec params to session on datapath.
```cpp theme={null}
int agm_session_write_datapath_params(uint32_t session_id, struct agm_buff *buff)
```
**Parameters**
* Valid audio session id
agm\_buffer where data will be copied from
**Returns**
0 on success, error code otherwise
### `agm_dump`
Dump AGM information based on client.
```cpp theme={null}
int agm_dump(struct agm_dump_info *dump_info)
```
**Parameters**
* dump information populated by the client to facilitate dump
**Returns**
0 on success, error code on failure.
### `agm_cshm_alloc`
Allocate shared memory and map it with SPF.
```cpp theme={null}
int agm_cshm_alloc(uint32_t size, agm_cshm_info *info)
```
**Parameters**
* Size of memory to alloc in bytes.
info - Info regarding the allocated shared memory
**Returns**
0 on success, error code on failure.
### `agm_cshm_msg`
Send a Global MSG to a module.
```cpp theme={null}
int agm_cshm_msg(uint32_t mem_id, uint32_t offset, uint32_t length, uint32_t miid, uint32_t flags)
```
**Parameters**
* Valid mem\_id returned as part of agm\_cshm\_alloc.
* Offset from the beginning of allocted memory.
* Length of the memory for module to use.
* Module Instance ID of the module for which this MSG is intented.
* Flag conveying additional info regarding the MSG.
**Returns**
0 on success, error code on failure.
### `agm_cshm_dealloc`
Unmap the shared memory with SPF and Deallocate it.
```cpp theme={null}
int agm_cshm_dealloc(uint32_t mem_id)
```
**Parameters**
* Valid mem\_id returned as part of agm\_cshm\_alloc.
**Returns**
0 on success, error code on failure.
## Type Definitions
### `agm_event_cb`
Callback function signature for events to client.
```cpp theme={null}
typedef void(* agm_event_cb
```
### `agm_service_crash_cb`
Callback function signature for crash notification to clients.
```cpp theme={null}
typedef void(* agm_service_crash_cb
```
## Enumerations
### `agm_media_format`
Bit formats.
#### Values
| Name | Value | Description |
| ------------------------ | ----- | ------------------ |
| `AGM_FORMAT_INVALID` | | |
| `AGM_FORMAT_PCM_S8` | | 8-bit signed |
| `AGM_FORMAT_PCM_S16_LE` | | 16-bit signed |
| `AGM_FORMAT_PCM_S24_LE` | | 24-bits in 4-bytes |
| `AGM_FORMAT_PCM_S24_3LE` | | 24-bits in 3-bytes |
| `AGM_FORMAT_PCM_S32_LE` | | 32-bit signed |
| `AGM_FORMAT_MP3` | | MP3 codec. |
| `AGM_FORMAT_AAC` | | AAC codec. |
| `AGM_FORMAT_FLAC` | | FLAC codec. |
| `AGM_FORMAT_ALAC` | | ALAC codec. |
| `AGM_FORMAT_APE` | | APE codec. |
| `AGM_FORMAT_WMASTD` | | WMA codec. |
| `AGM_FORMAT_WMAPRO` | | WMA pro codec. |
| `AGM_FORMAT_VORBIS` | | Vorbis codec. |
| `AGM_FORMAT_AMR_NB` | | AMR NB codec. |
| `AGM_FORMAT_AMR_WB` | | AMR WB codec. |
| `AGM_FORMAT_AMR_WB_PLUS` | | AMR WB Plus codec. |
| `AGM_FORMAT_EVRC` | | EVRC codec. |
| `AGM_FORMAT_G711` | | G711 codec. |
| `AGM_FORMAT_QCELP` | | G711 codec. |
| `AGM_FORMAT_OPUS` | | OPUS codec. |
| `AGM_FORMAT_MAX` | | |
### `agm_data_format`
Data format MUST stay in sync with media\_fmt\_api.h.
#### Values
| Name | Value | Description |
| ------------------------------------------------ | ----- | -------------------------------------------------- |
| `AGM_DATA_FORMAT_INVALID` | | |
| `AGM_DATA_FORMAT_FIXED_POINT` | | fixed point |
| `AGM_DATA_FORMAT_IEC61937_PACKETIZED` | | IEC61937 packetized stream. |
| `AGM_DATA_FORMAT_IEC60958_PACKETIZED` | | IEC60958 packetized stream for PCM only. |
| `AGM_DATA_FORMAT_DSD_OVER_PCM` | | DSD over PCM stream. |
| `AGM_DATA_FORMAT_GENERIC_COMPRESSED` | | generic compressed stream |
| `AGM_DATA_FORMAT_RAW_COMPRESSED` | | raw compressed stream |
| `AGM_DATA_FORMAT_COMPR_OVER_PCM_PACKETIZED` | | Compressed bitstreams packetized. |
| `AGM_DATA_FORMAT_IEC60958_PACKETIZED_NON_LINEAR` | | IEC60958 packetized stream for compressed streams. |
### `agm_data_mode`
AGM data modes.
#### Values
| Name | Value | Description |
| ----------------------- | ----- | ------------------ |
| `AGM_DATA_INVALID` | | |
| `AGM_DATA_BLOCKING` | | Blocking mode. |
| `AGM_DATA_NON_BLOCKING` | | Non blocking mode. |
| `AGM_DATA_PUSH_PULL` | | Push Pull mode. |
| `AGM_DATA_EXTERN_MEM` | | Push Pull mode. |
| `AGM_DATA_MODE_MAX` | | |
### `agm_session_mode`
AGM session modes.
#### Values
| Name | Value | Description |
| ------------------------ | ----- | -------------------------- |
| `AGM_SESSION_DEFAULT` | | Normal agm tunnel session. |
| `AGM_SESSION_NO_HOST` | | Hostless mode. |
| `AGM_SESSION_NON_TUNNEL` | | Non tunnel mode. |
| `AGM_SESSION_NO_CONFIG` | | No Config mode. |
| `AGM_SESSION_COMPRESS` | | Compress mode. |
### `agm_cshm_type`
#### Values
| Name | Value | Description |
| ---------- | ----- | ------------------------------------------------------------ |
| `CACHED` | = 1 | Indicates that the allocated shared memory is cacheable. |
| `UNCACHED` | | Indicates that the allocated shared memory is non-cacheable. |
### `agm_gapless_silence_type`
Gapless playback Silence type.
#### Values
| Name | Value | Description |
| ------------------ | ----- | -------------------------------------- |
| `INITIAL_SILENCE` | | Initial silence sample to be removed. |
| `TRAILING_SILENCE` | | Trailing silence sample to be removed. |
### `buf_flag`
Flag to determine data buf or postion buf.
#### Values
| Name | Value | Description |
| ---------- | ----- | ----------- |
| `DATA_BUF` | = 0x1 | |
| `POS_BUF` | = 0x2 | |
### `direction`
Session Direction.
#### Values
| Name | Value | Description |
| ---- | ----- | ----------- |
| `RX` | = 1 | RX. |
| `TX` | | TX. |
### `event_type`
Event types.
#### Values
| Name | Value | Description |
| --------------------- | ----- | --------------------------------------------------- |
| `AGM_EVENT_DATA_PATH` | = 1 | Events on the Data path, READ\_DONE or WRITE\_DONE. |
| `AGM_EVENT_MODULE` | | Events raised by modules. |
### `agm_event_id`
Data Events that will be notified to client from AGM.
#### Values
| Name | Value | Description |
| ------------------------------ | ------------ | ------------------------------------------------------------------ |
| `AGM_EVENT_EOS_RENDERED` | = 0x0 | Indicates EOS rendered event. |
| `AGM_EVENT_READ_DONE` | = 0x1 | Indicates buffer provided as part of read call has been filled. |
| `AGM_EVENT_WRITE_DONE` | = 0x2 | Indicates buffer provided as part of write has been consumed. |
| `AGM_EVENT_EARLY_EOS_INTERNAL` | = 0x5 | Indicates early EOS event flagged internally by AGM in case flush. |
| `AGM_EVENT_EARLY_EOS` | = 0x08001126 | Indicates early EOS event. |
| `AGM_EVENT_ID_MAX` | | |
## Macros
### `AGM_BUFF_FLAG_EOS`
used to indicate a given buffer is the final buffer, client will get notified once the buffer has been rendered
```c theme={null}
#define AGM_BUFF_FLAG_EOS 0x1
```
### `AGM_BUFF_FLAG_TS_VALID`
true if buffer is marked as EOF
```c theme={null}
#define AGM_BUFF_FLAG_TS_VALID 0x2
```
### `AGM_BUFF_FLAG_EOF`
true if buffer contains media format
```c theme={null}
#define AGM_BUFF_FLAG_EOF 0x4
```
### `AGM_BUFF_FLAG_MEDIA_FORMAT`
```c theme={null}
#define AGM_BUFF_FLAG_MEDIA_FORMAT 0x8
```
### `AGM_SESSION_FLAG_INBAND_SRCM`
```c theme={null}
#define AGM_SESSION_FLAG_INBAND_SRCM 0x1
```
### `AIF_NAME_MAX_LEN`
MAX length of the AIF Name.
```c theme={null}
#define AIF_NAME_MAX_LEN 32
```