The also-alsa Reference Manual

3.1.1 also-alsa/also-alsa.asd

Source

also-alsa.asd.

Parent Component

also-alsa (system).

ASDF Systems

also-alsa.

---

3.1.2 also-alsa/package.lisp

Source

also-alsa.asd.

Parent Component

also-alsa (system).

Packages

also-alsa.

---

3.1.3 also-alsa/also-alsa.lisp

Dependency

package.lisp (file).

Source

also-alsa.asd.

Parent Component

also-alsa (system).

Public Interface

• *alsa-warn* (special variable).
• alsa-close (method).
• alsa-element-type (function).
• alsa-get-start-threshold (method).
• alsa-open (function).
• alsa-read (method).
• alsa-reopen (generic function).
• alsa-resume (method).
• alsa-set-start-threshold (method).
• alsa-start (method).
• alsa-wait (method).
• alsa-warn (function).
• alsa-write (method).
• buffer (reader method).
• buffer-size (reader method).
• contents-to-lisp (method).
• direction (reader method).
• drain (method).
• element-type (reader method).
• get-avail-delay (method).
• get-delay (method).
• get-state (method).
• load-alsa (function).
• make-alsa-buffer (function).
• pcm-format (reader method).
• pcm-stream (class).
• ref (method).
• (setf ref) (method).
• with-alsa-device (macro).

Internals

• +epipe+ (constant).
• alsa-open-2 (function).
• channels-count (reader method).
• deref (function).
• device (reader method).
• ensure-success (function).
• handle (reader method).
• params (reader method).
• sample-rate (reader method).
• snd-pcm-avail-delay (function).
• snd-pcm-close (function).
• snd-pcm-delay (function).
• snd-pcm-drain (function).
• snd-pcm-drop (function).
• snd-pcm-hw-params (function).
• snd-pcm-hw-params-any (function).
• snd-pcm-hw-params-free (function).
• snd-pcm-hw-params-get-period-size (function).
• snd-pcm-hw-params-malloc (function).
• snd-pcm-hw-params-set-access (function).
• snd-pcm-hw-params-set-channels (function).
• snd-pcm-hw-params-set-format (function).
• snd-pcm-hw-params-set-rate (function).
• snd-pcm-open (function).
• snd-pcm-prepare (function).
• snd-pcm-readi (function).
• snd-pcm-start (function).
• snd-pcm-state (function).
• snd-pcm-sw-params (function).
• snd-pcm-sw-params-current (function).
• snd-pcm-sw-params-get-start-threshold (function).
• snd-pcm-sw-params-malloc (function).
• snd-pcm-sw-params-set-avail-min (function).
• snd-pcm-sw-params-set-start-threshold (function).
• snd-pcm-wait (function).
• snd-pcm-writei (function).
• snd-strerror (function).
• status (reader method).
• (setf status) (writer method).
• swparams (reader method).
• to-alsa-format (function).
• with-alsa-buffer (macro).

---

3.1.4 also-alsa/also-mixer.lisp

Dependency

also-alsa.lisp (file).

Source

also-alsa.asd.

Parent Component

also-alsa (system).

Public Interface

• access-mixer-element (function).
• close-mixer (function).
• get-mixer-element-capture-db (function).
• get-mixer-element-playback-db (function).
• open-mixer (function).
• set-mixer-element-capture-db (function).
• set-mixer-element-capture-volume (function).
• set-mixer-element-playback-db (function).
• set-mixer-element-playback-volume (function).
• set-mixer-element-volume (function).

Internals

• snd-mixer-attach (function).
• snd-mixer-close (function).
• snd-mixer-find-selem (function).
• snd-mixer-load (function).
• snd-mixer-open (function).
• snd-mixer-selem-get-capture-db (function).
• snd-mixer-selem-get-capture-db-range (function).
• snd-mixer-selem-get-capture-volume-range (function).
• snd-mixer-selem-get-playback-db (function).
• snd-mixer-selem-get-playback-db-range (function).
• snd-mixer-selem-get-playback-volume-range (function).
• snd-mixer-selem-id-set-index (function).
• snd-mixer-selem-id-set-name (function).
• snd-mixer-selem-id-tclass (class).
• snd-mixer-selem-register (function).
• snd-mixer-selem-set-capture-db-all (function).
• snd-mixer-selem-set-capture-volume-all (function).
• snd-mixer-selem-set-playback-db-all (function).
• snd-mixer-selem-set-playback-volume-all (function).
• snd-mixer-wait (function).

