audio_module_data_rx()

int audio_module_data_rx	(	struct audio_module_handle *	handle,
		struct audio_data *	audio_data,
		k_timeout_t	timeout
	)

#include <include/audio_module/audio_module.h>

Retrieve an audio data item from an audio module.

Note

: The data pointer and its associated size that are passed via the audio data pointer, can be NULL and/or 0. It is the responsibility of the low level module functions to handle this correctly.

Parameters

handle	[in/out] The handle to the module instance.
audio_data	[out] Pointer to the audio data from the module.
timeout	[in] Non-negative waiting period to wait for operation to complete (in milliseconds). Use K_NO_WAIT to return without waiting, or K_FOREVER to wait as long as necessary.

Returns

0 if successful, error otherwise.