Safe Haskell	None
Language	Haskell2010

SDL.Audio

Contents

Managing AudioDevices
AudioSpec
Audio Drivers
Explicit Initialization

Description

SDL.Audio provides a high-level API to SDL's audio device capabilities.

Synopsis

Managing `AudioDevice`s

data AudioDevice Source #

An open audio device. These can be created via openAudioDevice and should be closed with closeAudioDevice

Instances

Eq AudioDevice Source #
Methods (==) :: AudioDevice -> AudioDevice -> Bool # (/=) :: AudioDevice -> AudioDevice -> Bool #

Opening and Closing `AudioDevice`s

openAudioDevice :: MonadIO m => OpenDeviceSpec -> m (AudioDevice, AudioSpec) Source #

Attempt to open the closest matching AudioDevice, as specified by the given OpenDeviceSpec.

See SDL_OpenAudioDevice for C documentation.

closeAudioDevice :: MonadIO m => AudioDevice -> m () Source #

See SDL_CloseAudioDevice for C documentation.

data OpenDeviceSpec Source #

A specification to openAudioDevice, indicating the desired output format. Note that many of these properties are Changeable, meaning that you can choose whether or not SDL should interpret your specification as an unbreakable request (Mandate), or as an approximation Desire.

Constructors

OpenDeviceSpec

Fields

openDeviceFreq :: !(Changeable CInt)
The output audio frequency in herts.
openDeviceFormat :: !(Changeable (AudioFormat sampleType))
The format of audio that will be sampled from the output buffer.
openDeviceChannels :: !(Changeable Channels)
The amount of audio channels.
openDeviceSamples :: !Word16
Output audio buffer size in samples. This should be a power of 2.
openDeviceCallback :: forall actualSampleType. AudioFormat actualSampleType -> IOVector actualSampleType -> IO ()
A callback to invoke whenever new sample data is required. The callback will be passed a single MVector that must be filled with audio data.
openDeviceUsage :: !AudioDeviceUsage
How you intend to use the opened AudioDevice - either for outputting or capturing audio.
openDeviceName :: !(Maybe Text)
The name of the AudioDevice that should be opened. If Nothing, any suitable AudioDevice will be used.

data AudioDeviceUsage Source #

How you intend to use an AudioDevice

Constructors

ForPlayback	The device will be used for sample playback.
ForCapture	The device will be used for sample capture.

Instances

