AgsPulsePort

AgsPulsePort — pulseaudio resource.

Functions

Properties

gchar * port-name Read / Write
AgsPulseClient * pulse-client Read / Write
AgsPulseDevout * pulse-devout Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsPulsePort

Implemented Interfaces

AgsPulsePort implements AgsConnectable.

Includes

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

Description

The AgsPulsePort represents either a pulseaudio sequencer or soundcard to communicate with.

Functions

ags_pulse_port_find ()

GList *
ags_pulse_port_find (GList *pulse_port,
                     gchar *port_name);

Finds next match of port_name in pulse_port .

Parameters

pulse_port

a GList

 

port_name

the port name to find

 

Returns

a GList or NULL

Since: 1.0.0


ags_pulse_port_register ()

void
ags_pulse_port_register (AgsPulsePort *pulse_port,
                         gchar *port_name,
                         gboolean is_audio,
                         gboolean is_midi,
                         gboolean is_output);

Register a new pulseaudio port and read uuid. Creates a new AgsSequencer or AgsSoundcard object.

Parameters

pulse_port

the AgsPulsePort

 

port_name

the name as string

 

is_audio

if TRUE interpreted as audio port

 

is_midi

if TRUE interpreted as midi port

 

is_output

if TRUE port is acting as output, otherwise as input

 

Since: 1.0.0


ags_pulse_port_unregister ()

void
ags_pulse_port_unregister (AgsPulsePort *pulse_port);

ags_pulse_port_get_fixed_size ()

guint
ags_pulse_port_get_fixed_size (AgsPulsePort *pulse_port);

ags_pulse_port_set_samplerate ()

void
ags_pulse_port_set_samplerate (AgsPulsePort *pulse_port,
                               guint samplerate);

ags_pulse_port_set_pcm_channels ()

void
ags_pulse_port_set_pcm_channels (AgsPulsePort *pulse_port,
                                 guint pcm_channels);

ags_pulse_port_set_buffer_size ()

void
ags_pulse_port_set_buffer_size (AgsPulsePort *pulse_port,
                                guint buffer_size);

ags_pulse_port_set_format ()

void
ags_pulse_port_set_format (AgsPulsePort *pulse_port,
                           guint format);

ags_pulse_port_get_latency ()

guint
ags_pulse_port_get_latency (AgsPulsePort *pulse_port);

Gets latency.

Parameters

pulse_port

the AgsPulsePort

 

Since: 1.0.0


ags_pulse_port_new ()

AgsPulsePort *
ags_pulse_port_new (GObject *pulse_client);

Instantiate a new AgsPulsePort.

Parameters

pulse_client

the AgsPulseClient assigned to

 

Returns

the new AgsPulsePort

Since: 1.0.0


AGS_IS_PULSE_PORT()

#define AGS_IS_PULSE_PORT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_PULSE_PORT))

AGS_PULSE_PORT()

#define AGS_PULSE_PORT(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_PULSE_PORT, AgsPulsePort))

AGS_PULSE_PORT_CLASS()

#define AGS_PULSE_PORT_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST(class, AGS_TYPE_PULSE_PORT, AgsPulsePort))

AGS_PULSE_PORT_GET_CLASS()

#define AGS_PULSE_PORT_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS(obj, AGS_TYPE_PULSE_PORT, AgsPulsePortClass))

ags_pulse_port_get_type ()

GType
ags_pulse_port_get_type ();

Types and Values

enum AgsPulsePortFlags

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

Members

AGS_PULSE_PORT_CONNECTED

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

 

AGS_PULSE_PORT_REGISTERED

the port was registered

 

AGS_PULSE_PORT_IS_AUDIO

the port provides audio data

 

AGS_PULSE_PORT_IS_MIDI

the port provides midi data

 

AGS_PULSE_PORT_IS_OUTPUT

the port does output

 

AGS_PULSE_PORT_IS_INPUT

the port does input

 

AGS_TYPE_PULSE_PORT

#define AGS_TYPE_PULSE_PORT                (ags_pulse_port_get_type())

struct AgsPulsePort

struct AgsPulsePort;

struct AgsPulsePortClass

struct AgsPulsePortClass {
  GObjectClass object;
};

Property Details

The “port-name” property

  “port-name”                gchar *

The pulse soundcard indentifier

Flags: Read / Write

Default value: "hw:0"

Since: 1.0.0


The “pulse-client” property

  “pulse-client”             AgsPulseClient *

The assigned AgsPulseClient.

Flags: Read / Write

Since: 1.0.0


The “pulse-devout” property

  “pulse-devout”             AgsPulseDevout *

The assigned AgsPulseDevout.

Flags: Read / Write

Since: 1.0.0