</releaseinfo>
</bookinfo>
+ <chapter id="introduction">
+ <title>Introduction</title>
+ <para>This library is designed for applications to manipulate ALSA
+ sequencer character device and operate its functionality abstracted.
+ as user client, port, and event. ALSASeqUserClient represent the user
+ client. It holds file descriptor and creates GSource for event
+ dispatching by GLib's GMainContext/GMainLoop.</para>
+ </chapter>
+
<chapter id="alsaseq-enumerations">
<title>ALSASeq enumerations</title>
<xi:include href="xml/alsaseq-enum-types.xml"/>
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "addr.h"
+/**
+ * SECTION: addr
+ * @Title: ALSASeqAddr
+ * @Short_description: A boxed object to represent address in ALSA Sequencer.
+ *
+ * A #ALSASeqAddr is a boxed object to represent address in ALSA Sequencer. The
+ * address consists of two parts; the numerical ID of client and port.
+ *
+ * The object wraps 'struct snd_seq_addr' in UAPI of Linux sound subsystem.
+ */
ALSASeqAddr *seq_addr_copy(const ALSASeqAddr *self)
{
return g_memdup(self, sizeof(*self));
#include <errno.h>
+/**
+ * SECTION: client-info
+ * @Title: ALSASeqClientInfo
+ * @Short_description: A GObject-derived object to represent information of
+ * client.
+ *
+ * A #ALSASeqClientInfo is a GObject-derived object to represent information of
+ * client. The call of alsaseq_get_client_info() returns the instance of object.
+ * The call of alsaseq_user_client_set_info() and alsaseq_user_client_get_info()
+ * require the instance of object.
+ *
+ * The object wraps 'struct snd_seq_client_info' in UAPI of Linux sound subsystem.
+ */
struct _ALSASeqClientInfoPrivate {
struct snd_seq_client_info info;
};
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "privates.h"
+/**
+ * SECTION: client-pool
+ * @Title: ALSASeqClientPool
+ * @Short_description: A GObject-derived object to represent information of
+ * pool owned by client.
+ *
+ * A #ALSASeqClientPool is a GObject-derived object to represent information of
+ * pool owned by client. The call of alsaseq_get_client_pool() returns the
+ * instance of object. The call of alsaseq_user_client_set_pool() and
+ * alsaseq_user_client_get_pool() require the instance of object.
+ *
+ * The object wraps 'struct snd_seq_client_pool' in UAPI of Linux sound subsystem.
+ */
struct _ALSASeqClientPoolPrivate {
struct snd_seq_client_pool pool;
};
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "event-data-connect.h"
+/**
+ * SECTION: event-data-connect
+ * @Title: ALSASeqEventDataConnect
+ * @Short_description: A boxed object to represent data of connect event
+ *
+ * A #ALSASeqEventDataConnect is a boxed object to represent data of connect
+ * event. The instance of object is one of data properties in
+ * #ALSASeqEventFixed.
+ *
+ * The object wraps 'struct snd_seq_connect' in UAPI of Linux sound subsystem.
+ */
ALSASeqEventDataConnect *seq_event_data_connect_copy(const ALSASeqEventDataConnect *self)
{
return g_memdup(self, sizeof(*self));
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "event-data-ctl.h"
+/**
+ * SECTION: event-data-ctl
+ * @Title: ALSASeqEventDataCtl
+ * @Short_description: A boxed object to represent data of control event
+ *
+ * A #ALSASeqEventDataCtl is a boxed object to represent data of control
+ * event. The instance of object is one of data properties in
+ * #ALSASeqEventFixed.
+ *
+ * The object wraps 'struct snd_seq_ev_ctrl' in UAPI of Linux sound subsystem.
+ */
ALSASeqEventDataCtl *seq_event_data_ctl_copy(const ALSASeqEventDataCtl *self)
{
return g_memdup(self, sizeof(*self));
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "event-data-note.h"
+/**
+ * SECTION: event-data-note
+ * @Title: ALSASeqEventDataNote
+ * @Short_description: A boxed object to represent data of note event
+ *
+ * A #ALSASeqEventDataNote is a boxed object to represent data of note event.
+ * The instance of object is one of data properties in #ALSASeqEventFixed.
+ *
+ * The object wraps 'struct snd_seq_ev_note' in UAPI of Linux sound subsystem.
+ */
ALSASeqEventDataNote *seq_event_data_note_copy(const ALSASeqEventDataNote *self)
{
return g_memdup(self, sizeof(*self));
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "event-data-queue.h"
+/**
+ * SECTION: event-data-queue
+ * @Title: ALSASeqEventDataQueue
+ * @Short_description: A boxed object to represent data of queue event
+ *
+ * A #ALSASeqEventDataQueue is a boxed object to represent data of queue event.
+ * The instance of object is one of data properties in #ALSASeqEventFixed.
+ *
+ * The object wraps 'struct snd_seq_ev_queue_control' in UAPI of Linux sound
+ * subsystem.
+ */
ALSASeqEventDataQueue *seq_event_data_queue_copy(const ALSASeqEventDataQueue *self)
{
return g_memdup(self, sizeof(*self));
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "event-data-result.h"
+/**
+ * SECTION: event-data-result
+ * @Title: ALSASeqEventDataResult
+ * @Short_description: A boxed object to represent data of result event
+ *
+ * A #ALSASeqEventDataResult is a boxed object to represent data of result
+ * event. The instance of object is one of data properties in
+ * #ALSASeqEventFixed.
+ *
+ * The object wraps 'struct snd_seq_result' in UAPI of Linux sound subsystem.
+ */
ALSASeqEventDataResult *seq_event_data_result_copy(const ALSASeqEventDataResult *self)
{
return g_memdup(self, sizeof(*self));
#include <errno.h>
+/**
+ * SECTION: event-fixed
+ * @Title: ALSASeqEventFixed
+ * @Short_description: A GObject-derived object to represent event with the
+ * various kind of fixed-size data.
+ *
+ * A #ALSASeqEventFixed is a GObject-derived object to represent event with the
+ * various kind of fixed-size data. The object has several properties to access
+ * to the data. The object inherits properties and methods from #ALSASeqEvent.
+ */
G_DEFINE_TYPE(ALSASeqEventFixed, alsaseq_event_fixed, ALSASEQ_TYPE_EVENT)
enum seq_event_fixed_prop_type {
#include <errno.h>
+/**
+ * SECTION: event-variable
+ * @Title: ALSASeqEventVariable
+ * @Short_description: A GObject-derived object to represent event with the
+ * various kind of variable-size data.
+ *
+ * A #ALSASeqEventVariable is a GObject-derived object to represent event with
+ * the various kind of variable-size data. The object has accessor methods for
+ * the variable-size data.
+ * The object inherits properties and methods from #ALSASeqEvent.
+ */
struct _ALSASeqEventVariablePrivate {
void *data;
};
#include <errno.h>
+/**
+ * SECTION: event
+ * @Title: ALSASeqEvent
+ * @Short_description: A GObject-derived abstract object to represent any event
+ *
+ * A #ALSASeqEvent is a GObject-derived abstract object to represent common
+ * properties and method for any event. Applications can use derived object;
+ * #ALSASeqEventFixed and #ALSASeqEventVariable.
+ *
+ * The object wraps 'struct snd_seq_event' in UAPI of Linux sound subsystem.
+ */
struct _ALSASeqEventPrivate {
struct snd_seq_event ev;
};
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "privates.h"
+/**
+ * SECTION: port-info
+ * @Title: ALSASeqPortInfo
+ * @Short_description: A GObject-derived object to represent information of port
+ *
+ * A #ALSASeqPortInfo is a GObject-derived object to represent information of
+ * port. The call of alsaseq_get_port_info() returns the instance of object.
+ * The call of alsaseq_user_client_create_port() and
+ * alsaseq_user_client_update_port() requires the instance of object.
+ *
+ * The object wraps 'struct snd_port_info' in UAPI of Linux sound subsystem.
+ */
struct _ALSASeqPortInfoPrivate {
struct snd_seq_port_info info;
};
#include <libudev.h>
+/**
+ * SECTION: query
+ * @Title: Global functions in ALSASeq
+ * @Short_description: Global functions available without holding any file
+ * descriptor
+ */
+
// For error handling.
G_DEFINE_QUARK("alsaseq-error", alsaseq_error)
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "privates.h"
+/**
+ * SECTION: queue-info
+ * @Title: ALSASeqQueueInfo
+ * @Short_description: A GObject-derived object to represent information of
+ * queue
+ *
+ * A #ALSASeqQueueInfo is a GObject-derived object to represent information of
+ * queue. The call of alsaseq_get_queue_info_by_id() and
+ * alsaseq_get_queue_info_by_name() returns the instance of object. The call of
+ * alsaseq_user_client_create_queue() and alsaseq_user_client_update_queue()
+ * requires the instance of object.
+ *
+ * The object wraps 'struct snd_seq_queue_info' in UAPI of Linux sound subsystem.
+ */
struct _ALSASeqQueueInfoPrivate {
struct snd_seq_queue_info info;
};
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "privates.h"
+/**
+ * SECTION: queue-status
+ * @Title: ALSASeqQueueStatus
+ * @Short_description: A GObject-derived object to represent status of queue
+ *
+ * A #ALSASeqQueueStatus is a GObject-derived object to represent status of
+ * queue. The call of alsaseq_get_queue_status() returns the instance of object.
+ *
+ * The object wraps 'struct snd_seq_queue_status' in UAPI of Linux sound
+ * subsystem.
+ */
struct _ALSASeqQueueStatusPrivate {
struct snd_seq_queue_status status;
};
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "privates.h"
+/**
+ * SECTION: queue-tempo
+ * @Title: ALSASeqQueueTempo
+ * @Short_description: A GObject-derived object to represent tempo of queue
+ *
+ * A #ALSASeqQueueTempo is a GObject-derived object to represent tempo of queue.
+ * The call of alsaseq_get_queue_status() returns the instance of object.
+ *
+ * The object wraps 'struct snd_seq_queue_tempo' in UAPI of Linux sound subsystem.
+ */
struct _ALSASeqQueueTempoPrivate {
struct snd_seq_queue_tempo tempo;
};
#include "queue-timer-alsa.h"
#include "privates.h"
+/**
+ * SECTION: queue-timer-alsa
+ * @Title: ALSASeqQueueTimerAlsa
+ * @Short_description: A GObject-derived object to represent timer instance for
+ * queue
+ *
+ * A #ALSASeqQueueTimerAlsa is a GObject-derived object to represent timer
+ * instance for queue. The instance belongs to ALSA timer functionality and is
+ * pointed by the identifier as property of the object. The object inherits
+ * properties and methods from #ALSASeqQueueTimer.
+ */
G_DEFINE_TYPE(ALSASeqQueueTimerAlsa, alsaseq_queue_timer_alsa, ALSASEQ_TYPE_QUEUE_TIMER)
enum seq_queue_timer_alsa_prop_type {
#include <sound/asequencer.h>
+/**
+ * SECTION: queue-timer
+ * @Title: ALSASeqQueueTimer
+ * @Short_description: A GObject-derived abstract object to represent timer for
+ * queue
+ *
+ * A #ALSASeqQueueTimer is a GObject-derived abstract object to represent common
+ * properties and methods of timer for queue. Applications can use derived
+ * object; ALSASeqQueueTimerAlsa.
+ *
+ * The object wraps 'struct snd_seq_queue_timer' in UAPI of Linux sound subsystem.
+ */
struct _ALSASeqQueueTimerPrivate {
struct snd_seq_queue_timer timer;
};
#include <errno.h>
+/**
+ * SECTION: remove-filter
+ * @Title: ALSASeqRemoveFilter
+ * @Short_description: A boxed object to represent filter to remove scheduled
+ * event in queue
+ *
+ * A #ALSASeqRemoveFilter is a boxed object to represent filter to remove
+ * scheduled event in queue. The call of alsaseq_user_client_remove_events()
+ * requires the instance of object. In the object, data shares the same storage,
+ * thus it's not possible to use several purposes.
+ *
+ * The object wraps 'struct snd_seq_remove_events' in UAPI of Linux sound
+ * subsystem.
+ */
ALSASeqRemoveFilter *seq_remove_filter_copy(const ALSASeqRemoveFilter *self)
{
return g_memdup(self, sizeof(*self));
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "privates.h"
+/**
+ * SECTION: subscribe-data
+ * @Title: ALSASeqSubscribeData
+ * @Short_description: A GObject-derived object to represent data for
+ * subscription between ports.
+ *
+ * A #ALSASeqSubscribeData is a GObject-derived object to represent data for
+ * subscription between a pair of ports. The call of
+ * alsaseq_get_subscription_list() returns the list of data. The call of
+ * alsaseq_user_client_operate_subscription() requires the instance of object.
+ *
+ * The object wraps 'struct snd_seq_port_subscribe' in UAPI of Linux sound
+ * subsystem.
+ */
struct _ALSASeqSubscribeDataPrivate {
struct snd_seq_port_subscribe data;
};
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "privates.h"
+/**
+ * SECTION: system-info
+ * @Title: ALSASeqSystemInfo
+ * @Short_description: A GObject-derived object to represent information of
+ * ALSA Sequencer
+ *
+ * A #ALSASeqSystemInfo is a GObject-derived object to represent information of
+ * ALSA Sequencer. The call of alsaseq_get_system_info() returns the instance of
+ * object.
+ *
+ * The object wraps 'struct snd_seq_system_info' in UAPI of Linux sound subsystem.
+ */
struct _ALSASeqSystemInfoPrivate {
struct snd_seq_system_info info;
};
// SPDX-License-Identifier: LGPL-3.0-or-later
#include "tstamp.h"
+/**
+ * SECTION: tstamp
+ * @Title: ALSASeqTstamp
+ * @Short_description: A boxed object to represent timestamp
+ *
+ * A #ALSASeqTstamp is a boxed object to represent timestamp. The object shares
+ * storage for two types of time; tick time and real time.
+ *
+ * The object wraps 'struct snd_seq_timestamp' in UAPI of Linux sound subsystem.
+ */
ALSASeqTstamp *seq_tstamp_copy(const ALSASeqTstamp *self)
{
return g_memdup(self, sizeof(*self));
#include <sys/ioctl.h>
#include <errno.h>
+/**
+ * SECTION: user-client
+ * @Title: ALSASeqUserClient
+ * @Short_description: A GObject-derived object to represent user client
+ *
+ * A #ALSASeqUserClient is a GObject-derived object to represent user client.
+ * Any port can be added to the client as destination or source for any event.
+ *
+ * When the call of alsaseq_user_client_open(), the object maintain file
+ * descriptor till object destruction. The call of
+ * alsaseq_user_client_create_source() returns the instance of GSource. Once
+ * attached to the GSource, GMainContext/GMainLoop is available as event
+ * dispatcher. The #handle-event GObject signal is emitted in the event
+ * dispatcher to notify the event. The call of
+ * alsaseq_user_client_schedule_event() schedules event with given parameters.
+ */
struct _ALSASeqUserClientPrivate {
int fd;
int client_id;
git://git.alsa-project.org / alsa-gobject.git / commitdiff