]>
code.delx.au - pulseaudio/blob - polyp/polyplib-simple.h
ee2e27e3f61ccc18696e503e83de607b87519afc
1 #ifndef foopolyplibsimplehfoo
2 #define foopolyplibsimplehfoo
7 This file is part of polypaudio.
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.
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.
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
25 #include <sys/types.h>
28 #include "polyplib-def.h"
32 * A simple but limited synchronous playback and recording API. */
37 * A simple connection object */
40 /** Create a new connection to the server */
41 struct pa_simple
* pa_simple_new(
42 const char *server
, /**< Server name, or NULL for default */
43 const char *name
, /**< A descriptive name for this client (application name, ...) */
44 enum pa_stream_direction dir
, /**< Open this stream for recording or playback? */
45 const char *dev
, /**< Sink (resp. source) name, or NULL for default */
46 const char *stream_name
, /**< A descriptive name for this client (application name, song title, ...) */
47 const struct pa_sample_spec
*ss
, /**< The sample type to use */
48 const struct pa_buffer_attr
*attr
, /**< Buffering attributes, or NULL for default */
49 int *error
/**< A pointer where the error code is stored when the routine returns NULL. It is OK to pass NULL here. */
52 /** Close and free the connection to the server. The connection objects becomes invalid when this is called. */
53 void pa_simple_free(struct pa_simple
*s
);
55 /** Write some data to the server */
56 int pa_simple_write(struct pa_simple
*s
, const void*data
, size_t length
, int *error
);
58 /** Wait until all data already written is played by the daemon */
59 int pa_simple_drain(struct pa_simple
*s
, int *error
);
61 /** Read some data from the server */
62 int pa_simple_read(struct pa_simple
*s
, void*data
, size_t length
, int *error
);