The cl-soloud Reference Manual

This is the cl-soloud Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:43:45 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-soloud

Bindings to SoLoud, a multi-platform, multi-backend, minimal dependencies sound mixing and output library

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://Shirakumo.github.io/cl-soloud/

Source Control

(GIT https://github.com/Shirakumo/cl-soloud.git)

Bug Tracker

https://github.com/Shirakumo/cl-soloud/issues

License

zlib

Version

1.0.0

Dependencies
  • alexandria (system).
  • cffi (system).
  • trivial-features (system).
  • trivial-garbage (system).
  • trivial-indent (system).
  • documentation-utils (system).
  • cl-mpg123 (system).
Source

cl-soloud.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 cl-soloud/cl-soloud.asd

Source

cl-soloud.asd.

Parent Component

cl-soloud (system).

ASDF Systems

cl-soloud.


3.1.2 cl-soloud/package.lisp

Source

cl-soloud.asd.

Parent Component

cl-soloud (system).

Packages

3.1.3 cl-soloud/low-level.lisp

Dependency

package.lisp (file).

Source

cl-soloud.asd.

Parent Component

cl-soloud (system).

Public Interface
Internals

3.1.4 cl-soloud/toolkit.lisp

Dependency

low-level.lisp (file).

Source

cl-soloud.asd.

Parent Component

cl-soloud (system).

Public Interface
Internals

3.1.5 cl-soloud/filter.lisp

Dependency

toolkit.lisp (file).

Source

cl-soloud.asd.

Parent Component

cl-soloud (system).

Public Interface
Internals

3.1.6 cl-soloud/source.lisp

Dependency

filter.lisp (file).

Source

cl-soloud.asd.

Parent Component

cl-soloud (system).

Public Interface
Internals

3.1.7 cl-soloud/soloud.lisp

Dependency

source.lisp (file).

Source

cl-soloud.asd.

Parent Component

cl-soloud (system).

Public Interface
Internals

3.1.8 cl-soloud/bus.lisp

Dependency

soloud.lisp (file).

Source

cl-soloud.asd.

Parent Component

cl-soloud (system).

Public Interface
Internals

3.1.9 cl-soloud/mp3.lisp

Dependency

bus.lisp (file).

Source

cl-soloud.asd.

Parent Component

cl-soloud (system).

Public Interface
Internals

3.1.10 cl-soloud/documentation.lisp

Dependency

mp3.lisp (file).

Source

cl-soloud.asd.

Parent Component

cl-soloud (system).


4 Packages

Packages are listed by definition order.


4.1 cl-soloud

Source

package.lisp.

Nickname

org.shirakumo.fraf.soloud

Use List
  • cffi.
  • common-lisp.
Public Interface
Internals

4.2 cl-soloud-cffi

Source

package.lisp.

Nickname

org.shirakumo.fraf.soloud.cffi

Use List
  • cffi.
  • common-lisp.
Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Special variables

Special Variable: *max-filters*
Package

cl-soloud-cffi.

Source

low-level.lisp.

Special Variable: *max-sources*
Package

cl-soloud-cffi.

Source

low-level.lisp.

Special Variable: *static*
Package

cl-soloud-cffi.

Source

low-level.lisp.


5.1.2 Ordinary functions

Function: add-voice-to-group (soloud voice-group-handle voice-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: attenuate-audio-attenuator (audio-attenuator distance min max rolloff)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: bus-calc-fft (bus)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: bus-play (bus sound)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: bus-play* (bus sound volume pan paused)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: bus-play-3d (bus sound x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: bus-play-3d* (bus sound x y z vx vy vz volume paused)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: bus-play-3d-clocked (bus sound-time sound x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: bus-play-3d-clocked* (bus sound-time sound x y z vx vy vz volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: bus-play-clocked (bus sound-time sound)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: bus-play-clocked* (bus sound-time sound volume pan)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: calc-fft (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-bass-boost-filter ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-biquad-resonant-filter ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-bus ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-dc-removal-filter ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-echo-filter ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-fft-filter ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-flanger-filter ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-lofi-filter ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-monotone ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-openmpt ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-prg ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-sfxr ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-speech ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-ted-sid ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-virtual-audio-attenuator ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-virtual-audio-collider ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-virtual-audio-source ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-virtual-filter ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-voice-group (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-wav ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: create-wav-stream ()
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: deinit (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-audio-attenuator (audio-attenuator)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-bass-boost-filter (bass-boost-filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-biquad-resonant-filter (biquad-resonant-filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-bus (bus)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-dc-removal-filter (dc-removal-filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-echo-filter (echo-filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-fft-filter (fft-filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-flanger-filter (flanger-filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-lofi-filter (lofi-filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-monotone (monotone)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-openmpt (openmpt)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-prg (prg)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-sfxr (sfxr)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-speech (speech)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-ted-sid (ted-sid)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-virtual-audio-attenuator (virtual-audio-attenuator)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-virtual-audio-collider (virtual-audio-collider)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-virtual-audio-source (virtual-audio-source)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-virtual-filter (virtual-filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-voice-group (soloud voice-group-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-wav (wav)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: destroy-wav-stream (wav-stream)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: fade-filter-parameter (soloud voice-handle filter-id attribute-id to time)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: fade-global-volume (soloud to time)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: fade-pan (soloud voice-handle to time)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: fade-relative-play-speed (soloud voice-handle to time)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: fade-volume (soloud voice-handle to time)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-3d-sound-speed (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-active-voice-count (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-attenuation-model (instance)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-attenuation-rolloff (instance)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-audio-attenuator (instance)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-audio-collider (instance)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-channel-volume (instance channel)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-collider-data (instance)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-doppler-factor (instance)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-doppler-value (instance)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-flags (instance)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-handle (instance)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-max-distance (instance)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-min-distance (instance)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-position (instance x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-velocity (instance x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-audio-source-instance-3d-data-volume (instance)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-backend-buffer-size (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-backend-channels (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-backend-id (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-backend-sample-rate (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-backend-string (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-bus-wave (bus)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-error-string (soloud error-code)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-filter-parameter (soloud voice-handle filter-id attribute-id)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-global-volume (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-info (soloud voice-handle info-key)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-loop-count (soloud voice-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-looping (soloud voice-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-max-active-voice-count (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-overall-volume (soloud voice-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-pan (soloud voice-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-pause (soloud voice-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-post-clip-scaler (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-protect-voice (soloud voice-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-relative-play-speed (soloud voice-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-sample-rate (soloud voice-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-stream-time (soloud voice-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-version (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-virtual-audio-source-base-samplerate (virtual-audio-source)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-virtual-audio-source-channels (virtual-audio-source)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-virtual-audio-source-flags (virtual-audio-source)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-voice-count (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-volume (soloud voice-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-wav-length (wav)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-wav-stream-length (wav)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: get-wave (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: init (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: init* (soloud flags backend sample-rate buffer-size channels)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: is-valid-voice-handle (soloud voice-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: is-voice-group (soloud voice-group-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: is-voice-group-empty (soloud voice-group-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-monotone (monotone filename)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-monotone-file (monotone file)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-monotone-mem (monotone mem length)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-monotone-mem* (monotone mem length copy take-ownership)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-openmpt (openmpt filename)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-openmpt-file (openmpt file)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-openmpt-mem (openmpt mem length)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-openmpt-mem* (openmpt mem length copy take-ownership)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-sfxr-params (sfxr filename)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-sfxr-params-file (sfxr file)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-sfxr-params-mem (sfxr mem length)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-sfxr-params-mem* (sfxr mem length copy take-ownership)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-sfxr-preset (sfxr preset-no seed)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-ted-sid (ted-sid filename)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-ted-sid-file (ted-sid file)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-ted-sid-file-to-mem (ted-sid file)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-ted-sid-mem (ted-sid mem length)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-ted-sid-mem* (ted-sid mem length copy take-ownership)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-ted-sid-to-mem (ted-sid filename)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-wav (wav filename)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-wav-file (wav file)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-wav-mem (wav mem length)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-wav-mem* (wav mem length copy take-ownership)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-wav-stream (wav-stream filename)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-wav-stream-file (wav-stream file)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-wav-stream-mem (wav-stream mem length)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-wav-stream-mem* (wav-stream mem length copy take-ownership)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: load-wav-stream-to-mem (wav-stream filename)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: mix (soloud buffer samples)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: mix-signed-16 (soloud buffer samples)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: oscillate-filter-parameter (soloud voice-handle filter-id attribute-id from to time)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: oscillate-global-volume (soloud from to time)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: oscillate-pan (soloud voice-handle from to time)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: oscillate-relative-play-speed (soloud voice-handle from to time)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: oscillate-volume (soloud voice-handle from to time)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: play (soloud sound)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: play* (soloud sound volume pan paused bus)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: play-3d (soloud sound x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: play-3d* (soloud sound x y z vx vy vz volume paused bus)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: play-3d-clocked (soloud sound-time sound x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: play-3d-clocked* (soloud sound-time sound x y z vx vy vz volume paused bus)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: play-clocked (soloud sound-time sound)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: play-clocked* (soloud sound-time sound volume pan paused bus)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: prg-random (prg)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: prg-srandom (prg seed)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: schedule-pause (soloud voice-handle time)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: schedule-stop (soloud voice-handle time)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: seek (soloud voice-handle seconds)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-listener-at (soloud x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-listener-parameters (soloud x y z x-at y-at z-at x-up y-up z-up)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-listener-parameters* (soloud x y z x-at y-at z-at x-up y-up z-up vx vy vz)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-listener-position (soloud x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-listener-up (soloud x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-listener-velocity (soloud x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-sound-speed (soloud speed)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-source-attenuation (soloud voice-handle attenuation-model attenuation-rolloff-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-source-doppler-factor (soloud voice-handle doppler-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-source-min-max-distance (soloud voice-handle min max)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-source-parameters (soloud voice-handle x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-source-parameters* (soloud voice-handle x y z vx vy vz)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-source-position (soloud voice-handle x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-3d-source-velocity (soloud voice-handle x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bass-boost-filter-params (bass-boost-filter boost)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-biquad-resonant-filter-params (biquad-resonant-filter type sample-rate frequency resonance)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-3d-attenuation (bus attenuation-model attenuation-rolloff-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-3d-attenuator (bus audio-attenuator)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-3d-collider (bus audio-collider)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-3d-collider* (bus audio-collider user-data)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-3d-distance-delay (bus distance-delay)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-3d-doppler-factor (bus doppler-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-3d-listener-relative (bus listener-relative)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-3d-min-max-distance (bus min max)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-3d-processing (bus do-3d-processing)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-channels (bus channels)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-filter (bus filter-id filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-inaudible-behavior (bus must-tick kill)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-looping (bus looping)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-visualization (bus enable)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-bus-volume (bus volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-dc-removal-filter-params (dc-removal-filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-dc-removal-filter-params* (dc-removal-filter length)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-delay-samples (soloud voice-handle samples)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-echo-filter-params (echo-filter delay)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-echo-filter-params* (echo-filter delay decay filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-filter-parameter (soloud voice-handle filter-id attribute-id value)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-flanger-filter-params (flanger-filter delay freq)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-global-filter (soloud filter-id filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-global-volume (soloud volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-inaudible-behavior (soloud voice-handle must-tick kill)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-lofi-filter-params (lofi-filter sample-rate bit-depth)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-looping (soloud voice-handle looping)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-max-active-voice-count (soloud voice-count)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-3d-attenuation (monotone attenuation-model attenuation-rolloff-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-3d-attenuator (monotone audio-attenuator)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-3d-collider (monotone audio-collider)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-3d-collider* (monotone audio-collider user-data)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-3d-distance-delay (monotone distance-delay)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-3d-doppler-factor (monotone doppler-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-3d-listener-relative (monotone listener-relative)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-3d-min-max-distance (monotone min max)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-3d-processing (monotone do-3d-processing)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-filter (monotone filter-id filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-inaudible-behavior (monotone must-tick kill)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-looping (monotone looping)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-params (monotone hardware-channels)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-params* (monotone hardware-channels wave-form)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-monotone-volume (monotone volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-openmpt-3d-attenuation (openmpt attenuation-model attenuation-rolloff-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-openmpt-3d-attenuator (openmpt audio-attenuator)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-openmpt-3d-collider (openmpt audio-collider)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-openmpt-3d-collider* (openmpt audio-collider user-data)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-openmpt-3d-distance-delay (openmpt distance-delay)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-openmpt-3d-doppler-factor (openmpt doppler-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-openmpt-3d-listener-relative (openmpt listener-relative)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-openmpt-3d-min-max-distance (openmpt min max)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-openmpt-3d-processing (openmpt do-3d-processing)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-openmpt-filter (openmpt filter-id filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-openmpt-inaudible-behavior (openmpt must-tick kill)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-openmpt-looping (openmpt looping)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-openmpt-volume (openmpt volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-pan (soloud voice-handle pan)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-pan-absolute (soloud voice-handle left-volume right-volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-pan-absolute* (soloud voice-handle front-left-volume front-right-volume back-left-volume back-right-volume center-volume subwoofer-volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-pause (soloud voice-handle pause)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-pause-all (soloud pause)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-post-clip-scaler (soloud scaler)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-protect-voice (soloud voice-handle protect)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-relative-play-speed (soloud voice-handle speed)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sample-rate (soloud voice-handle sample-rate)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sfxr-3d-attenuation (sfxr attenuation-model attenuation-rolloff-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sfxr-3d-attenuator (sfxr audio-attenuator)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sfxr-3d-collider (sfxr audio-collider)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sfxr-3d-collider* (sfxr audio-collider user-data)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sfxr-3d-distance-delay (sfxr distance-delay)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sfxr-3d-doppler-factor (sfxr doppler-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sfxr-3d-listener-relative (sfxr listener-relative)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sfxr-3d-min-max-distance (sfxr min max)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sfxr-3d-processing (sfxr do-3d-processing)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sfxr-filter (sfxr filter-id filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sfxr-inaudible-behavior (sfxr must-tick kill)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sfxr-looping (sfxr looping)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-sfxr-volume (sfxr volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speaker-position (soloud channel x y z)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-3d-attenuation (speech attenuation-model attenuation-rolloff-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-3d-attenuator (speech audio-attenuator)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-3d-collider (speech audio-collider)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-3d-collider* (speech audio-collider user-data)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-3d-distance-delay (speech distance-delay)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-3d-doppler-factor (speech doppler-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-3d-listener-relative (speech listener-relative)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-3d-min-max-distance (speech min max)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-3d-processing (speech do-3d-processing)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-filter (speech filter-id filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-inaudible-behavior (speech must-tick kill)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-looping (speech looping)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-text (speech text)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-speech-volume (speech volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-ted-sid-3d-attenuation (ted-sid attenuation-model attenuation-rolloff-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-ted-sid-3d-attenuator (ted-sid audio-attenuator)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-ted-sid-3d-collider (ted-sid audio-collider)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-ted-sid-3d-collider* (ted-sid audio-collider user-data)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-ted-sid-3d-distance-delay (ted-sid distance-delay)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-ted-sid-3d-doppler-factor (ted-sid doppler-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-ted-sid-3d-listener-relative (ted-sid listener-relative)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-ted-sid-3d-min-max-distance (ted-sid min max)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-ted-sid-3d-processing (ted-sid do-3d-processing)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-ted-sid-filter (ted-sid filter-id filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-ted-sid-inaudible-behavior (ted-sid must-tick kill)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-ted-sid-looping (ted-sid looping)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-ted-sid-volume (ted-sid volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-attenuator-attenuate (function)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-collider-collide (function)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-3d-attenuation (virtual-audio-source attenuation-model attenuation-rolloff-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-3d-attenuator (virtual-audio-source audio-attenuator)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-3d-collider (virtual-audio-source audio-collider)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-3d-collider* (virtual-audio-source audio-collider user-data)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-3d-distance-delay (virtual-audio-source distance-delay)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-3d-doppler-factor (virtual-audio-source doppler-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-3d-listener-relative (virtual-audio-source listener-relative)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-3d-min-max-distance (virtual-audio-source min max)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-3d-processing (virtual-audio-source do-3d-processing)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-base-samplerate (virtual-audio-source samplerate)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-channels (virtual-audio-source channels)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-filter (virtual-audio-source filter-id filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-flags (virtual-audio-source flags)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-get-audio (function)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-get-info (function)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-has-ended (function)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-inaudible-behavior (virtual-audio-source must-tick kill)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-looping (virtual-audio-source looping)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-rewind (function)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-seek (function)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-audio-source-volume (virtual-audio-source volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-filter-filter (function)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-virtual-filter-filter-channel (function)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-visualization (soloud enable)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-volume (soloud voice-handle volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-3d-attenuation (wav attenuation-model attenuation-rolloff-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-3d-attenuator (wav audio-attenuator)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-3d-collider (wav audio-collider)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-3d-collider* (wav audio-collider user-data)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-3d-distance-delay (wav distance-delay)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-3d-doppler-factor (wav doppler-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-3d-listener-relative (wav listener-relative)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-3d-min-max-distance (wav min max)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-3d-processing (wav do-3d-processing)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-filter (wav filter-id filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-inaudible-behavior (wav must-tick kill)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-looping (wav looping)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-stream-3d-attenuation (wav-stream attenuation-model attenuation-rolloff-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-stream-3d-attenuator (wav-stream audio-attenuator)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-stream-3d-collider (wav-stream audio-collider)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-stream-3d-collider* (wav-stream audio-collider user-data)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-stream-3d-distance-delay (wav-stream distance-delay)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-stream-3d-doppler-factor (wav-stream doppler-factor)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-stream-3d-listener-relative (wav-stream listener-relative)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-stream-3d-min-max-distance (wav-stream min max)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-stream-3d-processing (wav-stream do-3d-processing)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-stream-filter (wav-stream filter-id filter)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-stream-inaudible-behavior (wav-stream must-tick kill)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-stream-looping (wav-stream looping)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-stream-volume (wav-stream volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: set-wav-volume (wav volume)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: stop (soloud voice-handle)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: stop-all (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: stop-audio-source (soloud source)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: stop-bus (bus)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: stop-monotone (monotone)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: stop-openmpt (openmpt)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: stop-sfxr (sfxr)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: stop-speech (speech)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: stop-ted-sid (ted-sid)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: stop-virtual-audio-source (virtual-audio-source)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: stop-wav (wav)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: stop-wav-stream (wav-stream)
Package

cl-soloud-cffi.

Source

low-level.lisp.

Function: update-3d-audio (soloud)
Package

cl-soloud-cffi.

Source

low-level.lisp.


5.1.3 Generic functions

Generic Function: 3d-processed-p (source)

Accessor to whether the source is processed as a 3d audio source.

See SOURCE

Package

cl-soloud.

Source

source.lisp.

Generic Function: (setf 3d-processed-p) (wav)
Package

cl-soloud.

Methods
Method: (setf 3d-processed-p) ((bus bus))
Source

bus.lisp.

Method: (setf 3d-processed-p) ((virtual-audio-source virtual-source))
Source

source.lisp.

Method: (setf 3d-processed-p) ((ted-sid ted-sid-source))
Source

source.lisp.

Method: (setf 3d-processed-p) ((monotone monotone-source))
Source

source.lisp.

Method: (setf 3d-processed-p) ((sfxr sfxr-source))
Source

source.lisp.

Method: (setf 3d-processed-p) ((speech speech-source))
Source

source.lisp.

Method: (setf 3d-processed-p) ((wav-stream wav-stream-source))
Source

source.lisp.

Method: (setf 3d-processed-p) ((wav wav-source))
Source

source.lisp.

Generic Function: active-playback-count (soloud)

Returns the current number of active playbacks.

See MAX-ACTIVE-PLAYBACK-COUNT
See PLAYBACK-COUNT
See SOLOUD

Package

cl-soloud.

Methods
Method: active-playback-count ((soloud soloud))
Source

soloud.lisp.

Generic Function: add (filter source)

Add the object to another object.

For groups that’s a playback, for sources that’s a filter.

See GROUP
See SOURCE

Package

cl-soloud.

Methods
Method: add ((playback playback) (group group))
Source

soloud.lisp.

Method: add ((filter filter) (source source))
Source

source.lisp.

Generic Function: attenuate (attenuator distance min-distance max-distance rolloff-factor)

Method called to compute the attenuation.

The return value is expected to be in the [0,1 range, and gives the general volume level.

The custom attenuators are called while processing the 3d audio in the update3dAudio() call, before any panning is calculated.

Note that calling any SoLoud functions (even to set the position of a 3d audio source) from the attenuate function will most likely cause the application - or at least the audio thread - to freeze due to mutex locks.

See VIRTUAL-ATTENUATOR

Package

cl-soloud.

Source

source.lisp.

Generic Function: attenuation (3d-data)

Accessor to the attenuation model and rolloff factor of the source.

See PLAYBACK
See SOURCE
See 3D-DATA

Package

cl-soloud.

Methods
Method: attenuation ((3d-data 3d-data))
Source

source.lisp.

Generic Function: (setf attenuation) (wav)
Package

cl-soloud.

Methods
Method: (setf attenuation) ((bus bus))
Source

bus.lisp.

Method: (setf attenuation) ((playback playback))
Source

soloud.lisp.

Method: (setf attenuation) ((virtual-audio-source virtual-source))
Source

source.lisp.

Method: (setf attenuation) ((ted-sid ted-sid-source))
Source

source.lisp.

Method: (setf attenuation) ((monotone monotone-source))
Source

source.lisp.

Method: (setf attenuation) ((sfxr sfxr-source))
Source

source.lisp.

Method: (setf attenuation) ((speech speech-source))
Source

source.lisp.

Method: (setf attenuation) ((wav-stream wav-stream-source))
Source

source.lisp.

Method: (setf attenuation) ((wav wav-source))
Source

source.lisp.

Generic Function: attenuator (3d-data)

Accessor to the custom audio attenuator instance.

SoLoud expects the attenuator to be there until all instances of the sound have stopped. The application is responsible for cleaning up the attenuator. Several sound sources may use the same attenuator.

See SOURCE
See ATTENUATOR

Package

cl-soloud.

Methods
Method: attenuator ((3d-data 3d-data))
Source

source.lisp.

Generic Function: (setf attenuator) (wav)
Package

cl-soloud.

Methods
Method: (setf attenuator) ((bus bus))
Source

bus.lisp.

Method: (setf attenuator) ((virtual-audio-source virtual-source))
Source

source.lisp.

Method: (setf attenuator) ((ted-sid ted-sid-source))
Source

source.lisp.

Method: (setf attenuator) ((monotone monotone-source))
Source

source.lisp.

Method: (setf attenuator) ((sfxr sfxr-source))
Source

source.lisp.

Method: (setf attenuator) ((speech speech-source))
Source

source.lisp.

Method: (setf attenuator) ((wav-stream wav-stream-source))
Source

source.lisp.

Method: (setf attenuator) ((wav wav-source))
Source

source.lisp.

Generic Function: backend (soloud)

Read out information about SoLoud’s audio backend.

Returns five values:
- The backend’s keyword ID
- The backend’s name as a string
- The number of channels of the backend
- The sample rate of the backend
- The internal buffer size of the backend

See SOLOUD

Package

cl-soloud.

Methods
Method: backend ((soloud soloud))
Source

soloud.lisp.

Generic Function: base-samplerate (virtual-source)

Accessor to the base samplerate used for this virtual source.

The samples requested by GET-AUDIO should be in this rate.

See VIRTUAL-SOURCE
See GET-AUDIO

Package

cl-soloud.

Methods
Method: base-samplerate ((virtual-source virtual-source))
Source

source.lisp.

Generic Function: (setf base-samplerate) (virtual-source)
Package

cl-soloud.

Methods
Method: (setf base-samplerate) ((virtual-source virtual-source))
Source

source.lisp.

Generic Function: channel-location (soloud channel)

Accessor to the location of a channel in 3d space.

The vector is a list of three floats.
The channel must be a valid channel id.

See SOLOUD

Package

cl-soloud.

Source

soloud.lisp.

Generic Function: (setf channel-location) (soloud channel)
Package

cl-soloud.

Methods
Method: (setf channel-location) ((soloud soloud) channel)
Source

soloud.lisp.

Generic Function: channels (virtual-source)

Accessor to the number of channels used for this virtual source.

The samples requested by GET-AUDIO should respect this value.

See VIRTUAL-SOURCE
See GET-AUDIO

Package

cl-soloud.

Methods
Method: channels ((virtual-source virtual-source))
Source

source.lisp.

Generic Function: (setf channels) (virtual-source)
Package

cl-soloud.

Methods
Method: (setf channels) ((virtual-source virtual-source))
Source

source.lisp.

Generic Function: collide (collider soloud 3d-data user-data)

Method called to compute the collision.

The return value is expected to be in the [0,1] range, and gives the general volume level. The Soloud object and 3D-data instance are given for convenience. Additionally, when setting the collider, the application may also set a user data integer value which is also provided to the custom collider through this call.

The custom colliders are called while processing the 3d audio in the update3dAudio() call, before any panning or attenuation is calculated. Thus, if the COLLIDE function adjusts the audio instance’s 3d position, the changes will take effect.

For example, if a river collider was to be created, the collider would check the player’s distance to the river, and adjust the sound source’s 3d position to the point closest to the player so that if the player runs along the river, the sound would be heard from the direction of the river (instead of, for instance, from just the middle of the river).

Note that calling any SoLoud functions (even to set the position of a 3d audio source) from the collide function will most likely cause the application - or at least the audio thread - to freeze due to mutex locks.

See VIRTUAL-COLLIDER

Package

cl-soloud.

Source

source.lisp.

Generic Function: collider (3d-data)

Accessor to the custom audio collider instance.

SoLoud expects the collider to be there until all instances of the sound have stopped. The application is responsible for cleaning up the collider. Several sound sources may use the same collider.

See SOURCE
See COLLIDER

Package

cl-soloud.

Methods
Method: collider ((3d-data 3d-data))
Source

source.lisp.

Generic Function: (setf collider) (wav)
Package

cl-soloud.

Methods
Method: (setf collider) ((bus bus))
Source

bus.lisp.

Method: (setf collider) ((virtual-audio-source virtual-source))
Source

source.lisp.

Method: (setf collider) ((ted-sid ted-sid-source))
Source

source.lisp.

Method: (setf collider) ((monotone monotone-source))
Source

source.lisp.

Method: (setf collider) ((sfxr sfxr-source))
Source

source.lisp.

Method: (setf collider) ((speech speech-source))
Source

source.lisp.

Method: (setf collider) ((wav-stream wav-stream-source))
Source

source.lisp.

Method: (setf collider) ((wav wav-source))
Source

source.lisp.

Generic Function: direction (object)

Accessor to the direction in which the listener faces in 3d space.

See SOLOUD

Package

cl-soloud.

Source

soloud.lisp.

Generic Function: (setf direction) (soloud)
Package

cl-soloud.

Methods
Method: (setf direction) ((soloud soloud))
Source

soloud.lisp.

Generic Function: distance-delayed-p (source)

Accessor to whether the sound’s playback will be delayed by its distance.

Since speed of sound is way slower than speed of light, in
reality we might see an explosion before we hear it. Default
is disabled, as this may be seen as a glitch since most games
do not bother simulating this.

See SOURCE

Package

cl-soloud.

Source

source.lisp.

Generic Function: (setf distance-delayed-p) (wav)
Package

cl-soloud.

Methods
Method: (setf distance-delayed-p) ((bus bus))
Source

bus.lisp.

Method: (setf distance-delayed-p) ((virtual-audio-source virtual-source))
Source

source.lisp.

Method: (setf distance-delayed-p) ((ted-sid ted-sid-source))
Source

source.lisp.

Method: (setf distance-delayed-p) ((monotone monotone-source))
Source

source.lisp.

Method: (setf distance-delayed-p) ((sfxr sfxr-source))
Source

source.lisp.

Method: (setf distance-delayed-p) ((speech speech-source))
Source

source.lisp.

Method: (setf distance-delayed-p) ((wav-stream wav-stream-source))
Source

source.lisp.

Method: (setf distance-delayed-p) ((wav wav-source))
Source

source.lisp.

Generic Function: doppler-factor (3d-data)

Accessor to the doppler factor of the source.

See PLAYBACK
See SOURCE
See 3D-DATA

Package

cl-soloud.

Methods
Method: doppler-factor ((3d-data 3d-data))
Source

source.lisp.

Generic Function: (setf doppler-factor) (wav)
Package

cl-soloud.

Methods
Method: (setf doppler-factor) ((bus bus))
Source

bus.lisp.

Method: (setf doppler-factor) ((playback playback))
Source

soloud.lisp.

Method: (setf doppler-factor) ((virtual-audio-source virtual-source))
Source

source.lisp.

Method: (setf doppler-factor) ((ted-sid ted-sid-source))
Source

source.lisp.

Method: (setf doppler-factor) ((monotone monotone-source))
Source

source.lisp.

Method: (setf doppler-factor) ((sfxr sfxr-source))
Source

source.lisp.

Method: (setf doppler-factor) ((speech speech-source))
Source

source.lisp.

Method: (setf doppler-factor) ((wav-stream wav-stream-source))
Source

source.lisp.

Method: (setf doppler-factor) ((wav wav-source))
Source

source.lisp.

Generic Function: filter (filter buffer samples channels samplerate time)

Accessor to add or remove a filter to the source.

See FILTER
See SOURCE

Package

cl-soloud.

Source

filter.lisp.

Methods
Method: filter ((filter virtual-filter) buffer samples channels samplerate time)
Generic Function: (setf filter) (wav id)
Package

cl-soloud.

Methods
Method: (setf filter) ((bus bus) id)
Source

bus.lisp.

Method: (setf filter) ((bus bus) id)
Source

bus.lisp.

Method: (setf filter) ((virtual-audio-source virtual-source) id)
Source

source.lisp.

Method: (setf filter) ((virtual-audio-source virtual-source) id)
Source

source.lisp.

Method: (setf filter) ((ted-sid ted-sid-source) id)
Source

source.lisp.

Method: (setf filter) ((ted-sid ted-sid-source) id)
Source

source.lisp.

Method: (setf filter) ((monotone monotone-source) id)
Source

source.lisp.

Method: (setf filter) ((monotone monotone-source) id)
Source

source.lisp.

Method: (setf filter) ((sfxr sfxr-source) id)
Source

source.lisp.

Method: (setf filter) ((sfxr sfxr-source) id)
Source

source.lisp.

Method: (setf filter) ((speech speech-source) id)
Source

source.lisp.

Method: (setf filter) ((speech speech-source) id)
Source

source.lisp.

Method: (setf filter) ((wav-stream wav-stream-source) id)
Source

source.lisp.

Method: (setf filter) ((wav-stream wav-stream-source) id)
Source

source.lisp.

Method: (setf filter) ((wav wav-source) id)
Source

source.lisp.

Method: (setf filter) ((wav wav-source) id)
Source

source.lisp.

Generic Function: filter-channel (filter buffer channel samples channels samplerate time)

Most filters are simpler to write on a channel-by-channel basis, so that they only deal with mono samples.

In this case, you may want to use this function instead. The
default implementation of FILTER calls this for every channel
in the source.

See VIRTUAL-FILTER
See FILTER

Package

cl-soloud.

Source

filter.lisp.

Generic Function: filter-parameter (playback filter attribute)

Accessor to a parameter of the filter.

See PLAYBACK
See FILTER

Package

cl-soloud.

Methods
Method: filter-parameter ((playback playback) filter attribute)
Source

soloud.lisp.

Generic Function: (setf filter-parameter) (playback filter attribute)
Package

cl-soloud.

Methods
Method: (setf filter-parameter) ((playback playback) filter attribute)
Source

soloud.lisp.

Generic Function: flags (virtual-source)

Accessor to the list of active flags for the source.

See VIRTUAL-SOURCE

Package

cl-soloud.

Methods
Method: flags ((3d-data 3d-data))
Source

source.lisp.

Method: flags ((virtual-source virtual-source))
Source

source.lisp.

Generic Function: (setf flags) (virtual-source)
Package

cl-soloud.

Methods
Method: (setf flags) ((virtual-source virtual-source))
Source

source.lisp.

Generic Function: free (object)

Explicitly and immediately frees the C object that this instance tracks.

See C-BACKED-OBJECT

Package

cl-soloud.

Methods
Method: free ((object c-backed-object))
Source

toolkit.lisp.

Generic Function: get-audio (audio-source buffer samples)

This method is called to generate audio from a source.

SoLoud requests samples from the sound instance using this function. If the instance generates more than one channel (i.e, stereo sound), the expected sample data first has the first channel samples, then second channel samples, etc.

So, for stereo this is: L{samples}R{samples}

The getAudio function is also responsible for handling looping, if the audio source supports it. If the audio source runs out of data, the rest of the buffer should be set to zero.

Each sample should be a single-float.

See VIRTUAL-SOURCE

Package

cl-soloud.

Source

source.lisp.

Methods
Method: get-audio ((source mp3-source) dst samples)
Source

mp3.lisp.

Generic Function: get-info (audio-source info-key)

This method is called when information is requested from the source.

This method is optional. You can provide the interface to let the application query real-time information about your audio source. This information may be channel volumes, register values, or some other information of interest.

See VIRTUAL-SOURCE

Package

cl-soloud.

Source

source.lisp.

Methods
Method: get-info ((source mp3-source) info-key)
Source

mp3.lisp.

Generic Reader: handle (object)

Accessor to the pointer to the C object that this instance tracks.

See C-BACKED-OBJECT

Package

cl-soloud.

Methods
Reader Method: handle ((c-backed-object c-backed-object))

automatically generated reader method

Source

toolkit.lisp.

Target Slot

handle.

Generic Writer: (setf handle) (object)
Package

cl-soloud.

Methods
Writer Method: (setf handle) ((c-backed-object c-backed-object))

automatically generated writer method

Source

toolkit.lisp.

Target Slot

handle.

Generic Function: has-ended (audio-source)

This method is called to determine if the source has ended.

After mixing, SoLoud asks all audio instances whether they have ended, and if they have, it will free the object and free the channel. Supporting looping will likely affect the implementation of this function.

See VIRTUAL-SOURCE

Package

cl-soloud.

Source

source.lisp.

Methods
Method: has-ended ((source mp3-source))
Source

mp3.lisp.

Generic Function: inaudible-behavior (source)

Accessor to the inaudible behaviour of the playback.

A list of two values:
- Whether the source should be ticked even when inaudible - Whether the source should be killed once inaudible

Package

cl-soloud.

Methods
Method: inaudible-behavior ((source virtual-source))
Source

source.lisp.

Generic Function: (setf inaudible-behavior) (wav)
Package

cl-soloud.

Methods
Method: (setf inaudible-behavior) ((bus bus))
Source

bus.lisp.

Method: (setf inaudible-behavior) ((playback playback))
Source

soloud.lisp.

Method: (setf inaudible-behavior) ((virtual-audio-source virtual-source))
Source

source.lisp.

Method: (setf inaudible-behavior) ((ted-sid ted-sid-source))
Source

source.lisp.

Method: (setf inaudible-behavior) ((monotone monotone-source))
Source

source.lisp.

Method: (setf inaudible-behavior) ((sfxr sfxr-source))
Source

source.lisp.

Method: (setf inaudible-behavior) ((speech speech-source))
Source

source.lisp.

Method: (setf inaudible-behavior) ((wav-stream wav-stream-source))
Source

source.lisp.

Method: (setf inaudible-behavior) ((wav wav-source))
Source

source.lisp.

Generic Function: inaudible-kill-p (virtual-source)

Accessor to whether this audio source should be killed when it is inaudible.

See FLAGS
See VIRTUAL-AUDIO-SOURCE
See INAUDIBLE-BEHAVIOR

Package

cl-soloud.

Methods
Method: inaudible-kill-p ((virtual-source virtual-source))
Source

source.lisp.

Generic Function: (setf inaudible-kill-p) (virtual-source)
Package

cl-soloud.

Methods
Method: (setf inaudible-kill-p) ((virtual-source virtual-source))
Source

source.lisp.

Generic Function: inaudible-tick-p (virtual-source)

Accessor to whether this audio source should still be ticked while inaudible.

See FLAGS
See VIRTUAL-AUDIO-SOURCE
See INAUDIBLE-BEHAVIOR

Package

cl-soloud.

Methods
Method: inaudible-tick-p ((virtual-source virtual-source))
Source

source.lisp.

Generic Function: (setf inaudible-tick-p) (virtual-source)
Package

cl-soloud.

Methods
Method: (setf inaudible-tick-p) ((virtual-source virtual-source))
Source

source.lisp.

Generic Function: listener-relative-p (source)

Accessor to whether the source is relative to the listener or not.

If a sound is listener-relative, the listener’s coordinates are assumed to be (0 0 0) in calculations.

See SOURCE

Package

cl-soloud.

Source

source.lisp.

Generic Function: (setf listener-relative-p) (wav)
Package

cl-soloud.

Methods
Method: (setf listener-relative-p) ((bus bus))
Source

bus.lisp.

Method: (setf listener-relative-p) ((virtual-audio-source virtual-source))
Source

source.lisp.

Method: (setf listener-relative-p) ((ted-sid ted-sid-source))
Source

source.lisp.

Method: (setf listener-relative-p) ((monotone monotone-source))
Source

source.lisp.

Method: (setf listener-relative-p) ((sfxr sfxr-source))
Source

source.lisp.

Method: (setf listener-relative-p) ((speech speech-source))
Source

source.lisp.

Method: (setf listener-relative-p) ((wav-stream wav-stream-source))
Source

source.lisp.

Method: (setf listener-relative-p) ((wav wav-source))
Source

source.lisp.

Generic Function: load-file (source file)

Load the audio source’s contents from a file on disk.

See WAV-SOURCE
See WAV-STREAM-SOURCE
See SFXR-SOURCE
See MONOTONE-SOURCE
See TED-SID-SOURCE
See MP3-SOURCE

Package

cl-soloud.

Methods
Method: load-file ((source mp3-source) file)
Source

mp3.lisp.

Method: load-file ((source ted-sid-source) file)
Source

source.lisp.

Method: load-file ((source monotone-source) file)
Source

source.lisp.

Method: load-file ((source sfxr-source) file)
Source

source.lisp.

Method: load-file ((source wav-stream-source) file)
Source

source.lisp.

Method: load-file ((source wav-source) file)
Source

source.lisp.

Method: load-file :around ((source source) file)
Source

source.lisp.

Generic Function: load-mem (source pointer length &key copy take-ownership)

Load the audio source’s contents from a memory buffer.

See WAV-SOURCE
See WAV-STREAM-SOURCE
See SFXR-SOURCE
See MONOTONE-SOURCE
See TED-SID-SOURCE

Package

cl-soloud.

Methods
Method: load-mem ((source ted-sid-source) pointer length &key copy take-ownership)
Source

source.lisp.

Method: load-mem ((source monotone-source) pointer length &key copy take-ownership)
Source

source.lisp.

Method: load-mem ((source sfxr-source) pointer length &key copy take-ownership)
Source

source.lisp.

Method: load-mem ((source wav-stream-source) pointer length &key copy take-ownership)
Source

source.lisp.

Method: load-mem ((source wav-source) pointer length &key copy take-ownership)
Source

source.lisp.

Method: load-mem :around ((source source) pointer length &key)
Source

source.lisp.

Generic Function: load-preset (source preset)

Load a preset into the SFXR-Source.

The symbol should be one of:
- :COINT
- :LASER
- :EXPLOSION
- :POWERUP
- :HURT
- :JUMP
- :BLIP

See SFXR-SOURCE

Package

cl-soloud.

Methods
Method: load-preset ((source sfxr-source) (preset symbol))
Source

source.lisp.

Generic Function: load-text (source text)

Load the text into the speech source for playback.

See SPEECH-SOURCE

Package

cl-soloud.

Methods
Method: load-text ((source speech-source) text)
Source

source.lisp.

Generic Function: location (3d-data)

Accessor to the location of the object in 3d space.

For the SOLOUD object, this is the location of the listener. For everything else it’s the location of the audio source.

See SOLOUD
See PLAYBACK
See 3D-DATA

Package

cl-soloud.

Methods
Method: location ((3d-data 3d-data))
Source

source.lisp.

Generic Function: (setf location) (soloud)
Package

cl-soloud.

Methods
Method: (setf location) ((playback playback))
Source

soloud.lisp.

Method: (setf location) ((soloud soloud))
Source

soloud.lisp.

Generic Function: looping-p (playback)

Accessor to whether the playback should loop or not.

See PLAYBACK
See SOURCE

Package

cl-soloud.

Methods
Method: looping-p ((playback playback))
Source

soloud.lisp.

Generic Function: (setf looping-p) (wav)
Package

cl-soloud.

Methods
Method: (setf looping-p) ((bus bus))
Source

bus.lisp.

Method: (setf looping-p) ((playback playback))
Source

soloud.lisp.

Method: (setf looping-p) ((virtual-audio-source virtual-source))
Source

source.lisp.

Method: (setf looping-p) ((ted-sid ted-sid-source))
Source

source.lisp.

Method: (setf looping-p) ((monotone monotone-source))
Source

source.lisp.

Method: (setf looping-p) ((sfxr sfxr-source))
Source

source.lisp.

Method: (setf looping-p) ((speech speech-source))
Source

source.lisp.

Method: (setf looping-p) ((wav-stream wav-stream-source))
Source

source.lisp.

Method: (setf looping-p) ((wav wav-source))
Source

source.lisp.

Generic Function: max-active-playback-count (soloud)

Accessor to the maximum amount of playbacks that can be heard simultaneously.

See ACTIVE-PLAYBACK-COUNT
See SOLOUD

Package

cl-soloud.

Methods
Method: max-active-playback-count ((soloud soloud))
Source

soloud.lisp.

Generic Function: (setf max-active-playback-count) (soloud)
Package

cl-soloud.

Methods
Method: (setf max-active-playback-count) ((soloud soloud))
Source

soloud.lisp.

Generic Function: min-max-distance (3d-data)

Accessor to the minimum and maximum distances for the source to be audible.

See PLAYBACK
See SOURCE
See 3D-DATA

Package

cl-soloud.

Methods
Method: min-max-distance ((3d-data 3d-data))
Source

source.lisp.

Generic Function: (setf min-max-distance) (wav)
Package

cl-soloud.

Methods
Method: (setf min-max-distance) ((bus bus))
Source

bus.lisp.

Method: (setf min-max-distance) ((playback playback))
Source

soloud.lisp.

Method: (setf min-max-distance) ((virtual-audio-source virtual-source))
Source

source.lisp.

Method: (setf min-max-distance) ((ted-sid ted-sid-source))
Source

source.lisp.

Method: (setf min-max-distance) ((monotone monotone-source))
Source

source.lisp.

Method: (setf min-max-distance) ((sfxr sfxr-source))
Source

source.lisp.

Method: (setf min-max-distance) ((speech speech-source))
Source

source.lisp.

Method: (setf min-max-distance) ((wav-stream wav-stream-source))
Source

source.lisp.

Method: (setf min-max-distance) ((wav wav-source))
Source

source.lisp.

Generic Function: oscillate-pan (playback from to time)

Constantly oscillate between the two pans in the given time.

See PLAYBACK

Package

cl-soloud.

Methods
Method: oscillate-pan ((playback playback) from to time)
Source

soloud.lisp.

Generic Function: oscillate-relative-speed (playback from to time)

Constantly oscillate between the two relative speeds in the given time.

See PLAYBACK

Package

cl-soloud.

Methods
Method: oscillate-relative-speed ((playback playback) from to time)
Source

soloud.lisp.

Generic Function: oscillate-volume (soloud from to time)

Constantly oscillate between two volumes in the given time.

See SOLOUD
See PLAYBACK

Package

cl-soloud.

Methods
Method: oscillate-volume ((playback playback) from to time)
Source

soloud.lisp.

Method: oscillate-volume ((soloud soloud) from to time)
Source

soloud.lisp.

Generic Function: pan (playback)

Accessor to the left/right panning of the playback.

The setf method accepts an additional argument, FADE, which will fade the pan to the specified amount in the given time.

See PLAYBACK

Package

cl-soloud.

Methods
Method: pan ((playback playback))
Source

soloud.lisp.

Generic Function: (setf pan) (playback &key fade)
Package

cl-soloud.

Methods
Method: (setf pan) ((playback playback) &key fade)
Source

soloud.lisp.

Generic Function: paused-p (playback)

Accessor to whether the playback is currently paused.

See PLAYBACK

Package

cl-soloud.

Methods
Method: paused-p ((playback playback))
Source

soloud.lisp.

Generic Function: (setf paused-p) (playback)
Package

cl-soloud.

Methods
Method: (setf paused-p) ((playback playback))
Source

soloud.lisp.

Generic Function: play (source target &key volume pan paused delay location velocity bus &allow-other-keys)

Play back an audio source on the target playback bus.

Returned is a PLAYBACK handle that represents
the access to the current playback. Note that SoLoud invalidates some playback handles as soon as the audio source has stopped playing. However, this library cannot know about this and cannot invalidate the handle for you automatically, which means you might end up with an invalid handle.

The bus can be either SOLOUD or BUS.

If DELAY is given, the sound is only played back after the specified amount of time has passed. Without the delay, the source is always played back as soon as possible.

If LOCATION is given, the source is played back at the specified location in 3d space.

If PAUSED is T, the source is started but paused and won’t play back until you unpause it.

See PLAYBACK
See SOLOUD
See BUS
See SOURCE

Package

cl-soloud.

Source

soloud.lisp.

Methods
Method: play ((source source) (bus bus) &key volume pan paused delay location velocity)
Source

bus.lisp.

Method: play :after ((source bus) (target bus) &key)
Source

bus.lisp.

Method: play :after ((source bus) (target soloud) &key)
Source

bus.lisp.

Method: play ((source source) (soloud soloud) &key volume pan paused delay location velocity bus)
Generic Function: playback-count (soloud)

Returns the current total number of playbacks.

See ACTIVE-PLAYBACK-COUNT
See SOLOUD

Package

cl-soloud.

Methods
Method: playback-count ((soloud soloud))
Source

soloud.lisp.

Generic Function: playing (soloud)

Returns true if there is something playing back right now

See SOLOUD
See ACTIVE-PLAYBACK-COUNT

Package

cl-soloud.

Methods
Method: playing ((soloud soloud))
Source

soloud.lisp.

Generic Function: pointer->object (pointer)

Attempts to translate a pointer or pointer address of a C resource to its corresponding lisp object.

See *C-OBJECT-TABLE*
See C-BACKED-OBJECT

Package

cl-soloud.

Methods
Method: pointer->object ((object c-backed-object))
Source

toolkit.lisp.

Method: pointer->object (pointer)
Source

toolkit.lisp.

Method: pointer->object ((pointer integer))
Source

toolkit.lisp.

Generic Function: protected-p (playback)

Accessor to whether the playback is protected or not.

Normally, if you try to play more sounds than there are slots, SoLoud will kill off the oldest playing sound to make room. That sound will most likely be your background music. This can be worked around by protecting the sound.

See PLAYBACK

Package

cl-soloud.

Methods
Method: protected-p ((playback playback))
Source

soloud.lisp.

Generic Function: (setf protected-p) (playback)
Package

cl-soloud.

Methods
Method: (setf protected-p) ((playback playback))
Source

soloud.lisp.

Generic Function: relative-speed (playback)

Accessor to the relative playback speed of the playback.

The setf method accepts an additional argument, FADE, which will fade the speed to the specified amount in the given time.

See PLAYBACK

Package

cl-soloud.

Methods
Method: relative-speed ((playback playback))
Source

soloud.lisp.

Generic Function: (setf relative-speed) (playback &key fade)
Package

cl-soloud.

Methods
Method: (setf relative-speed) ((playback playback) &key fade)
Source

soloud.lisp.

Generic Function: rewind (audio-source)

This method is called when a complete rewind is necessary.

To enable the base implementation of seek to seek backwards from the current play position, sound source may implement the rewind function. In most cases the rewind is easier to implement than actual smart seeking.

See VIRTUAL-SOURCE

Package

cl-soloud.

Source

source.lisp.

Methods
Method: rewind ((source mp3-source))
Source

mp3.lisp.

Generic Function: sample-rate (playback)

Returns the sample rate used by the source or target.

See SOLOUD
See SOURCE

Package

cl-soloud.

Methods
Method: sample-rate ((playback playback))
Source

soloud.lisp.

Generic Function: (setf sample-rate) (playback)
Package

cl-soloud.

Methods
Method: (setf sample-rate) ((playback playback))
Source

soloud.lisp.

Generic Function: seek (playback seconds)

Seek to the specified absolute position in the source.

Note that not all audio sources support seeking, and for those that do this operation is usually rather heavy.

See PLAYBACK

Package

cl-soloud.

Methods
Method: seek ((playback playback) seconds)
Source

soloud.lisp.

Generic Function: seek-to (audio-source time scratch size)

This method is called when a seek request is made.

This method is optional. The base implementation will simply request (and discard) samples from the sound source until the desired position has been reached; for many sound sources, a smarter way exists.

See VIRTUAL-SOURCE

Package

cl-soloud.

Source

source.lisp.

Methods
Method: seek-to ((source mp3-source) time scratch size)
Source

mp3.lisp.

Generic Function: set-absolute-pan (playback &key front-left front-right back-left back-right center subwoofer)

Set the absolute pan of all the possible speakers of the playback.

Currently SoLoud does not support surround sound, so this
does nothing.

See PLAYBACK

Package

cl-soloud.

Methods
Method: set-absolute-pan ((playback playback) &key front-left front-right back-left back-right center subwoofer)
Source

soloud.lisp.

Generic Function: set-parameters (filter &key boost length delay freq sample-rate bit-depth decay filter-type type frequency resonance &allow-other-keys)

Allows you to set the configuration parameters of the filter instance.

See FILTER

Package

cl-soloud.

Source

filter.lisp.

Methods
Method: set-parameters ((filter bass-boost-filter) &key boost)
Method: set-parameters ((filter dc-removal-filter) &key length)
Method: set-parameters ((filter flanger-filter) &key delay freq)
Method: set-parameters ((filter lofi-filter) &key sample-rate bit-depth)
Method: set-parameters ((filter echo-filter) &key delay decay filter-type)
Method: set-parameters ((filter biquad-resonant-filter) &key type sample-rate frequency resonance)
Generic Function: single-instance-p (virtual-source)

Accessor to whether there can only be a single playback instance of the audio source at once.

See FLAGS
See VIRTUAL-AUDIO-SOURCE

Package

cl-soloud.

Methods
Method: single-instance-p ((virtual-source virtual-source))
Source

source.lisp.

Generic Function: (setf single-instance-p) (virtual-source)
Package

cl-soloud.

Methods
Method: (setf single-instance-p) ((virtual-source virtual-source))
Source

source.lisp.

Generic Function: soloud (object)

Returns the base soloud object that this object relates back to.

See BUS
See PLAYBACK

Package

cl-soloud.

Methods
Reader Method: soloud :around ((playback playback))
Source

bus.lisp.

Target Slot

soloud.

Reader Method: soloud :around ((bus bus))
Source

bus.lisp.

Target Slot

soloud.

Method: soloud ((soloud soloud))
Source

bus.lisp.

Method: soloud ((bus bus))

automatically generated reader method

Source

bus.lisp.

Method: soloud ((playback playback))

automatically generated reader method

Source

soloud.lisp.

Generic Writer: (setf soloud) (object)
Package

cl-soloud.

Methods
Writer Method: (setf soloud) ((bus bus))

automatically generated writer method

Source

bus.lisp.

Target Slot

soloud.

Writer Method: (setf soloud) ((playback playback))

automatically generated writer method

Source

soloud.lisp.

Target Slot

soloud.

Generic Function: sound-speed (soloud)

Accessor to the speed of sound in the system.

The speed of sound is used to calculate doppler effects in addition to the distance delay. Since SoLoud has no knowledge of the scale of your coordinates, you may need to adjust the speed of sound for these effects to work correctly. The default value is 343, which assumes that your world coordinates are in meters (where 1 unit is 1 meter), and that the environment is dry air at around 20 degrees Celsius.

See SOLOUD

Package

cl-soloud.

Methods
Method: sound-speed ((soloud soloud))
Source

soloud.lisp.

Generic Function: (setf sound-speed) (soloud)
Package

cl-soloud.

Methods
Method: (setf sound-speed) ((soloud soloud))
Source

soloud.lisp.

Generic Reader: source (object)

Accessor to the playback’s audio source that is being played back.

See PLAYBACK

Package

cl-soloud.

Methods
Reader Method: source ((playback playback))

automatically generated reader method

Source

soloud.lisp.

Target Slot

source.

Generic Writer: (setf source) (object)
Package

cl-soloud.

Methods
Writer Method: (setf source) ((playback playback))

automatically generated writer method

Source

soloud.lisp.

Target Slot

source.

Generic Function: stop (wav)

Stops the playback.

If you pass in the SOLOUD object, playback of all sources will be stopped.

See PLAYBACK
See SOLOUD

Package

cl-soloud.

Methods
Method: stop ((bus bus))
Source

bus.lisp.

Method: stop ((soloud soloud))
Source

soloud.lisp.

Method: stop ((playback playback))
Source

soloud.lisp.

Method: stop ((virtual-audio-source virtual-source))
Source

source.lisp.

Method: stop ((ted-sid ted-sid-source))
Source

source.lisp.

Method: stop ((monotone monotone-source))
Source

source.lisp.

Method: stop ((sfxr sfxr-source))
Source

source.lisp.

Method: stop ((speech speech-source))
Source

source.lisp.

Method: stop ((wav-stream wav-stream-source))
Source

source.lisp.

Method: stop ((wav wav-source))
Source

source.lisp.

Generic Function: up (object)

Accessor to the UP vector for the listener in 3d space.

See SOLOUD

Package

cl-soloud.

Source

soloud.lisp.

Generic Function: (setf up) (soloud)
Package

cl-soloud.

Methods
Method: (setf up) ((soloud soloud))
Source

soloud.lisp.

Generic Function: velocity (3d-data)

Accessor to the velocity of the object in 3d space.

For the SOLOUD object, this is the velocity of the listener. For everything else it’s the velocity of the audio source.

See SOLOUD
See PLAYBACK
See 3D-DATA

Package

cl-soloud.

Methods
Method: velocity ((3d-data 3d-data))
Source

source.lisp.

Generic Function: (setf velocity) (soloud)
Package

cl-soloud.

Methods
Method: (setf velocity) ((playback playback))
Source

soloud.lisp.

Method: (setf velocity) ((soloud soloud))
Source

soloud.lisp.

Generic Function: volume (3d-data)

Accessor to the volume.

The setf method accepts an additional argument, FADE, which will fade the volume to the specified amount in the given time.

See PLAYBACK
See SOLOUD
See SOURCE

Package

cl-soloud.

Methods
Method: volume ((playback playback))
Source

soloud.lisp.

Method: volume ((soloud soloud))
Source

soloud.lisp.

Method: volume ((3d-data 3d-data))
Source

source.lisp.

Generic Function: (setf volume) (wav &key fade)
Package

cl-soloud.

Methods
Method: (setf volume) ((bus bus) &key fade)
Source

bus.lisp.

Method: (setf volume) ((playback playback) &key fade)
Source

soloud.lisp.

Method: (setf volume) ((soloud soloud) &key fade)
Source

soloud.lisp.

Method: (setf volume) ((virtual-audio-source virtual-source) &key fade)
Source

source.lisp.

Method: (setf volume) ((ted-sid ted-sid-source) &key fade)
Source

source.lisp.

Method: (setf volume) ((monotone monotone-source) &key fade)
Source

source.lisp.

Method: (setf volume) ((sfxr sfxr-source) &key fade)
Source

source.lisp.

Method: (setf volume) ((speech speech-source) &key fade)
Source

source.lisp.

Method: (setf volume) ((wav-stream wav-stream-source) &key fade)
Source

source.lisp.

Method: (setf volume) ((wav wav-source) &key fade)
Source

source.lisp.

Generic Function: withdraw (filter source)

Remove the given filter from the source again.

See FILTER
See SOURCE

Package

cl-soloud.

Methods
Method: withdraw ((filter filter) (source source))
Source

source.lisp.


5.1.4 Standalone methods

Method: initialize-instance :after ((group group) &key soloud)
Source

soloud.lisp.

Method: initialize-instance :after ((c-backed-object c-backed-object) &key handle)
Source

toolkit.lisp.

Method: initialize-instance :after ((soloud soloud) &key flags backend sample-rate buffer-size channels max-active-playback-count)
Source

soloud.lisp.


5.1.5 Classes

Class: attenuator

Superclass for all audio attenuators.

See ATTENUATOR
See VIRTUAL-ATTENUATOR

Package

cl-soloud.

Source

source.lisp.

Direct superclasses

c-backed-object.

Direct subclasses

virtual-attenuator.

Class: bass-boost-filter

The bassboost filter is a proof of concept FFT filter.

It simply multiplies the first few bands of the FFT by the boost value.

There is one parameter, BOOST, of how strong the boost effect is.

See FILTER

Package

cl-soloud.

Source

filter.lisp.

Direct superclasses

filter.

Direct methods
Class: biquad-resonant-filter

The biquad resonant filter is a surprisingly cheap way to implement low and high pass filters, as well as some kind of band bass filter.

The implementation in SoLoud is based on
"Using the Biquad Resonant Filter",
Phil Burk, Game Programming Gems 3, p. 606.

The filter has three parameters - sample rate, cutoff frequency
and resonance. These can also be adjusted on live streams, for
instance to fade the low pass filter cutoff frequency for an
outdoors/indoors transition effect.

Currently, four parameters can be adjusted:
WET — Filter’s wet signal; 1.0f for fully filtered,
0.0f for original, 0.5f for half and half.
SAMPLERATE — Filter’s samplerate parameter
FREQUENCY — Filter’s cutoff frequency
RESONANCE — Filter’s resonance - higher means sharper cutoff

See FILTER

Package

cl-soloud.

Source

filter.lisp.

Direct superclasses

filter.

Direct methods
Class: bus

The mixing busses are a special case of an audio stream.

They are a kind of audio stream that plays other audio streams. Mixing bus can also play other mixing busses. Like any other audio stream, mixing bus has volume, panning and filters. Only one instance of a mixing bus can play at the same time, however; trying to play the same bus several times stops the earlier instance.

While a mixing bus doesn’t generate audio by itself, playing it counts against the maximum number of concurrent streams.

Mixing busses are protected by default (i.e, won’t stop playing if maximum number of concurrent streams is reached), and also marked as "must tick" (i.e, will always be present in the active voices list).

See SOURCE
See SOLOUD
See PLAY

Package

cl-soloud.

Source

bus.lisp.

Direct superclasses

source.

Direct methods
Direct slots
Slot: soloud
Readers

soloud.

Writers

(setf soloud).

Class: c-backed-object

Superclass for all objects that track a C-allocated resource.

The class takes care of automatically freeing the resource when an instance is being garbage collected, and allows you to retrieve the object based on a pointer address.

See *C-OBJECT-TABLE*
See HANDLE
See CREATE-HANDLE
See DESTROY-HANDLE
See FREE

Package

cl-soloud.

Source

toolkit.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: handle
Initargs

:handle

Readers

handle.

Writers

(setf handle).

Class: collider

Superclass for all audio colliders.

See COLLIDER
See VIRTUAL-COLLIDER

Package

cl-soloud.

Source

source.lisp.

Direct superclasses

c-backed-object.

Direct subclasses

virtual-collider.

Class: dc-removal-filter

This filter tries to remove DC signal from the audio.

In other words, it tries to center the waveform around 0. This can be useful if some of the input waveforms gets stuck on non-zero values for a long time.

The filter does not support changing of parameters on the fly, nor does it take changing of relative play speed into account.

The DC removal is performed by calculating the average sample value over a relatively long period of time, and subtracting this from the output.

There is one parameter, LENGTH, of how long the averaging buffer should be. The time is in seconds.

See FILTER

Package

cl-soloud.

Source

filter.lisp.

Direct superclasses

filter.

Direct methods
Class: echo-filter

The echo filter in SoLoud is a very simple one.

When the sound starts to play, the echo filter allocates a buffer to contain the echo samples, and loops through this until the sound ends.

The filter does not support changing of parameters on the fly, nor does it take changing of relative play speed into account.

There are two parameters - DELAY and DECAY. Delay is the time in seconds until the echo, and decay is multiplier for the echo. If the multiplier is outside the [0..1[ range, the results are unpredictable.

See FILTER

Package

cl-soloud.

Source

filter.lisp.

Direct superclasses

filter.

Direct methods
Class: fft-filter

The FFT filter is a short-time Fourier transform filter which can be used as basis for FFT-based effects.

The base implementation does a simple tone downshifting.

The filter exists mainly to adjust the speech synthesizer’s
voice in strange ways. It can also be used as basis for other
FFT-based filters.

See FILTER

Package

cl-soloud.

Source

filter.lisp.

Direct superclasses

filter.

Direct methods
Class: filter

Filters can be used to modify the sound some way.

Typical uses for a filter are to create environmental effects, like echo, or to modify the way the speech synthesizer sounds like.

See S-BACKED-OBJECT
See SET-PARAMETERS

Package

cl-soloud.

Source

filter.lisp.

Direct superclasses

c-backed-object.

Direct subclasses
Direct methods
Class: flanger-filter

The flanger filter can be used to create a "flanger" effect on the signal.

Applying this on a human voice may sound more "robotic", for instance.

Currently, four parameters can be adjusted:
WET — Filter’s wet signal; 1.0f for fully filtered,
0.0f for original, 0.5f for half and half.
FREQ — Filter’s frequency
DELAY — Filter’s delay

See FILTER

Package

cl-soloud.

Source

filter.lisp.

Direct superclasses

filter.

Direct methods
Class: group

This class represents a "playback group".

Groups allow you to bundle together multiple playback handles and change their properties all at once, rather than risking updates happening between changes to individual sources.

See PLAYBACK
See ADD

Package

cl-soloud.

Source

soloud.lisp.

Direct superclasses

playback.

Direct methods
Class: lofi-filter

The lofi filter is a signal degrading filter.

You can adjust both the bit depth and the sample rate of the output, and these parameters can also be adjusted (and even faded) on the fly.

The following parameters exist:
WET — Filter’s wet signal; 1.0f for fully filtered, 0.0f for original, 0.5f for half and half. SAMPLERATE — Filter’s samplerate parameter
BITDEPTH — Filter’s bit-depth parameter

See FILTER

Package

cl-soloud.

Source

filter.lisp.

Direct superclasses

filter.

Direct methods
Class: monotone-source

The SoLoud::Monotone is a replayer for MONOTONE tracker songs.

MONOTONE is a pc-speaker tracker, available on GitHub at

https://github.com/MobyGamer/MONOTONE/

The SoLoud MONOTONE replayer can play MONOTONE v1 songs (only format available at the time of this writing). You can pick the number of hardware playbacks used - typically the songs are composed for a single playback (PC beeper).

The waveform used is square wave.

See SOURCE
See LOAD-FILE
See LOAD-MEM

Package

cl-soloud.

Source

source.lisp.

Direct superclasses

source.

Direct methods
Class: mp3-source

This source uses mpg123 to play back an MP3 file.

See VIRTUAL-SOURCE
See LOAD-FILE
See FILE

Package

cl-soloud.

Source

mp3.lisp.

Direct superclasses

virtual-source.

Direct methods
Direct slots
Slot: file
Readers

file.

Writers

(setf file).

Class: playback

A handle representing the playback of an audio source.

See HANDLE
See SOLOUD
See SOURCE
See PLAY
See SEEK
See VOLUME
See PAN
See SET-ABSOLUTE-PAN
See RELATIVE-SPEED
See PAUSED-P
See STOP
See LOOPING-P
See PROTECTED-P
See SAMPLE-RATE
See OSCILLATE-VOLUME
See OSCILLATE-PAN
See OSCILLATE-RELATIVE-SPEED
See LOCATION
See VELOCITY
See MIN-MAX-DISTANCE
See ATTENUATION
See DOPPLER-FACTOR
See FILTER-PARAMETER
See INAUDIBLE-BEHAVIOR

Package

cl-soloud.

Source

soloud.lisp.

Direct subclasses

group.

Direct methods
Direct slots
Slot: handle
Initargs

:handle

Slot: soloud
Initargs

:soloud

Readers

soloud.

Writers

(setf soloud).

Slot: source
Initargs

:source

Readers

source.

Writers

(setf source).

Class: sfxr-source

The SoLoud::Sfxr is a retro sound effect synthesizer based on the original Sfxr by Tomas Pettersson.

The original sfxr tool was designed to easily generate
sound effects for Ludum Dare 48h games. SoLoud includes the
same engine built in, so you can (should you wish) make
every coin, explosion etc. sound different.

The Sfxr sound sources also include a pseudo-random number
generator which should probably be moved to more general use
at some point.

See SOURCE
See LOAD-FILE
See LOAD-MEM
See LOAD-PRESET

Package

cl-soloud.

Source

source.lisp.

Direct superclasses

source.

Direct methods
Class: soloud

This object represents the base instance needed to play audio with the soloud library.

It might be possible, though questionable in reasoning, to
create multiple instances of this at the same time. However,
doing so is not directly supported and probably not a good
idea. Thus, just make sure only to keep a single instance
around.

See C-BACKED-OBJECT
See BACKEND
See CHANNEL-LOCATION
See PLAY
See VOLUME
See STOP
See MAX-ACTIVE-PLAYBACK-COUNT
See ACTIVE-PLAYBACK-COUNT
See PLAYBACK-COUNT
See SAMPLE-RATE
See OSCILLATE-VOLUME
See SOUND-SPEED
See LOCATION
See DIRECTION
See UP
See VELOCITY
See PLAYING

Package

cl-soloud.

Source

soloud.lisp.

Direct superclasses

c-backed-object.

Direct methods
Class: source

Superclass for all audio sources.

Audio sources represent potential playback sources. Most sources can be played back multiple times simultaneously.

Before a source can be played back, it must be loaded. Depending on the source, this can be one of the following load methods:

See LOAD-FILE
See LOAD-MEM
See LOAD-PRESET
See LOAD-TEXT

See FILTER-MAP
See ADD
See WITHDRAW
See VOLUME
See LOOPING-P
See MIN-MAX-DISTANCE
See ATTENUATION
See DOPPLER-FACTOR
See 3D-PROCESSED-P
See LISTENER-RELATIVE-P
See DISTANCE-DELAYED-P
See COLLIDER
See ATTENUATOR
See INAUDIBLE-BEHAVIOR
See FILTER
See STOP

Package

cl-soloud.

Source

source.lisp.

Direct superclasses

c-backed-object.

Direct subclasses
Direct methods
Direct slots
Slot: filter-map
Initform

(make-hash-table :test (quote eql))

Readers

filter-map.

Writers

(setf filter-map).

Class: speech-source

The SoLoud::Speech class implements a simple Klatt-style formant speech synthesizer.

It’s barely legible, not really human-like, but it’s free,
and it’s here.

Adjusting the speech synthesizer’s output with audio filters
should allow for various voices, which, along with subtitles,
will let you add voice to your games cheaply.

For more serious use, feel free to study the source code and
play with the various internal parameters, as well as apply
various filters to the sound.

See SOURCE
See LOAD-TEXT

Package

cl-soloud.

Source

source.lisp.

Direct superclasses

source.

Direct methods
Class: ted-sid-source

The SoLoud::TedSid is a replayer for TED and SID soundchip register write dumps.

This is based on tedplay (c) 2012 Attila Grosz, used under
Unlicense http://unlicense.org/.

TED is the soundchip of the commodore plus/4, and SID is the
soundchip of the commodore 64.

The TED and SID songs are actually complete c64 or plus/4
programs, so in order to avoid running a complete c64 emulator
in an audio engine, we only simulate the soundchips at real time.

You can use the Soloud.getInfo() interface to query TED and SID
register values while the song is playing. The SID registers are
mapped to values 0-31 and the TED registers to 64-69.

See SOURCE
See LOAD-FILE
See LOAD-MEM

Package

cl-soloud.

Source

source.lisp.

Direct superclasses

source.

Direct methods
Class: virtual-attenuator

Superclass to create your own, custom attenuators.

You must implement the ATTENUATE method.

Package

cl-soloud.

Source

source.lisp.

Direct superclasses

attenuator.

Direct methods
Class: virtual-collider

Superclass to create your own, custom colliders.

3d sound sources may have custom audio colliders attached to them. By default, audio sources are only defined by their position and maximum range, which makes the sound sources point sources and omnidirectional.

With custom colliders, audio sources may be made to be bound to some area, as well as be directional.

You must implement the COLLIDE method.

See COLLIDER
See COLLIDE

Package

cl-soloud.

Source

source.lisp.

Direct superclasses

collider.

Direct methods
Class: virtual-filter

This is a class for your own filter classes.

Subclass this and implement the FILTER and FILTER-CHANNEL methods to create a new kind of filter.

See FILTER

Package

cl-soloud.

Source

filter.lisp.

Direct superclasses

filter.

Direct methods
Class: wav-source

The SoLoud::Wav class represents a wave sound effect.

The source files may be in 8 or 16 bit raw RIFF WAV files, or compressed Ogg Vorbis files.

The sounds are loaded and converted to float samples, which means that every second of a 44100Hz stereo sound takes about 350kB of memory. The good side is, after loading, these samples are very lightweight, as their processing is mostly just a memory copy.

For lengthy samples like background music, you may want to use SoLoud::WavStream instead. The Wav is all about speed, and always decodes the whole sample into memory at load time.

See SOURCE
See LOAD-FILE
See LOAD-MEM

Package

cl-soloud.

Source

source.lisp.

Direct superclasses

source.

Direct methods
Class: wav-stream-source

The SoLoud::WavStream class represents a wave sound effect that is streamed off disk while it’s playing.

The source files may be in 8 or 16 bit raw RIFF WAV files, or
compressed Ogg Vorbis files.

The sounds are loaded in pieces while they are playing, which
takes more processing power than playing samples from memory,
but they require much less memory.

For short or often used samples, you may want to use
SoLoud::Wav instead.

See SOURCE
See LOAD-FILE
See LOAD-MEM

Package

cl-soloud.

Source

source.lisp.

Direct superclasses

source.

Direct methods

5.2 Internals


5.2.1 Special variables

Special Variable: *c-object-table*

Table associating pointer addresses to their lisp-side objects.

See POINTER->OBJECT
See C-BACKED-OBJECT

Package

cl-soloud.

Source

toolkit.lisp.

Special Variable: *here*
Package

cl-soloud-cffi.

Source

low-level.lisp.


5.2.2 Macros

Macro: define-flag-accessor (name flag)

Define a shorthand accessor for a specific flag.

See FLAGS

Package

cl-soloud.

Source

source.lisp.

Macro: define-internal-source (class direct-superclasses direct-slots &rest options)

Define a new source class.

This will automatically create the appropriate methods for all the common source operations.

See SOURCE

Package

cl-soloud.

Source

source.lisp.

Macro: with-callback-handling ((instance &optional default error) &body body)

Evaluates the body with the proper callback handling in place.

This also resolves the instance to a lisp instance if it can. If the instance cannot be resolved, the body is not evaluated and the default is returned instead.

If an error occurs, a message is printed to *standard-output* and the error value is returned instead.

See POINTER->OBJECT

Package

cl-soloud.

Source

toolkit.lisp.


5.2.3 Ordinary functions

Function: compute-soloud-flags (flags)
Package

cl-soloud.

Source

soloud.lisp.

Function: decode-audio-source-flags (flags)

Decodes the integer of OR-combined flags into a list of keywords in the audio-source-flags enum.

See ENCODE-AUDIO-SOURCE-FLAGS

Package

cl-soloud.

Source

source.lisp.

Function: encode-audio-source-flags (flags)

Encodes the list of keywords form the audio-source-flags enum to an OR-combined flags integer.

See DECODE-AUDIO-SOURCE-FLAGS

Package

cl-soloud.

Source

source.lisp.

Function: find-cffi-symbol (temp fill)

Attempt to find an equivalent symbol in the soloud CFFI package.

Replaces underscores in the temp symbol by the fill string.

Package

cl-soloud.

Source

toolkit.lisp.

Function: load-wav-stream-file-to-mem (wav-stream file)
Package

cl-soloud-cffi.

Source

low-level.lisp.


5.2.4 Generic functions

Generic Function: channel-volume (3d-data channel)

Returns the volume of a single channel, with the panning in effect.

See 3D-DATA

Package

cl-soloud.

Methods
Method: channel-volume ((3d-data 3d-data) channel)
Source

source.lisp.

Generic Function: collider-data (3d-data)

Returns the internal data for the audio collider.

See 3D-DATA

Package

cl-soloud.

Methods
Method: collider-data ((3d-data 3d-data))
Source

source.lisp.

Generic Function: create-handle (biquad-resonant-filter)
Package

cl-soloud.

Methods
Method: create-handle ((bus bus))
Source

bus.lisp.

Method: create-handle ((soloud soloud))
Source

soloud.lisp.

Method: create-handle ((virtual-attenuator virtual-attenuator))
Source

source.lisp.

Method: create-handle ((virtual-collider virtual-collider))
Source

source.lisp.

Method: create-handle ((virtual-audio-source virtual-source))
Source

source.lisp.

Method: create-handle ((ted-sid ted-sid-source))
Source

source.lisp.

Method: create-handle ((monotone monotone-source))
Source

source.lisp.

Method: create-handle ((sfxr sfxr-source))
Source

source.lisp.

Method: create-handle ((speech speech-source))
Source

source.lisp.

Method: create-handle ((wav-stream wav-stream-source))
Source

source.lisp.

Method: create-handle ((wav wav-source))
Source

source.lisp.

Method: create-handle ((virtual-filter virtual-filter))
Source

filter.lisp.

Method: create-handle ((bass-boost-filter bass-boost-filter))
Source

filter.lisp.

Method: create-handle ((fft-filter fft-filter))
Source

filter.lisp.

Method: create-handle ((dc-removal-filter dc-removal-filter))
Source

filter.lisp.

Method: create-handle ((flanger-filter flanger-filter))
Source

filter.lisp.

Method: create-handle ((lofi-filter lofi-filter))
Source

filter.lisp.

Method: create-handle ((echo-filter echo-filter))
Source

filter.lisp.

Method: create-handle ((biquad-resonant-filter biquad-resonant-filter))
Source

filter.lisp.

Generic Function: destroy-handle (biquad-resonant-filter handle)
Package

cl-soloud.

Methods
Method: destroy-handle ((bus bus) handle)
Source

bus.lisp.

Method: destroy-handle ((soloud soloud) handle)
Source

soloud.lisp.

Method: destroy-handle ((virtual-attenuator virtual-attenuator) handle)
Source

source.lisp.

Method: destroy-handle ((virtual-collider virtual-collider) handle)
Source

source.lisp.

Method: destroy-handle ((virtual-audio-source virtual-source) handle)
Source

source.lisp.

Method: destroy-handle ((ted-sid ted-sid-source) handle)
Source

source.lisp.

Method: destroy-handle ((monotone monotone-source) handle)
Source

source.lisp.

Method: destroy-handle ((sfxr sfxr-source) handle)
Source

source.lisp.

Method: destroy-handle ((speech speech-source) handle)
Source

source.lisp.

Method: destroy-handle ((wav-stream wav-stream-source) handle)
Source

source.lisp.

Method: destroy-handle ((wav wav-source) handle)
Source

source.lisp.

Method: destroy-handle ((virtual-filter virtual-filter) handle)
Source

filter.lisp.

Method: destroy-handle ((bass-boost-filter bass-boost-filter) handle)
Source

filter.lisp.

Method: destroy-handle ((fft-filter fft-filter) handle)
Source

filter.lisp.

Method: destroy-handle ((dc-removal-filter dc-removal-filter) handle)
Source

filter.lisp.

Method: destroy-handle ((flanger-filter flanger-filter) handle)
Source

filter.lisp.

Method: destroy-handle ((lofi-filter lofi-filter) handle)
Source

filter.lisp.

Method: destroy-handle ((echo-filter echo-filter) handle)
Source

filter.lisp.

Method: destroy-handle ((biquad-resonant-filter biquad-resonant-filter) handle)
Source

filter.lisp.

Generic Function: doppler-value (3d-data)

Returns the internal data for the doppler effect.

See 3D-DATA

Package

cl-soloud.

Methods
Method: doppler-value ((3d-data 3d-data))
Source

source.lisp.

Generic Reader: file (object)

Accessor to the CL-MPG123:FILE instance used to process the MP3 file.

See MP3-SOURCE

Package

cl-soloud.

Methods
Reader Method: file ((mp3-source mp3-source))

automatically generated reader method

Source

mp3.lisp.

Target Slot

file.

Generic Writer: (setf file) (object)
Package

cl-soloud.

Methods
Writer Method: (setf file) ((mp3-source mp3-source))

automatically generated writer method

Source

mp3.lisp.

Target Slot

file.

Generic Reader: filter-map (object)

Accessor to the hash table associating filter IDs to filter instances.

See SOURCE
See FILTER

Package

cl-soloud.

Methods
Reader Method: filter-map ((source source))

automatically generated reader method

Source

source.lisp.

Target Slot

filter-map.

Generic Writer: (setf filter-map) (object)
Package

cl-soloud.

Methods
Writer Method: (setf filter-map) ((source source))

automatically generated writer method

Source

source.lisp.

Target Slot

filter-map.


5.2.5 Classes

Class: 3d-data

Container class for data related to 3d playback.

See LOCATION
See VELOCITY
See MIN-MAX-DISTANCE
See ATTENUATION
See DOPPLER-FACTOR
See COLLIDER
See ATTENUATOR
See COLLIDER-DATA
See DOPPLER-VALUE
See VOLUME
See CHANNEL-VOLUME
See FLAGS

Package

cl-soloud.

Source

source.lisp.

Direct superclasses

c-backed-object.

Direct methods
Class: virtual-source

Base class for your own custom audio source implementations.

In order to create a custom source, simply subclass this and implement the following methods:
See GET-AUDIO
See HAS-ENDED
See SEEK-TO
See REWIND
See GET-INFO

See SOURCE
See BASE-SAMPLERATE
See CHANNELS
See FLAGS
See SINGLE-INSTANCE-P
See INAUDIBLE-KILL-P
See INAUDIBLE-TICK-P

Package

cl-soloud.

Source

source.lisp.

Direct superclasses

source.

Direct subclasses

mp3-source.

Direct methods

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (   3  
A   B   C   D   E   F   G   H   I   L   M   O   P   R   S   U   V   W  
Index Entry  Section

(
(setf 3d-processed-p): Public generic functions
(setf 3d-processed-p): Public generic functions
(setf 3d-processed-p): Public generic functions
(setf 3d-processed-p): Public generic functions
(setf 3d-processed-p): Public generic functions
(setf 3d-processed-p): Public generic functions
(setf 3d-processed-p): Public generic functions
(setf 3d-processed-p): Public generic functions
(setf 3d-processed-p): Public generic functions
(setf attenuation): Public generic functions
(setf attenuation): Public generic functions
(setf attenuation): Public generic functions
(setf attenuation): Public generic functions
(setf attenuation): Public generic functions
(setf attenuation): Public generic functions
(setf attenuation): Public generic functions
(setf attenuation): Public generic functions
(setf attenuation): Public generic functions
(setf attenuation): Public generic functions
(setf attenuator): Public generic functions
(setf attenuator): Public generic functions
(setf attenuator): Public generic functions
(setf attenuator): Public generic functions
(setf attenuator): Public generic functions
(setf attenuator): Public generic functions
(setf attenuator): Public generic functions
(setf attenuator): Public generic functions
(setf attenuator): Public generic functions
(setf base-samplerate): Public generic functions
(setf base-samplerate): Public generic functions
(setf channel-location): Public generic functions
(setf channel-location): Public generic functions
(setf channels): Public generic functions
(setf channels): Public generic functions
(setf collider): Public generic functions
(setf collider): Public generic functions
(setf collider): Public generic functions
(setf collider): Public generic functions
(setf collider): Public generic functions
(setf collider): Public generic functions
(setf collider): Public generic functions
(setf collider): Public generic functions
(setf collider): Public generic functions
(setf direction): Public generic functions
(setf direction): Public generic functions
(setf distance-delayed-p): Public generic functions
(setf distance-delayed-p): Public generic functions
(setf distance-delayed-p): Public generic functions
(setf distance-delayed-p): Public generic functions
(setf distance-delayed-p): Public generic functions
(setf distance-delayed-p): Public generic functions
(setf distance-delayed-p): Public generic functions
(setf distance-delayed-p): Public generic functions
(setf distance-delayed-p): Public generic functions
(setf doppler-factor): Public generic functions
(setf doppler-factor): Public generic functions
(setf doppler-factor): Public generic functions
(setf doppler-factor): Public generic functions
(setf doppler-factor): Public generic functions
(setf doppler-factor): Public generic functions
(setf doppler-factor): Public generic functions
(setf doppler-factor): Public generic functions
(setf doppler-factor): Public generic functions
(setf doppler-factor): Public generic functions
(setf file): Private generic functions
(setf file): Private generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter): Public generic functions
(setf filter-map): Private generic functions
(setf filter-map): Private generic functions
(setf filter-parameter): Public generic functions
(setf filter-parameter): Public generic functions
(setf flags): Public generic functions
(setf flags): Public generic functions
(setf handle): Public generic functions
(setf handle): Public generic functions
(setf inaudible-behavior): Public generic functions
(setf inaudible-behavior): Public generic functions
(setf inaudible-behavior): Public generic functions
(setf inaudible-behavior): Public generic functions
(setf inaudible-behavior): Public generic functions
(setf inaudible-behavior): Public generic functions
(setf inaudible-behavior): Public generic functions
(setf inaudible-behavior): Public generic functions
(setf inaudible-behavior): Public generic functions
(setf inaudible-behavior): Public generic functions
(setf inaudible-kill-p): Public generic functions
(setf inaudible-kill-p): Public generic functions
(setf inaudible-tick-p): Public generic functions
(setf inaudible-tick-p): Public generic functions
(setf listener-relative-p): Public generic functions
(setf listener-relative-p): Public generic functions
(setf listener-relative-p): Public generic functions
(setf listener-relative-p): Public generic functions
(setf listener-relative-p): Public generic functions
(setf listener-relative-p): Public generic functions
(setf listener-relative-p): Public generic functions
(setf listener-relative-p): Public generic functions
(setf listener-relative-p): Public generic functions
(setf location): Public generic functions
(setf location): Public generic functions
(setf location): Public generic functions
(setf looping-p): Public generic functions
(setf looping-p): Public generic functions
(setf looping-p): Public generic functions
(setf looping-p): Public generic functions
(setf looping-p): Public generic functions
(setf looping-p): Public generic functions
(setf looping-p): Public generic functions
(setf looping-p): Public generic functions
(setf looping-p): Public generic functions
(setf looping-p): Public generic functions
(setf max-active-playback-count): Public generic functions
(setf max-active-playback-count): Public generic functions
(setf min-max-distance): Public generic functions
(setf min-max-distance): Public generic functions
(setf min-max-distance): Public generic functions
(setf min-max-distance): Public generic functions
(setf min-max-distance): Public generic functions
(setf min-max-distance): Public generic functions
(setf min-max-distance): Public generic functions
(setf min-max-distance): Public generic functions
(setf min-max-distance): Public generic functions
(setf min-max-distance): Public generic functions
(setf pan): Public generic functions
(setf pan): Public generic functions
(setf paused-p): Public generic functions
(setf paused-p): Public generic functions
(setf protected-p): Public generic functions
(setf protected-p): Public generic functions
(setf relative-speed): Public generic functions
(setf relative-speed): Public generic functions
(setf sample-rate): Public generic functions
(setf sample-rate): Public generic functions
(setf single-instance-p): Public generic functions
(setf single-instance-p): Public generic functions
(setf soloud): Public generic functions
(setf soloud): Public generic functions
(setf soloud): Public generic functions
(setf sound-speed): Public generic functions
(setf sound-speed): Public generic functions
(setf source): Public generic functions
(setf source): Public generic functions
(setf up): Public generic functions
(setf up): Public generic functions
(setf velocity): Public generic functions
(setf velocity): Public generic functions
(setf velocity): Public generic functions
(setf volume): Public generic functions
(setf volume): Public generic functions
(setf volume): Public generic functions
(setf volume): Public generic functions
(setf volume): Public generic functions
(setf volume): Public generic functions
(setf volume): Public generic functions
(setf volume): Public generic functions
(setf volume): Public generic functions
(setf volume): Public generic functions
(setf volume): Public generic functions

3
3d-processed-p: Public generic functions

A
active-playback-count: Public generic functions
active-playback-count: Public generic functions
add: Public generic functions
add: Public generic functions
add: Public generic functions
add-voice-to-group: Public ordinary functions
attenuate: Public generic functions
attenuate-audio-attenuator: Public ordinary functions
attenuation: Public generic functions
attenuation: Public generic functions
attenuator: Public generic functions
attenuator: Public generic functions

B
backend: Public generic functions
backend: Public generic functions
base-samplerate: Public generic functions
base-samplerate: Public generic functions
bus-calc-fft: Public ordinary functions
bus-play: Public ordinary functions
bus-play*: Public ordinary functions
bus-play-3d: Public ordinary functions
bus-play-3d*: Public ordinary functions
bus-play-3d-clocked: Public ordinary functions
bus-play-3d-clocked*: Public ordinary functions
bus-play-clocked: Public ordinary functions
bus-play-clocked*: Public ordinary functions

C
calc-fft: Public ordinary functions
channel-location: Public generic functions
channel-volume: Private generic functions
channel-volume: Private generic functions
channels: Public generic functions
channels: Public generic functions
collide: Public generic functions
collider: Public generic functions
collider: Public generic functions
collider-data: Private generic functions
collider-data: Private generic functions
compute-soloud-flags: Private ordinary functions
create: Public ordinary functions
create-bass-boost-filter: Public ordinary functions
create-biquad-resonant-filter: Public ordinary functions
create-bus: Public ordinary functions
create-dc-removal-filter: Public ordinary functions
create-echo-filter: Public ordinary functions
create-fft-filter: Public ordinary functions
create-flanger-filter: Public ordinary functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-handle: Private generic functions
create-lofi-filter: Public ordinary functions
create-monotone: Public ordinary functions
create-openmpt: Public ordinary functions
create-prg: Public ordinary functions
create-sfxr: Public ordinary functions
create-speech: Public ordinary functions
create-ted-sid: Public ordinary functions
create-virtual-audio-attenuator: Public ordinary functions
create-virtual-audio-collider: Public ordinary functions
create-virtual-audio-source: Public ordinary functions
create-virtual-filter: Public ordinary functions
create-voice-group: Public ordinary functions
create-wav: Public ordinary functions
create-wav-stream: Public ordinary functions

D
decode-audio-source-flags: Private ordinary functions
define-flag-accessor: Private macros
define-internal-source: Private macros
deinit: Public ordinary functions
destroy: Public ordinary functions
destroy-audio-attenuator: Public ordinary functions
destroy-bass-boost-filter: Public ordinary functions
destroy-biquad-resonant-filter: Public ordinary functions
destroy-bus: Public ordinary functions
destroy-dc-removal-filter: Public ordinary functions
destroy-echo-filter: Public ordinary functions
destroy-fft-filter: Public ordinary functions
destroy-flanger-filter: Public ordinary functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-handle: Private generic functions
destroy-lofi-filter: Public ordinary functions
destroy-monotone: Public ordinary functions
destroy-openmpt: Public ordinary functions
destroy-prg: Public ordinary functions
destroy-sfxr: Public ordinary functions
destroy-speech: Public ordinary functions
destroy-ted-sid: Public ordinary functions
destroy-virtual-audio-attenuator: Public ordinary functions
destroy-virtual-audio-collider: Public ordinary functions
destroy-virtual-audio-source: Public ordinary functions
destroy-virtual-filter: Public ordinary functions
destroy-voice-group: Public ordinary functions
destroy-wav: Public ordinary functions
destroy-wav-stream: Public ordinary functions
direction: Public generic functions
distance-delayed-p: Public generic functions
doppler-factor: Public generic functions
doppler-factor: Public generic functions
doppler-value: Private generic functions
doppler-value: Private generic functions

E
encode-audio-source-flags: Private ordinary functions

F
fade-filter-parameter: Public ordinary functions
fade-global-volume: Public ordinary functions
fade-pan: Public ordinary functions
fade-relative-play-speed: Public ordinary functions
fade-volume: Public ordinary functions
file: Private generic functions
file: Private generic functions
filter: Public generic functions
filter: Public generic functions
filter-channel: Public generic functions
filter-map: Private generic functions
filter-map: Private generic functions
filter-parameter: Public generic functions
filter-parameter: Public generic functions
find-cffi-symbol: Private ordinary functions
flags: Public generic functions
flags: Public generic functions
flags: Public generic functions
free: Public generic functions
free: Public generic functions
Function, add-voice-to-group: Public ordinary functions
Function, attenuate-audio-attenuator: Public ordinary functions
Function, bus-calc-fft: Public ordinary functions
Function, bus-play: Public ordinary functions
Function, bus-play*: Public ordinary functions
Function, bus-play-3d: Public ordinary functions
Function, bus-play-3d*: Public ordinary functions
Function, bus-play-3d-clocked: Public ordinary functions
Function, bus-play-3d-clocked*: Public ordinary functions
Function, bus-play-clocked: Public ordinary functions
Function, bus-play-clocked*: Public ordinary functions
Function, calc-fft: Public ordinary functions
Function, compute-soloud-flags: Private ordinary functions
Function, create: Public ordinary functions
Function, create-bass-boost-filter: Public ordinary functions
Function, create-biquad-resonant-filter: Public ordinary functions
Function, create-bus: Public ordinary functions
Function, create-dc-removal-filter: Public ordinary functions
Function, create-echo-filter: Public ordinary functions
Function, create-fft-filter: Public ordinary functions
Function, create-flanger-filter: Public ordinary functions
Function, create-lofi-filter: Public ordinary functions
Function, create-monotone: Public ordinary functions
Function, create-openmpt: Public ordinary functions
Function, create-prg: Public ordinary functions
Function, create-sfxr: Public ordinary functions
Function, create-speech: Public ordinary functions
Function, create-ted-sid: Public ordinary functions
Function, create-virtual-audio-attenuator: Public ordinary functions
Function, create-virtual-audio-collider: Public ordinary functions
Function, create-virtual-audio-source: Public ordinary functions
Function, create-virtual-filter: Public ordinary functions
Function, create-voice-group: Public ordinary functions
Function, create-wav: Public ordinary functions
Function, create-wav-stream: Public ordinary functions
Function, decode-audio-source-flags: Private ordinary functions
Function, deinit: Public ordinary functions
Function, destroy: Public ordinary functions
Function, destroy-audio-attenuator: Public ordinary functions
Function, destroy-bass-boost-filter: Public ordinary functions
Function, destroy-biquad-resonant-filter: Public ordinary functions
Function, destroy-bus: Public ordinary functions
Function, destroy-dc-removal-filter: Public ordinary functions
Function, destroy-echo-filter: Public ordinary functions
Function, destroy-fft-filter: Public ordinary functions
Function, destroy-flanger-filter: Public ordinary functions
Function, destroy-lofi-filter: Public ordinary functions
Function, destroy-monotone: Public ordinary functions
Function, destroy-openmpt: Public ordinary functions
Function, destroy-prg: Public ordinary functions
Function, destroy-sfxr: Public ordinary functions
Function, destroy-speech: Public ordinary functions
Function, destroy-ted-sid: Public ordinary functions
Function, destroy-virtual-audio-attenuator: Public ordinary functions
Function, destroy-virtual-audio-collider: Public ordinary functions
Function, destroy-virtual-audio-source: Public ordinary functions
Function, destroy-virtual-filter: Public ordinary functions
Function, destroy-voice-group: Public ordinary functions
Function, destroy-wav: Public ordinary functions
Function, destroy-wav-stream: Public ordinary functions
Function, encode-audio-source-flags: Private ordinary functions
Function, fade-filter-parameter: Public ordinary functions
Function, fade-global-volume: Public ordinary functions
Function, fade-pan: Public ordinary functions
Function, fade-relative-play-speed: Public ordinary functions
Function, fade-volume: Public ordinary functions
Function, find-cffi-symbol: Private ordinary functions
Function, get-3d-sound-speed: Public ordinary functions
Function, get-active-voice-count: Public ordinary functions
Function, get-audio-source-instance-3d-data-attenuation-model: Public ordinary functions
Function, get-audio-source-instance-3d-data-attenuation-rolloff: Public ordinary functions
Function, get-audio-source-instance-3d-data-audio-attenuator: Public ordinary functions
Function, get-audio-source-instance-3d-data-audio-collider: Public ordinary functions
Function, get-audio-source-instance-3d-data-channel-volume: Public ordinary functions
Function, get-audio-source-instance-3d-data-collider-data: Public ordinary functions
Function, get-audio-source-instance-3d-data-doppler-factor: Public ordinary functions
Function, get-audio-source-instance-3d-data-doppler-value: Public ordinary functions
Function, get-audio-source-instance-3d-data-flags: Public ordinary functions
Function, get-audio-source-instance-3d-data-handle: Public ordinary functions
Function, get-audio-source-instance-3d-data-max-distance: Public ordinary functions
Function, get-audio-source-instance-3d-data-min-distance: Public ordinary functions
Function, get-audio-source-instance-3d-data-position: Public ordinary functions
Function, get-audio-source-instance-3d-data-velocity: Public ordinary functions
Function, get-audio-source-instance-3d-data-volume: Public ordinary functions
Function, get-backend-buffer-size: Public ordinary functions
Function, get-backend-channels: Public ordinary functions
Function, get-backend-id: Public ordinary functions
Function, get-backend-sample-rate: Public ordinary functions
Function, get-backend-string: Public ordinary functions
Function, get-bus-wave: Public ordinary functions
Function, get-error-string: Public ordinary functions
Function, get-filter-parameter: Public ordinary functions
Function, get-global-volume: Public ordinary functions
Function, get-info: Public ordinary functions
Function, get-loop-count: Public ordinary functions
Function, get-looping: Public ordinary functions
Function, get-max-active-voice-count: Public ordinary functions
Function, get-overall-volume: Public ordinary functions
Function, get-pan: Public ordinary functions
Function, get-pause: Public ordinary functions
Function, get-post-clip-scaler: Public ordinary functions
Function, get-protect-voice: Public ordinary functions
Function, get-relative-play-speed: Public ordinary functions
Function, get-sample-rate: Public ordinary functions
Function, get-stream-time: Public ordinary functions
Function, get-version: Public ordinary functions
Function, get-virtual-audio-source-base-samplerate: Public ordinary functions
Function, get-virtual-audio-source-channels: Public ordinary functions
Function, get-virtual-audio-source-flags: Public ordinary functions
Function, get-voice-count: Public ordinary functions
Function, get-volume: Public ordinary functions
Function, get-wav-length: Public ordinary functions
Function, get-wav-stream-length: Public ordinary functions
Function, get-wave: Public ordinary functions
Function, init: Public ordinary functions
Function, init*: Public ordinary functions
Function, is-valid-voice-handle: Public ordinary functions
Function, is-voice-group: Public ordinary functions
Function, is-voice-group-empty: Public ordinary functions
Function, load-monotone: Public ordinary functions
Function, load-monotone-file: Public ordinary functions
Function, load-monotone-mem: Public ordinary functions
Function, load-monotone-mem*: Public ordinary functions
Function, load-openmpt: Public ordinary functions
Function, load-openmpt-file: Public ordinary functions
Function, load-openmpt-mem: Public ordinary functions
Function, load-openmpt-mem*: Public ordinary functions
Function, load-sfxr-params: Public ordinary functions
Function, load-sfxr-params-file: Public ordinary functions
Function, load-sfxr-params-mem: Public ordinary functions
Function, load-sfxr-params-mem*: Public ordinary functions
Function, load-sfxr-preset: Public ordinary functions
Function, load-ted-sid: Public ordinary functions
Function, load-ted-sid-file: Public ordinary functions
Function, load-ted-sid-file-to-mem: Public ordinary functions
Function, load-ted-sid-mem: Public ordinary functions
Function, load-ted-sid-mem*: Public ordinary functions
Function, load-ted-sid-to-mem: Public ordinary functions
Function, load-wav: Public ordinary functions
Function, load-wav-file: Public ordinary functions
Function, load-wav-mem: Public ordinary functions
Function, load-wav-mem*: Public ordinary functions
Function, load-wav-stream: Public ordinary functions
Function, load-wav-stream-file: Public ordinary functions
Function, load-wav-stream-file-to-mem: Private ordinary functions
Function, load-wav-stream-mem: Public ordinary functions
Function, load-wav-stream-mem*: Public ordinary functions
Function, load-wav-stream-to-mem: Public ordinary functions
Function, mix: Public ordinary functions
Function, mix-signed-16: Public ordinary functions
Function, oscillate-filter-parameter: Public ordinary functions
Function, oscillate-global-volume: Public ordinary functions
Function, oscillate-pan: Public ordinary functions
Function, oscillate-relative-play-speed: Public ordinary functions
Function, oscillate-volume: Public ordinary functions
Function, play: Public ordinary functions
Function, play*: Public ordinary functions
Function, play-3d: Public ordinary functions
Function, play-3d*: Public ordinary functions
Function, play-3d-clocked: Public ordinary functions
Function, play-3d-clocked*: Public ordinary functions
Function, play-clocked: Public ordinary functions
Function, play-clocked*: Public ordinary functions
Function, prg-random: Public ordinary functions
Function, prg-srandom: Public ordinary functions
Function, schedule-pause: Public ordinary functions
Function, schedule-stop: Public ordinary functions
Function, seek: Public ordinary functions
Function, set-3d-listener-at: Public ordinary functions
Function, set-3d-listener-parameters: Public ordinary functions
Function, set-3d-listener-parameters*: Public ordinary functions
Function, set-3d-listener-position: Public ordinary functions
Function, set-3d-listener-up: Public ordinary functions
Function, set-3d-listener-velocity: Public ordinary functions
Function, set-3d-sound-speed: Public ordinary functions
Function, set-3d-source-attenuation: Public ordinary functions
Function, set-3d-source-doppler-factor: Public ordinary functions
Function, set-3d-source-min-max-distance: Public ordinary functions
Function, set-3d-source-parameters: Public ordinary functions
Function, set-3d-source-parameters*: Public ordinary functions
Function, set-3d-source-position: Public ordinary functions
Function, set-3d-source-velocity: Public ordinary functions
Function, set-bass-boost-filter-params: Public ordinary functions
Function, set-biquad-resonant-filter-params: Public ordinary functions
Function, set-bus-3d-attenuation: Public ordinary functions
Function, set-bus-3d-attenuator: Public ordinary functions
Function, set-bus-3d-collider: Public ordinary functions
Function, set-bus-3d-collider*: Public ordinary functions
Function, set-bus-3d-distance-delay: Public ordinary functions
Function, set-bus-3d-doppler-factor: Public ordinary functions
Function, set-bus-3d-listener-relative: Public ordinary functions
Function, set-bus-3d-min-max-distance: Public ordinary functions
Function, set-bus-3d-processing: Public ordinary functions
Function, set-bus-channels: Public ordinary functions
Function, set-bus-filter: Public ordinary functions
Function, set-bus-inaudible-behavior: Public ordinary functions
Function, set-bus-looping: Public ordinary functions
Function, set-bus-visualization: Public ordinary functions
Function, set-bus-volume: Public ordinary functions
Function, set-dc-removal-filter-params: Public ordinary functions
Function, set-dc-removal-filter-params*: Public ordinary functions
Function, set-delay-samples: Public ordinary functions
Function, set-echo-filter-params: Public ordinary functions
Function, set-echo-filter-params*: Public ordinary functions
Function, set-filter-parameter: Public ordinary functions
Function, set-flanger-filter-params: Public ordinary functions
Function, set-global-filter: Public ordinary functions
Function, set-global-volume: Public ordinary functions
Function, set-inaudible-behavior: Public ordinary functions
Function, set-lofi-filter-params: Public ordinary functions
Function, set-looping: Public ordinary functions
Function, set-max-active-voice-count: Public ordinary functions
Function, set-monotone-3d-attenuation: Public ordinary functions
Function, set-monotone-3d-attenuator: Public ordinary functions
Function, set-monotone-3d-collider: Public ordinary functions
Function, set-monotone-3d-collider*: Public ordinary functions
Function, set-monotone-3d-distance-delay: Public ordinary functions
Function, set-monotone-3d-doppler-factor: Public ordinary functions
Function, set-monotone-3d-listener-relative: Public ordinary functions
Function, set-monotone-3d-min-max-distance: Public ordinary functions
Function, set-monotone-3d-processing: Public ordinary functions
Function, set-monotone-filter: Public ordinary functions
Function, set-monotone-inaudible-behavior: Public ordinary functions
Function, set-monotone-looping: Public ordinary functions
Function, set-monotone-params: Public ordinary functions
Function, set-monotone-params*: Public ordinary functions
Function, set-monotone-volume: Public ordinary functions
Function, set-openmpt-3d-attenuation: Public ordinary functions
Function, set-openmpt-3d-attenuator: Public ordinary functions
Function, set-openmpt-3d-collider: Public ordinary functions
Function, set-openmpt-3d-collider*: Public ordinary functions
Function, set-openmpt-3d-distance-delay: Public ordinary functions
Function, set-openmpt-3d-doppler-factor: Public ordinary functions
Function, set-openmpt-3d-listener-relative: Public ordinary functions
Function, set-openmpt-3d-min-max-distance: Public ordinary functions
Function, set-openmpt-3d-processing: Public ordinary functions
Function, set-openmpt-filter: Public ordinary functions
Function, set-openmpt-inaudible-behavior: Public ordinary functions
Function, set-openmpt-looping: Public ordinary functions
Function, set-openmpt-volume: Public ordinary functions
Function, set-pan: Public ordinary functions
Function, set-pan-absolute: Public ordinary functions
Function, set-pan-absolute*: Public ordinary functions
Function, set-pause: Public ordinary functions
Function, set-pause-all: Public ordinary functions
Function, set-post-clip-scaler: Public ordinary functions
Function, set-protect-voice: Public ordinary functions
Function, set-relative-play-speed: Public ordinary functions
Function, set-sample-rate: Public ordinary functions
Function, set-sfxr-3d-attenuation: Public ordinary functions
Function, set-sfxr-3d-attenuator: Public ordinary functions
Function, set-sfxr-3d-collider: Public ordinary functions
Function, set-sfxr-3d-collider*: Public ordinary functions
Function, set-sfxr-3d-distance-delay: Public ordinary functions
Function, set-sfxr-3d-doppler-factor: Public ordinary functions
Function, set-sfxr-3d-listener-relative: Public ordinary functions
Function, set-sfxr-3d-min-max-distance: Public ordinary functions
Function, set-sfxr-3d-processing: Public ordinary functions
Function, set-sfxr-filter: Public ordinary functions
Function, set-sfxr-inaudible-behavior: Public ordinary functions
Function, set-sfxr-looping: Public ordinary functions
Function, set-sfxr-volume: Public ordinary functions
Function, set-speaker-position: Public ordinary functions
Function, set-speech-3d-attenuation: Public ordinary functions
Function, set-speech-3d-attenuator: Public ordinary functions
Function, set-speech-3d-collider: Public ordinary functions
Function, set-speech-3d-collider*: Public ordinary functions
Function, set-speech-3d-distance-delay: Public ordinary functions
Function, set-speech-3d-doppler-factor: Public ordinary functions
Function, set-speech-3d-listener-relative: Public ordinary functions
Function, set-speech-3d-min-max-distance: Public ordinary functions
Function, set-speech-3d-processing: Public ordinary functions
Function, set-speech-filter: Public ordinary functions
Function, set-speech-inaudible-behavior: Public ordinary functions
Function, set-speech-looping: Public ordinary functions
Function, set-speech-text: Public ordinary functions
Function, set-speech-volume: Public ordinary functions
Function, set-ted-sid-3d-attenuation: Public ordinary functions
Function, set-ted-sid-3d-attenuator: Public ordinary functions
Function, set-ted-sid-3d-collider: Public ordinary functions
Function, set-ted-sid-3d-collider*: Public ordinary functions
Function, set-ted-sid-3d-distance-delay: Public ordinary functions
Function, set-ted-sid-3d-doppler-factor: Public ordinary functions
Function, set-ted-sid-3d-listener-relative: Public ordinary functions
Function, set-ted-sid-3d-min-max-distance: Public ordinary functions
Function, set-ted-sid-3d-processing: Public ordinary functions
Function, set-ted-sid-filter: Public ordinary functions
Function, set-ted-sid-inaudible-behavior: Public ordinary functions
Function, set-ted-sid-looping: Public ordinary functions
Function, set-ted-sid-volume: Public ordinary functions
Function, set-virtual-audio-attenuator-attenuate: Public ordinary functions
Function, set-virtual-audio-collider-collide: Public ordinary functions
Function, set-virtual-audio-source-3d-attenuation: Public ordinary functions
Function, set-virtual-audio-source-3d-attenuator: Public ordinary functions
Function, set-virtual-audio-source-3d-collider: Public ordinary functions
Function, set-virtual-audio-source-3d-collider*: Public ordinary functions
Function, set-virtual-audio-source-3d-distance-delay: Public ordinary functions
Function, set-virtual-audio-source-3d-doppler-factor: Public ordinary functions
Function, set-virtual-audio-source-3d-listener-relative: Public ordinary functions
Function, set-virtual-audio-source-3d-min-max-distance: Public ordinary functions
Function, set-virtual-audio-source-3d-processing: Public ordinary functions
Function, set-virtual-audio-source-base-samplerate: Public ordinary functions
Function, set-virtual-audio-source-channels: Public ordinary functions
Function, set-virtual-audio-source-filter: Public ordinary functions
Function, set-virtual-audio-source-flags: Public ordinary functions
Function, set-virtual-audio-source-get-audio: Public ordinary functions
Function, set-virtual-audio-source-get-info: Public ordinary functions
Function, set-virtual-audio-source-has-ended: Public ordinary functions
Function, set-virtual-audio-source-inaudible-behavior: Public ordinary functions
Function, set-virtual-audio-source-looping: Public ordinary functions
Function, set-virtual-audio-source-rewind: Public ordinary functions
Function, set-virtual-audio-source-seek: Public ordinary functions
Function, set-virtual-audio-source-volume: Public ordinary functions
Function, set-virtual-filter-filter: Public ordinary functions
Function, set-virtual-filter-filter-channel: Public ordinary functions
Function, set-visualization: Public ordinary functions
Function, set-volume: Public ordinary functions
Function, set-wav-3d-attenuation: Public ordinary functions
Function, set-wav-3d-attenuator: Public ordinary functions
Function, set-wav-3d-collider: Public ordinary functions
Function, set-wav-3d-collider*: Public ordinary functions
Function, set-wav-3d-distance-delay: Public ordinary functions
Function, set-wav-3d-doppler-factor: Public ordinary functions
Function, set-wav-3d-listener-relative: Public ordinary functions
Function, set-wav-3d-min-max-distance: Public ordinary functions
Function, set-wav-3d-processing: Public ordinary functions
Function, set-wav-filter: Public ordinary functions
Function, set-wav-inaudible-behavior: Public ordinary functions
Function, set-wav-looping: Public ordinary functions
Function, set-wav-stream-3d-attenuation: Public ordinary functions
Function, set-wav-stream-3d-attenuator: Public ordinary functions
Function, set-wav-stream-3d-collider: Public ordinary functions
Function, set-wav-stream-3d-collider*: Public ordinary functions
Function, set-wav-stream-3d-distance-delay: Public ordinary functions
Function, set-wav-stream-3d-doppler-factor: Public ordinary functions
Function, set-wav-stream-3d-listener-relative: Public ordinary functions
Function, set-wav-stream-3d-min-max-distance: Public ordinary functions
Function, set-wav-stream-3d-processing: Public ordinary functions
Function, set-wav-stream-filter: Public ordinary functions
Function, set-wav-stream-inaudible-behavior: Public ordinary functions
Function, set-wav-stream-looping: Public ordinary functions
Function, set-wav-stream-volume: Public ordinary functions
Function, set-wav-volume: Public ordinary functions
Function, stop: Public ordinary functions
Function, stop-all: Public ordinary functions
Function, stop-audio-source: Public ordinary functions
Function, stop-bus: Public ordinary functions
Function, stop-monotone: Public ordinary functions
Function, stop-openmpt: Public ordinary functions
Function, stop-sfxr: Public ordinary functions
Function, stop-speech: Public ordinary functions
Function, stop-ted-sid: Public ordinary functions
Function, stop-virtual-audio-source: Public ordinary functions
Function, stop-wav: Public ordinary functions
Function, stop-wav-stream: Public ordinary functions
Function, update-3d-audio: Public ordinary functions

G
Generic Function, (setf 3d-processed-p): Public generic functions
Generic Function, (setf attenuation): Public generic functions
Generic Function, (setf attenuator): Public generic functions
Generic Function, (setf base-samplerate): Public generic functions
Generic Function, (setf channel-location): Public generic functions
Generic Function, (setf channels): Public generic functions
Generic Function, (setf collider): Public generic functions
Generic Function, (setf direction): Public generic functions
Generic Function, (setf distance-delayed-p): Public generic functions
Generic Function, (setf doppler-factor): Public generic functions
Generic Function, (setf file): Private generic functions
Generic Function, (setf filter): Public generic functions
Generic Function, (setf filter-map): Private generic functions
Generic Function, (setf filter-parameter): Public generic functions
Generic Function, (setf flags): Public generic functions
Generic Function, (setf handle): Public generic functions
Generic Function, (setf inaudible-behavior): Public generic functions
Generic Function, (setf inaudible-kill-p): Public generic functions
Generic Function, (setf inaudible-tick-p): Public generic functions
Generic Function, (setf listener-relative-p): Public generic functions
Generic Function, (setf location): Public generic functions
Generic Function, (setf looping-p): Public generic functions
Generic Function, (setf max-active-playback-count): Public generic functions
Generic Function, (setf min-max-distance): Public generic functions
Generic Function, (setf pan): Public generic functions
Generic Function, (setf paused-p): Public generic functions
Generic Function, (setf protected-p): Public generic functions
Generic Function, (setf relative-speed): Public generic functions
Generic Function, (setf sample-rate): Public generic functions
Generic Function, (setf single-instance-p): Public generic functions
Generic Function, (setf soloud): Public generic functions
Generic Function, (setf sound-speed): Public generic functions
Generic Function, (setf source): Public generic functions
Generic Function, (setf up): Public generic functions
Generic Function, (setf velocity): Public generic functions
Generic Function, (setf volume): Public generic functions
Generic Function, 3d-processed-p: Public generic functions
Generic Function, active-playback-count: Public generic functions
Generic Function, add: Public generic functions
Generic Function, attenuate: Public generic functions
Generic Function, attenuation: Public generic functions
Generic Function, attenuator: Public generic functions
Generic Function, backend: Public generic functions
Generic Function, base-samplerate: Public generic functions
Generic Function, channel-location: Public generic functions
Generic Function, channel-volume: Private generic functions
Generic Function, channels: Public generic functions
Generic Function, collide: Public generic functions
Generic Function, collider: Public generic functions
Generic Function, collider-data: Private generic functions
Generic Function, create-handle: Private generic functions
Generic Function, destroy-handle: Private generic functions
Generic Function, direction: Public generic functions
Generic Function, distance-delayed-p: Public generic functions
Generic Function, doppler-factor: Public generic functions
Generic Function, doppler-value: Private generic functions
Generic Function, file: Private generic functions
Generic Function, filter: Public generic functions
Generic Function, filter-channel: Public generic functions
Generic Function, filter-map: Private generic functions
Generic Function, filter-parameter: Public generic functions
Generic Function, flags: Public generic functions
Generic Function, free: Public generic functions
Generic Function, get-audio: Public generic functions
Generic Fun