The cl-soloud Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-soloud Reference Manual

This is the cl-soloud Reference Manual, version 1.0.0, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:33:35 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

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.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

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
Source

cl-soloud.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-soloud.asd

Location

cl-soloud.asd

Systems

cl-soloud (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-soloud/package.lisp

Parent

cl-soloud (system)

Location

package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-soloud/low-level.lisp

Dependency

package.lisp (file)

Parent

cl-soloud (system)

Location

low-level.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cl-soloud/toolkit.lisp

Dependency

low-level.lisp (file)

Parent

cl-soloud (system)

Location

toolkit.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 cl-soloud/filter.lisp

Dependency

toolkit.lisp (file)

Parent

cl-soloud (system)

Location

filter.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 cl-soloud/source.lisp

Dependency

filter.lisp (file)

Parent

cl-soloud (system)

Location

source.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.7 cl-soloud/soloud.lisp

Dependency

source.lisp (file)

Parent

cl-soloud (system)

Location

soloud.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.8 cl-soloud/bus.lisp

Dependency

soloud.lisp (file)

Parent

cl-soloud (system)

Location

bus.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.9 cl-soloud/mp3.lisp

Dependency

bus.lisp (file)

Parent

cl-soloud (system)

Location

mp3.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.10 cl-soloud/documentation.lisp

Dependency

mp3.lisp (file)

Parent

cl-soloud (system)

Location

documentation.lisp


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 cl-soloud

Source

package.lisp (file)

Nickname

org.shirakumo.fraf.soloud

Use List
Exported Definitions
Internal Definitions

Previous: , Up: Packages   [Contents][Index]

4.2 cl-soloud-cffi

Source

package.lisp (file)

Nickname

org.shirakumo.fraf.soloud.cffi

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)

Function: load-sfxr-params-mem* SFXR MEM LENGTH COPY TAKE-OWNERSHIP
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-sfxr-preset SFXR PRESET-NO SEED
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-ted-sid TED-SID FILENAME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-ted-sid-file TED-SID FILE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-ted-sid-file-to-mem TED-SID FILE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-ted-sid-mem TED-SID MEM LENGTH
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-ted-sid-mem* TED-SID MEM LENGTH COPY TAKE-OWNERSHIP
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-ted-sid-to-mem TED-SID FILENAME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-wav WAV FILENAME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-wav-file WAV FILE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-wav-mem WAV MEM LENGTH
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-wav-mem* WAV MEM LENGTH COPY TAKE-OWNERSHIP
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-wav-stream WAV-STREAM FILENAME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-wav-stream-file WAV-STREAM FILE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-wav-stream-mem WAV-STREAM MEM LENGTH
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-wav-stream-mem* WAV-STREAM MEM LENGTH COPY TAKE-OWNERSHIP
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: load-wav-stream-to-mem WAV-STREAM FILENAME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: mix SOLOUD BUFFER SAMPLES
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: mix-signed-16 SOLOUD BUFFER SAMPLES
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: oscillate-filter-parameter SOLOUD VOICE-HANDLE FILTER-ID ATTRIBUTE-ID FROM TO TIME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: oscillate-global-volume SOLOUD FROM TO TIME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: oscillate-pan SOLOUD VOICE-HANDLE FROM TO TIME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: oscillate-relative-play-speed SOLOUD VOICE-HANDLE FROM TO TIME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: oscillate-volume SOLOUD VOICE-HANDLE FROM TO TIME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: play SOLOUD SOUND
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: play* SOLOUD SOUND VOLUME PAN PAUSED BUS
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: play-3d SOLOUD SOUND X Y Z
Package

cl-soloud-cffi

Source

low-level.lisp (file)

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

cl-soloud-cffi

Source

low-level.lisp (file)

Function: play-3d-clocked SOLOUD SOUND-TIME SOUND X Y Z
Package

cl-soloud-cffi

Source

low-level.lisp (file)

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 (file)

Function: play-clocked SOLOUD SOUND-TIME SOUND
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: play-clocked* SOLOUD SOUND-TIME SOUND VOLUME PAN PAUSED BUS
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: prg-random PRG
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: prg-srandom PRG SEED
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: schedule-pause SOLOUD VOICE-HANDLE TIME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: schedule-stop SOLOUD VOICE-HANDLE TIME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: seek SOLOUD VOICE-HANDLE SECONDS
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-3d-listener-at SOLOUD X Y Z
Package

cl-soloud-cffi

Source

low-level.lisp (file)

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 (file)

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 (file)