Bounded AudioDeviceUsage Source #
Methods minBound :: AudioDeviceUsage # maxBound :: AudioDeviceUsage #
Enum AudioDeviceUsage Source #
Methods succ :: AudioDeviceUsage -> AudioDeviceUsage # pred :: AudioDeviceUsage -> AudioDeviceUsage # toEnum :: Int -> AudioDeviceUsage # fromEnum :: AudioDeviceUsage -> Int # enumFrom :: AudioDeviceUsage -> [AudioDeviceUsage] # enumFromThen :: AudioDeviceUsage -> AudioDeviceUsage -> [AudioDeviceUsage] # enumFromTo :: AudioDeviceUsage -> AudioDeviceUsage -> [AudioDeviceUsage] # enumFromThenTo :: AudioDeviceUsage -> AudioDeviceUsage -> AudioDeviceUsage -> [AudioDeviceUsage] #
Eq AudioDeviceUsage Source #
Methods (==) :: AudioDeviceUsage -> AudioDeviceUsage -> Bool # (/=) :: AudioDeviceUsage -> AudioDeviceUsage -> Bool #
Data AudioDeviceUsage Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AudioDeviceUsage -> c AudioDeviceUsage # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AudioDeviceUsage # toConstr :: AudioDeviceUsage -> Constr # dataTypeOf :: AudioDeviceUsage -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c AudioDeviceUsage) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AudioDeviceUsage) # gmapT :: (forall b. Data b => b -> b) -> AudioDeviceUsage -> AudioDeviceUsage # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AudioDeviceUsage -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AudioDeviceUsage -> r # gmapQ :: (forall d. Data d => d -> u) -> AudioDeviceUsage -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AudioDeviceUsage -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AudioDeviceUsage -> m AudioDeviceUsage # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AudioDeviceUsage -> m AudioDeviceUsage # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AudioDeviceUsage -> m AudioDeviceUsage #
Ord AudioDeviceUsage Source #
Methods compare :: AudioDeviceUsage -> AudioDeviceUsage -> Ordering # (<) :: AudioDeviceUsage -> AudioDeviceUsage -> Bool # (<=) :: AudioDeviceUsage -> AudioDeviceUsage -> Bool # (>) :: AudioDeviceUsage -> AudioDeviceUsage -> Bool # (>=) :: AudioDeviceUsage -> AudioDeviceUsage -> Bool # max :: AudioDeviceUsage -> AudioDeviceUsage -> AudioDeviceUsage # min :: AudioDeviceUsage -> AudioDeviceUsage -> AudioDeviceUsage #
Read AudioDeviceUsage Source #
Methods readsPrec :: Int -> ReadS AudioDeviceUsage # readList :: ReadS [AudioDeviceUsage] # readPrec :: ReadPrec AudioDeviceUsage # readListPrec :: ReadPrec [AudioDeviceUsage] #
Show AudioDeviceUsage Source #
Methods showsPrec :: Int -> AudioDeviceUsage -> ShowS # show :: AudioDeviceUsage -> String # showList :: [AudioDeviceUsage] -> ShowS #
Generic AudioDeviceUsage Source #
Associated Types type Rep AudioDeviceUsage :: * -> * # Methods from :: AudioDeviceUsage -> Rep AudioDeviceUsage x # to :: Rep AudioDeviceUsage x -> AudioDeviceUsage #
type Rep AudioDeviceUsage Source #
type Rep AudioDeviceUsage = D1 * (MetaData "AudioDeviceUsage" "SDL.Audio" "sdl2-2.4.0.1-FTTDCZzWo58E4WH8VwW0oW" False) ((:+:) * (C1 * (MetaCons "ForPlayback" PrefixI False) (U1 )) (C1 (MetaCons "ForCapture" PrefixI False) (U1 *)))

data Channels Source #

How many channels audio should be played on

Constructors

Mono	A single speaker configuration
Stereo	A traditional left/right stereo system
Quad
FivePointOne	1 surround sound

Instances

Bounded Channels Source #
Methods minBound :: Channels # maxBound :: Channels #
Enum Channels Source #
Methods succ :: Channels -> Channels # pred :: Channels -> Channels # toEnum :: Int -> Channels # fromEnum :: Channels -> Int # enumFrom :: Channels -> [Channels] # enumFromThen :: Channels -> Channels -> [Channels] # enumFromTo :: Channels -> Channels -> [Channels] # enumFromThenTo :: Channels -> Channels -> Channels -> [Channels] #
Eq Channels Source #
Methods (==) :: Channels -> Channels -> Bool # (/=) :: Channels -> Channels -> Bool #
Data Channels Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Channels -> c Channels # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Channels # toConstr :: Channels -> Constr # dataTypeOf :: Channels -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c Channels) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Channels) # gmapT :: (forall b. Data b => b -> b) -> Channels -> Channels # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Channels -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Channels -> r # gmapQ :: (forall d. Data d => d -> u) -> Channels -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Channels -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Channels -> m Channels # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Channels -> m Channels # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Channels -> m Channels #
Ord Channels Source #
Methods compare :: Channels -> Channels -> Ordering # (<) :: Channels -> Channels -> Bool # (<=) :: Channels -> Channels -> Bool # (>) :: Channels -> Channels -> Bool # (>=) :: Channels -> Channels -> Bool # max :: Channels -> Channels -> Channels # min :: Channels -> Channels -> Channels #
Read Channels Source #
Methods readsPrec :: Int -> ReadS Channels # readList :: ReadS [Channels] # readPrec :: ReadPrec Channels # readListPrec :: ReadPrec [Channels] #
Show Channels Source #
Methods showsPrec :: Int -> Channels -> ShowS # show :: Channels -> String # showList :: [Channels] -> ShowS #
Generic Channels Source #
Associated Types type Rep Channels :: * -> * # Methods from :: Channels -> Rep Channels x # to :: Rep Channels x -> Channels #
type Rep Channels Source #
type Rep Channels = D1 * (MetaData "Channels" "SDL.Audio" "sdl2-2.4.0.1-FTTDCZzWo58E4WH8VwW0oW" False) ((:+:) * ((:+:) * (C1 * (MetaCons "Mono" PrefixI False) (U1 )) (C1 (MetaCons "Stereo" PrefixI False) (U1 ))) ((:+:) (C1 * (MetaCons "Quad" PrefixI False) (U1 )) (C1 (MetaCons "FivePointOne" PrefixI False) (U1 *))))

