Functions
const platform_audio_device_info_t *	platform_audio_device_get_info (platform_audio_direction_t io_type, uint16_t index)

const platform_audio_device_info_t *	platform_audio_device_get_info_by_id (platform_audio_device_id_t device_id)

const char *	platform_audio_device_get_port_string (platform_audio_port_type_t type)

const char *	platform_audio_device_get_sample_rates_string (platform_audio_sample_rates_t sample_rates)

const char *	platform_audio_device_get_sample_sizes_string (platform_audio_sample_sizes_t sample_sizes)

platform_audio_device_id_t	platform_audio_device_get_type (platform_audio_device_info_t *device_info)

uint8_t	platform_audio_get_device_count (void)

void	platform_audio_print_device_list (const platform_audio_device_id_t audio_input_device_id, uint8_t in_dirty, const platform_audio_device_id_t audio_output_device_id, uint8_t out_dirty, int verbose)

wiced_result_t	platform_audio_timer_disable (void)

wiced_result_t	platform_audio_timer_enable (uint32_t frame_count)

wiced_result_t	platform_audio_timer_get_frame_sync (uint32_t timeout_msecs)

wiced_result_t	platform_audio_timer_get_nanoseconds (uint32_t audio_sample_rate, uint32_t audio_time_secs, uint32_t audio_time_nanosecs)

wiced_result_t	platform_audio_timer_get_resolution (uint32_t audio_sample_rate, uint32_t *ticks_per_sec)

wiced_result_t	platform_audio_timer_get_time (uint32_t time_hi, uint32_t time_lo)

Function Documentation

◆ platform_audio_device_get_info()

const platform_audio_device_info_t * platform_audio_device_get_info	(	platform_audio_direction_t	io_type,
		uint16_t	index )

Get Audio Device Info.

Parameters

[in]	io_type	: input / output Device type platform_input_output_t
[in]	index	: index into list (max = platform_audio_device_count(io_type) - 1)

Returns: pointer to platform_audio_device_info_t NULL if bad argument(s)

◆ platform_audio_device_get_info_by_id()

const platform_audio_device_info_t * platform_audio_device_get_info_by_id ( platform_audio_device_id_t device_id )

Get Device Information

Parameters

[in] device_id : platform_audio_device_id_t

Returns: pointer to platform_audio_device_info_t NULL if bad argument(s) or not defined for this platform

◆ platform_audio_device_get_port_string()

const char * platform_audio_device_get_port_string ( platform_audio_port_type_t type )

Get a string of the Port type for debug logging

Parameters

[in] type : platform_audio_port_type_t

Returns: description string ("Unknown" on error)

◆ platform_audio_device_get_sample_rates_string()

const char * platform_audio_device_get_sample_rates_string ( platform_audio_sample_rates_t sample_rates )

Get a string of the sample rates for debug logging

Parameters

[in] sample_rates : platform_audio_sample_rates_t

Returns: description string

◆ platform_audio_device_get_sample_sizes_string()

const char * platform_audio_device_get_sample_sizes_string ( platform_audio_sample_sizes_t sample_sizes )

Get a string of the sample sizes for debug logging

Parameters

[in] sample_sizes : platform_audio_sample_sizes_t

Returns: description string

◆ platform_audio_device_get_type()

platform_audio_device_id_t platform_audio_device_get_type ( platform_audio_device_info_t * device_info )

Get Audio Device Type

Parameters

[in] device_info : pointer to partially filled out device information Required fields: direction port_type Optional fields: (checked if they are non-zero) num_channels sample_sizes sample_rates Ignored fields: device_id device_name description

Returns: platform_audio_device_id_t AUDIO_DEVICE_ID_NONE on error (no devices match requirements)

◆ platform_audio_get_device_count()

uint8_t platform_audio_get_device_count ( void )

Get total number of audio devices

Returns: device count uint32_t

◆ platform_audio_print_device_list()

void platform_audio_print_device_list	(	const platform_audio_device_id_t	audio_input_device_id,
		uint8_t	in_dirty,
		const platform_audio_device_id_t	audio_output_device_id,
		uint8_t	out_dirty,
		int	verbose )

Print audio device info

Parameters

audio_input_device_id	: current audio input device (AUDIO_DEVICE_ID_NONE - don't print input information)
in_dirty	: !=0, show input device as dirty (not saved to Application DCT)
audio_output_device_id	: current audio output device (AUDIO_DEVICE_ID_NONE - don't print output information)
out_dirty	: !=0, show output device as dirty (not saved to Application DCT)
verbose	: print multi-line information

◆ platform_audio_timer_disable()

wiced_result_t platform_audio_timer_disable ( void )

Disable audio timer

Returns: wiced_result_t

◆ platform_audio_timer_enable()

wiced_result_t platform_audio_timer_enable ( uint32_t frame_count )

Enable audio timer

Parameters

[in] audio_frame_count : audio timer interrupts period expressed in number of audio samples/frames

Returns: wiced_result_t

◆ platform_audio_timer_get_frame_sync()

wiced_result_t platform_audio_timer_get_frame_sync ( uint32_t timeout_msecs )

Wait for audio timer frame sync event

Parameters

[in] timeout_msecs : timeout value in msecs; WICED_NO_WAIT or WICED_WAIT_FOREVER otherwise.

Returns: wiced_result_t

◆ platform_audio_timer_get_nanoseconds()

wiced_result_t platform_audio_timer_get_nanoseconds	(	uint32_t	audio_sample_rate,
		uint32_t *	audio_time_secs,
		uint32_t *	audio_time_nanosecs )

Read audio timer value in seconds and nanoseconds; a valid audio sample rate needs to be provided

Parameters

[in]	audio_sample_rate	: sample rate of audio platback/capture
[out]	audio_time_secs	: returned time seconds
[out]	audio_time_nanosecs	: returned time nanoseconds portion

Returns: wiced_result_t

◆ platform_audio_timer_get_resolution()

wiced_result_t platform_audio_timer_get_resolution	(	uint32_t	audio_sample_rate,
		uint32_t *	ticks_per_sec )

Get audio timer resolution (ticks per second)

Parameters

[in]	audio_sample_rate	: audio sample rate
[out]	ticks_per_sec	: returned audio timer resolution

Returns: wiced_result_t

◆ platform_audio_timer_get_time()

wiced_result_t platform_audio_timer_get_time	(	uint32_t *	time_hi,
		uint32_t *	time_lo )

Read audio timer value (tick count)

Parameters

[out]	time_hi	: Upper 32-bit of 64-bit audio timer ticks
[out]	time_lo	: Lower 32-bit of 64-bit audio timer ticks

Returns: wiced_result_t

Functions

Function Documentation

◆ platform_audio_device_get_info()

◆ platform_audio_device_get_info_by_id()

◆ platform_audio_device_get_port_string()

◆ platform_audio_device_get_sample_rates_string()

◆ platform_audio_device_get_sample_sizes_string()

◆ platform_audio_device_get_type()

◆ platform_audio_get_device_count()

◆ platform_audio_print_device_list()

◆ platform_audio_timer_disable()

◆ platform_audio_timer_enable()

◆ platform_audio_timer_get_frame_sync()

◆ platform_audio_timer_get_nanoseconds()

◆ platform_audio_timer_get_resolution()

◆ platform_audio_timer_get_time()