> ## 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.

# RTM Logging API

> This file contains audio rtm logging parameters.

**Header:** `spf/api/modules/rtm_logging_api.h`

## Structures

### `rtm_logging_enable_payload_t`

**Members**

<ParamField path="enable_rtm_logging" type="uint32_t" />

<ParamField path="log_code" type="uint32_t" />

### `rtm_logging_param_data_t`

**Members**

<ParamField path="module_instance_id" type="uint32_t" />

<ParamField path="param_id" type="uint32_t" />

<ParamField path="param_size" type="uint16_t" />

<ParamField path="reserved" type="uint16_t" />

### `rtm_pcm_logging_payload_t`

**Members**

<ParamField path="pcm_size" type="uint32_t" />

<ParamField path="log_tap_id" type="uint32_t" />

<ParamField path="sampling_rate" type="uint32_t" />

<ParamField path="num_channels" type="uint16_t" />

<ParamField path="pcm_width" type="uint8_t" />

<ParamField path="interleaved" type="uint8_t" />

<ParamField path="channel_map" type="uint8_t" />

## Type Definitions

### `rtm_logging_enable_payload_t`

```cpp theme={null}
typedef struct rtm_logging_enable_payload_t rtm_logging_enable_payload_t
```

### `rtm_logging_param_data_t`

```cpp theme={null}
typedef struct rtm_logging_param_data_t rtm_logging_param_data_t
```

### `rtm_pcm_logging_payload_t`

```cpp theme={null}
typedef struct rtm_pcm_logging_payload_t rtm_pcm_logging_payload_t
```

## Macros

### `PARAM_ID_RTM_LOGGING_ENABLE`

```c theme={null}
#define PARAM_ID_RTM_LOGGING_ENABLE 0x080010A6
```

### `RTM_HEADER_VERSION_0`

```c theme={null}
#define RTM_HEADER_VERSION_0 0
```

### `PARAM_ID_RTM_PCM_LOGGING`

```c theme={null}
#define PARAM_ID_RTM_PCM_LOGGING 0x080010A7
```