pico_audio_i2s

Classes
struct	audio_i2s_config
	Base configuration structure used when setting up. More...

Typedefs
typedef struct audio_i2s_config	audio_i2s_config_t
	Base configuration structure used when setting up.

Functions
const audio_format_t *	audio_i2s_setup (const audio_format_t *intended_audio_format, const audio_i2s_config_t *config)
	Set up system to output I2S audio. More...
bool	audio_i2s_connect_thru (audio_buffer_pool_t *producer, audio_connection_t *connection)
bool	audio_i2s_connect (audio_buffer_pool_t *producer)
bool	audio_i2s_connect_s8 (audio_buffer_pool_t *producer)
bool	audio_i2s_connect_extra (audio_buffer_pool_t *producer, bool buffer_on_give, uint buffer_count, uint samples_per_buffer, audio_connection_t *connection)
void	audio_i2s_set_enabled (bool enabled)
	Set up system to output I2S audio. More...

Detailed Description

I2S audio output using the PIO

This library uses the hardware_pio system to implement a I2S audio interface

Todo:

Must be more we need to say here.

certainly need an example

Function Documentation

audio_i2s_connect()

bool audio_i2s_connect

(

audio_buffer_pool_t *

producer

)

Todo:

Parameters

producer

todo make a common version (or a macro) .. we don't want to pull in unnecessary code by default

audio_i2s_connect_extra()

bool audio_i2s_connect_extra	(	audio_buffer_pool_t *	producer,
		bool	buffer_on_give,
		uint	buffer_count,
		uint	samples_per_buffer,
		audio_connection_t *	connection
	)

Todo:

Parameters

producer
buffer_on_give
buffer_count
samples_per_buffer
connection

Returns

audio_i2s_connect_s8()

bool audio_i2s_connect_s8

(

audio_buffer_pool_t *

producer

)

Todo:

Parameters

producer

audio_i2s_connect_thru()

bool audio_i2s_connect_thru	(	audio_buffer_pool_t *	producer,
		audio_connection_t *	connection
	)

Todo:

Parameters

producer
connection

audio_i2s_set_enabled()

void audio_i2s_set_enabled

(

bool

enabled

)

Set up system to output I2S audio.

Parameters

enable

true to enable I2S audio, false to disable.

audio_i2s_setup()

const audio_format_t* audio_i2s_setup	(	const audio_format_t *	intended_audio_format,
		const audio_i2s_config_t *	config
	)

Set up system to output I2S audio.

Parameters

intended_audio_format

Todo:

Parameters

config

The configuration to apply.