Search packages:
 Sourcecode: pulseaudio version 0.9.100.9.10-1ubuntu10.9.10-20.9.10-2.10.9.10-2ubuntu30.9.10-2ubuntu60.9.10-2ubuntu70.9.10-2ubuntu80.9.10-2ubuntu90.9.10-30.9.10-3+lenny10.9.10-3+lenny20.9.130.9.13-10.9.13-1ubuntu10.9.13-1ubuntu20.9.13-1ubuntu30.9.13-20.9.13-2ubuntu10.9.13-2ubuntu20.9.13-2ubuntu30.9.14-0ubuntu100.9.14-0ubuntu110.9.14-0ubuntu130.9.14-0ubuntu140.9.14-0ubuntu150.9.14-0ubuntu30.9.14-0ubuntu40.9.14-0ubuntu70.9.14-10.9.14-20.9.150.9.15-10.9.15-20.9.15-4.10.9.15~test50.9.15~test5-10.9.160.9.16~test2~20090726git59659e1db0.9.16~test2~20090726git59659e1db-10.9.16~test40.9.16~test50.9.16~test5-10.9.16~test6-3-g57e10.9.16~test7-14-g7ca810.9.170.9.17-10.9.180.9.190.9.19-20.9.200.9.20-10.9.210.9.21-10.9.21-1.10.9.21-1.20.9.21-20.9.21-30.9.21-3+squeeze10.9.21-40.9.21-4.10.9.220.9.22+stable-queue-18-geb9660.9.22+stable-queue-24-g67d180.9.22-10.9.22-1.10.9.22~0.9.21+341-g62bf0.9.22~0.9.21+stable-queue-24-gfa640.9.22~0.9.21+stable-queue-32-g84780.9.22~0.9.21+stable-queue-98-ga8d70.9.230.9.23-10.9.50.9.5-5etch10.9.5-5ubuntu40.9.60.9.6-1ubuntu20.99.1-10.99.21.01.1-21:0.9.14-0ubuntu161:0.9.14-0ubuntu201:0.9.15-1ubuntu31:0.9.15-2ubuntu11:0.9.15-3ubuntu11:0.9.15-4ubuntu11:0.9.15-4ubuntu21:0.9.15-4ubuntu31:0.9.16-0ubuntu11:0.9.16~test4-0ubuntu11:0.9.16~test4-0ubuntu21:0.9.16~test4-0ubuntu41:0.9.16~test6-3-g57e1-0ubuntu21:0.9.16~test7-14-g7ca81-0ubuntu11:0.9.16~test7-14-g7ca81-0ubuntu21:0.9.17-0ubuntu11:0.9.17-0ubuntu21:0.9.18-0ubuntu21:0.9.18-0ubuntu31:0.9.19-0ubuntu11:0.9.19-0ubuntu41:0.9.21-0ubuntu21:0.9.21-0ubuntu51:0.9.21-0ubuntu61:0.9.22+stable-queue-18-geb966-0ubuntu11:0.9.22+stable-queue-18-geb966-0ubuntu21:0.9.22+stable-queue-24-g67d18-0ubuntu21:0.9.22+stable-queue-24-g67d18-0ubuntu31:0.9.22-0ubuntu11:0.9.22-0ubuntu31:0.9.22~0.9.21+341-g62bf-0ubuntu11:0.9.22~0.9.21+stable-queue-24-gfa64-0ubuntu11:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu11:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu101:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu111:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu121:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu141:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu151:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu161:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu171:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu191:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu201:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu211:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu41:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu51:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu61:0.9.22~0.9.21+stable-queue-32-g8478-0ubuntu91:0.9.22~0.9.21+stable-queue-98-ga8d7-0ubuntu31:0.9.23-0ubuntu21:0.99.2-0ubuntu21:1.0-0ubuntu3

# scache.h

Go to the documentation of this file.
#ifndef fooscachehfoo
#define fooscachehfoo