Function: set-3d-listener-position SOLOUD X Y Z
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-3d-listener-up SOLOUD X Y Z
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-3d-listener-velocity SOLOUD X Y Z
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-3d-sound-speed SOLOUD SPEED
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-3d-source-attenuation SOLOUD VOICE-HANDLE ATTENUATION-MODEL ATTENUATION-ROLLOFF-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-3d-source-doppler-factor SOLOUD VOICE-HANDLE DOPPLER-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-3d-source-min-max-distance SOLOUD VOICE-HANDLE MIN MAX
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-3d-source-parameters SOLOUD VOICE-HANDLE X Y Z
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-3d-source-parameters* SOLOUD VOICE-HANDLE X Y Z VX VY VZ
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-3d-source-position SOLOUD VOICE-HANDLE X Y Z
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-3d-source-velocity SOLOUD VOICE-HANDLE X Y Z
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bass-boost-filter-params BASS-BOOST-FILTER BOOST
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-biquad-resonant-filter-params BIQUAD-RESONANT-FILTER TYPE SAMPLE-RATE FREQUENCY RESONANCE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-3d-attenuation BUS ATTENUATION-MODEL ATTENUATION-ROLLOFF-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-3d-attenuator BUS AUDIO-ATTENUATOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-3d-collider BUS AUDIO-COLLIDER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-3d-collider* BUS AUDIO-COLLIDER USER-DATA
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-3d-distance-delay BUS DISTANCE-DELAY
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-3d-doppler-factor BUS DOPPLER-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-3d-listener-relative BUS LISTENER-RELATIVE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-3d-min-max-distance BUS MIN MAX
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-3d-processing BUS DO-3D-PROCESSING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-channels BUS CHANNELS
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-filter BUS FILTER-ID FILTER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-inaudible-behavior BUS MUST-TICK KILL
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-looping BUS LOOPING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-visualization BUS ENABLE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-bus-volume BUS VOLUME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-dc-removal-filter-params DC-REMOVAL-FILTER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-dc-removal-filter-params* DC-REMOVAL-FILTER LENGTH
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-delay-samples SOLOUD VOICE-HANDLE SAMPLES
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-echo-filter-params ECHO-FILTER DELAY
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-echo-filter-params* ECHO-FILTER DELAY DECAY FILTER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-filter-parameter SOLOUD VOICE-HANDLE FILTER-ID ATTRIBUTE-ID VALUE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-flanger-filter-params FLANGER-FILTER DELAY FREQ
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-global-filter SOLOUD FILTER-ID FILTER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-global-volume SOLOUD VOLUME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-inaudible-behavior SOLOUD VOICE-HANDLE MUST-TICK KILL
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-lofi-filter-params LOFI-FILTER SAMPLE-RATE BIT-DEPTH
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-looping SOLOUD VOICE-HANDLE LOOPING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-max-active-voice-count SOLOUD VOICE-COUNT
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-3d-attenuation MONOTONE ATTENUATION-MODEL ATTENUATION-ROLLOFF-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-3d-attenuator MONOTONE AUDIO-ATTENUATOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-3d-collider MONOTONE AUDIO-COLLIDER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-3d-collider* MONOTONE AUDIO-COLLIDER USER-DATA
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-3d-distance-delay MONOTONE DISTANCE-DELAY
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-3d-doppler-factor MONOTONE DOPPLER-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-3d-listener-relative MONOTONE LISTENER-RELATIVE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-3d-min-max-distance MONOTONE MIN MAX
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-3d-processing MONOTONE DO-3D-PROCESSING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-filter MONOTONE FILTER-ID FILTER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-inaudible-behavior MONOTONE MUST-TICK KILL
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-looping MONOTONE LOOPING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-params MONOTONE HARDWARE-CHANNELS
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-params* MONOTONE HARDWARE-CHANNELS WAVE-FORM
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-monotone-volume MONOTONE VOLUME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-openmpt-3d-attenuation OPENMPT ATTENUATION-MODEL ATTENUATION-ROLLOFF-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-openmpt-3d-attenuator OPENMPT AUDIO-ATTENUATOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-openmpt-3d-collider OPENMPT AUDIO-COLLIDER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-openmpt-3d-collider* OPENMPT AUDIO-COLLIDER USER-DATA
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-openmpt-3d-distance-delay OPENMPT DISTANCE-DELAY
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-openmpt-3d-doppler-factor OPENMPT DOPPLER-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-openmpt-3d-listener-relative OPENMPT LISTENER-RELATIVE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-openmpt-3d-min-max-distance OPENMPT MIN MAX
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-openmpt-3d-processing OPENMPT DO-3D-PROCESSING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-openmpt-filter OPENMPT FILTER-ID FILTER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-openmpt-inaudible-behavior OPENMPT MUST-TICK KILL
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-openmpt-looping OPENMPT LOOPING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-openmpt-volume OPENMPT VOLUME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-pan SOLOUD VOICE-HANDLE PAN
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-pan-absolute SOLOUD VOICE-HANDLE LEFT-VOLUME RIGHT-VOLUME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

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 (file)

Function: set-pause SOLOUD VOICE-HANDLE PAUSE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-pause-all SOLOUD PAUSE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-post-clip-scaler SOLOUD SCALER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-protect-voice SOLOUD VOICE-HANDLE PROTECT
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-relative-play-speed SOLOUD VOICE-HANDLE SPEED
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sample-rate SOLOUD VOICE-HANDLE SAMPLE-RATE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sfxr-3d-attenuation SFXR ATTENUATION-MODEL ATTENUATION-ROLLOFF-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sfxr-3d-attenuator SFXR AUDIO-ATTENUATOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sfxr-3d-collider SFXR AUDIO-COLLIDER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sfxr-3d-collider* SFXR AUDIO-COLLIDER USER-DATA
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sfxr-3d-distance-delay SFXR DISTANCE-DELAY
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sfxr-3d-doppler-factor SFXR DOPPLER-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sfxr-3d-listener-relative SFXR LISTENER-RELATIVE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sfxr-3d-min-max-distance SFXR MIN MAX
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sfxr-3d-processing SFXR DO-3D-PROCESSING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sfxr-filter SFXR FILTER-ID FILTER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sfxr-inaudible-behavior SFXR MUST-TICK KILL
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sfxr-looping SFXR LOOPING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-sfxr-volume SFXR VOLUME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speaker-position SOLOUD CHANNEL X Y Z
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-3d-attenuation SPEECH ATTENUATION-MODEL ATTENUATION-ROLLOFF-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-3d-attenuator SPEECH AUDIO-ATTENUATOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-3d-collider SPEECH AUDIO-COLLIDER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-3d-collider* SPEECH AUDIO-COLLIDER USER-DATA
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-3d-distance-delay SPEECH DISTANCE-DELAY
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-3d-doppler-factor SPEECH DOPPLER-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-3d-listener-relative SPEECH LISTENER-RELATIVE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-3d-min-max-distance SPEECH MIN MAX
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-3d-processing SPEECH DO-3D-PROCESSING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-filter SPEECH FILTER-ID FILTER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-inaudible-behavior SPEECH MUST-TICK KILL
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-looping SPEECH LOOPING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-text SPEECH TEXT
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-speech-volume SPEECH VOLUME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-ted-sid-3d-attenuation TED-SID ATTENUATION-MODEL ATTENUATION-ROLLOFF-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-ted-sid-3d-attenuator TED-SID AUDIO-ATTENUATOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-ted-sid-3d-collider TED-SID AUDIO-COLLIDER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-ted-sid-3d-collider* TED-SID AUDIO-COLLIDER USER-DATA
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-ted-sid-3d-distance-delay TED-SID DISTANCE-DELAY
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-ted-sid-3d-doppler-factor TED-SID DOPPLER-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-ted-sid-3d-listener-relative TED-SID LISTENER-RELATIVE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-ted-sid-3d-min-max-distance TED-SID MIN MAX
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-ted-sid-3d-processing TED-SID DO-3D-PROCESSING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-ted-sid-filter TED-SID FILTER-ID FILTER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-ted-sid-inaudible-behavior TED-SID MUST-TICK KILL
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-ted-sid-looping TED-SID LOOPING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-ted-sid-volume TED-SID VOLUME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-attenuator-attenuate FUNCTION
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-collider-collide FUNCTION
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-3d-attenuation VIRTUAL-AUDIO-SOURCE ATTENUATION-MODEL ATTENUATION-ROLLOFF-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-3d-attenuator VIRTUAL-AUDIO-SOURCE AUDIO-ATTENUATOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-3d-collider VIRTUAL-AUDIO-SOURCE AUDIO-COLLIDER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-3d-collider* VIRTUAL-AUDIO-SOURCE AUDIO-COLLIDER USER-DATA
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-3d-distance-delay VIRTUAL-AUDIO-SOURCE DISTANCE-DELAY
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-3d-doppler-factor VIRTUAL-AUDIO-SOURCE DOPPLER-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-3d-listener-relative VIRTUAL-AUDIO-SOURCE LISTENER-RELATIVE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-3d-min-max-distance VIRTUAL-AUDIO-SOURCE MIN MAX
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-3d-processing VIRTUAL-AUDIO-SOURCE DO-3D-PROCESSING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-base-samplerate VIRTUAL-AUDIO-SOURCE SAMPLERATE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-channels VIRTUAL-AUDIO-SOURCE CHANNELS
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-filter VIRTUAL-AUDIO-SOURCE FILTER-ID FILTER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-flags VIRTUAL-AUDIO-SOURCE FLAGS
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-get-audio FUNCTION
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-get-info FUNCTION
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-has-ended FUNCTION
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-inaudible-behavior VIRTUAL-AUDIO-SOURCE MUST-TICK KILL
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-looping VIRTUAL-AUDIO-SOURCE LOOPING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-rewind FUNCTION
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-seek FUNCTION
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-audio-source-volume VIRTUAL-AUDIO-SOURCE VOLUME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-filter-filter FUNCTION
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-virtual-filter-filter-channel FUNCTION
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-visualization SOLOUD ENABLE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-volume SOLOUD VOICE-HANDLE VOLUME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-3d-attenuation WAV ATTENUATION-MODEL ATTENUATION-ROLLOFF-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-3d-attenuator WAV AUDIO-ATTENUATOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-3d-collider WAV AUDIO-COLLIDER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-3d-collider* WAV AUDIO-COLLIDER USER-DATA
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-3d-distance-delay WAV DISTANCE-DELAY
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-3d-doppler-factor WAV DOPPLER-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-3d-listener-relative WAV LISTENER-RELATIVE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-3d-min-max-distance WAV MIN MAX
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-3d-processing WAV DO-3D-PROCESSING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-filter WAV FILTER-ID FILTER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-inaudible-behavior WAV MUST-TICK KILL
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-looping WAV LOOPING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-stream-3d-attenuation WAV-STREAM ATTENUATION-MODEL ATTENUATION-ROLLOFF-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-stream-3d-attenuator WAV-STREAM AUDIO-ATTENUATOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-stream-3d-collider WAV-STREAM AUDIO-COLLIDER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-stream-3d-collider* WAV-STREAM AUDIO-COLLIDER USER-DATA
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-stream-3d-distance-delay WAV-STREAM DISTANCE-DELAY
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-stream-3d-doppler-factor WAV-STREAM DOPPLER-FACTOR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-stream-3d-listener-relative WAV-STREAM LISTENER-RELATIVE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-stream-3d-min-max-distance WAV-STREAM MIN MAX
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-stream-3d-processing WAV-STREAM DO-3D-PROCESSING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-stream-filter WAV-STREAM FILTER-ID FILTER
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-stream-inaudible-behavior WAV-STREAM MUST-TICK KILL
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-stream-looping WAV-STREAM LOOPING
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-stream-volume WAV-STREAM VOLUME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: set-wav-volume WAV VOLUME
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: stop SOLOUD VOICE-HANDLE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: stop-all SOLOUD
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: stop-audio-source SOLOUD SOURCE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: stop-bus BUS
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: stop-monotone MONOTONE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: stop-openmpt OPENMPT
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: stop-sfxr SFXR
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: stop-speech SPEECH
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: stop-ted-sid TED-SID
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: stop-virtual-audio-source VIRTUAL-AUDIO-SOURCE
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: stop-wav WAV
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: stop-wav-stream WAV-STREAM
Package