---

5.1.1 Special variables

Special Variable: *alsa-warn* ¶

Package

also-alsa.

Source

also-alsa.lisp.

---

5.1.2 Macros

Macro: with-alsa-device ((stream device buffer-size element-type &key direction sample-rate channels-count buffer) &body body) ¶

Package

also-alsa.

Source

also-alsa.lisp.

---

5.1.3 Ordinary functions

Function: access-mixer-element (handle selem-name) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: alsa-element-type (type) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: alsa-open (device buffer-size element-type &key direction sample-rate channels-count buffer) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: alsa-warn (string) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: close-mixer (handle) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: get-mixer-element-capture-db (selem &optional channel) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: get-mixer-element-playback-db (selem &optional channel) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: load-alsa () ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: make-alsa-buffer (&key element-type size channels) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: open-mixer (&optional card) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: set-mixer-element-capture-db (selem db) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: set-mixer-element-capture-volume (selem volume) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: set-mixer-element-playback-db (selem db) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: set-mixer-element-playback-volume (selem volume) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: set-mixer-element-volume (volume &key element direction) ¶

Package

also-alsa.

Source

also-mixer.lisp.

---

5.1.4 Generic functions

Generic Function: alsa-close (pcm) ¶

Package

also-alsa.

Methods

Method: alsa-close ((pcm pcm-stream)) ¶

Source

also-alsa.lisp.

Generic Function: alsa-get-start-threshold (pcm) ¶

Package

also-alsa.

Methods

Method: alsa-get-start-threshold ((pcm pcm-stream)) ¶

Source

also-alsa.lisp.

Generic Function: alsa-read (pcm) ¶

Package

also-alsa.

Methods

Method: alsa-read ((pcm pcm-stream)) ¶

Source

also-alsa.lisp.

Generic Function: alsa-reopen (pcs device buffer-size element-type &key direction sample-rate channels-count) ¶

Reopens the stream. If all parameters are the same, just keeps the exiting one.

Package

also-alsa.

Source

also-alsa.lisp.

Methods

Method: alsa-reopen ((pcs pcm-stream) device buffer-size element-type &key direction sample-rate channels-count) ¶

Generic Function: alsa-resume (pcm) ¶

Package

also-alsa.

Methods

Method: alsa-resume ((pcm pcm-stream)) ¶

Source

also-alsa.lisp.

Generic Function: alsa-set-start-threshold (pcm value) ¶

Package

also-alsa.

Methods

Method: alsa-set-start-threshold ((pcm pcm-stream) value) ¶

Source

also-alsa.lisp.

Generic Function: alsa-start (pcm) ¶

Package

also-alsa.

Methods

Method: alsa-start ((pcm pcm-stream)) ¶

Source

also-alsa.lisp.

Generic Function: alsa-wait (pcm &optional timeout) ¶

Package

also-alsa.

Methods

Method: alsa-wait ((pcm pcm-stream) &optional timeout) ¶

Source

also-alsa.lisp.

Generic Function: alsa-write (pcm) ¶

Package

also-alsa.

Methods

Method: alsa-write ((pcm pcm-stream)) ¶

Source

also-alsa.lisp.

Generic Reader: buffer (object) ¶

Package

also-alsa.

Methods

Reader Method: buffer ((pcm-stream pcm-stream)) ¶

automatically generated reader method

Source

also-alsa.lisp.

Target Slot

buffer.

Generic Reader: buffer-size (object) ¶

Package

also-alsa.

Methods

Reader Method: buffer-size ((pcm-stream pcm-stream)) ¶

automatically generated reader method

Source

also-alsa.lisp.

Target Slot

buffer-size.

Generic Function: contents-to-lisp (pcm) ¶

Package

also-alsa.

Methods

Method: contents-to-lisp ((pcm pcm-stream)) ¶

Source

also-alsa.lisp.

Generic Reader: direction (object) ¶

Package

also-alsa.

Methods

Reader Method: direction ((pcm-stream pcm-stream)) ¶

automatically generated reader method

Source

also-alsa.lisp.

Target Slot

