Sound Open Firmware
Loading...
Searching...
No Matches
sink_api.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: BSD-3-Clause
2 *
3 * Copyright(c) 2023 Intel Corporation. All rights reserved.
4 *
5 */
6
13#ifndef __SOF_SINK_API_H__
14#define __SOF_SINK_API_H__
15
16#include <module/audio/sink_api.h>
17
33void sink_init(struct sof_sink *sink, const struct sink_ops *ops,
34 struct sof_audio_stream_params *audio_stream_params);
35
41size_t sink_get_num_of_processed_bytes(struct sof_sink *sink);
42
47void sink_reset_num_of_processed_bytes(struct sof_sink *sink);
48
54bool sink_get_overrun(struct sof_sink *sink);
55
61void sink_set_min_free_space(struct sof_sink *sink, size_t min_free_space);
62
65#endif /* __SOF_SINK_API_H__ */
sink_get_overrun
bool sink_get_overrun(struct sof_sink *sink)
Check if buffer overrun is permitted on sink stream.
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 (committed by sink_commit_buffer()).
sink_init
void sink_init(struct sof_sink *sink, const struct sink_ops *ops, struct sof_audio_stream_params *audio_stream_params)
Initialize sink API structure before any operation.
sink_set_min_free_space
void sink_set_min_free_space(struct sof_sink *sink, size_t min_free_space)
Set minimum free space required in sink buffer.
sink_reset_num_of_processed_bytes
void sink_reset_num_of_processed_bytes(struct sof_sink *sink)
Reset counter of total processed bytes to zero.
sink_api.h
Sink audio endpoint API for module output buffers.
sink_ops
this is a definition of internals of sink API
Definition sink_api.h:69
sof_audio_stream_params
set of parameters describing audio stream this structure is shared between audio_stream....
Definition audio_stream.h:49
sof_sink
internals of sink API.
Definition sink_api.h:141