scache.h File Reference

All sample cache related routines. More...

Go to the source code of this file.

Functions

int pa_stream_connect_upload (pa_stream *s, size_t length)
 Make this stream a sample upload stream.
int pa_stream_finish_upload (pa_stream *s)
 Finish the sample upload, the stream name will become the sample name.
pa_operationpa_context_play_sample (pa_context *c, const char *name, const char *dev, pa_volume_t volume, pa_context_success_cb_t cb, void *userdata)
 Play a sample from the sample cache to the specified device.
pa_operationpa_context_remove_sample (pa_context *c, const char *name, pa_context_success_cb_t, void *userdata)
 Remove a sample from the sample cache.


Detailed Description

All sample cache related routines.


Function Documentation

pa_operation* pa_context_play_sample ( pa_context c,
const char *  name,
const char *  dev,
pa_volume_t  volume,
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

Parameters:
c  Context
name  Name of the sample to play
dev  Sink to play this sample on
volume  Volume to play this sample with
cb  Call this function after successfully starting playback, or NULL
userdata  Userdata to pass to the callback

pa_operation* pa_context_remove_sample ( pa_context c,
const char *  name,
pa_context_success_cb_t  ,
void *  userdata 
)

Remove a sample from the sample cache.

Returns an operation object which may be used to cancel the operation while it is running

int pa_stream_connect_upload ( pa_stream s,
size_t  length 
)

Make this stream a sample upload stream.

int pa_stream_finish_upload ( pa_stream s  ) 

Finish the sample upload, the stream name will become the sample name.

You cancel a samp le upload by issuing pa_stream_disconnect()


Generated on Mon Sep 29 02:44:36 2008 for PulseAudio by  doxygen 1.5.6