SpiceClientGLib.PlaybackChannel

Subclasses:

None

Methods

Inherited:

SpiceClientGLib.Channel (13), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

set_delay (delay_ms)

Virtual Methods

Inherited:

SpiceClientGLib.Channel (8), GObject.Object (7)

	do_playback_data (data, size)
	do_playback_start (format, channels, freq)
	do_playback_stop ()

Properties

Inherited:

SpiceClientGLib.Channel (5)

Name	Type	Flags	Short Description
min-latency	int	r/w	Playback min buffer size (ms)
mute	bool	r/w	Mute
nchannels	int	r/w	Number of Channels
volume	int	r/w	Playback volume

Signals

Inherited:

SpiceClientGLib.Channel (2), GObject.Object (1)

Name	Short Description
playback-data	Provide audio data to be played.
playback-get-delay	Notify when the current playback delay is requested
playback-start	Notify when the playback should start, and provide audio format characteristics.
playback-stop	Notify when the playback should stop.

Fields

Inherited:

SpiceClientGLib.Channel (2), GObject.Object (1)

Name	Type	Access	Description
parent	SpiceClientGLib.Channel	r

Class Details

class SpiceClientGLib.PlaybackChannel(**kwargs)

Bases:

SpiceClientGLib.Channel

Abstract:

No

Structure:

SpiceClientGLib.PlaybackChannelClass

The SpiceClientGLib.PlaybackChannel struct is opaque and should not be accessed directly.

set_delay(delay_ms)

Parameters:

delay_ms (int) – the delay in ms

Adjust the multimedia time according to the delay.

do_playback_data(data, size) virtual

Parameters:

• data (object or None) –

• size (int) –

do_playback_start(format, channels, freq) virtual

Parameters:

• format (int) –

• channels (int) –

• freq (int) –

do_playback_stop() virtual

Signal Details

SpiceClientGLib.PlaybackChannel.signals.playback_data(playback_channel, data, data_size)

Signal Name:

playback-data

Flags:

RUN_FIRST

Parameters:

• playback_channel (SpiceClientGLib.PlaybackChannel) – The object which received the signal

• data (object or None) – pointer to audio data

• data_size (int) – size in byte of data

Provide audio data to be played.

SpiceClientGLib.PlaybackChannel.signals.playback_get_delay(playback_channel)

Signal Name:

playback-get-delay

Flags:

RUN_FIRST

Parameters:

playback_channel (SpiceClientGLib.PlaybackChannel) – The object which received the signal

Notify when the current playback delay is requested

SpiceClientGLib.PlaybackChannel.signals.playback_start(playback_channel, format, channels, rate)

Signal Name:

playback-start

Flags:

RUN_FIRST

Parameters:

• playback_channel (SpiceClientGLib.PlaybackChannel) – The object which received the signal

• format (int) – a #SPICE_AUDIO_FMT

• channels (int) – number of channels

• rate (int) – audio rate

Notify when the playback should start, and provide audio format characteristics.

SpiceClientGLib.PlaybackChannel.signals.playback_stop(playback_channel)

Signal Name:

playback-stop

Flags:

RUN_FIRST

Parameters:

playback_channel (SpiceClientGLib.PlaybackChannel) – The object which received the signal

Notify when the playback should stop.

Property Details

SpiceClientGLib.PlaybackChannel.props.min_latency

Name:

min-latency

Type:

int

Default Value:

200

Flags:

READABLE, WRITABLE

Playback min buffer size (ms)

SpiceClientGLib.PlaybackChannel.props.mute

Name:

mute

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE

Mute

SpiceClientGLib.PlaybackChannel.props.nchannels

Name:

nchannels

Type:

int

Default Value:

2

Flags:

READABLE, WRITABLE

Number of Channels

SpiceClientGLib.PlaybackChannel.props.volume

Name:

volume

Type:

int

Default Value:

None

Flags:

READABLE, WRITABLE

Playback volume