data Changeable a Source #

Used to indicate to SDL whether it is allowed to open other audio devices (if a property is marked as a Desire) or if it should fail if the device is unavailable (Mandate).

Constructors

Mandate !a	`Mandate` this exact property value, and fail if a matching audio device cannot be found.
Desire !a	`Desire` this property value, but allow other audio devices to be opened.

Instances

Functor Changeable Source #
Methods fmap :: (a -> b) -> Changeable a -> Changeable b # (<$) :: a -> Changeable b -> Changeable a #
Foldable Changeable Source #
Methods fold :: Monoid m => Changeable m -> m # foldMap :: Monoid m => (a -> m) -> Changeable a -> m # foldr :: (a -> b -> b) -> b -> Changeable a -> b # foldr' :: (a -> b -> b) -> b -> Changeable a -> b # foldl :: (b -> a -> b) -> b -> Changeable a -> b # foldl' :: (b -> a -> b) -> b -> Changeable a -> b # foldr1 :: (a -> a -> a) -> Changeable a -> a # foldl1 :: (a -> a -> a) -> Changeable a -> a # toList :: Changeable a -> [a] # null :: Changeable a -> Bool # length :: Changeable a -> Int # elem :: Eq a => a -> Changeable a -> Bool # maximum :: Ord a => Changeable a -> a # minimum :: Ord a => Changeable a -> a # sum :: Num a => Changeable a -> a # product :: Num a => Changeable a -> a #
Traversable Changeable Source #
Methods traverse :: Applicative f => (a -> f b) -> Changeable a -> f (Changeable b) # sequenceA :: Applicative f => Changeable (f a) -> f (Changeable a) # mapM :: Monad m => (a -> m b) -> Changeable a -> m (Changeable b) # sequence :: Monad m => Changeable (m a) -> m (Changeable a) #
Eq a => Eq (Changeable a) Source #
Methods (==) :: Changeable a -> Changeable a -> Bool # (/=) :: Changeable a -> Changeable a -> Bool #
Data a => Data (Changeable a) Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Changeable a -> c (Changeable a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Changeable a) # toConstr :: Changeable a -> Constr # dataTypeOf :: Changeable a -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c (Changeable a)) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Changeable a)) # gmapT :: (forall b. Data b => b -> b) -> Changeable a -> Changeable a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Changeable a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Changeable a -> r # gmapQ :: (forall d. Data d => d -> u) -> Changeable a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Changeable a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Changeable a -> m (Changeable a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Changeable a -> m (Changeable a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Changeable a -> m (Changeable a) #
Read a => Read (Changeable a) Source #
Methods readsPrec :: Int -> ReadS (Changeable a) # readList :: ReadS [Changeable a] # readPrec :: ReadPrec (Changeable a) # readListPrec :: ReadPrec [Changeable a] #
Show a => Show (Changeable a) Source #
Methods showsPrec :: Int -> Changeable a -> ShowS # show :: Changeable a -> String # showList :: [Changeable a] -> ShowS #
Generic (Changeable a) Source #
Associated Types type Rep (Changeable a) :: * -> * # Methods from :: Changeable a -> Rep (Changeable a) x # to :: Rep (Changeable a) x -> Changeable a #
type Rep (Changeable a) Source #
type Rep (Changeable a) = D1 * (MetaData "Changeable" "SDL.Audio" "sdl2-2.4.0.1-FTTDCZzWo58E4WH8VwW0oW" False) ((:+:) * (C1 * (MetaCons "Mandate" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * a))) (C1 * (MetaCons "Desire" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * a))))

