AgsPulseClient

AgsPulseClient — pulseaudio connection

Functions

Properties

GObject * device Read / Write
GObject * port Read / Write
AgsPulseServer * pulse-server Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsPulseClient

Implemented Interfaces

AgsPulseClient implements AgsConnectable.

Includes

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

Description

The AgsPulseClient communicates with a pulseaudio instance.

Functions

ags_pulse_client_find_uuid ()

GList *
ags_pulse_client_find_uuid (GList *pulse_client,
                            gchar *client_uuid);

Finds next match of client_uuid in pulse_client .

Parameters

pulse_client

a GList

 

client_uuid

the client uuid to find

 

Returns

a GList or NULL

Since: 1.0.0


ags_pulse_client_find ()

GList *
ags_pulse_client_find (GList *pulse_client,
                       gchar *client_name);

Finds next match of client_name in pulse_client .

Parameters

pulse_client

a GList

 

client_name

the client name to find

 

Returns

a GList or NULL

Since: 1.0.0


ags_pulse_client_open ()

void
ags_pulse_client_open (AgsPulseClient *pulse_client,
                       gchar *client_name);

Open the pulseaudio client's connection and read uuid.

Parameters

pulse_client

the AgsPulseClient

 

client_name

the client's name

 

Since: 1.0.0


ags_pulse_client_add_device ()

void
ags_pulse_client_add_device (AgsPulseClient *pulse_client,
                             GObject *pulse_device);

Add pulse_device to pulse_client .

Parameters

pulse_client

the AgsPulseClient

 

pulse_device

an AgsPulseDevout or AgsPulseMidiin

 

Since: 1.0.0


ags_pulse_client_remove_device ()

void
ags_pulse_client_remove_device (AgsPulseClient *pulse_client,
                                GObject *pulse_device);

Remove pulse_device from pulse_client .

Parameters

pulse_client

the AgsPulseClient

 

pulse_device

an AgsPulseDevout or AgsPulseMidiin

 

Since: 1.0.0


ags_pulse_client_add_port ()

void
ags_pulse_client_add_port (AgsPulseClient *pulse_client,
                           GObject *pulse_port);

Add pulse_port to pulse_client .

Parameters

pulse_client

the AgsPulseClient

 

pulse_port

an AgsPulsePort

 

Since: 1.0.0


ags_pulse_client_remove_port ()

void
ags_pulse_client_remove_port (AgsPulseClient *pulse_client,
                              GObject *pulse_port);

Remove pulse_port from pulse_client .

Parameters

pulse_client

the AgsPulseClient

 

pulse_port

an AgsPulsePort

 

Since: 1.0.0


ags_pulse_client_activate ()

void
ags_pulse_client_activate (AgsPulseClient *pulse_client);

Activate client.

Parameters

pulse_client

the AgsPulseClient

 

Since: 1.0.0


ags_pulse_client_deactivate ()

void
ags_pulse_client_deactivate (AgsPulseClient *pulse_client);

Deactivate client.

Parameters

pulse_client

the AgsPulseClient

 

Since: 1.0.0


ags_pulse_client_new ()

AgsPulseClient *
ags_pulse_client_new (GObject *pulse_server);

Instantiate a new AgsPulseClient.

Parameters

pulse_server

the assigned AgsPulseServer

 

Returns

the new AgsPulseClient

Since: 1.0.0


AGS_IS_PULSE_CLIENT()

#define AGS_IS_PULSE_CLIENT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_PULSE_CLIENT))

AGS_PULSE_CLIENT()

#define AGS_PULSE_CLIENT(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_PULSE_CLIENT, AgsPulseClient))

AGS_PULSE_CLIENT_CLASS()

#define AGS_PULSE_CLIENT_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST(class, AGS_TYPE_PULSE_CLIENT, AgsPulseClient))

AGS_PULSE_CLIENT_GET_CLASS()

#define AGS_PULSE_CLIENT_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS(obj, AGS_TYPE_PULSE_CLIENT, AgsPulseClientClass))

ags_pulse_client_get_type ()

GType
ags_pulse_client_get_type ();

Types and Values

enum AgsPulseClientFlags

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

Members

AGS_PULSE_CLIENT_CONNECTED

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

 

AGS_PULSE_CLIENT_ACTIVATED

the client was activated

 

AGS_PULSE_CLIENT_READY

the client is ready

 

AGS_TYPE_PULSE_CLIENT

#define AGS_TYPE_PULSE_CLIENT                (ags_pulse_client_get_type())

struct AgsPulseClient

struct AgsPulseClient;

struct AgsPulseClientClass

struct AgsPulseClientClass {
  GObjectClass object;
};

Property Details

The “device” property

  “device”                   GObject *

The assigned devices.

Flags: Read / Write

Since: 1.0.0


The “port” property

  “port”                     GObject *

The assigned ports.

Flags: Read / Write

Since: 1.0.0


The “pulse-server” property

  “pulse-server”             AgsPulseServer *

The assigned AgsPulseServer.

Flags: Read / Write

Since: 1.0.0