direction.

Generic Function: drain (pcm) ¶

Package

also-alsa.

Methods

Method: drain ((pcm pcm-stream)) ¶

Source

also-alsa.lisp.

Generic Reader: element-type (object) ¶

Package

also-alsa.

Methods

Reader Method: element-type ((pcm-stream pcm-stream)) ¶

automatically generated reader method

Source

also-alsa.lisp.

Target Slot

element-type.

Generic Function: get-avail-delay (pcm) ¶

Package

also-alsa.

Methods

Method: get-avail-delay ((pcm pcm-stream)) ¶

Source

also-alsa.lisp.

Generic Function: get-delay (pcm) ¶

Package

also-alsa.

Methods

Method: get-delay ((pcm pcm-stream)) ¶

Source

also-alsa.lisp.

Generic Function: get-state (pcm) ¶

Package

also-alsa.

Methods

Method: get-state ((pcm pcm-stream)) ¶

Source

also-alsa.lisp.

Generic Reader: pcm-format (object) ¶

Package

also-alsa.

Methods

Reader Method: pcm-format ((pcm-stream pcm-stream)) ¶

automatically generated reader method

Source

also-alsa.lisp.

Target Slot

pcm-format.

Generic Function: ref (pcm position) ¶

Package

also-alsa.

Methods

Method: ref ((pcm pcm-stream) position) ¶

Source

also-alsa.lisp.

Generic Function: (setf ref) (pcm position) ¶

Package

also-alsa.

Methods

Method: (setf ref) ((pcm pcm-stream) position) ¶

Source

also-alsa.lisp.

---

5.1.5 Classes

Class: pcm-stream ¶

Package

also-alsa.

Source

also-alsa.lisp.

Direct methods

• alsa-close.
• alsa-get-start-threshold.
• alsa-read.
• alsa-reopen.
• alsa-resume.
• alsa-set-start-threshold.
• alsa-start.
• alsa-wait.
• alsa-write.
• buffer.
• buffer-size.
• channels-count.
• contents-to-lisp.
• device.
• direction.
• drain.
• element-type.
• get-avail-delay.
• get-delay.
• get-state.
• handle.
• params.
• pcm-format.
• (setf ref).
• ref.
• sample-rate.
• (setf status).
• status.
• swparams.

Direct slots

Slot: handle ¶

Initform

(cffi:foreign-alloc :pointer :initial-contents (list (cffi-sys:null-pointer)))

Readers

handle.

Writers

This slot is read-only.

Slot: device ¶

Initargs

:device

Readers

device.

Writers

This slot is read-only.

Slot: params ¶

Initform

(cffi:foreign-alloc :pointer :initial-contents (list (cffi-sys:null-pointer)))

Readers

params.

Writers

This slot is read-only.

Slot: swparams ¶

Initform

(cffi:foreign-alloc :pointer :initial-contents (list (cffi-sys:null-pointer)))

Readers

swparams.

Writers

This slot is read-only.

Slot: pcm-format ¶

Initform

:snd-pcm-format-s16-le

Initargs

:pcm-format

Readers

pcm-format.

Writers

This slot is read-only.

Slot: buffer ¶

Initargs

:buffer

Readers

buffer.

Writers

This slot is read-only.

Slot: buffer-size ¶

Initargs

:buffer-size

Readers

buffer-size.

Writers

This slot is read-only.

Slot: element-type ¶

Initargs

:element-type

Readers

element-type.

Writers

This slot is read-only.

Slot: sample-rate ¶

Initform

44100

Initargs

:sample-rate

Readers

sample-rate.

Writers

This slot is read-only.

Slot: direction ¶

Initargs

:direction

Readers

direction.

Writers

This slot is read-only.

Slot: channels-count ¶

Initargs

:channels-count

Readers

channels-count.

Writers

This slot is read-only.

Slot: status ¶

Type

(or :initial :open :closed)

Initform

:initial

Readers

status.

Writers

(setf status).

---

5.2.1 Constants

Constant: +epipe+ ¶

Package

also-alsa.

Source

also-alsa.lisp.

---

5.2.2 Macros

Macro: with-alsa-buffer ((buffer pcm &body body)) ¶

Package

also-alsa.

Source

also-alsa.lisp.

---

5.2.3 Ordinary functions

