|  |  |  | Spice-GTK Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | Signals | ||||
#include <channel-playback.h> struct SpicePlaybackChannel; struct SpicePlaybackChannelClass; void spice_playback_channel_set_delay (SpicePlaybackChannel *channel,guint32 delay_ms);
"min-latency" guint : Read / Write "mute" gboolean : Read / Write "nchannels" guint : Read / Write "volume" gpointer : Read / Write
"playback-data" :Run First"playback-get-delay" :Run First"playback-start" :Run First"playback-stop" :Run First
SpicePlaybackChannel class handles an audio playback stream. The audio data is received via "playback-data" signal, and is controlled by the guest with "playback-stop" and "playback-start" signal events.
Note: You may be interested to let the SpiceAudio class play and record audio channels for your application.
struct SpicePlaybackChannel;
The SpicePlaybackChannel struct is opaque and should not be accessed directly.
struct SpicePlaybackChannelClass {
    SpiceChannelClass parent_class;
    /* signals */
    void (*playback_start)(SpicePlaybackChannel *channel,
                           gint format, gint channels, gint freq);
    void (*playback_data)(SpicePlaybackChannel *channel, gpointer *data, gint size);
    void (*playback_stop)(SpicePlaybackChannel *channel);
};
Class structure for SpicePlaybackChannel.
| SpiceChannelClass  | Parent class. | 
| Signal class handler for the "playback-start" signal. | |
| Signal class handler for the "playback-data" signal. | |
| Signal class handler for the "playback-stop" signal. | 
void spice_playback_channel_set_delay (SpicePlaybackChannel *channel,guint32 delay_ms);
"min-latency" property"min-latency" guint : Read / Write
Playback min buffer size (ms).
Default value: 200
"nchannels" property"nchannels" guint : Read / Write
Number of Channels.
Allowed values: <= 255
Default value: 2
"playback-data" signalvoid                user_function                      (SpicePlaybackChannel *channel,
                                                        gpointer              data,
                                                        gint                  data_size,
                                                        gpointer              user_data)      : Run First
Provide audio data to be played.
| 
 | the SpicePlaybackChannel that emitted the signal | 
| 
 | pointer to audio data | 
| 
 | size in byte of data | 
| 
 | user data set when the signal handler was connected. | 
"playback-get-delay" signalvoid                user_function                      (SpicePlaybackChannel *channel,
                                                        gpointer              user_data)      : Run First
Notify when the current playback delay is requested
| 
 | the SpicePlaybackChannel that emitted the signal | 
| 
 | user data set when the signal handler was connected. | 
"playback-start" signalvoid                user_function                      (SpicePlaybackChannel *channel,
                                                        gint                  format,
                                                        gint                  channels,
                                                        gint                  rate,
                                                        gpointer              user_data)      : Run First
Notify when the playback should start, and provide audio format characteristics.
| 
 | the SpicePlaybackChannel that emitted the signal | 
| 
 | a SPICE_AUDIO_FMT | 
| 
 | number of channels | 
| 
 | audio rate | 
| 
 | minimum playback latency in ms | 
| 
 | user data set when the signal handler was connected. | 
"playback-stop" signalvoid                user_function                      (SpicePlaybackChannel *channel,
                                                        gpointer              user_data)      : Run First
Notify when the playback should stop.
| 
 | the SpicePlaybackChannel that emitted the signal | 
| 
 | user data set when the signal handler was connected. |