Working with Opened Devices

Locking `AudioDevice`s

setAudioDeviceLocked :: MonadIO m => AudioDevice -> LockState -> m () Source #

Lock an AudioDevice such that its associated callback will not be called until the device is unlocked.

data LockState Source #

Whether a device should be locked or unlocked.

Constructors

Locked	Lock the device, preventing the callback from producing data.
Unlocked	Unlock the device, resuming calls to the callback.

Instances

Bounded LockState Source #
Methods minBound :: LockState # maxBound :: LockState #
Enum LockState Source #
Methods succ :: LockState -> LockState # pred :: LockState -> LockState # toEnum :: Int -> LockState # fromEnum :: LockState -> Int # enumFrom :: LockState -> [LockState] # enumFromThen :: LockState -> LockState -> [LockState] # enumFromTo :: LockState -> LockState -> [LockState] # enumFromThenTo :: LockState -> LockState -> LockState -> [LockState] #
Eq LockState Source #
Methods (==) :: LockState -> LockState -> Bool # (/=) :: LockState -> LockState -> Bool #
Data LockState Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LockState -> c LockState # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LockState # toConstr :: LockState -> Constr # dataTypeOf :: LockState -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c LockState) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LockState) # gmapT :: (forall b. Data b => b -> b) -> LockState -> LockState # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LockState -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LockState -> r # gmapQ :: (forall d. Data d => d -> u) -> LockState -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> LockState -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> LockState -> m LockState # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LockState -> m LockState # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LockState -> m LockState #
Ord LockState Source #
Methods compare :: LockState -> LockState -> Ordering # (<) :: LockState -> LockState -> Bool # (<=) :: LockState -> LockState -> Bool # (>) :: LockState -> LockState -> Bool # (>=) :: LockState -> LockState -> Bool # max :: LockState -> LockState -> LockState # min :: LockState -> LockState -> LockState #
Read LockState Source #
Methods readsPrec :: Int -> ReadS LockState # readList :: ReadS [LockState] # readPrec :: ReadPrec LockState # readListPrec :: ReadPrec [LockState] #
Show LockState Source #
Methods showsPrec :: Int -> LockState -> ShowS # show :: LockState -> String # showList :: [LockState] -> ShowS #
Generic LockState Source #
Associated Types type Rep LockState :: * -> * # Methods from :: LockState -> Rep LockState x # to :: Rep LockState x -> LockState #
type Rep LockState Source #
type Rep LockState = D1 * (MetaData "LockState" "SDL.Audio" "sdl2-2.4.0.1-FTTDCZzWo58E4WH8VwW0oW" False) ((:+:) * (C1 * (MetaCons "Locked" PrefixI False) (U1 )) (C1 (MetaCons "Unlocked" PrefixI False) (U1 *)))

Switching Playback States

data PlaybackState Source #

Whether to allow an AudioDevice to play sound or remain paused.

Constructors

Pause	Pause the `AudioDevice`, which will stop producing/capturing audio.
Play	Resume the `AudioDevice`.

Instances

