Moduleproteaaudio-sdl-0.10.1Haskell2010

Sound.ProteaAudio.SDL

ProteaAudio-SDL is a stereo audio mixer and playback library for SDL (platform independent)

Contents

Sample
Audio System Setup
Main Mixer
Sample Loading
Sample Playback

Synopsis

newtype Sample
newtype Sound
value initAudio
value finishAudio
value volume
value soundActiveAll
value soundStopAll
value loaderAvailable
value sampleFromMemoryPcm
value sampleFromMemoryWav
value sampleFromMemoryOgg
value sampleFromMemoryMp3
value sampleFromMemory
value sampleFromFile
value sampleDestroy
value soundLoop
value soundPlay
value soundLoopOn
value soundPlayOn
value soundUpdate
value soundStop
value soundActive

Packageproteaaudio-sdl-0.10.1
Exports22
LanguageHaskell2010
LicenceBSD-3-Clause
SourceSDL.chs

Sample

newtypenewtype Sample

Source#

Audio sample resource handle. A sample can be shared between multiple Sound tracks. (abstraction for data)

newtypenewtype Sound

Source#

Sound track handle. It is used to control the audio playback. (abstraction for playback)

Audio System Setup

valueinitAudio

:: Int
the maximum number of sounds that are played parallely, at most 1024. Computation time is linearly correlated to this factor.
-> Int
sample frequency of the playback in Hz. 22050 corresponds to FM radio 44100 is CD quality. Computation time is linearly correlated to this factor.
-> Int
the number of bytes that are sent to the sound card at once. Low numbers lead to smaller latencies but need more computation time (thread switches). If a too small number is chosen, the sounds might not be played continuously. The default value 512 guarantees a good latency below 40 ms at 22050 Hz sample frequency.
-> IO Bool
returns True on success

Source#

Initializes the audio system.

valuefinishAudio :: IO ()

Source#

Releases the audio device and cleans up resources.

Main Mixer

valuevolume

:: Float
left
-> Float
right
-> IO ()

Source#

Set main mixer volume.

valuesoundActiveAll :: IO Int

Source#

Return the number of currently active sounds.

valuesoundStopAll :: IO ()

Source#

Stops all sounds immediately.

Sample Loading

valueloaderAvailable

:: String
file extension (e.g. ogg)
-> IO Bool

Source#

Checks if loader for this file type is available.

valuesampleFromMemoryPcm

:: ByteString
pcm sample data; array of pcm samples (signed 8 bit int, signed 16 bit int or 32 bit float)
-> Int
number of channels, e.g. 1 for mono, 2 for stereo.
-> Int
sample rate, i.e. 44100 Hz
-> Int
bits per sample, i.e. 8, 16, 32
-> Float
volume
-> IO Sample
return sample handle

Source#

Loads raw linear pcm sound sample from memory buffer.

valuesampleFromMemoryWav

:: ByteString
wav sample data
-> Float
volume
-> IO Sample
return sample handle

Source#

Loads wav sound sample from memory buffer.

valuesampleFromMemoryOgg

:: ByteString
ogg sample data
-> Float
volume
-> IO Sample
return sample handle

Source#

Loads ogg sound sample from memory buffer.

valuesampleFromMemoryMp3

:: ByteString
mp3 sample data
-> Float
volume
-> IO Sample
return sample handle

Source#

Loads mp3 sound sample from memory buffer.

valuesampleFromMemory :: ByteString -> Float -> IO Sample

Source#

Loads wav, ogg or mp3 sound sample from memory buffer (autodetects audio format).

valuesampleFromFile

:: String
sample filepath
-> Float
volume
-> IO Sample
returns handle

Source#

Loads a sound sample from file.

valuesampleDestroy :: Sample -> IO Bool

Source#

Unloads a previously loaded sample from memory, invalidating the handle.

Sample Playback

valuesoundLoop

:: Sample
handle of a previously loaded sample
-> Float
left volume
-> Float
right volume
-> Float
time difference between left and right channel in seconds. Use negative values to specify a delay for the left channel, positive for the right
-> Float
pitch factor for playback. 0.5 corresponds to one octave below, 2.0 to one above the original sample
-> IO Sound

Source#

Plays a specified sound sample continuously any free channel and sets its parameters.

valuesoundPlay

:: Sample
handle of a previously loaded sample
-> Float
left volume
-> Float
right volume
-> Float
time difference between left and right channel in seconds. Use negative values to specify a delay for the left channel, positive for the right
-> Float
pitch factor for playback. 0.5 corresponds to one octave below, 2.0 to one above the original sample
-> IO Sound

Source#

Plays a specified sound sample once any free channel and sets its parameters.

valuesoundLoopOn

:: Int
number of the channel to use for playback with the first channel starting at 0
-> Sample
handle of a previously loaded sample
-> Float
left volume
-> Float
right volume
-> Float
time difference between left and right channel in seconds. Use negative values to specify a delay for the left channel, positive for the right
-> Float
pitch factor for playback. 0.5 corresponds to one octave below, 2.0 to one above the original sample
-> IO Sound

Source#

Plays a specified sound sample continuously on a specific channel and sets its parameters.

valuesoundPlayOn

:: Int
number of the channel to use for playback with the first channel starting at 0
-> Sample
handle of a previously loaded sample
-> Float
left volume
-> Float
right volume
-> Float
time difference between left and right channel in seconds. Use negative values to specify a delay for the left channel, positive for the right
-> Float
pitch factor for playback. 0.5 corresponds to one octave below, 2.0 to one above the original sample
-> IO Sound

Source#

Plays a specified sound sample once on a specific channel and sets its parameters.

valuesoundUpdate

:: Sound
handle of a currently active sound (if sound has stopped, this is a no-op)
-> Bool
is paused state, this does not change the sound active state
-> Float
left volume
-> Float
right volume
-> Float
time difference between left and right channel in seconds. Use negative values to specify a delay for the left channel, positive for the right
-> Float
pitch factor for playback. 0.5 corresponds to one octave below, 2.0 to one above the original sample
-> IO Bool
return True in case the parameters have been updated successfully

Source#

Updates parameters of a specified sound.

valuesoundStop :: Sound -> IO Bool

Source#

Stops a specified sound immediately.

valuesoundActive :: Sound -> IO Bool

Source#

Checks if a specified sound is still active.