PulseAudio  5.0
simple.h
Go to the documentation of this file.
1 #ifndef foosimplehfoo
2 #define foosimplehfoo
3 
4 /***
5  This file is part of PulseAudio.
6 
7  Copyright 2004-2006 Lennart Poettering
8  Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9 
10  PulseAudio is free software; you can redistribute it and/or modify
11  it under the terms of the GNU Lesser General Public License as published
12  by the Free Software Foundation; either version 2.1 of the License,
13  or (at your option) any later version.
14 
15  PulseAudio is distributed in the hope that it will be useful, but
16  WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  General Public License for more details.
19 
20  You should have received a copy of the GNU Lesser General Public License
21  along with PulseAudio; if not, write to the Free Software
22  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
23  USA.
24 ***/
25 
26 #include <sys/types.h>
27 
28 #include <pulse/sample.h>
29 #include <pulse/channelmap.h>
30 #include <pulse/def.h>
31 #include <pulse/cdecl.h>
32 #include <pulse/version.h>
33 
113 PA_C_DECL_BEGIN
114 
117 typedef struct pa_simple pa_simple;
118 
121  const char *server,
122  const char *name,
124  const char *dev,
125  const char *stream_name,
126  const pa_sample_spec *ss,
127  const pa_channel_map *map,
128  const pa_buffer_attr *attr,
129  int *error
130  );
131 
133 void pa_simple_free(pa_simple *s);
134 
136 int pa_simple_write(pa_simple *s, const void *data, size_t bytes, int *error);
137 
139 int pa_simple_drain(pa_simple *s, int *error);
140 
144 int pa_simple_read(
145  pa_simple *s,
146  void *data,
147  size_t bytes,
148  int *error
151  );
152 
155 
157 int pa_simple_flush(pa_simple *s, int *error);
158 
159 PA_C_DECL_END
160 
161 #endif
int pa_simple_read(pa_simple *s, void *data, size_t bytes, int *error)
Read some data from the server.
A sample format and attribute specification.
Definition: sample.h:250
int pa_simple_drain(pa_simple *s, int *error)
Wait until all data already written is played by the daemon.
Global definitions.
void pa_simple_free(pa_simple *s)
Close and free the connection to the server.
int pa_simple_write(pa_simple *s, const void *data, size_t bytes, int *error)
Write some data to the server.
uint64_t pa_usec_t
Type for usec specifications (unsigned).
Definition: sample.h:262
enum pa_stream_direction pa_stream_direction_t
The direction of a pa_stream object.
Constants and routines for channel mapping handling.
Playback and record buffer metrics.
Definition: def.h:389
pa_usec_t pa_simple_get_latency(pa_simple *s, int *error)
Return the playback or record latency.
int pa_simple_flush(pa_simple *s, int *error)
Flush the playback or record buffer.
pa_simple * pa_simple_new(const char *server, const char *name, pa_stream_direction_t dir, const char *dev, const char *stream_name, const pa_sample_spec *ss, const pa_channel_map *map, const pa_buffer_attr *attr, int *error)
Create a new connection to the server.
Define header version.
Constants and routines for sample type handling.
An opaque simple connection object.
A channel map which can be used to attach labels to specific channels of a stream.
Definition: channelmap.h:264