Bounded PlaybackState Source #
Methods minBound :: PlaybackState # maxBound :: PlaybackState #
Enum PlaybackState Source #
Methods succ :: PlaybackState -> PlaybackState # pred :: PlaybackState -> PlaybackState # toEnum :: Int -> PlaybackState # fromEnum :: PlaybackState -> Int # enumFrom :: PlaybackState -> [PlaybackState] # enumFromThen :: PlaybackState -> PlaybackState -> [PlaybackState] # enumFromTo :: PlaybackState -> PlaybackState -> [PlaybackState] # enumFromThenTo :: PlaybackState -> PlaybackState -> PlaybackState -> [PlaybackState] #
Eq PlaybackState Source #
Methods (==) :: PlaybackState -> PlaybackState -> Bool # (/=) :: PlaybackState -> PlaybackState -> Bool #
Data PlaybackState Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PlaybackState -> c PlaybackState # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PlaybackState # toConstr :: PlaybackState -> Constr # dataTypeOf :: PlaybackState -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c PlaybackState) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PlaybackState) # gmapT :: (forall b. Data b => b -> b) -> PlaybackState -> PlaybackState # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PlaybackState -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PlaybackState -> r # gmapQ :: (forall d. Data d => d -> u) -> PlaybackState -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PlaybackState -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PlaybackState -> m PlaybackState # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PlaybackState -> m PlaybackState # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PlaybackState -> m PlaybackState #
Ord PlaybackState Source #
Methods compare :: PlaybackState -> PlaybackState -> Ordering # (<) :: PlaybackState -> PlaybackState -> Bool # (<=) :: PlaybackState -> PlaybackState -> Bool # (>) :: PlaybackState -> PlaybackState -> Bool # (>=) :: PlaybackState -> PlaybackState -> Bool # max :: PlaybackState -> PlaybackState -> PlaybackState # min :: PlaybackState -> PlaybackState -> PlaybackState #
Read PlaybackState Source #
Methods readsPrec :: Int -> ReadS PlaybackState # readList :: ReadS [PlaybackState] # readPrec :: ReadPrec PlaybackState # readListPrec :: ReadPrec [PlaybackState] #
Show PlaybackState Source #
Methods showsPrec :: Int -> PlaybackState -> ShowS # show :: PlaybackState -> String # showList :: [PlaybackState] -> ShowS #
Generic PlaybackState Source #
Associated Types type Rep PlaybackState :: * -> * # Methods from :: PlaybackState -> Rep PlaybackState x # to :: Rep PlaybackState x -> PlaybackState #
type Rep PlaybackState Source #
type Rep PlaybackState = D1 * (MetaData "PlaybackState" "SDL.Audio" "sdl2-2.4.0.1-FTTDCZzWo58E4WH8VwW0oW" False) ((:+:) * (C1 * (MetaCons "Pause" PrefixI False) (U1 )) (C1 (MetaCons "Play" PrefixI False) (U1 *)))

setAudioDevicePlaybackState :: MonadIO m => AudioDevice -> PlaybackState -> m () Source #

Change the playback state of an AudioDevice.

Querying an `AudioDevice`s Status.

data AudioDeviceStatus Source #

Opened devices are always Playing or Paused in normal circumstances. A failing device may change its status to Stopped at any time, and closing a device will progress to Stopped too.

Constructors

Playing	The `AudioDevice` is playing.
Paused	The `AudioDevice` is paused.
Stopped	The `AudioDevice` is stopped.

Instances

