Data Structures
struct	audio_codec_driver_api
	Driver Operations Audio Codec driver operations More...

Macros
#define	audio_codec_api audio_codec_driver_api __DEPRECATED_MACRO
	Legacy struct tag alias for audio_codec_driver_api for audio codec drivers that have not been updated to use audio_codec_driver_api for their backend struct.

Typedefs
typedef int(*	audio_codec_configure_t) (const struct device dev, struct audio_codec_cfg cfg)
	Callback API to configure an audio codec device.
typedef void(*	audio_codec_start_output_t) (const struct device *dev)
	Callback API to start output audio playback.
typedef void(*	audio_codec_stop_output_t) (const struct device *dev)
	Callback API to stop output audio playback.
typedef int(*	audio_codec_set_property_t) (const struct device *dev, audio_property_t property, audio_channel_t channel, audio_property_value_t val)
	Callback API to set an audio codec property.
typedef int(*	audio_codec_apply_properties_t) (const struct device *dev)
	Callback API to apply cached audio codec properties.
typedef int(*	audio_codec_clear_errors_t) (const struct device *dev)
	Callback API to clear audio codec errors.
typedef int(*	audio_codec_register_error_callback_t) (const struct device *dev, audio_codec_error_callback_t cb)
	Callback API to register an audio codec error callback.
typedef int(*	audio_codec_route_input_t) (const struct device *dev, audio_channel_t channel, uint32_t input)
	Callback API to route an audio codec input.
typedef int(*	audio_codec_route_output_t) (const struct device *dev, audio_channel_t channel, uint32_t output)
	Callback API to route an audio codec output.
typedef int(*	audio_codec_start_t) (const struct device *dev, audio_dai_dir_t dir)
	Callback API to start audio codec playback or capture.
typedef int(*	audio_codec_stop_t) (const struct device *dev, audio_dai_dir_t dir)
	Callback API to stop audio codec playback or capture.
typedef int(*	audio_codec_write_t) (const struct device dev, uint8_t data, size_t data_size)
	Callback API to submit data for audio codec playback.
typedef int(*	audio_codec_register_done_callback_t) (const struct device dev, audio_codec_tx_done_callback_t tx_cb, void tx_cb_user_data, audio_codec_rx_done_callback_t rx_cb, void *rx_cb_user_data)
	Callback API to register audio codec DMA completion callbacks.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a Audio Codec driver.

Macro Definition Documentation

◆ audio_codec_api

#define audio_codec_api audio_codec_driver_api __DEPRECATED_MACRO

#include <zephyr/audio/codec.h>

Legacy struct tag alias for audio_codec_driver_api for audio codec drivers that have not been updated to use audio_codec_driver_api for their backend struct.

Deprecated: Audio codec drivers should use the DEVICE_API() macro to declare their driver API.

Typedef Documentation

◆ audio_codec_apply_properties_t

typedef int(* audio_codec_apply_properties_t) (const struct device *dev)

#include <zephyr/audio/codec.h>

Callback API to apply cached audio codec properties.

See audio_codec_apply_properties() for argument descriptions.

◆ audio_codec_clear_errors_t

typedef int(* audio_codec_clear_errors_t) (const struct device *dev)

#include <zephyr/audio/codec.h>

Callback API to clear audio codec errors.

See audio_codec_clear_errors() for argument descriptions.

◆ audio_codec_configure_t

typedef int(* audio_codec_configure_t) (const struct device *dev, struct audio_codec_cfg *cfg)

#include <zephyr/audio/codec.h>

Callback API to configure an audio codec device.

See audio_codec_configure() for argument descriptions.

◆ audio_codec_register_done_callback_t

typedef int(* audio_codec_register_done_callback_t) (const struct device *dev, audio_codec_tx_done_callback_t tx_cb, void *tx_cb_user_data, audio_codec_rx_done_callback_t rx_cb, void *rx_cb_user_data)

#include <zephyr/audio/codec.h>

Callback API to register audio codec DMA completion callbacks.

See audio_codec_register_done_callback() for argument descriptions.