polyp/polyplib-simple.h

   1 #ifndef foopolyplibsimplehfoo
   2 #define foopolyplibsimplehfoo
   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 #include <sys/types.h>
  26
  27 #include "sample.h"
  28 #include "polyplib-def.h"
  29 #include "cdecl.h"
  30
  31 /** \file
  32  * A simple but limited synchronous playback and recording
  33  * API. This is synchronouse, simplified wrapper around the standard
  34  * asynchronous API. */
  35
  36 /** \example pacat-simple.c
  37  * A simple playback tool using the simple API */
  38
  39 /** \example parec-simple.c
  40  * A simple recording tool using the simple API */
  41
  42 PA_C_DECL_BEGIN
  43
  44 /** \struct pa_simple
  45  * An opaque simple connection object */
  46 struct pa_simple;
  47
  48 /** Create a new connection to the server */
  49 struct pa_simple* pa_simple_new(
  50     const char *server,                 /**< Server name, or NULL for default */
  51     const char *name,                   /**< A descriptive name for this client (application name, ...) */
  52     enum pa_stream_direction dir,       /**< Open this stream for recording or playback? */
  53     const char *dev,                    /**< Sink (resp. source) name, or NULL for default */
  54     const char *stream_name,            /**< A descriptive name for this client (application name, song title, ...) */
  55     const struct pa_sample_spec *ss,    /**< The sample type to use */
  56     const struct pa_buffer_attr *attr,  /**< Buffering attributes, or NULL for default */
  57     int *error                        /**< A pointer where the error code is stored when the routine returns NULL. It is OK to pass NULL here. */
  58     );
  59
  60 /** Close and free the connection to the server. The connection objects becomes invalid when this is called. */
  61 void pa_simple_free(struct pa_simple *s);
  62
  63 /** Write some data to the server */
  64 int pa_simple_write(struct pa_simple *s, const void*data, size_t length, int *error);
  65
  66 /** Wait until all data already written is played by the daemon */
  67 int pa_simple_drain(struct pa_simple *s, int *error);
  68
  69 /** Read some data from the server */
  70 int pa_simple_read(struct pa_simple *s, void*data, size_t length, int *error);
  71
  72 PA_C_DECL_END
  73
  74 #endif