sink_api.h File Reference

Include dependency graph for sink_api.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	sink_init (struct sof_sink *sink, const struct sink_ops *ops, struct sof_audio_stream_params *audio_stream_params)
	Init of the API, must be called before any operation.
size_t	sink_get_num_of_processed_bytes (struct sof_sink *sink)
	Get total number of bytes processed by the sink (meaning - committed by sink_commit_buffer()).
void	sink_reset_num_of_processed_bytes (struct sof_sink *sink)
	sets counter of total number of bytes processed to zero
bool	sink_get_overrun (struct sof_sink *sink)
	set of functions for retrieve audio parameters
void	sink_set_min_free_space (struct sof_sink *sink, size_t min_free_space)
	set of functions for setting audio parameters

Function Documentation

sink_get_num_of_processed_bytes()

size_t sink_get_num_of_processed_bytes

(

struct sof_sink *

sink

)

Get total number of bytes processed by the sink (meaning - committed by sink_commit_buffer()).

Parameters

sink	a handler to sink

Returns

total number of processed data

sink_get_overrun()

bool sink_get_overrun

(

struct sof_sink *

sink

)

set of functions for retrieve audio parameters

sink_init()

void sink_init	(	struct sof_sink *	sink,
		const struct sink_ops *	ops,
		struct sof_audio_stream_params *	audio_stream_params )

Init of the API, must be called before any operation.

Parameters

sink	pointer to the structure
ops	pointer to API operations
audio_stream_params	pointer to structure with audio parameters note that the audio_stream_params must be accessible by the caller core the implementation must ensure coherent access to the parameteres in case of i.e. cross core shared queue, it must be located in non-cached memory

sink_reset_num_of_processed_bytes()

void sink_reset_num_of_processed_bytes

(

struct sof_sink *

sink

)

sets counter of total number of bytes processed to zero

sink_set_min_free_space()

void sink_set_min_free_space	(	struct sof_sink *	sink,
		size_t	min_free_space )

set of functions for setting audio parameters