code.delx.au - pulseaudio/blob - src/polyp/scache.h

   1 #ifndef fooscachehfoo
   2 #define fooscachehfoo
   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 Lesser 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 Lesser 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 <polyp/context.h>
  28 #include <polyp/stream.h>
  29 #include <polyp/cdecl.h>
  30
  31 /** \file
  32  * All sample cache related routines */
  33
  34 PA_C_DECL_BEGIN
  35
  36 /** Make this stream a sample upload stream */
  37 int pa_stream_connect_upload(pa_stream *s, size_t length);
  38
  39 /** Finish the sample upload, the stream name will become the sample name. You cancel a samp
  40  * le upload by issuing pa_stream_disconnect() */
  41 int pa_stream_finish_upload(pa_stream *s);
  42
  43 /** Play a sample from the sample cache to the specified device. If the latter is NULL use the default sink. Returns an operation object */
  44 pa_operation* pa_context_play_sample(
  45         pa_context *c               /**< Context */,
  46         const char *name            /**< Name of the sample to play */,
  47         const char *dev             /**< Sink to play this sample on */,
  48         pa_volume_t volume          /**< Volume to play this sample with */ ,
  49         pa_context_success_cb_t cb  /**< Call this function after successfully starting playback, or NULL */,
  50         void *userdata              /**< Userdata to pass to the callback */);
  51
  52 /** Remove a sample from the sample cache. Returns an operation object which may be used to cancel the operation while it is running */
  53 pa_operation* pa_context_remove_sample(pa_context *c, const char *name, pa_context_success_cb_t, void *userdata);
  54
  55 PA_C_DECL_END
  56
  57 #endif