SpiceClientGLib.Audio¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`get` (session, context)
class	`new` (session, context, name)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_connect_channel` (channel)
	`do_get_playback_volume_info_async` (cancellable, main_channel, callback, *user_data)
	`do_get_playback_volume_info_finish` (res, mute, nchannels, volume)
	`do_get_record_volume_info_async` (cancellable, main_channel, callback, *user_data)
	`do_get_record_volume_info_finish` (res, mute, nchannels, volume)

Properties¶

Name	Type	Flags	Short Description
`main-context`	`GLib.MainContext`	r/w/co	`GLib.MainContext` to use for the event source
`session`	`SpiceClientGLib.Session`	r/w/co	`SpiceClientGLib.Session`

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class SpiceClientGLib.Audio(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: SpiceClientGLib.AudioClass

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

classmethod get(session, context)¶

Parameters:

session (SpiceClientGLib.Session) – the SpiceClientGLib.Session to connect to
context (GLib.MainContext or None) – a GLib.MainContext to attach to (or None for default).

Returns:

a weak reference to a SpiceClientGLib.Audio instance or None if failed.

Return type:

SpiceClientGLib.Audio

Gets the SpiceClientGLib.Audio associated with the passed in SpiceClientGLib.Session. A new SpiceClientGLib.Audio instance will be created the first time this function is called for a certain SpiceClientGLib.Session.

Note that this function returns a weak reference, which should not be used after the SpiceClientGLib.Session itself has been unref-ed by the caller.

classmethod new(session, context, name)¶

Parameters:

session (SpiceClientGLib.Session) – the SpiceClientGLib.Session to connect to
context (GLib.MainContext or None) – a GLib.MainContext to attach to (or None for default).
name (str or None) – a name for the audio channels (or None for application name).

Returns:

a new SpiceClientGLib.Audio instance or None if no backend or failed.

Return type:

SpiceClientGLib.Audio

Once instantiated, SpiceClientGLib.Audio will handle the playback and record channels to stream to your local audio system.

Deprecated since version 0.8: Use SpiceClientGLib.Audio.get() instead

do_connect_channel(channel) virtual¶

Parameters:: channel (SpiceClientGLib.Channel) –
Return type:: bool

do_get_playback_volume_info_async(cancellable, main_channel, callback, *user_data) virtual¶

Parameters:

cancellable (Gio.Cancellable or None) –
main_channel (SpiceClientGLib.MainChannel) –
callback (Gio.AsyncReadyCallback or None) –
user_data (object or None) –

do_get_playback_volume_info_finish(res, mute, nchannels, volume) virtual¶

Parameters:

res (Gio.AsyncResult) –
mute (bool) –
nchannels (int) –
volume (int) –

Return type:

bool

do_get_record_volume_info_async(cancellable, main_channel, callback, *user_data) virtual¶

Parameters:

cancellable (Gio.Cancellable or None) –
main_channel (SpiceClientGLib.MainChannel) –
callback (Gio.AsyncReadyCallback or None) –
user_data (object or None) –

do_get_record_volume_info_finish(res, mute, nchannels, volume) virtual¶

Parameters:

res (Gio.AsyncResult) –
mute (bool) –
nchannels (int) –
volume (int) –

Return type:

bool

Property Details¶

SpiceClientGLib.Audio.props.main_context¶

Name:: main-context
Type:: GLib.MainContext
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

GLib.MainContext to use for the event source

SpiceClientGLib.Audio.props.session¶

Name:: session
Type:: SpiceClientGLib.Session
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

SpiceClientGLib.Session this SpiceClientGLib.Audio is associated with