AgsPulseServer

AgsPulseServer — pulseaudio instance

Functions

Properties

AgsApplicationContext * application-context Read / Write
AgsPulseClient * default-pulse-client Read / Write
GObject * default-soundcard Read / Write
gpointer pulse-client Read / Write
gchar * url Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsPulseServer

Implemented Interfaces

AgsPulseServer implements AgsConnectable and AgsSoundServer.

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_get_class_mutex ()

pthread_mutex_t *
ags_pulse_server_get_class_mutex ();

Use this function's returned mutex to access mutex fields.

Returns

the class mutex

Since: 2.0.0


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: 2.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: 2.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: 2.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

 

url

the url to find

 

Returns

the GList containing a AgsPulseServer matching url or NULL

Since: 2.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

Since: 2.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

Since: 2.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: 2.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: 2.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: 2.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: 2.1.14


ags_pulse_server_start_poll ()

void
ags_pulse_server_start_poll (AgsPulseServer *pulse_server);

ags_pulse_server_new ()

AgsPulseServer *
ags_pulse_server_new (AgsApplicationContext *application_context,
                      gchar *url);

Create a new instance of AgsPulseServer.

Parameters

application_context

the AgsApplicationContext

 

url

the URL as string

 

Returns

the new AgsPulseServer

Since: 2.0.0


AGS_IS_PULSE_SERVER()

#define AGS_IS_PULSE_SERVER(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_PULSE_SERVER))

AGS_PULSE_SERVER()

#define AGS_PULSE_SERVER(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_PULSE_SERVER, AgsPulseServer))

AGS_PULSE_SERVER_CLASS()

#define AGS_PULSE_SERVER_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST(class, AGS_TYPE_PULSE_SERVER, AgsPulseServer))

AGS_PULSE_SERVER_GET_CLASS()

#define AGS_PULSE_SERVER_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS(obj, AGS_TYPE_PULSE_SERVER, AgsPulseServerClass))

ags_pulse_server_get_type ()

GType
ags_pulse_server_get_type ();

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()

 

AGS_TYPE_PULSE_SERVER

#define AGS_TYPE_PULSE_SERVER                (ags_pulse_server_get_type())

struct AgsPulseServer

struct AgsPulseServer;

struct AgsPulseServerClass

struct AgsPulseServerClass {
  GObjectClass gobject;
};

Property Details

The “application-context” property

  “application-context”      AgsApplicationContext *

The assigned AgsApplicationContext

Flags: Read / Write

Since: 2.0.0


The “default-pulse-client” property

  “default-pulse-client”     AgsPulseClient *

The default pulse client.

Flags: Read / Write

Since: 2.0.0


The “default-soundcard” property

  “default-soundcard”        GObject *

The default soundcard.

Flags: Read / Write

Since: 2.0.0


The “pulse-client” property

  “pulse-client”             gpointer

The pulse client list.

Flags: Read / Write

Since: 2.0.0


The “url” property

  “url”                      gchar *

The assigned URL.

Flags: Read / Write

Default value: NULL

Since: 2.0.0