cl-soloud-cffi

Source

low-level.lisp (file)

Function: update-3d-audio SOLOUD
Package

cl-soloud-cffi

Source

low-level.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

Writer

(setf 3d-processed-p) (generic function)

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

cl-soloud

Reader

3d-processed-p (generic function)

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

bus.lisp (file)

Method: (setf 3d-processed-p) VALUE (VIRTUAL-AUDIO-SOURCE virtual-source)
Source

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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 (file)

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 (file)

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

source.lisp (file)

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 (file)

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

Writer

(setf attenuation) (generic function)

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

source.lisp (file)

Generic Function: (setf attenuation) VALUE WAV
Package

cl-soloud

Reader

attenuation (generic function)

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

bus.lisp (file)

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

soloud.lisp (file)

Method: (setf attenuation) VALUE (VIRTUAL-AUDIO-SOURCE virtual-source)
Source

source.lisp (file)

Method: (setf attenuation) VALUE (TED-SID ted-sid-source)
Source

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

Method: (setf attenuation) VALUE (WAV-STREAM wav-stream-source)
Source

source.lisp (file)

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

source.lisp (file)

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

Writer

(setf attenuator) (generic function)

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

source.lisp (file)

Generic Function: (setf attenuator) VALUE WAV
Package

cl-soloud

Reader

attenuator (generic function)

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

bus.lisp (file)

Method: (setf attenuator) VALUE (VIRTUAL-AUDIO-SOURCE virtual-source)
Source

source.lisp (file)

Method: (setf attenuator) VALUE (TED-SID ted-sid-source)
Source

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

Method: (setf attenuator) VALUE (WAV-STREAM wav-stream-source)
Source

source.lisp (file)

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

source.lisp (file)

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 (file)

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

Writer

(setf base-samplerate) (generic function)

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

source.lisp (file)

Generic Function: (setf base-samplerate) VALUE VIRTUAL-SOURCE
Package

cl-soloud

Reader

base-samplerate (generic function)

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

source.lisp (file)

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 (file)

Writer

(setf channel-location) (generic function)

Generic Function: (setf channel-location) LOCATION SOLOUD CHANNEL
Package

cl-soloud

Reader

channel-location (generic function)

Methods
Method: (setf channel-location) LOCATION (SOLOUD soloud) CHANNEL
Source

soloud.lisp (file)

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

Writer

(setf channels) (generic function)

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

source.lisp (file)

Generic Function: (setf channels) VALUE VIRTUAL-SOURCE
Package

cl-soloud

Reader

channels (generic function)

Methods
Method: (setf channels) VALUE (VIRTUAL-SOURCE virtual-source)
Source

source.lisp (file)

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 (file)

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

Writer

(setf collider) (generic function)

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

source.lisp (file)

Generic Function: (setf collider) VALUE WAV
Package

cl-soloud

Reader

collider (generic function)

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

bus.lisp (file)

Method: (setf collider) VALUE (VIRTUAL-AUDIO-SOURCE virtual-source)
Source

source.lisp (file)

Method: (setf collider) VALUE (TED-SID ted-sid-source)
Source

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

