src/*/*.h: add link to examples, remove trailing spaces, improve documentation
[aubio.git] / src / io / sink.h
1 /*
2   Copyright (C) 2012 Paul Brossier <piem@aubio.org>
3
4   This file is part of aubio.
5
6   aubio is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   aubio is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with aubio.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21 #ifndef _AUBIO_SINK_H
22 #define _AUBIO_SINK_H
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 /** \file
29
30   Media sink
31
32   \example io/test-sink.c
33
34 */
35
36 typedef struct _aubio_sink_t aubio_sink_t;
37 aubio_sink_t * new_aubio_sink(char_t * uri, uint_t samplerate);
38 void aubio_sink_do(aubio_sink_t * s, fvec_t * write_data, uint_t written);
39 void del_aubio_sink(aubio_sink_t * s);
40
41 #ifdef __cplusplus
42 }
43 #endif
44
45 #endif /* _AUBIO_SINK_H */