Function: alsa-open-2 (pcs) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: deref (var) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: ensure-success (value) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-mixer-attach (handle card) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-close (handle) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-find-selem (handle sid) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-load (handle) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-open (handle mode) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-selem-get-capture-db (selem channel value) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-selem-get-capture-db-range (selem min max) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-selem-get-capture-volume-range (selem min max) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-selem-get-playback-db (selem channel value) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-selem-get-playback-db-range (selem min max) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-selem-get-playback-volume-range (selem min max) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-selem-id-set-index (sid val) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-selem-id-set-name (sid val) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-selem-register (handle options classp) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-selem-set-capture-db-all (selem volume dir) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-selem-set-capture-volume-all (selem volume) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-selem-set-playback-db-all (selem volume dir) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-selem-set-playback-volume-all (selem volume) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-mixer-wait (handle timeout) ¶

Package

also-alsa.

Source

also-mixer.lisp.

Function: snd-pcm-avail-delay (pcm availp delayp) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-close (pcm) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-delay (pcm delayp) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-drain (pcm) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-drop (pcm) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-hw-params (pcm params) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-hw-params-any (pcm params) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-hw-params-free (params) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-hw-params-get-period-size (pcm valp dir) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-hw-params-malloc (dptr) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-hw-params-set-access (pcm params access) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-hw-params-set-channels (pcm params val) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-hw-params-set-format (pcm params format) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-hw-params-set-rate (pcm params val dir) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-open (pcm name stream mode) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-prepare (pcm) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-readi (pcm buffer size) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-start (pcm) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-state (pcm) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-sw-params (pcm swparams) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-sw-params-current (pcm swparams) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-sw-params-get-start-threshold (pcm swparams pval) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-sw-params-malloc (dptr) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-sw-params-set-avail-min (pcm swparams val) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-sw-params-set-start-threshold (pcm swparams val) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-wait (pcm timeout) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-pcm-writei (pcm buffer size) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: snd-strerror (val) ¶

Package

also-alsa.

Source

also-alsa.lisp.

Function: to-alsa-format (element-type) ¶

Package

also-alsa.

Source

also-alsa.lisp.

---

5.2.4 Generic functions

Generic Reader: channels-count (object) ¶

Package

also-alsa.

Methods

Reader Method: channels-count ((pcm-stream pcm-stream)) ¶

automatically generated reader method

Source

also-alsa.lisp.

Target Slot

channels-count.

Generic Reader: device (object) ¶

Package

also-alsa.

Methods

Reader Method: device ((pcm-stream pcm-stream)) ¶

automatically generated reader method

Source

also-alsa.lisp.

Target Slot

device.

Generic Reader: handle (object) ¶

Package

also-alsa.

Methods

Reader Method: handle ((pcm-stream pcm-stream)) ¶

automatically generated reader method

Source

also-alsa.lisp.

Target Slot

handle.

Generic Reader: params (object) ¶

Package

also-alsa.

Methods

Reader Method: params ((pcm-stream pcm-stream)) ¶

automatically generated reader method

Source

also-alsa.lisp.

Target Slot

params.

Generic Reader: sample-rate (object) ¶

Package

also-alsa.

Methods

Reader Method: sample-rate ((pcm-stream pcm-stream)) ¶

automatically generated reader method

Source

also-alsa.lisp.

Target Slot

sample-rate.

Generic Reader: status (object) ¶

Package

also-alsa.

Methods

Reader Method: status ((pcm-stream pcm-stream)) ¶

automatically generated reader method

Source

also-alsa.lisp.

Target Slot

status.

Generic Writer: (setf status) (object) ¶

Package

also-alsa.

Methods

Writer Method: (setf status) ((pcm-stream pcm-stream)) ¶

automatically generated writer method

Source

also-alsa.lisp.

Target Slot

status.

Generic Reader: swparams (object) ¶

Package

also-alsa.

Methods

Reader Method: swparams ((pcm-stream pcm-stream)) ¶

automatically generated reader method

Source

also-alsa.lisp.

Target Slot

swparams.

---

5.2.5 Classes

Class: snd-mixer-selem-id-tclass ¶

Package

also-alsa.

Source

also-mixer.lisp.

Direct superclasses

• foreign-struct-type.
• translatable-foreign-type.

---