Ags.SoundServer

Implementations:

None

Methods

	get_ports (port_count)
	get_sequencer (client_uuid)
	get_soundcard (client_uuid)
	get_url ()
	register_sequencer (is_output)
	register_sequencer_with_params (is_output, param_strv, param_value)
	register_soundcard (is_output)
	register_soundcard_with_params (is_output, param_strv, param_value)
	set_ports (port, port_count)
	set_sequencer (client_uuid, sequencer)
	set_soundcard (client_uuid, soundcard)
	set_url (url)
	unregister_sequencer (sequencer)
	unregister_soundcard (soundcard)

Virtual Methods

	do_get_ports (port_count)
	do_get_sequencer (client_uuid)
	do_get_soundcard (client_uuid)
	do_get_url ()
	do_register_sequencer (is_output)
	do_register_sequencer_with_params (is_output, param_strv, param_value)
	do_register_soundcard (is_output)
	do_register_soundcard_with_params (is_output, param_strv, param_value)
	do_set_ports (ports, port_count)
	do_set_sequencer (client_uuid, sequencer)
	do_set_soundcard (client_uuid, soundcard)
	do_set_url (url)
	do_unregister_sequencer (sequencer)
	do_unregister_soundcard (soundcard)

Properties

None

Signals

None

Fields

None

Class Details

class Ags.SoundServer

Bases:

GObject.GInterface

Structure:

Ags.SoundServerInterface

get_ports(port_count)

Parameters:

port_count (int) – the number of ports returned

Returns:

the port as string None-terminated array

Return type:

int

Gets the ports of self.

New in version 3.0.0.

get_sequencer(client_uuid)

Parameters:

client_uuid (str) – the client uuid

Returns:

the sequencer as GLib.List-struct

Return type:

[GObject.Object]

Gets the sequencer of self associated with client_uuid.

New in version 3.0.0.

get_soundcard(client_uuid)

Parameters:

client_uuid (str) – the client uuid

Returns:

the soundcard as GLib.List-struct

Return type:

[GObject.Object]

Gets the soundcard of self associated with client_uuid.

New in version 3.0.0.

get_url()

Returns:

the URL as string

Return type:

str

Gets the URL of self.

New in version 3.0.0.

register_sequencer(is_output)

Parameters:

is_output (bool) – if True the used as sink, else as source

Returns:

a new Ags.Sequencer

Return type:

GObject.Object

Fetches sequencer of self.

New in version 3.0.0.

register_sequencer_with_params(is_output, param_strv, param_value)

Parameters:

• is_output (bool) – if True the used as sink, else as source

• param_strv (str) – the parameter string vector

• param_value (GObject.Value) – the parameter values

Returns:

a new Ags.Sequencer

Return type:

GObject.Object

Fetches sequencer of self.

New in version 7.3.8.

register_soundcard(is_output)

Parameters:

is_output (bool) – if True the used as sink, else as source

Returns:

a new Ags.Soundcard

Return type:

GObject.Object

Fetches soundcard of self.

New in version 3.0.0.

register_soundcard_with_params(is_output, param_strv, param_value)

Parameters:

• is_output (bool) – if True the used as sink, else as source

• param_strv (str) – the parameter string vector

• param_value (GObject.Value) – the parameter values

Returns:

a new Ags.Soundcard

Return type:

GObject.Object

Fetches soundcard of self.

New in version 7.3.8.

set_ports(port, port_count)

Parameters:

• port (int) –

• port_count (int) –

set_sequencer(client_uuid, sequencer)

Parameters:

• client_uuid (str) – the location to fetch from

• sequencer ([GObject.Object]) – the sequencer to set

Sets the sequencer at client_uuid.

New in version 3.0.0.

set_soundcard(client_uuid, soundcard)

Parameters:

• client_uuid (str) – the location to fetch from

• soundcard ([GObject.Object]) – the soundcard to set

Sets the soundcard at client_uuid.

New in version 3.0.0.

set_url(url)

Parameters:

url (str) – the url to set

Sets the url of self.

New in version 3.0.0.

unregister_sequencer(sequencer)

Parameters:

sequencer (GObject.Object) – the Ags.Sequencer

Releases sequencer in self.

New in version 3.0.0.

unregister_soundcard(soundcard)

Parameters:

soundcard (GObject.Object) – the Ags.Soundcard

Releases soundcard in self.

New in version 3.0.0.

do_get_ports(port_count) virtual

Parameters:

port_count (int) – the number of ports returned

Returns:

the port as string None-terminated array

Return type:

int

Gets the ports of sound_server.

New in version 3.0.0.

do_get_sequencer(client_uuid) virtual

Parameters:

client_uuid (str) – the client uuid

Returns:

the sequencer as GLib.List-struct

Return type:

[GObject.Object]

Gets the sequencer of sound_server associated with client_uuid.

New in version 3.0.0.

do_get_soundcard(client_uuid) virtual

Parameters:

client_uuid (str) – the client uuid

Returns:

the soundcard as GLib.List-struct

Return type:

[GObject.Object]

Gets the soundcard of sound_server associated with client_uuid.

New in version 3.0.0.

do_get_url() virtual

Returns:

the URL as string

Return type:

str

Gets the URL of sound_server.

New in version 3.0.0.

do_register_sequencer(is_output) virtual

Parameters:

is_output (bool) – if True the used as sink, else as source

Returns:

a new Ags.Sequencer

Return type:

GObject.Object

Fetches sequencer of sound_server.

New in version 3.0.0.

do_register_sequencer_with_params(is_output, param_strv, param_value) virtual

Parameters:

• is_output (bool) – if True the used as sink, else as source

• param_strv (str) – the parameter string vector

• param_value (GObject.Value) – the parameter values

Returns:

a new Ags.Sequencer

Return type:

GObject.Object

Fetches sequencer of sound_server.

New in version 7.3.8.

do_register_soundcard(is_output) virtual

Parameters:

is_output (bool) – if True the used as sink, else as source

Returns:

a new Ags.Soundcard

Return type:

GObject.Object

Fetches soundcard of sound_server.

New in version 3.0.0.

do_register_soundcard_with_params(is_output, param_strv, param_value) virtual

Parameters:

• is_output (bool) – if True the used as sink, else as source

• param_strv (str) – the parameter string vector

• param_value (GObject.Value) – the parameter values

Returns:

a new Ags.Soundcard

Return type:

GObject.Object

Fetches soundcard of sound_server.

New in version 7.3.8.

do_set_ports(ports, port_count) virtual

Parameters:

• ports (int) –

• port_count (int) –

do_set_sequencer(client_uuid, sequencer) virtual

Parameters:

• client_uuid (str) – the location to fetch from

• sequencer ([GObject.Object]) – the sequencer to set

Sets the sequencer at client_uuid.

New in version 3.0.0.

do_set_soundcard(client_uuid, soundcard) virtual

Parameters:

• client_uuid (str) – the location to fetch from

• soundcard ([GObject.Object]) – the soundcard to set

Sets the soundcard at client_uuid.

New in version 3.0.0.

do_set_url(url) virtual

Parameters:

url (str) – the url to set

Sets the url of sound_server.

New in version 3.0.0.

do_unregister_sequencer(sequencer) virtual

Parameters:

sequencer (GObject.Object) – the Ags.Sequencer

Releases sequencer in sound_server.

New in version 3.0.0.

do_unregister_soundcard(soundcard) virtual

Parameters:

soundcard (GObject.Object) – the Ags.Soundcard

Releases soundcard in sound_server.

New in version 3.0.0.