Method: (setf collider) VALUE (WAV-STREAM wav-stream-source)
Source

source.lisp (file)

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

source.lisp (file)

Generic Function: direction OBJECT

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

See SOLOUD

Package

cl-soloud

Source

soloud.lisp (file)

Writer

(setf direction) (generic function)

Generic Function: (setf direction) VALUE SOLOUD
Package

cl-soloud

Reader

direction (generic function)

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

soloud.lisp (file)

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 (file)

Writer

(setf distance-delayed-p) (generic function)

Generic Function: (setf distance-delayed-p) VALUE WAV
Package

cl-soloud

Reader

distance-delayed-p (generic function)

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

bus.lisp (file)

Method: (setf distance-delayed-p) VALUE (VIRTUAL-AUDIO-SOURCE virtual-source)
Source

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

Generic Function: doppler-factor 3D-DATA

Accessor to the doppler factor of the source.

See PLAYBACK
See SOURCE
See 3D-DATA

Package

cl-soloud

Writer

(setf doppler-factor) (generic function)

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

source.lisp (file)

Generic Function: (setf doppler-factor) VALUE WAV
Package

cl-soloud

Reader

doppler-factor (generic function)

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

bus.lisp (file)

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

soloud.lisp (file)

Method: (setf doppler-factor) VALUE (VIRTUAL-AUDIO-SOURCE virtual-source)
Source

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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 (file)

Writer

(setf filter) (generic function)

Methods
Method: filter (FILTER virtual-filter) BUFFER SAMPLES CHANNELS SAMPLERATE TIME
Generic Function: (setf filter) FILTER WAV ID
Package

cl-soloud

Reader

filter (generic function)

Methods
Method: (setf filter) (NULL null) (BUS bus) ID
Source

bus.lisp (file)

Method: (setf filter) (FILTER filter) (BUS bus) ID
Source

bus.lisp (file)

Method: (setf filter) (NULL null) (VIRTUAL-AUDIO-SOURCE virtual-source) ID
Source

source.lisp (file)

Method: (setf filter) (FILTER filter) (VIRTUAL-AUDIO-SOURCE virtual-source) ID
Source

source.lisp (file)

Method: (setf filter) (NULL null) (TED-SID ted-sid-source) ID
Source

source.lisp (file)

Method: (setf filter) (FILTER filter) (TED-SID ted-sid-source) ID
Source

source.lisp (file)

Method: (setf filter) (NULL null) (MONOTONE monotone-source) ID
Source

source.lisp (file)

Method: (setf filter) (FILTER filter) (MONOTONE monotone-source) ID
Source

source.lisp (file)

Method: (setf filter) (NULL null) (SFXR sfxr-source) ID
Source

source.lisp (file)

Method: (setf filter) (FILTER filter) (SFXR sfxr-source) ID
Source

source.lisp (file)

Method: (setf filter) (NULL null) (SPEECH speech-source) ID
Source

source.lisp (file)

Method: (setf filter) (FILTER filter) (SPEECH speech-source) ID
Source

source.lisp (file)

Method: (setf filter) (NULL null) (WAV-STREAM wav-stream-source) ID
Source

source.lisp (file)

Method: (setf filter) (FILTER filter) (WAV-STREAM wav-stream-source) ID
Source

source.lisp (file)

Method: (setf filter) (NULL null) (WAV wav-source) ID
Source

source.lisp (file)

Method: (setf filter) (FILTER filter) (WAV wav-source) ID
Source

source.lisp (file)

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 (file)

Generic Function: filter-parameter PLAYBACK FILTER ATTRIBUTE

Accessor to a parameter of the filter.

See PLAYBACK
See FILTER

Package

cl-soloud

Writer

(setf filter-parameter) (generic function)

Methods
Method: filter-parameter (PLAYBACK playback) FILTER ATTRIBUTE
Source

soloud.lisp (file)

Generic Function: (setf filter-parameter) VALUE PLAYBACK FILTER ATTRIBUTE
Package

cl-soloud

Reader

filter-parameter (generic function)

Methods
Method: (setf filter-parameter) VALUE (PLAYBACK playback) FILTER ATTRIBUTE
Source

soloud.lisp (file)

Generic Function: flags VIRTUAL-SOURCE

Accessor to the list of active flags for the source.

See VIRTUAL-SOURCE

Package

cl-soloud

Writer

(setf flags) (generic function)

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

source.lisp (file)

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

source.lisp (file)

Generic Function: (setf flags) VALUE VIRTUAL-SOURCE
Package

cl-soloud

Reader

flags (generic function)

Methods
Method: (setf flags) VALUE (VIRTUAL-SOURCE virtual-source)
Source

source.lisp (file)

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 (file)

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 (file)

Methods
Method: get-audio (SOURCE mp3-source) DST SAMPLES
Source

mp3.lisp (file)

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 (file)

Methods
Method: get-info (SOURCE mp3-source) INFO-KEY
Source

mp3.lisp (file)

Generic Function: handle OBJECT

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

See C-BACKED-OBJECT

Package

cl-soloud

Writer

(setf handle) (generic function)

Methods
Method: handle (C-BACKED-OBJECT c-backed-object)

automatically generated reader method

Source

toolkit.lisp (file)

Generic Function: (setf handle) NEW-VALUE OBJECT
Package

cl-soloud

Reader

handle (generic function)

Methods
Method: (setf handle) NEW-VALUE (C-BACKED-OBJECT c-backed-object)

automatically generated writer method

Source

toolkit.lisp (file)

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 (file)

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

mp3.lisp (file)

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

Writer

(setf inaudible-behavior) (generic function)

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

source.lisp (file)

Generic Function: (setf inaudible-behavior) VALUE WAV
Package

cl-soloud

Reader

inaudible-behavior (generic function)

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

bus.lisp (file)

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

soloud.lisp (file)

Method: (setf inaudible-behavior) VALUE (VIRTUAL-AUDIO-SOURCE virtual-source)
Source

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

Writer

(setf inaudible-kill-p) (generic function)

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

source.lisp (file)

Generic Function: (setf inaudible-kill-p) ACTIVE VIRTUAL-SOURCE
Package

cl-soloud

Reader

inaudible-kill-p (generic function)

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

source.lisp (file)

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

Writer

(setf inaudible-tick-p) (generic function)

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

source.lisp (file)

Generic Function: (setf inaudible-tick-p) ACTIVE VIRTUAL-SOURCE
Package

cl-soloud

Reader

inaudible-tick-p (generic function)

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

source.lisp (file)

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 (file)

Writer

(setf listener-relative-p) (generic function)

Generic Function: (setf listener-relative-p) VALUE WAV
Package

cl-soloud

