Documentation work
[platform/upstream/pulseaudio.git] / polyp / sink.h
1 #ifndef foosinkhfoo
2 #define foosinkhfoo
3
4 /* $Id$ */
5
6 /***
7   This file is part of polypaudio.
8  
9   polypaudio is free software; you can redistribute it and/or modify
10   it under the terms of the GNU General Public License as published
11   by the Free Software Foundation; either version 2 of the License,
12   or (at your option) any later version.
13  
14   polypaudio is distributed in the hope that it will be useful, but
15   WITHOUT ANY WARRANTY; without even the implied warranty of
16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   General Public License for more details.
18  
19   You should have received a copy of the GNU General Public License
20   along with polypaudio; if not, write to the Free Software
21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
22   USA.
23 ***/
24
25 struct pa_sink;
26
27 #include <inttypes.h>
28
29 #include "core.h"
30 #include "sample.h"
31 #include "idxset.h"
32 #include "source.h"
33
34 struct pa_sink {
35     uint32_t index;
36
37     char *name, *description;
38     struct pa_module *owner;
39     struct pa_core *core;
40     struct pa_sample_spec sample_spec;
41     struct pa_idxset *inputs;
42
43     struct pa_source *monitor_source;
44
45     pa_volume_t volume;
46
47     void (*notify)(struct pa_sink*sink);
48     uint32_t (*get_latency)(struct pa_sink *s);
49     void *userdata;
50 };
51
52 struct pa_sink* pa_sink_new(struct pa_core *core, const char *name, int fail, const struct pa_sample_spec *spec);
53 void pa_sink_free(struct pa_sink* s);
54
55 int pa_sink_render(struct pa_sink*s, size_t length, struct pa_memchunk *result);
56 int pa_sink_render_into(struct pa_sink*s, struct pa_memchunk *target);
57 void pa_sink_render_into_full(struct pa_sink *s, struct pa_memchunk *target);
58
59 uint32_t pa_sink_get_latency(struct pa_sink *s);
60
61 void pa_sink_notify(struct pa_sink*s);
62
63 void pa_sink_set_owner(struct pa_sink *sink, struct pa_module *m);
64
65 void pa_sink_set_volume(struct pa_sink *sink, pa_volume_t volume);
66
67 #endif