/***
This file is part of PulseAudio.

Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB

PulseAudio is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License,
or (at your option) any later version.

PulseAudio is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with PulseAudio; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA.
***/

#include <sys/types.h>

#include <pulse/context.h>
#include <pulse/stream.h>
#include <pulse/cdecl.h>
#include <pulse/version.h>

/** \page scache Sample Cache
*
* \section overv_sec Overview
*
* The sample cache provides a simple way of overcoming high network latencies
* and reducing bandwidth. Instead of streaming a sound precisely when it
* should be played, it is stored on the server and only the command to start
* playing it needs to be sent.
*
* \section create_sec Creation
*
* To create a sample, the normal stream API is used (see \ref streams). The
* function pa_stream_connect_upload() will make sure the stream is stored as
* a sample on the server.
*
* will receive the same name as the stream. If the upload should be aborted,
* simply call pa_stream_disconnect().
*
* \section play_sec Playing samples
*
* To play back a sample, simply call pa_context_play_sample():
*
* \code
* pa_operation *o;
*
* o = pa_context_play_sample(my_context,
*                            "sample2",       // Name of my sample
*                            NULL,            // Use default sink
*                            PA_VOLUME_NORM,  // Full volume
*                            NULL,            // Don't need a callback
*                            NULL
*                            );
* if (o)
*     pa_operation_unref(o);
* \endcode
*
* \section rem_sec Removing samples
*
* When a sample is no longer needed, it should be removed on the server to
* save resources. The sample is deleted using pa_context_remove_sample().
*/

/** \file
* All sample cache related routines */

PA_C_DECL_BEGIN

/** Callback prototype for pa_context_play_sample_with_proplist(). The
* idx value is the index of the sink input object, or
* PA_INVALID_INDEX on failure. \since 0.9.11 */
typedef void (*pa_context_play_sample_cb_t)(pa_context *c, uint32_t idx, void *userdata);

/** Make this stream a sample upload stream */

/** Finish the sample upload, the stream name will become the sample
* name. You cancel a sample upload by issuing
* pa_stream_disconnect() */

/** Remove a sample from the sample cache. Returns an operation object which may be used to cancel the operation while it is running */
pa_operation* pa_context_remove_sample(pa_context *c, const char *name, pa_context_success_cb_t cb, void *userdata);

/** Play a sample from the sample cache to the specified device. If
* the latter is NULL use the default sink. Returns an operation
* object */
pa_operation* pa_context_play_sample(
pa_context *c               /**< Context */,
const char *name            /**< Name of the sample to play */,
const char *dev             /**< Sink to play this sample on */,
pa_volume_t volume          /**< Volume to play this sample with. Starting with 0.9.15 you may pass here PA_VOLUME_INVALID which will leave the decision about the volume to the server side which is a good idea. */ ,
pa_context_success_cb_t cb  /**< Call this function after successfully starting playback, or NULL */,
void *userdata              /**< Userdata to pass to the callback */);

/** Play a sample from the sample cache to the specified device,
* allowing specification of a property list for the playback
* stream. If the latter is NULL use the default sink. Returns an
* operation object. \since 0.9.11 */
pa_operation* pa_context_play_sample_with_proplist(
pa_context *c                   /**< Context */,
const char *name                /**< Name of the sample to play */,
const char *dev                 /**< Sink to play this sample on */,
pa_volume_t volume              /**< Volume to play this sample with. Starting with 0.9.15 you may pass here PA_VOLUME_INVALID which will leave the decision about the volume to the server side which is a good idea.  */ ,
pa_proplist *proplist           /**< Property list for this sound. The property list of the cached entry will be merged into this property list */,
pa_context_play_sample_cb_t cb  /**< Call this function after successfully starting playback, or NULL */,
void *userdata                  /**< Userdata to pass to the callback */);

PA_C_DECL_END

#endif


Generated by  Doxygen 1.6.0   Back to index