Reader

listener-relative-p (generic function)

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

bus.lisp (file)

Method: (setf listener-relative-p) VALUE (VIRTUAL-AUDIO-SOURCE virtual-source)
Source

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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 (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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 (file)

Method: load-mem (SOURCE monotone-source) POINTER LENGTH &key COPY TAKE-OWNERSHIP
Source

source.lisp (file)

Method: load-mem (SOURCE sfxr-source) POINTER LENGTH &key COPY TAKE-OWNERSHIP
Source

source.lisp (file)

Method: load-mem (SOURCE wav-stream-source) POINTER LENGTH &key COPY TAKE-OWNERSHIP
Source

source.lisp (file)

Method: load-mem (SOURCE wav-source) POINTER LENGTH &key COPY TAKE-OWNERSHIP
Source

source.lisp (file)

Method: load-mem (SOURCE source) POINTER LENGTH &key around
Source

source.lisp (file)

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 (file)

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 (file)

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

Writer

(setf location) (generic function)

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

source.lisp (file)

Generic Function: (setf location) VALUE SOLOUD
Package

cl-soloud

Reader

location (generic function)

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

soloud.lisp (file)

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

soloud.lisp (file)

Generic Function: looping-p PLAYBACK

Accessor to whether the playback should loop or not.

See PLAYBACK
See SOURCE

Package

cl-soloud

Writer

(setf looping-p) (generic function)

Methods
Method: looping-p (PLAYBACK playback)
Source

soloud.lisp (file)

Generic Function: (setf looping-p) VALUE WAV
Package

cl-soloud

Reader

looping-p (generic function)

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

bus.lisp (file)

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

soloud.lisp (file)

Method: (setf looping-p) VALUE (VIRTUAL-AUDIO-SOURCE virtual-source)
Source

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

Writer

(setf max-active-playback-count) (generic function)

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

soloud.lisp (file)

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

cl-soloud

Reader

max-active-playback-count (generic function)

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

soloud.lisp (file)

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

Writer

(setf min-max-distance) (generic function)

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

source.lisp (file)

Generic Function: (setf min-max-distance) VALUE WAV
Package

cl-soloud

Reader

min-max-distance (generic function)

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

bus.lisp (file)

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

soloud.lisp (file)

Method: (setf min-max-distance) VALUE (VIRTUAL-AUDIO-SOURCE virtual-source)
Source

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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 (file)

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 (file)

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 (file)

Method: oscillate-volume (SOLOUD soloud) FROM TO TIME
Source

soloud.lisp (file)

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

Writer

(setf pan) (generic function)

Methods
Method: pan (PLAYBACK playback)
Source

soloud.lisp (file)

Generic Function: (setf pan) PAN PLAYBACK &key FADE
Package

cl-soloud

Reader

pan (generic function)

Methods
Method: (setf pan) PAN (PLAYBACK playback) &key FADE
Source

soloud.lisp (file)

Generic Function: paused-p PLAYBACK

Accessor to whether the playback is currently paused.

See PLAYBACK

Package

cl-soloud

Writer

(setf paused-p) (generic function)

Methods
Method: paused-p (PLAYBACK playback)
Source

soloud.lisp (file)

Generic Function: (setf paused-p) VALUE PLAYBACK
Package

cl-soloud

Reader

paused-p (generic function)

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

soloud.lisp (file)

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 (file)

Methods
Method: play (SOURCE source) (BUS bus) &key VOLUME PAN PAUSED DELAY LOCATION VELOCITY
Source

bus.lisp (file)

Method: play (SOURCE bus) (TARGET bus) &key after
Source

bus.lisp (file)

Method: play (SOURCE bus) (TARGET soloud) &key after
Source

bus.lisp (file)

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 (file)

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 (file)

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 (file)

Method: pointer->object POINTER
Source

toolkit.lisp (file)

Method: pointer->object (POINTER integer)
Source

toolkit.lisp (file)

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

Writer

(setf protected-p) (generic function)

Methods
Method: protected-p (PLAYBACK playback)
Source

soloud.lisp (file)

Generic Function: (setf protected-p) VALUE PLAYBACK
Package

cl-soloud

Reader

protected-p (generic function)

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

soloud.lisp (file)

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

Writer

(setf relative-speed) (generic function)

Methods
Method: relative-speed (PLAYBACK playback)
Source

soloud.lisp (file)

Generic Function: (setf relative-speed) RELATIVE-SPEED PLAYBACK &key FADE
Package

cl-soloud

Reader

relative-speed (generic function)

Methods
Method: (setf relative-speed) RELATIVE-SPEED (PLAYBACK playback) &key FADE
Source

soloud.lisp (file)

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 (file)

Methods
Method: rewind (SOURCE mp3-source)
Source

mp3.lisp (file)

Generic Function: sample-rate PLAYBACK

Returns the sample rate used by the source or target.

See SOLOUD
See SOURCE

Package

cl-soloud

Writer

(setf sample-rate) (generic function)

Methods
Method: sample-rate (PLAYBACK playback)
Source

soloud.lisp (file)

Generic Function: (setf sample-rate) SAMPLE-RATE PLAYBACK
Package

cl-soloud

Reader

sample-rate (generic function)

Methods
Method: (setf sample-rate) SAMPLE-RATE (PLAYBACK playback)
Source

soloud.lisp (file)

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 (file)

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 (file)

Methods
Method: seek-to (SOURCE mp3-source) TIME SCRATCH SIZE
Source

mp3.lisp (file)

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 (file)

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 (file)

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

Writer

(setf single-instance-p) (generic function)

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

source.lisp (file)

Generic Function: (setf single-instance-p) ACTIVE VIRTUAL-SOURCE
Package

cl-soloud

Reader

single-instance-p (generic function)

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

source.lisp (file)

Generic Function: soloud OBJECT

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

See BUS
See PLAYBACK

Package

cl-soloud

Writer

(setf soloud) (generic function)

Methods
Method: soloud (PLAYBACK playback) around
Source

bus.lisp (file)

Method: soloud (BUS bus) around
Source

bus.lisp (file)

Method: soloud (SOLOUD soloud)
Source

bus.lisp (file)

Method: soloud (BUS bus)

automatically generated reader method

Source

bus.lisp (file)

Method: soloud (PLAYBACK playback)

automatically generated reader method

Source

soloud.lisp (file)

Generic Function: (setf soloud) NEW-VALUE OBJECT
Package

cl-soloud

Reader

soloud (generic function)

Methods
Method: (setf soloud) NEW-VALUE (BUS bus)

automatically generated writer method

Source

bus.lisp (file)

Method: (setf soloud) NEW-VALUE (PLAYBACK playback)

automatically generated writer method

Source

soloud.lisp (file)

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

Writer

(setf sound-speed) (generic function)

Methods
Method: sound-speed (SOLOUD soloud)
Source

soloud.lisp (file)

Generic Function: (setf sound-speed) VALUE SOLOUD
Package

cl-soloud

Reader

sound-speed (generic function)

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

soloud.lisp (file)

Generic Function: source OBJECT

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

See PLAYBACK

Package

cl-soloud

Writer

(setf source) (generic function)

Methods
Method: source (PLAYBACK playback)

automatically generated reader method

Source

soloud.lisp (file)

Generic Function: (setf source) NEW-VALUE OBJECT
Package

cl-soloud

Reader

source (generic function)

Methods
Method: (setf source) NEW-VALUE (PLAYBACK playback)

automatically generated writer method

Source

soloud.lisp (file)

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 (file)

Method: stop (SOLOUD soloud)
Source

soloud.lisp (file)

Method: stop (PLAYBACK playback)
Source

soloud.lisp (file)

Method: stop (VIRTUAL-AUDIO-SOURCE virtual-source)
Source

source.lisp (file)

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

source.lisp (file)

Method: stop (MONOTONE monotone-source)
Source

source.lisp (file)

Method: stop (SFXR sfxr-source)
Source

source.lisp (file)

Method: stop (SPEECH speech-source)
Source

source.lisp (file)

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

source.lisp (file)

Method: stop (WAV wav-source)
Source

source.lisp (file)

Generic Function: up OBJECT

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

See SOLOUD

Package

cl-soloud

Source

soloud.lisp (file)

Writer

(setf up) (generic function)

Generic Function: (setf up) VALUE SOLOUD
Package

cl-soloud

Reader

up (generic function)

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

soloud.lisp (file)

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

Writer

(setf velocity) (generic function)

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

source.lisp (file)

Generic Function: (setf velocity) VALUE SOLOUD
Package

cl-soloud

Reader

velocity (generic function)

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

soloud.lisp (file)

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

soloud.lisp (file)

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

Writer

(setf volume) (generic function)

Methods
Method: volume (PLAYBACK playback)
Source

soloud.lisp (file)

Method: volume (SOLOUD soloud)
Source

soloud.lisp (file)

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

source.lisp (file)

Generic Function: (setf volume) VALUE WAV &key FADE
Package

cl-soloud

Reader

volume (generic function)

Methods
Method: (setf volume) VALUE (BUS bus) &key FADE
Source

bus.lisp (file)

Method: (setf volume) VOLUME (PLAYBACK playback) &key FADE
Source

soloud.lisp (file)

Method: (setf volume) VOLUME (SOLOUD soloud) &key FADE
Source

soloud.lisp (file)

Method: (setf volume) VALUE (VIRTUAL-AUDIO-SOURCE virtual-source) &key FADE
Source

source.lisp (file)

Method: (setf volume) VALUE (TED-SID ted-sid-source) &key FADE
Source

source.lisp (file)

Method: (setf volume) VALUE (MONOTONE monotone-source) &key FADE
Source

source.lisp (file)

Method: (setf volume) VALUE (SFXR sfxr-source) &key FADE
Source

source.lisp (file)

Method: (setf volume) VALUE (SPEECH speech-source) &key FADE
Source

source.lisp (file)

Method: (setf volume) VALUE (WAV-STREAM wav-stream-source) &key FADE
Source

source.lisp (file)

Method: (setf volume) VALUE (WAV wav-source) &key FADE
Source

source.lisp (file)

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 (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Classes

Class: attenuator ()

Superclass for all audio attenuators.

See ATTENUATOR
See VIRTUAL-ATTENUATOR

Package

cl-soloud

Source

source.lisp (file)

Direct superclasses

c-backed-object (class)

Direct subclasses

virtual-attenuator (class)

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 (file)

Direct superclasses

filter (class)

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 (file)

Direct superclasses

filter (class)

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 (file)

Direct superclasses

source (class)

Direct methods
Direct slots
Slot: soloud
Readers

soloud (generic function)

Writers

(setf soloud) (generic function)

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 (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: handle
Initargs

:handle

Readers

handle (generic function)

Writers

(setf handle) (generic function)

Class: collider ()

Superclass for all audio colliders.

See COLLIDER
See VIRTUAL-COLLIDER

Package

cl-soloud

Source

source.lisp (file)

Direct superclasses

c-backed-object (class)

Direct subclasses

virtual-collider (class)

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 (file)

Direct superclasses

filter (class)

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 (file)

Direct superclasses

filter (class)

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 (file)

Direct superclasses

filter (class)

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 (file)

Direct superclasses

c-backed-object (class)

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 (file)

Direct superclasses

filter (class)

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 (file)

Direct superclasses

playback (class)

Direct methods
  • add (method)
  • initialize-instance (method)
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 (file)

Direct superclasses

filter (class)

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 (file)

Direct superclasses

source (class)

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 (file)

Direct superclasses

virtual-source (class)

Direct methods
Direct slots
Slot: file
Readers

file (generic function)

Writers

(setf file) (generic function)

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 (file)

Direct superclasses

standard-object (class)

Direct subclasses

group (class)

Direct methods
Direct slots
Slot: handle
Initargs

:handle

Slot: soloud
Initargs

:soloud

Readers

soloud (generic function)

Writers

(setf soloud) (generic function)

Slot: source
Initargs

:source

Readers

source (generic function)

Writers

(setf source) (generic function)

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 (file)

Direct superclasses

source (class)

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 (file)

Direct superclasses

c-backed-object (class)

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 (file)

Direct superclasses

c-backed-object (class)

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

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

Readers

filter-map (generic function)

Writers

(setf filter-map) (generic function)

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 (file)

Direct superclasses

source (class)

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 (file)

Direct superclasses

source (class)

Direct methods
Class: virtual-attenuator ()

Superclass to create your own, custom attenuators.

You must implement the ATTENUATE method.

Package

cl-soloud

Source

source.lisp (file)

Direct superclasses

attenuator (class)

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 (file)

Direct superclasses

collider (class)

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 (file)

Direct superclasses

filter (class)

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 (file)

Direct superclasses

source (class)

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 (file)

Direct superclasses

source (class)

Direct methods

Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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 (file)

Special Variable: *here*
Package

cl-soloud-cffi

Source

low-level.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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 (file)

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 (file)

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 (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: compute-soloud-flags FLAGS
Package

cl-soloud

Source

soloud.lisp (file)

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 (file)

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 (file)

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 (file)

Function: load-wav-stream-file-to-mem WAV-STREAM FILE
Package

cl-soloud-cffi

Source

low-level.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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 (file)

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 (file)

Generic Function: create-handle BIQUAD-RESONANT-FILTER
Package

cl-soloud

Methods
Method: create-handle (BUS bus)
Source

bus.lisp (file)

Method: create-handle (SOLOUD soloud)
Source

soloud.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

Method: create-handle (VIRTUAL-AUDIO-SOURCE virtual-source)
Source

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

filter.lisp (file)

Method: create-handle (BASS-BOOST-FILTER bass-boost-filter)
Source

filter.lisp (file)

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

filter.lisp (file)

Method: create-handle (DC-REMOVAL-FILTER dc-removal-filter)
Source

filter.lisp (file)

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

filter.lisp (file)

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

filter.lisp (file)

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

filter.lisp (file)

Method: create-handle (BIQUAD-RESONANT-FILTER biquad-resonant-filter)
Source

filter.lisp (file)

Generic Function: destroy-handle BIQUAD-RESONANT-FILTER HANDLE
Package

cl-soloud

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

bus.lisp (file)

Method: destroy-handle (SOLOUD soloud) HANDLE
Source

soloud.lisp (file)

Method: destroy-handle (VIRTUAL-ATTENUATOR virtual-attenuator) HANDLE
Source

source.lisp (file)

Method: destroy-handle (VIRTUAL-COLLIDER virtual-collider) HANDLE
Source

source.lisp (file)

Method: destroy-handle (VIRTUAL-AUDIO-SOURCE virtual-source) HANDLE
Source

source.lisp (file)

Method: destroy-handle (TED-SID ted-sid-source) HANDLE
Source

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

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

source.lisp (file)

Method: destroy-handle (WAV-STREAM wav-stream-source) HANDLE
Source

source.lisp (file)

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

source.lisp (file)

Method: destroy-handle (VIRTUAL-FILTER virtual-filter) HANDLE
Source

filter.lisp (file)

Method: destroy-handle (BASS-BOOST-FILTER bass-boost-filter) HANDLE
Source

filter.lisp (file)

Method: destroy-handle (FFT-FILTER fft-filter) HANDLE
Source

filter.lisp (file)

Method: destroy-handle (DC-REMOVAL-FILTER dc-removal-filter) HANDLE
Source

filter.lisp (file)

Method: destroy-handle (FLANGER-FILTER flanger-filter) HANDLE
Source

filter.lisp (file)

Method: destroy-handle (LOFI-FILTER lofi-filter) HANDLE
Source

filter.lisp (file)

Method: destroy-handle (ECHO-FILTER echo-filter) HANDLE
Source

filter.lisp (file)

Method: destroy-handle (BIQUAD-RESONANT-FILTER biquad-resonant-filter) HANDLE
Source

filter.lisp (file)

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 (file)

Generic Function: file OBJECT

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

See MP3-SOURCE

Package

cl-soloud

Writer

(setf file) (generic function)

Methods
Method: file (MP3-SOURCE mp3-source)

automatically generated reader method

Source

mp3.lisp (file)

Generic Function: (setf file) NEW-VALUE OBJECT
Package

cl-soloud

Reader

file (generic function)

Methods
Method: (setf file) NEW-VALUE (MP3-SOURCE mp3-source)

automatically generated writer method

Source

mp3.lisp (file)

Generic Function: filter-map OBJECT

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

See SOURCE
See FILTER

Package

cl-soloud

Writer

(setf filter-map) (generic function)

Methods
Method: filter-map (SOURCE source)

automatically generated reader method

Source

source.lisp (file)

Generic Function: (setf filter-map) NEW-VALUE OBJECT
Package

cl-soloud

Reader

filter-map (generic function)

Methods
Method: (setf filter-map) NEW-VALUE (SOURCE source)

automatically generated writer method

Source

source.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

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 (file)

Direct superclasses

c-backed-object (class)

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 (file)

Direct superclasses

source (class)

Direct subclasses

mp3-source (class)

Direct methods

Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-soloud.asd: The cl-soloud<dot>asd file
cl-soloud/bus.lisp: The cl-soloud/bus<dot>lisp file
cl-soloud/documentation.lisp: The cl-soloud/documentation<dot>lisp file
cl-soloud/filter.lisp: The cl-soloud/filter<dot>lisp file
cl-soloud/low-level.lisp: The cl-soloud/low-level<dot>lisp file
cl-soloud/mp3.lisp: The cl-soloud/mp3<dot>lisp file
cl-soloud/package.lisp: The cl-soloud/package<dot>lisp file
cl-soloud/soloud.lisp: The cl-soloud/soloud<dot>lisp file
cl-soloud/source.lisp: The cl-soloud/source<dot>lisp file
cl-soloud/toolkit.lisp: The cl-soloud/toolkit<dot>lisp file

F
File, Lisp, cl-soloud.asd: The cl-soloud<dot>asd file
File, Lisp, cl-soloud/bus.lisp: The cl-soloud/bus<dot>lisp file
File, Lisp, cl-soloud/documentation.lisp: The cl-soloud/documentation<dot>lisp file
File, Lisp, cl-soloud/filter.lisp: The cl-soloud/filter<dot>lisp file
File, Lisp, cl-soloud/low-level.lisp: The cl-soloud/low-level<dot>lisp file
File, Lisp, cl-soloud/mp3.lisp: The cl-soloud/mp3<dot>lisp file
File, Lisp, cl-soloud/package.lisp: The cl-soloud/package<dot>lisp file
File, Lisp, cl-soloud/soloud.lisp: The cl-soloud/soloud<dot>lisp file
File, Lisp, cl-soloud/source.lisp: The cl-soloud/source<dot>lisp file
File, Lisp, cl-soloud/toolkit.lisp: The cl-soloud/toolkit<dot>lisp file

L
Lisp File, cl-soloud.asd: The cl-soloud<dot>asd file
Lisp File, cl-soloud/bus.lisp: The cl-soloud/bus<dot>lisp file
Lisp File, cl-soloud/documentation.lisp: The cl-soloud/documentation<dot>lisp file
Lisp File, cl-soloud/filter.lisp: The cl-soloud/filter<dot>lisp file
Lisp File, cl-soloud/low-level.lisp: The cl-soloud/low-level<dot>lisp file
Lisp File, cl-soloud/mp3.lisp: The cl-soloud/mp3<dot>lisp file
Lisp File, cl-soloud/package.lisp: The cl-soloud/package<dot>lisp file
Lisp File, cl-soloud/soloud.lisp: The cl-soloud/soloud<dot>lisp file
Lisp File, cl-soloud/source.lisp: The cl-soloud/source<dot>lisp file
Lisp File, cl-soloud/toolkit.lisp: The cl-soloud/toolkit<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

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

3
3d-processed-p: Exported generic functions

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

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

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

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

E
encode-audio-source-flags: Internal functions

F
fade-filter-parameter: Exported functions
fade-global-volume: Exported functions
fade-pan: Exported functions
fade-relative-play-speed: Exported functions
fade-volume: Exported functions
file: Internal generic functions
file: Internal generic functions
filter: Exported generic functions
filter: Exported generic functions
filter-channel: Exported generic functions
filter-map: Internal generic functions
filter-map: Internal generic functions
filter-parameter: Exported generic functions
filter-parameter: Exported generic functions
find-cffi-symbol: Internal functions
flags: Exported generic functions
flags: Exported generic functions
flags: Exported generic functions
free: Exported generic functions
free: Exported generic functions
Function, add-voice-to-group: Exported functions
Function, attenuate-audio-attenuator: Exported functions
Function, bus-calc-fft: Exported functions
Function, bus-play: Exported functions
Function, bus-play*: Exported functions
Function, bus-play-3d: Exported functions
Function, bus-play-3d*: Exported functions
Function, bus-play-3d-clocked: Exported functions
Function, bus-play-3d-clocked*: Exported functions
Function, bus-play-clocked: Exported functions
Function, bus-play-clocked*: Exported functions
Function, calc-fft: Exported functions
Function, compute-soloud-flags: Internal functions
Function, create: Exported functions
Function, create-bass-boost-filter: Exported functions
Function, create-biquad-resonant-filter: Exported functions
Function, create-bus: Exported functions
Function, create-dc-removal-filter: Exported functions
Function, create-echo-filter: Exported functions
Function, create-fft-filter: Exported functions
Function, create-flanger-filter: Exported functions
Function, create-lofi-filter: Exported functions
Function, create-monotone: Exported functions
Function, create-openmpt: Exported functions
Function, create-prg: Exported functions
Function, create-sfxr: Exported functions
Function, create-speech: Exported functions
Function, create-ted-sid: Exported functions
Function, create-virtual-audio-attenuator: Exported functions
Function, create-virtual-audio-collider: Exported functions
Function, create-virtual-audio-source: Exported functions
Function, create-virtual-filter: Exported functions
Function, create-voice-group: Exported functions
Function, create-wav: Exported functions
Function, create-wav-stream: Exported functions
Function, decode-audio-source-flags: Internal functions
Function, deinit: Exported functions
Function, destroy: Exported functions
Function, destroy-audio-attenuator: Exported functions
Function, destroy-bass-boost-filter: Exported functions
Function, destroy-biquad-resonant-filter: Exported functions
Function, destroy-bus: Exported functions
Function, destroy-dc-removal-filter: Exported functions
Function, destroy-echo-filter: Exported functions
Function, destroy-fft-filter: Exported functions
Function, destroy-flanger-filter: Exported functions
Function, destroy-lofi-filter: Exported functions
Function, destroy-monotone: Exported functions
Function, destroy-openmpt: Exported functions
Function, destroy-prg: Exported functions
Function, destroy-sfxr: Exported functions
Function, destroy-speech: Exported functions
Function, destroy-ted-sid: Exported functions
Function, destroy-virtual-audio-attenuator: Exported functions
Function, destroy-virtual-audio-collider: Exported functions
Function, destroy-virtual-audio-source: Exported functions
Function, destroy-virtual-filter: Exported functions
Function, destroy-voice-group: Exported functions
Function, destroy-wav: Exported functions
Function, destroy-wav-stream: Exported functions
Function, encode-audio-source-flags: Internal functions
Function, fade-filter-parameter: Exported functions
Function, fade-global-volume: Exported functions
Function, fade-pan: Exported functions
Function, fade-relative-play-speed: Exported functions
Function, fade-volume: Exported functions
Function, find-cffi-symbol: Internal functions
Function, get-3d-sound-speed: Exported functions
Function, get-active-voice-count: Exported functions
Function, get-audio-source-instance-3d-data-attenuation-model: Exported functions
Function, get-audio-source-instance-3d-data-attenuation-rolloff: Exported functions
Function, get-audio-source-instance-3d-data-audio-attenuator: Exported functions
Function, get-audio-source-instance-3d-data-audio-collider: Exported functions
Function, get-audio-source-instance-3d-data-channel-volume: Exported functions
Function, get-audio-source-instance-3d-data-collider-data: Exported functions
Function, get-audio-source-instance-3d-data-doppler-factor: Exported functions
Function, get-audio-source-instance-3d-data-doppler-value: Exported functions
Function, get-audio-source-instance-3d-data-flags: Exported functions
Function, get-audio-source-instance-3d-data-handle: Exported functions
Function, get-audio-source-instance-3d-data-max-distance: Exported functions
Function, get-audio-source-instance-3d-data-min-distance: Exported functions
Function, get-audio-source-instance-3d-data-position: Exported functions
Function, get-audio-source-instance-3d-data-velocity: Exported functions
Function, get-audio-source-instance-3d-data-volume: Exported functions
Function, get-backend-buffer-size: Exported functions
Function, get-backend-channels: Exported functions
Function, get-backend-id: Exported functions
Function, get-backend-sample-rate: Exported functions
Function, get-backend-string: Exported functions
Function, get-bus-wave: Exported functions
Function, get-error-string: Exported functions
Function, get-filter-parameter: Exported functions
Function, get-global-volume: Exported functions
Function, get-info: Exported functions
Function, get-loop-count: Exported functions
Function, get-looping: Exported functions
Function, get-max-active-voice-count: Exported functions
Function, get-overall-volume: Exported functions
Function, get-pan: Exported functions
Function, get-pause: Exported functions
Function, get-post-clip-scaler: Exported functions
Function, get-protect-voice: Exported functions
Function, get-relative-play-speed: Exported functions
Function, get-sample-rate: Exported functions
Function, get-stream-time: Exported functions
Function, get-version: Exported functions
Function, get-virtual-audio-source-base-samplerate: Exported functions
Function, get-virtual-audio-source-channels: Exported functions
Function, get-virtual-audio-source-flags: Exported functions
Function, get-voice-count: Exported functions
Function, get-volume: Exported functions
Function, get-wav-length: Exported functions
Function, get-wav-stream-length: Exported functions
Function, get-wave: Exported functions
Function, init: Exported functions
Function, init*: Exported functions
Function, is-valid-voice-handle: Exported functions
Function, is-voice-group: Exported functions
Function, is-voice-group-empty: Exported functions
Function, load-monotone: Exported functions
Function, load-monotone-file: Exported functions
Function, load-monotone-mem: Exported functions
Function, load-monotone-mem*: Exported functions
Function, load-openmpt: Exported functions