Bounded AudioDeviceStatus Source #
Methods minBound :: AudioDeviceStatus # maxBound :: AudioDeviceStatus #
Enum AudioDeviceStatus Source #
Methods succ :: AudioDeviceStatus -> AudioDeviceStatus # pred :: AudioDeviceStatus -> AudioDeviceStatus # toEnum :: Int -> AudioDeviceStatus # fromEnum :: AudioDeviceStatus -> Int # enumFrom :: AudioDeviceStatus -> [AudioDeviceStatus] # enumFromThen :: AudioDeviceStatus -> AudioDeviceStatus -> [AudioDeviceStatus] # enumFromTo :: AudioDeviceStatus -> AudioDeviceStatus -> [AudioDeviceStatus] # enumFromThenTo :: AudioDeviceStatus -> AudioDeviceStatus -> AudioDeviceStatus -> [AudioDeviceStatus] #
Eq AudioDeviceStatus Source #
Methods (==) :: AudioDeviceStatus -> AudioDeviceStatus -> Bool # (/=) :: AudioDeviceStatus -> AudioDeviceStatus -> Bool #
Data AudioDeviceStatus Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AudioDeviceStatus -> c AudioDeviceStatus # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AudioDeviceStatus # toConstr :: AudioDeviceStatus -> Constr # dataTypeOf :: AudioDeviceStatus -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c AudioDeviceStatus) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AudioDeviceStatus) # gmapT :: (forall b. Data b => b -> b) -> AudioDeviceStatus -> AudioDeviceStatus # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AudioDeviceStatus -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AudioDeviceStatus -> r # gmapQ :: (forall d. Data d => d -> u) -> AudioDeviceStatus -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AudioDeviceStatus -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AudioDeviceStatus -> m AudioDeviceStatus # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AudioDeviceStatus -> m AudioDeviceStatus # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AudioDeviceStatus -> m AudioDeviceStatus #
Ord AudioDeviceStatus Source #
Methods compare :: AudioDeviceStatus -> AudioDeviceStatus -> Ordering # (<) :: AudioDeviceStatus -> AudioDeviceStatus -> Bool # (<=) :: AudioDeviceStatus -> AudioDeviceStatus -> Bool # (>) :: AudioDeviceStatus -> AudioDeviceStatus -> Bool # (>=) :: AudioDeviceStatus -> AudioDeviceStatus -> Bool # max :: AudioDeviceStatus -> AudioDeviceStatus -> AudioDeviceStatus # min :: AudioDeviceStatus -> AudioDeviceStatus -> AudioDeviceStatus #
Read AudioDeviceStatus Source #
Methods readsPrec :: Int -> ReadS AudioDeviceStatus # readList :: ReadS [AudioDeviceStatus] # readPrec :: ReadPrec AudioDeviceStatus # readListPrec :: ReadPrec [AudioDeviceStatus] #
Show AudioDeviceStatus Source #
Methods showsPrec :: Int -> AudioDeviceStatus -> ShowS # show :: AudioDeviceStatus -> String # showList :: [AudioDeviceStatus] -> ShowS #
Generic AudioDeviceStatus Source #
Associated Types type Rep AudioDeviceStatus :: * -> * # Methods from :: AudioDeviceStatus -> Rep AudioDeviceStatus x # to :: Rep AudioDeviceStatus x -> AudioDeviceStatus #
type Rep AudioDeviceStatus Source #
type Rep AudioDeviceStatus = D1 * (MetaData "AudioDeviceStatus" "SDL.Audio" "sdl2-2.4.0.1-FTTDCZzWo58E4WH8VwW0oW" False) ((:+:) * (C1 * (MetaCons "Playing" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "Paused" PrefixI False) (U1 )) (C1 (MetaCons "Stopped" PrefixI False) (U1 *))))

audioDeviceStatus :: MonadIO m => AudioDevice -> m AudioDeviceStatus Source #

Query the state of an AudioDevice.

`AudioFormat`

data AudioFormat sampleType where Source #

Information about what format an audio bytestream is. The type variable t indicates the type used for audio buffer samples. It is determined by the choice of the provided SampleBitSize. For example:

AudioFormat UnsignedInteger Sample8Bit Native :: AudioFormat Word8

Indicating that an 8-bit audio format in the platforms native endianness uses a buffer of Word8 values.

Instances

Eq (AudioFormat sampleType) Source #
Methods (==) :: AudioFormat sampleType -> AudioFormat sampleType -> Bool # (/=) :: AudioFormat sampleType -> AudioFormat sampleType -> Bool #
Ord (AudioFormat sampleType) Source #
Methods compare :: AudioFormat sampleType -> AudioFormat sampleType -> Ordering # (<) :: AudioFormat sampleType -> AudioFormat sampleType -> Bool # (<=) :: AudioFormat sampleType -> AudioFormat sampleType -> Bool # (>) :: AudioFormat sampleType -> AudioFormat sampleType -> Bool # (>=) :: AudioFormat sampleType -> AudioFormat sampleType -> Bool # max :: AudioFormat sampleType -> AudioFormat sampleType -> AudioFormat sampleType # min :: AudioFormat sampleType -> AudioFormat sampleType -> AudioFormat sampleType #
Show (AudioFormat sampleType) Source #
Methods showsPrec :: Int -> AudioFormat sampleType -> ShowS # show :: AudioFormat sampleType -> String # showList :: [AudioFormat sampleType] -> ShowS #

