The cl-soloud Reference Manual

Table of Contents

The cl-soloud Reference Manual

This is the cl-soloud Reference Manual, version 1.0.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:23:57 2018 GMT+0.

1 Introduction

About cl-soloud

This is a bindings library to SoLoud which allows easy cross-platform mixing and playback.

How To

Precompiled versions of the underlying library are included in this. If you want to build it manually however, refer to the SoLoud repository.

Load the system through ASDF or Quicklisp:

(ql:quickload :cl-soloud)

First you'll need to create an instance of the basic SoLoud object that will keep the system state around and allow you to manage playback.

(defvar *s* (make-instance 'cl-soloud:soloud))

Next you'll want to get an audio source to play back from. The simplest would be a speech source, which crudely turns text to speech.

(let ((source (make-instance 'cl-soloud:speech-source)))
  (cl-soloud:load-text source "This text to speech is pretty terrible")
  (cl-soloud:play source *s*))

Returned by play is a playback handle with which you can control the playback. Note that all the objects returned by this API will take care of automatically cleaning up the underlying resources when they are finalized. This means that you must keep a reference to your SoLoud object and sources around or things will randomly stop working.

SoLoud has a limit of how many playbacks can be played simultaneously. It is initially set to 16, but if you need more active sources then you can up it with the :max-active-playback-count initarg. Just note that the higher the number is, the more processing power will be required. If you play more things than the simultaneous limit, SoLoud will only play back the loudest ones. SoLoud also has a hard-coded maximum number of playbacks that can exist (this includes silent and active ones), which is set to 1024. The wrapper's API will make sure to check the maximum limit when you play a source.

Extending SoLoud

SoLoud can be extended by adding custom audio sources, filters, attenuators, or colliders. All of those have a corresponding "virtual" class that you should subclass (virtual-source virtual-filter virtual-attenuator virtual-collider) and specialise their respective methods on. The explanation of which methods you need is described in the class' docstring, and what each method should do should be clearly outlined in its own docstring.

2 Systems

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

2.1 cl-soloud

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

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

License

Artistic

Description

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

Version

1.0.0

Dependencies

• alexandria
• cffi
• trivial-features
• trivial-garbage
• trivial-indent
• documentation-utils
• cl-mpg123

Source

cl-soloud.asd (file)

Components

• package.lisp (file)
• low-level.lisp (file)
• toolkit.lisp (file)
• filter.lisp (file)
• source.lisp (file)
• soloud.lisp (file)
• bus.lisp (file)
• mp3.lisp (file)
• documentation.lisp (file)

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.asd

Location

cl-soloud.asd

Systems

cl-soloud (system)

3.1.2 cl-soloud/package.lisp

Parent

cl-soloud (system)

Location

package.lisp

Packages

• cl-soloud
• cl-soloud-cffi

3.1.3 cl-soloud/low-level.lisp

Dependency

package.lisp (file)

Parent

cl-soloud (system)

Location

low-level.lisp

Exported Definitions

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

Internal Definitions

• *here* (special variable)
• load-wav-stream-file-to-mem (function)

3.1.4 cl-soloud/toolkit.lisp

Dependency

low-level.lisp (file)

Parent

cl-soloud (system)

Location

toolkit.lisp

Exported Definitions

• c-backed-object (class)
• free (method)
• handle (method)
• (setf handle) (method)
• pointer->object (method)
• pointer->object (method)
• pointer->object (method)

Internal Definitions

• *c-object-table* (special variable)
• find-cffi-symbol (function)
• with-callback-handling (macro)

3.1.5 cl-soloud/filter.lisp

Dependency

toolkit.lisp (file)

Parent

cl-soloud (system)

Location

filter.lisp

Exported Definitions

• bass-boost-filter (class)
• biquad-resonant-filter (class)
• dc-removal-filter (class)
• echo-filter (class)
• fft-filter (class)
• filter (generic function)
• filter (method)
• filter (class)
• filter-channel (generic function)
• flanger-filter (class)
• lofi-filter (class)
• set-parameters (generic function)
• set-parameters (method)
• set-parameters (method)
• set-parameters (method)
• set-parameters (method)
• set-parameters (method)
• set-parameters (method)
• virtual-filter (class)

Internal Definitions

• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)

3.1.6 cl-soloud/source.lisp

Dependency

filter.lisp (file)

Parent

cl-soloud (system)

Location

source.lisp

Exported Definitions

• 3d-processed-p (generic function)
• (setf 3d-processed-p) (method)
• (setf 3d-processed-p) (method)
• (setf 3d-processed-p) (method)
• (setf 3d-processed-p) (method)
• (setf 3d-processed-p) (method)
• (setf 3d-processed-p) (method)
• (setf 3d-processed-p) (method)
• add (method)
• attenuate (generic function)
• attenuation (method)
• (setf attenuation) (method)
• (setf attenuation) (method)
• (setf attenuation) (method)
• (setf attenuation) (method)
• (setf attenuation) (method)
• (setf attenuation) (method)
• (setf attenuation) (method)
• attenuator (method)
• (setf attenuator) (method)
• (setf attenuator) (method)
• (setf attenuator) (method)
• (setf attenuator) (method)
• (setf attenuator) (method)
• (setf attenuator) (method)
• (setf attenuator) (method)
• attenuator (class)
• base-samplerate (method)
• (setf base-samplerate) (method)
• channels (method)
• (setf channels) (method)
• collide (generic function)
• collider (method)
• (setf collider) (method)
• (setf collider) (method)
• (setf collider) (method)
• (setf collider) (method)
• (setf collider) (method)
• (setf collider) (method)
• (setf collider) (method)
• collider (class)
• distance-delayed-p (generic function)
• (setf distance-delayed-p) (method)
• (setf distance-delayed-p) (method)
• (setf distance-delayed-p) (method)
• (setf distance-delayed-p) (method)
• (setf distance-delayed-p) (method)
• (setf distance-delayed-p) (method)
• (setf distance-delayed-p) (method)
• doppler-factor (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• flags (method)
• flags (method)
• (setf flags) (method)
• get-audio (generic function)
• get-info (generic function)
• has-ended (generic function)
• inaudible-behavior (method)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• inaudible-kill-p (method)
• (setf inaudible-kill-p) (method)
• inaudible-tick-p (method)
• (setf inaudible-tick-p) (method)
• listener-relative-p (generic function)
• (setf listener-relative-p) (method)
• (setf listener-relative-p) (method)
• (setf listener-relative-p) (method)
• (setf listener-relative-p) (method)
• (setf listener-relative-p) (method)
• (setf listener-relative-p) (method)
• (setf listener-relative-p) (method)
• load-file (method)
• load-file (method)
• load-file (method)
• load-file (method)
• load-file (method)
• load-file (method)
• load-mem (method)
• load-mem (method)
• load-mem (method)
• load-mem (method)
• load-mem (method)
• load-mem (method)
• load-preset (method)
• load-text (method)
• location (method)
• (setf looping-p) (method)
• (setf looping-p) (method)
• (setf looping-p) (method)
• (setf looping-p) (method)
• (setf looping-p) (method)
• (setf looping-p) (method)
• (setf looping-p) (method)
• min-max-distance (method)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• monotone-source (class)
• rewind (generic function)
• seek-to (generic function)
• sfxr-source (class)
• single-instance-p (method)
• (setf single-instance-p) (method)
• source (class)
• speech-source (class)
• stop (method)
• stop (method)
• stop (method)
• stop (method)
• stop (method)
• stop (method)
• stop (method)
• ted-sid-source (class)
• velocity (method)
• virtual-attenuator (class)
• virtual-collider (class)
• volume (method)
• (setf volume) (method)
• (setf volume) (method)
• (setf volume) (method)
• (setf volume) (method)
• (setf volume) (method)
• (setf volume) (method)
• (setf volume) (method)
• wav-source (class)
• wav-stream-source (class)
• withdraw (method)

Internal Definitions

• 3d-data (class)
• channel-volume (method)
• collider-data (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• decode-audio-source-flags (function)
• define-flag-accessor (macro)
• define-internal-source (macro)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• doppler-value (method)
• encode-audio-source-flags (function)
• filter-map (method)
• (setf filter-map) (method)
• virtual-source (class)

3.1.7 cl-soloud/soloud.lisp

Dependency

source.lisp (file)

Parent

cl-soloud (system)

Location

soloud.lisp

Exported Definitions

• active-playback-count (method)
• add (method)
• (setf attenuation) (method)
• backend (method)
• channel-location (generic function)
• (setf channel-location) (method)
• direction (generic function)
• (setf direction) (method)
• (setf doppler-factor) (method)
• filter-parameter (method)
• (setf filter-parameter) (method)
• group (class)
• (setf inaudible-behavior) (method)
• (setf location) (method)
• (setf location) (method)
• looping-p (method)
• (setf looping-p) (method)
• max-active-playback-count (method)
• (setf max-active-playback-count) (method)
• (setf min-max-distance) (method)
• oscillate-pan (method)
• oscillate-relative-speed (method)
• oscillate-volume (method)
• oscillate-volume (method)
• pan (method)
• (setf pan) (method)
• paused-p (method)
• (setf paused-p) (method)
• play (generic function)
• play (method)
• playback (class)
• playback-count (method)
• playing (method)
• protected-p (method)
• (setf protected-p) (method)
• relative-speed (method)
• (setf relative-speed) (method)
• sample-rate (method)
• (setf sample-rate) (method)
• seek (method)
• set-absolute-pan (method)
• soloud (method)
• (setf soloud) (method)
• soloud (class)
• sound-speed (method)
• (setf sound-speed) (method)
• source (method)
• (setf source) (method)
• stop (method)
• stop (method)
• up (generic function)
• (setf up) (method)
• (setf velocity) (method)
• (setf velocity) (method)
• volume (method)
• volume (method)
• (setf volume) (method)
• (setf volume) (method)

Internal Definitions

• compute-soloud-flags (function)
• create-handle (method)
• destroy-handle (method)

3.1.8 cl-soloud/bus.lisp

Dependency

soloud.lisp (file)

Parent

cl-soloud (system)

Location

bus.lisp

Exported Definitions

• (setf 3d-processed-p) (method)
• (setf attenuation) (method)
• (setf attenuator) (method)
• bus (class)
• (setf collider) (method)
• (setf distance-delayed-p) (method)
• (setf doppler-factor) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf inaudible-behavior) (method)
• (setf listener-relative-p) (method)
• (setf looping-p) (method)
• (setf min-max-distance) (method)
• play (method)
• play (method)
• play (method)
• soloud (method)
• soloud (method)
• soloud (method)
• soloud (method)
• (setf soloud) (method)
• stop (method)
• (setf volume) (method)

Internal Definitions

• create-handle (method)
• destroy-handle (method)

3.1.9 cl-soloud/mp3.lisp

Dependency

bus.lisp (file)

Parent

cl-soloud (system)

Location

mp3.lisp

Exported Definitions

• get-audio (method)
• get-info (method)
• has-ended (method)
• load-file (method)
• mp3-source (class)
• rewind (method)
• seek-to (method)

Internal Definitions

• file (method)
• (setf file) (method)

3.1.10 cl-soloud/documentation.lisp

Dependency

mp3.lisp (file)

Parent

cl-soloud (system)

Location

documentation.lisp

4 Packages

Packages are listed by definition order.

4.1 cl-soloud

Source

package.lisp (file)

Nickname

org.shirakumo.fraf.soloud

Use List

• cffi
• common-lisp

Exported Definitions

• 3d-processed-p (generic function)
• (setf 3d-processed-p) (generic function)
• (setf 3d-processed-p) (method)
• (setf 3d-processed-p) (method)
• (setf 3d-processed-p) (method)
• (setf 3d-processed-p) (method)
• (setf 3d-processed-p) (method)
• (setf 3d-processed-p) (method)
• (setf 3d-processed-p) (method)
• (setf 3d-processed-p) (method)
• active-playback-count (generic function)
• active-playback-count (method)
• add (generic function)
• add (method)
• add (method)
• attenuate (generic function)
• attenuation (generic function)
• attenuation (method)
• (setf attenuation) (generic function)
• (setf attenuation) (method)
• (setf attenuation) (method)
• (setf attenuation) (method)
• (setf attenuation) (method)
• (setf attenuation) (method)
• (setf attenuation) (method)
• (setf attenuation) (method)
• (setf attenuation) (method)
• (setf attenuation) (method)
• attenuator (generic function)
• attenuator (method)
• (setf attenuator) (generic function)
• (setf attenuator) (method)
• (setf attenuator) (method)
• (setf attenuator) (method)
• (setf attenuator) (method)
• (setf attenuator) (method)
• (setf attenuator) (method)
• (setf attenuator) (method)
• (setf attenuator) (method)
• attenuator (class)
• backend (generic function)
• backend (method)
• base-samplerate (generic function)
• base-samplerate (method)
• (setf base-samplerate) (method)
• (setf base-samplerate) (generic function)
• bass-boost-filter (class)
• biquad-resonant-filter (class)
• bus (class)
• c-backed-object (class)
• channel-location (generic function)
• (setf channel-location) (generic function)
• (setf channel-location) (method)
• channels (generic function)
• channels (method)
• (setf channels) (method)
• (setf channels) (generic function)
• collide (generic function)
• collider (generic function)
• collider (method)
• (setf collider) (generic function)
• (setf collider) (method)
• (setf collider) (method)
• (setf collider) (method)
• (setf collider) (method)
• (setf collider) (method)
• (setf collider) (method)
• (setf collider) (method)
• (setf collider) (method)
• collider (class)
• dc-removal-filter (class)
• direction (generic function)
• (setf direction) (generic function)
• (setf direction) (method)
• distance-delayed-p (generic function)
• (setf distance-delayed-p) (generic function)
• (setf distance-delayed-p) (method)
• (setf distance-delayed-p) (method)
• (setf distance-delayed-p) (method)
• (setf distance-delayed-p) (method)
• (setf distance-delayed-p) (method)
• (setf distance-delayed-p) (method)
• (setf distance-delayed-p) (method)
• (setf distance-delayed-p) (method)
• doppler-factor (generic function)
• doppler-factor (method)
• (setf doppler-factor) (generic function)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• (setf doppler-factor) (method)
• echo-filter (class)
• fft-filter (class)
• filter (generic function)
• filter (method)
• (setf filter) (generic function)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• (setf filter) (method)
• filter (class)
• filter-channel (generic function)
• filter-parameter (generic function)
• filter-parameter (method)
• (setf filter-parameter) (method)
• (setf filter-parameter) (generic function)
• flags (generic function)
• flags (method)
• flags (method)
• (setf flags) (method)
• (setf flags) (generic function)
• flanger-filter (class)
• free (generic function)
• free (method)
• get-audio (generic function)
• get-audio (method)
• get-info (generic function)
• get-info (method)
• group (class)
• handle (generic function)
• handle (method)
• (setf handle) (method)
• (setf handle) (generic function)
• has-ended (generic function)
• has-ended (method)
• inaudible-behavior (generic function)
• inaudible-behavior (method)
• (setf inaudible-behavior) (generic function)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• (setf inaudible-behavior) (method)
• inaudible-kill-p (generic function)
• inaudible-kill-p (method)
• (setf inaudible-kill-p) (method)
• (setf inaudible-kill-p) (generic function)
• inaudible-tick-p (generic function)
• inaudible-tick-p (method)
• (setf inaudible-tick-p) (method)
• (setf inaudible-tick-p) (generic function)
• listener-relative-p (generic function)
• (setf listener-relative-p) (generic function)
• (setf listener-relative-p) (method)
• (setf listener-relative-p) (method)
• (setf listener-relative-p) (method)
• (setf listener-relative-p) (method)
• (setf listener-relative-p) (method)
• (setf listener-relative-p) (method)
• (setf listener-relative-p) (method)
• (setf listener-relative-p) (method)
• load-file (generic function)
• load-file (method)
• load-file (method)
• load-file (method)
• load-file (method)
• load-file (method)
• load-file (method)
• load-file (method)
• load-mem (generic function)
• load-mem (method)
• load-mem (method)
• load-mem (method)
• load-mem (method)
• load-mem (method)
• load-mem (method)
• load-preset (generic function)
• load-preset (method)
• load-text (generic function)
• load-text (method)
• location (generic function)
• location (method)
• (setf location) (generic function)
• (setf location) (method)
• (setf location) (method)
• lofi-filter (class)
• looping-p (generic function)
• looping-p (method)
• (setf looping-p) (generic function)
• (setf looping-p) (method)
• (setf looping-p) (method)
• (setf looping-p) (method)
• (setf looping-p) (method)
• (setf looping-p) (method)
• (setf looping-p) (method)
• (setf looping-p) (method)
• (setf looping-p) (method)
• (setf looping-p) (method)
• max-active-playback-count (generic function)
• max-active-playback-count (method)
• (setf max-active-playback-count) (method)
• (setf max-active-playback-count) (generic function)
• min-max-distance (generic function)
• min-max-distance (method)
• (setf min-max-distance) (generic function)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• (setf min-max-distance) (method)
• monotone-source (class)
• mp3-source (class)
• oscillate-pan (generic function)
• oscillate-pan (method)
• oscillate-relative-speed (generic function)
• oscillate-relative-speed (method)
• oscillate-volume (generic function)
• oscillate-volume (method)
• oscillate-volume (method)
• pan (generic function)
• pan (method)
• (setf pan) (generic function)
• (setf pan) (method)
• paused-p (generic function)
• paused-p (method)
• (setf paused-p) (method)
• (setf paused-p) (generic function)
• play (generic function)
• play (method)
• play (method)
• play (method)
• play (method)
• playback (class)
• playback-count (generic function)
• playback-count (method)
• playing (generic function)
• playing (method)
• pointer->object (generic function)
• pointer->object (method)
• pointer->object (method)
• pointer->object (method)
• protected-p (generic function)
• protected-p (method)
• (setf protected-p) (method)
• (setf protected-p) (generic function)
• relative-speed (generic function)
• relative-speed (method)
• (setf relative-speed) (generic function)
• (setf relative-speed) (method)
• rewind (generic function)
• rewind (method)
• sample-rate (generic function)
• sample-rate (method)
• (setf sample-rate) (method)
• (setf sample-rate) (generic function)
• seek (generic function)
• seek (method)
• seek-to (generic function)
• seek-to (method)
• set-absolute-pan (generic function)
• set-absolute-pan (method)
• set-parameters (generic function)
• set-parameters (method)
• set-parameters (method)
• set-parameters (method)
• set-parameters (method)
• set-parameters (method)
• set-parameters (method)
• sfxr-source (class)
• single-instance-p (generic function)
• single-instance-p (method)
• (setf single-instance-p) (method)
• (setf single-instance-p) (generic function)
• soloud (generic function)
• soloud (method)
• soloud (method)
• soloud (method)
• soloud (method)
• (setf soloud) (method)
• soloud (method)
• (setf soloud) (method)
• (setf soloud) (generic function)
• soloud (class)
• sound-speed (generic function)
• sound-speed (method)
• (setf sound-speed) (method)
• (setf sound-speed) (generic function)
• source (generic function)
• source (method)
• (setf source) (method)
• (setf source) (generic function)
• source (class)
• speech-source (class)
• stop (generic function)
• stop (method)
• stop (method)
• stop (method)
• stop (method)
• stop (method)
• stop (method)
• stop (method)
• stop (method)
• stop (method)
• stop (method)
• ted-sid-source (class)
• up (generic function)
• (setf up) (generic function)
• (setf up) (method)
• velocity (generic function)
• velocity (method)
• (setf velocity) (generic function)
• (setf velocity) (method)
• (setf velocity) (method)
• virtual-attenuator (class)
• virtual-collider (class)
• virtual-filter (class)
• volume (generic function)
• volume (method)
• volume (method)
• volume (method)
• (setf volume) (generic function)
• (setf volume) (method)
• (setf volume) (method)
• (setf volume) (method)
• (setf volume) (method)
• (setf volume) (method)
• (setf volume) (method)
• (setf volume) (method)
• (setf volume) (method)
• (setf volume) (method)
• (setf volume) (method)
• wav-source (class)
• wav-stream-source (class)
• withdraw (generic function)
• withdraw (method)

Internal Definitions

• *c-object-table* (special variable)
• 3d-data (class)
• channel-volume (generic function)
• channel-volume (method)
• collider-data (generic function)
• collider-data (method)
• compute-soloud-flags (function)
• create-handle (generic function)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• create-handle (method)
• decode-audio-source-flags (function)
• define-flag-accessor (macro)
• define-internal-source (macro)
• destroy-handle (generic function)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• destroy-handle (method)
• doppler-value (generic function)
• doppler-value (method)
• encode-audio-source-flags (function)
• file (generic function)
• file (method)
• (setf file) (method)
• (setf file) (generic function)
• filter-map (generic function)
• filter-map (method)
• (setf filter-map) (method)
• (setf filter-map) (generic function)
• find-cffi-symbol (function)
• virtual-source (class)
• with-callback-handling (macro)

4.2 cl-soloud-cffi

Source

package.lisp (file)

Nickname

org.shirakumo.fraf.soloud.cffi

Use List

• cffi
• common-lisp

Exported Definitions

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

Internal Definitions

• *here* (special variable)
• load-wav-stream-file-to-mem (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *max-filters*

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Special Variable: *max-sources*

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Special Variable: *static*

Package

cl-soloud-cffi

Source

low-level.lisp (file)

5.1.2 Functions

Function: add-voice-to-group SOLOUD VOICE-GROUP-HANDLE VOICE-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: attenuate-audio-attenuator AUDIO-ATTENUATOR DISTANCE MIN MAX ROLLOFF

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: bus-calc-fft BUS

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: bus-play BUS SOUND

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: bus-play* BUS SOUND VOLUME PAN PAUSED

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: bus-play-3d BUS SOUND X Y Z

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: bus-play-3d* BUS SOUND X Y Z VX VY VZ VOLUME PAUSED

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: bus-play-3d-clocked BUS SOUND-TIME SOUND X Y Z

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: bus-play-3d-clocked* BUS SOUND-TIME SOUND X Y Z VX VY VZ VOLUME

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: bus-play-clocked BUS SOUND-TIME SOUND

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: bus-play-clocked* BUS SOUND-TIME SOUND VOLUME PAN

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: calc-fft SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-bass-boost-filter ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-biquad-resonant-filter ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-bus ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-dc-removal-filter ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-echo-filter ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-fft-filter ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-flanger-filter ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-lofi-filter ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-monotone ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-openmpt ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-prg ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-sfxr ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-speech ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-ted-sid ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-virtual-audio-attenuator ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-virtual-audio-collider ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-virtual-audio-source ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-virtual-filter ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-voice-group SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-wav ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: create-wav-stream ()

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: deinit SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-audio-attenuator AUDIO-ATTENUATOR

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-bass-boost-filter BASS-BOOST-FILTER

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-biquad-resonant-filter BIQUAD-RESONANT-FILTER

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-bus BUS

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-dc-removal-filter DC-REMOVAL-FILTER

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-echo-filter ECHO-FILTER

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-fft-filter FFT-FILTER

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-flanger-filter FLANGER-FILTER

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-lofi-filter LOFI-FILTER

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-monotone MONOTONE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-openmpt OPENMPT

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-prg PRG

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-sfxr SFXR

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-speech SPEECH

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-ted-sid TED-SID

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-virtual-audio-attenuator VIRTUAL-AUDIO-ATTENUATOR

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-virtual-audio-collider VIRTUAL-AUDIO-COLLIDER

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-virtual-audio-source VIRTUAL-AUDIO-SOURCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-virtual-filter VIRTUAL-FILTER

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-voice-group SOLOUD VOICE-GROUP-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-wav WAV

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: destroy-wav-stream WAV-STREAM

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: fade-filter-parameter SOLOUD VOICE-HANDLE FILTER-ID ATTRIBUTE-ID TO TIME

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: fade-global-volume SOLOUD TO TIME

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: fade-pan SOLOUD VOICE-HANDLE TO TIME

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: fade-relative-play-speed SOLOUD VOICE-HANDLE TO TIME

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: fade-volume SOLOUD VOICE-HANDLE TO TIME

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-3d-sound-speed SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-active-voice-count SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-attenuation-model INSTANCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-attenuation-rolloff INSTANCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-audio-attenuator INSTANCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-audio-collider INSTANCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-channel-volume INSTANCE CHANNEL

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-collider-data INSTANCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-doppler-factor INSTANCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-doppler-value INSTANCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-flags INSTANCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-handle INSTANCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-max-distance INSTANCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-min-distance INSTANCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-position INSTANCE X Y Z

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-velocity INSTANCE X Y Z

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-audio-source-instance-3d-data-volume INSTANCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-backend-buffer-size SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-backend-channels SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-backend-id SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-backend-sample-rate SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-backend-string SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-bus-wave BUS

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-error-string SOLOUD ERROR-CODE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-filter-parameter SOLOUD VOICE-HANDLE FILTER-ID ATTRIBUTE-ID

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-global-volume SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-info SOLOUD VOICE-HANDLE INFO-KEY

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-loop-count SOLOUD VOICE-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-looping SOLOUD VOICE-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-max-active-voice-count SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-overall-volume SOLOUD VOICE-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-pan SOLOUD VOICE-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-pause SOLOUD VOICE-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-post-clip-scaler SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-protect-voice SOLOUD VOICE-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-relative-play-speed SOLOUD VOICE-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-sample-rate SOLOUD VOICE-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-stream-time SOLOUD VOICE-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-version SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-virtual-audio-source-base-samplerate VIRTUAL-AUDIO-SOURCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-virtual-audio-source-channels VIRTUAL-AUDIO-SOURCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-virtual-audio-source-flags VIRTUAL-AUDIO-SOURCE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-voice-count SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-volume SOLOUD VOICE-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-wav-length WAV

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-wav-stream-length WAV

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: get-wave SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: init SOLOUD

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: init* SOLOUD FLAGS BACKEND SAMPLE-RATE BUFFER-SIZE CHANNELS

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: is-valid-voice-handle SOLOUD VOICE-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: is-voice-group SOLOUD VOICE-GROUP-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: is-voice-group-empty SOLOUD VOICE-GROUP-HANDLE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-monotone MONOTONE FILENAME

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-monotone-file MONOTONE FILE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-monotone-mem MONOTONE MEM LENGTH

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-monotone-mem* MONOTONE MEM LENGTH COPY TAKE-OWNERSHIP

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-openmpt OPENMPT FILENAME

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-openmpt-file OPENMPT FILE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-openmpt-mem OPENMPT MEM LENGTH

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-openmpt-mem* OPENMPT MEM LENGTH COPY TAKE-OWNERSHIP

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-sfxr-params SFXR FILENAME

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-sfxr-params-file SFXR FILE

Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-sfxr-params-mem SFXR MEM LENGTH

Package

cl-soloud-cffi

Source

low-level.lisp (file)