AgsPulseServer

AgsPulseServer — pulseaudio instance

Stability Level

Stable, unless otherwise indicated

Functions

Types and Values

Includes

#include <ags/audio/pulse/ags_pulse_server.h>

Description

The AgsPulseServer is an object to represent a running pulseaudio instance.

Functions

AGS_PULSE_SERVER_GET_OBJ_MUTEX()

#define AGS_PULSE_SERVER_GET_OBJ_MUTEX(obj) (&(((AgsPulseServer *) obj)->obj_mutex))

ags_pulse_server_test_flags ()

gboolean
ags_pulse_server_test_flags (AgsPulseServer *pulse_server,
                             guint flags);

Test flags to be set on pulse_server .

Parameters

pulse_server

the AgsPulseServer

 

flags

the flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0


ags_pulse_server_set_flags ()

void
ags_pulse_server_set_flags (AgsPulseServer *pulse_server,
                            guint flags);

Enable a feature of pulse_server .

Parameters

pulse_server

the AgsPulseServer

 

flags

see AgsPulseServerFlags

 

Since: 3.0.0


ags_pulse_server_unset_flags ()

void
ags_pulse_server_unset_flags (AgsPulseServer *pulse_server,
                              guint flags);

Disable a feature of pulse_server .

Parameters

pulse_server

the AgsPulseServer

 

flags

see AgsPulseServerFlags

 

Since: 3.0.0


ags_pulse_server_find_url ()

GList *
ags_pulse_server_find_url (GList *pulse_server,
                           gchar *url);

Find AgsPulseServer by url.

Parameters

pulse_server

the GList containing AgsPulseServer.

[element-type AgsAudio.PulseServer][transfer none]

url

the url to find

 

Returns

the GList containing a AgsPulseServer matching url or NULL.

[element-type AgsAudio.PulseServer][transfer none]

Since: 3.0.0


ags_pulse_server_find_client ()

GObject *
ags_pulse_server_find_client (AgsPulseServer *pulse_server,
                              gchar *client_uuid);

Find AgsPulseClient by uuid.

Parameters

pulse_server

the AgsPulseServer

 

client_uuid

the uuid to find

 

Returns

the AgsPulseClient found or NULL.

[transfer none]

Since: 3.0.0


ags_pulse_server_find_port ()

GObject *
ags_pulse_server_find_port (AgsPulseServer *pulse_server,
                            gchar *port_uuid);

Find AgsPulsePort by uuid.

Parameters

pulse_server

the AgsPulseServer

 

port_uuid

the uuid to find

 

Returns

the AgsPulsePort found or NULL.

[transfer none]

Since: 3.0.0


ags_pulse_server_add_client ()

void
ags_pulse_server_add_client (AgsPulseServer *pulse_server,
                             GObject *pulse_client);

Add pulse_client to pulse_server

Parameters

pulse_server

the AgsPulseServer

 

pulse_client

the AgsPulseClient to add

 

Since: 3.0.0


ags_pulse_server_remove_client ()

void
ags_pulse_server_remove_client (AgsPulseServer *pulse_server,
                                GObject *pulse_client);

Remove pulse_client to pulse_server

Parameters

pulse_server

the AgsPulseServer

 

pulse_client

the AgsPulseClient to remove

 

Since: 3.0.0


ags_pulse_server_connect_client ()

void
ags_pulse_server_connect_client (AgsPulseServer *pulse_server);

Connect all clients.

Parameters

pulse_server

the AgsPulseServer

 

Since: 3.0.0


ags_pulse_server_disconnect_client ()

void
ags_pulse_server_disconnect_client (AgsPulseServer *pulse_server);

Disconnect all clients.

Parameters

pulse_server

the AgsPulseServer

 

Since: 3.0.0


ags_pulse_server_start_poll ()

void
ags_pulse_server_start_poll (AgsPulseServer *pulse_server);

ags_pulse_server_new ()

AgsPulseServer *
ags_pulse_server_new (gchar *url);

Create a new instance of AgsPulseServer.

Parameters

url

the URL as string

 

Returns

the new AgsPulseServer

Since: 3.0.0

Types and Values

enum AgsPulseServerFlags

Enum values to control the behavior or indicate internal state of AgsPulseServer by enable/disable as flags.

Members

AGS_PULSE_SERVER_ADDED_TO_REGISTRY

the pulseaudio server was added to registry, see AgsConnectable::add_to_registry()

 

AGS_PULSE_SERVER_CONNECTED

indicates the server was connected by calling AgsConnectable::connect()