Enumerating `AudioDevice`s

getAudioDeviceNames :: MonadIO m => AudioDeviceUsage -> m (Maybe (Vector Text)) Source #

Enumerate all AudioDevices attached to this system, that can be used as specified by the given AudioDeviceUsage. SDL cannot always guarantee that this list can be produced, in which case Nothing will be returned.

`AudioSpec`

data AudioSpec Source #

AudioSpec is the concrete specification of how an AudioDevice was sucessfully opened. Unlike OpenDeviceSpec, which specifies what you want, AudioSpec specifies what you have.

audioSpecFreq :: AudioSpec -> CInt Source #

DSP frequency (samples per second)

audioSpecFormat :: AudioSpec -> AudioFormat sampleType Source #

Audio data format

audioSpecChannels :: AudioSpec -> Channels Source #

Number of separate sound channels

audioSpecSilence :: AudioSpec -> Word8 Source #

Calculated udio buffer silence value

audioSpecSize :: AudioSpec -> Word32 Source #

Calculated audio buffer size in bytes

audioSpecCallback :: AudioSpec -> AudioFormat sampleType -> IOVector sampleType -> IO () Source #

The function to call when the audio device needs more data

Audio Drivers

getAudioDrivers :: MonadIO m => m (Vector AudioDriver) Source #

Obtain a list of all possible audio drivers for this system. These drivers can be used to specificially initialize the audio system.

currentAudioDriver :: MonadIO m => m (Maybe Text) Source #

Query SDL for the name of the currently initialized audio driver, if possible. This will return Nothing if no driver has been initialized.

data AudioDriver Source #

An abstract description of an audio driver on the host machine.

Instances

Eq AudioDriver Source #
Methods (==) :: AudioDriver -> AudioDriver -> Bool # (/=) :: AudioDriver -> AudioDriver -> Bool #
Show AudioDriver Source #
Methods showsPrec :: Int -> AudioDriver -> ShowS # show :: AudioDriver -> String # showList :: [AudioDriver] -> ShowS #

audioDriverName :: AudioDriver -> Text Source #

Get the human readable name of an AudioDriver

Explicit Initialization

audioInit :: MonadIO m => AudioDriver -> m () Source #

Explicitly initialize the audio system against a specific AudioDriver. Note that most users will not need to do this, as the normal initialization routines will already take care of this for you.

Signed8BitAudio :: AudioFormat Int8
Unsigned8BitAudio :: AudioFormat Word8
Signed16BitLEAudio :: AudioFormat Int16
Signed16BitBEAudio :: AudioFormat Int16
Signed16BitNativeAudio :: AudioFormat Int16
Unsigned16BitLEAudio :: AudioFormat Word16
Unsigned16BitBEAudio :: AudioFormat Word16
Unsigned16BitNativeAudio :: AudioFormat Word16
Signed32BitLEAudio :: AudioFormat Int32
Signed32BitBEAudio :: AudioFormat Int32
Signed32BitNativeAudio :: AudioFormat Int32
FloatingLEAudio :: AudioFormat Float
FloatingBEAudio :: AudioFormat Float
FloatingNativeAudio :: AudioFormat Float

Managing AudioDevices

Opening and Closing AudioDevices

Working with Opened Devices

Locking AudioDevices

Switching Playback States

Querying an AudioDevices Status.

AudioFormat

Enumerating AudioDevices

AudioSpec

Audio Drivers

Explicit Initialization

Managing `AudioDevice`s

Opening and Closing `AudioDevice`s

Locking `AudioDevice`s

Querying an `AudioDevice`s Status.

`AudioFormat`

Enumerating `AudioDevice`s

`AudioSpec`