HinawaSndUnit

HinawaSndUnit — An event listener for ALSA FireWire sound devices

Functions

void hinawa_snd_unit_open ()
void hinawa_snd_unit_lock ()
void hinawa_snd_unit_unlock ()
void hinawa_snd_unit_read_transact ()
void hinawa_snd_unit_write_transact ()
void hinawa_snd_unit_lock_transact ()
void hinawa_snd_unit_listen ()
void hinawa_snd_unit_unlisten ()

Properties

gint card Read
gchar * device Read
guint64 guid Read
gboolean listening Read
gboolean streaming Read
gint type Read

Signals

void lock-status Run Last

Object Hierarchy

    GObject
    ╰── HinawaFwUnit
        ╰── HinawaSndUnit
            ├── HinawaSndDg00x
            ├── HinawaSndDice
            ╰── HinawaSndEfw

Description

This class is an application of ALSA FireWire stack. Any functionality which ALSA drivers in the stack can be available.

Functions

hinawa_snd_unit_open ()

void
hinawa_snd_unit_open (HinawaSndUnit *self,
                      gchar *path,
                      GError **exception);

Open ALSA hwdep character device and check it for FireWire sound devices.

Parameters

self

A HinawaSndUnit

  

path

A full path of a special file for ALSA hwdep character device

  

exception

A GError

  

hinawa_snd_unit_lock ()

void
hinawa_snd_unit_lock (HinawaSndUnit *self,
                      GError **exception);

Disallow ALSA to start kernel-streaming.

Parameters

self

A HinawaSndUnit

  

exception

A GError

  

hinawa_snd_unit_unlock ()

void
hinawa_snd_unit_unlock (HinawaSndUnit *self,
                        GError **exception);

Allow ALSA to start kernel-streaming.

Parameters

self

A HinawaSndUnit

  

exception

A GError

  

hinawa_snd_unit_read_transact ()

void
hinawa_snd_unit_read_transact (HinawaSndUnit *self,
                               guint64 addr,
                               GArray *frame,
                               guint len,
                               GError **exception);

Execute read transaction to the given unit.

Parameters

self

A HinawaSndUnit

  

addr

A destination address of target device

  

frame

a 32bit array.

[element-type guint32][array][out caller-allocates]

len

the bytes to read

  

exception

A GError

  

hinawa_snd_unit_write_transact ()

void
hinawa_snd_unit_write_transact (HinawaSndUnit *self,
                                guint64 addr,
                                GArray *frame,
                                GError **exception);

Execute write transactions to the given unit.

Parameters

self

A HinawaSndUnit

  

addr

A destination address of target device

  

frame

a 32bit array.

[element-type guint32][array][in]

exception

A GError

  

hinawa_snd_unit_lock_transact ()

void
hinawa_snd_unit_lock_transact (HinawaSndUnit *self,
                               guint64 addr,
                               GArray **frame,
                               GError **exception);

Execute lock transaction to the given unit.

Parameters

self

A HinawaSndUnit

  

addr

A destination address of target device

  

frame

a 32bit array.

[element-type guint32][array][inout]

exception

A GError

  

hinawa_snd_unit_listen ()

void
hinawa_snd_unit_listen (HinawaSndUnit *self,
                        GError **exception);

Start listening to events.

Parameters

self

A HinawaSndUnit

  

exception

A GError

  

hinawa_snd_unit_unlisten ()

void
hinawa_snd_unit_unlisten (HinawaSndUnit *self);

Stop listening to events.

Parameters

self

A HinawaSndUnit

  

Types and Values

Property Details

The “card” property

  “card”                     gint

A numerical ID for ALSA sound card.

Flags: Read

Allowed values: >= 0

Default value: 0

The “device” property

  “device”                   gchar *

A name of special file as FireWire unit.

Flags: Read

Default value: NULL

The “guid” property

  “guid”                     guint64

Global unique ID for this firewire unit.

Flags: Read

Default value: 0

The “listening” property

  “listening”                gboolean

Whether this device is under listening.

Flags: Read

Default value: FALSE

The “streaming” property

  “streaming”                gboolean

Whether this device is streaming or not.

Flags: Read

Default value: FALSE

The “type” property

  “type”                     gint

The value of SNDRV_FIREWIRE_TYPE_XXX.

Flags: Read

Allowed values: >= 0

Default value: 0

Signal Details

The “lock-status” signal

void
user_function (HinawaSndUnit *self,
               gboolean       state,
               gpointer       user_data)

When ALSA kernel-streaming status is changed, this ::lock-status signal is generated.

Parameters

self

A HinawaSndUnit

  

state

TRUE when locked, FALSE when unlocked.

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

Generated by GTK-Doc V1.24