Driver Operations Audio Codec driver operations More...

#include <zephyr/audio/codec.h>

Data Fields
audio_codec_configure_t	configure
	REQ Configure the audio codec.
audio_codec_start_output_t	start_output
	REQ Set codec to start output audio playback.
audio_codec_stop_output_t	stop_output
	REQ Set codec to stop output audio playback.
audio_codec_set_property_t	set_property
	REQ Set a codec property defined by audio_property_t.
audio_codec_apply_properties_t	apply_properties
	REQ Atomically apply any cached properties.
audio_codec_clear_errors_t	clear_errors
	OPT Clear any codec errors.
audio_codec_register_error_callback_t	register_error_callback
	OPT Register a callback function for codec error.
audio_codec_route_input_t	route_input
	OPT Sets up signal routing for a given input channel.
audio_codec_route_output_t	route_output
	OPT Sets up signal routing for a given output channel.
audio_codec_start_t	start
	OPT Set codec to start audio playback or capture.
audio_codec_stop_t	stop
	OPT Set codec to stop audio playback or capture.
audio_codec_write_t	write
	OPT write one block size data for audio playback.
audio_codec_register_done_callback_t	register_done_callback
	OPT Register a callback function for codec one frame data tx/rx done.

Detailed Description

Driver Operations Audio Codec driver operations

This is the driver API structure any Audio Codec driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ apply_properties

audio_codec_apply_properties_t audio_codec_driver_api::apply_properties

REQ Atomically apply any cached properties.

◆ clear_errors

audio_codec_clear_errors_t audio_codec_driver_api::clear_errors

OPT Clear any codec errors.

◆ configure

audio_codec_configure_t audio_codec_driver_api::configure

REQ Configure the audio codec.

◆ register_done_callback

audio_codec_register_done_callback_t audio_codec_driver_api::register_done_callback

OPT Register a callback function for codec one frame data tx/rx done.

◆ register_error_callback

audio_codec_register_error_callback_t audio_codec_driver_api::register_error_callback

OPT Register a callback function for codec error.

◆ route_input

audio_codec_route_input_t audio_codec_driver_api::route_input

OPT Sets up signal routing for a given input channel.

◆ route_output

audio_codec_route_output_t audio_codec_driver_api::route_output

OPT Sets up signal routing for a given output channel.

◆ set_property

audio_codec_set_property_t audio_codec_driver_api::set_property

REQ Set a codec property defined by audio_property_t.

◆ start

audio_codec_start_t audio_codec_driver_api::start

OPT Set codec to start audio playback or capture.

◆ start_output

audio_codec_start_output_t audio_codec_driver_api::start_output

REQ Set codec to start output audio playback.

◆ stop

audio_codec_stop_t audio_codec_driver_api::stop

OPT Set codec to stop audio playback or capture.

◆ stop_output

audio_codec_stop_output_t audio_codec_driver_api::stop_output

REQ Set codec to stop output audio playback.

◆ write

audio_codec_write_t audio_codec_driver_api::write

OPT write one block size data for audio playback.

The documentation for this struct was generated from the following file:

zephyr/audio/codec.h

Data Fields