Safe Haskell	None
Language	Haskell2010

System.PortAudio

Contents

Initialization
Devices
Opening a stream
Stream parameters
Timestamps and status flags
Stream flags

Synopsis

withPortAudio :: IO a -> IO a
data Error
- = NotInitialized
- | UnanticipatedHostError
- | InvalidChannelCount
- | InvalidSampleRate
- | InvalidDevice
- | InvalidFlag
- | SampleFormatNotSupported
- | BadIODeviceCombination
- | InsufficientMemory
- | BufferTooBig
- | BufferTooSmall
- | NullCallback
- | BadStreamPtr
- | TimedOut
- | InternalError
- | DeviceUnavailable
- | IncompatibleHostApiSpecificStreamInfo
- | StreamIsStopped
- | StreamIsNotStopped
- | InputOverflowed
- | OutputUnderflowed
- | HostApiNotFound
- | InvalidHostApi
- | CanNotReadFromACallbackStream
- | CanNotWriteToACallbackStream
- | CanNotReadFromAnOutputOnlyStream
- | CanNotWriteToAnInputOnlyStream
- | IncompatibleStreamHostApi
- | BadBufferPtr
getDevices :: IO ([Device Input], [Device Output])
data Device t = Device {
- deviceIndex :: CInt
- deviceName :: String
- deviceMaxChannels :: Int
- deviceLowLatency :: Double
- deviceHighLatency :: Double
- deviceDefaultSampleRate :: Double
}
data Input
data Output
data Stream
withStream :: (Storable i, Storable o) => Double -> Int -> Maybe (StreamParameters Input i) -> Maybe (StreamParameters Output o) -> StreamFlags -> (Status -> Vector i -> IOVector o -> IO StreamCallbackResult) -> (Stream -> IO r) -> IO r
data StreamCallbackResult
- = Continue
- | Complete
- | Abort
startStream :: Stream -> IO ()
stopStream :: Stream -> IO ()
withStartStream :: Stream -> IO r -> IO r
isStreamStopped :: Stream -> IO Bool
setStreamFinishedCallback :: Stream -> IO () -> IO ()
data StreamParameters t a
streamParameters :: forall t f a. (Applicative f, Foldable f, PortAudioSample a) => Device t -> Double -> Maybe (StreamParameters t (f a))
class PortAudioSample a
noConnection :: Maybe (StreamParameters t ())
data Status = Status {
- currentTime :: !Double
- inputBufferAdcTime :: !Double
- outputBufferDacTime :: !Double
- inputUnderflow :: !Bool
- inputOverflow :: !Bool
- outputUnderflow :: !Bool
- outputOverflow :: !Bool
- primingOutput :: !Bool
}
data StreamFlags
clipOff :: StreamFlags
ditherOff :: StreamFlags
neverDropInput :: StreamFlags
primeOutputBuffersUsingStreamCallback :: StreamFlags

Initialization

withPortAudio :: IO a -> IO a Source #

data Error Source #

Instances

Instances details

Enum Error Source #
Instance details Defined in System.PortAudio Methods succ :: Error -> Error # pred :: Error -> Error # toEnum :: Int -> Error # fromEnum :: Error -> Int # enumFrom :: Error -> [Error] # enumFromThen :: Error -> Error -> [Error] # enumFromTo :: Error -> Error -> [Error] # enumFromThenTo :: Error -> Error -> Error -> [Error] #
Eq Error Source #
Instance details Defined in System.PortAudio Methods (==) :: Error -> Error -> Bool # (/=) :: Error -> Error -> Bool #
Ord Error Source #
Instance details Defined in System.PortAudio Methods compare :: Error -> Error -> Ordering # (<) :: Error -> Error -> Bool # (<=) :: Error -> Error -> Bool # (>) :: Error -> Error -> Bool # (>=) :: Error -> Error -> Bool # max :: Error -> Error -> Error # min :: Error -> Error -> Error #
Show Error Source #
Instance details Defined in System.PortAudio Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
Exception Error Source #
Instance details Defined in System.PortAudio Methods toException :: Error -> SomeException # fromException :: SomeException -> Maybe Error # displayException :: Error -> String #

Devices

getDevices :: IO ([Device Input], [Device Output]) Source #

data Device t Source #

Constructors

Device
Fields deviceIndex :: CInt deviceName :: String deviceMaxChannels :: Int deviceLowLatency :: Double deviceHighLatency :: Double deviceDefaultSampleRate :: Double

Instances

Instances details

Eq (Device t) Source #
Instance details Defined in System.PortAudio Methods (==) :: Device t -> Device t -> Bool # (/=) :: Device t -> Device t -> Bool #
Ord (Device t) Source #
Instance details Defined in System.PortAudio Methods compare :: Device t -> Device t -> Ordering # (<) :: Device t -> Device t -> Bool # (<=) :: Device t -> Device t -> Bool # (>) :: Device t -> Device t -> Bool # (>=) :: Device t -> Device t -> Bool # max :: Device t -> Device t -> Device t # min :: Device t -> Device t -> Device t #
Show (Device t) Source #
Instance details Defined in System.PortAudio Methods showsPrec :: Int -> Device t -> ShowS # show :: Device t -> String # showList :: [Device t] -> ShowS #

data Input Source #

data Output Source #

Opening a stream

data Stream Source #

withStream Source #

Arguments

:: (Storable i, Storable o)
=> Double	sampling rate
-> Int	buffer size
-> Maybe (StreamParameters Input i)
-> Maybe (StreamParameters Output o)
-> StreamFlags
-> (Status -> Vector i -> IOVector o -> IO StreamCallbackResult)	callback
-> (Stream -> IO r)
-> IO r

data StreamCallbackResult Source #

Constructors

Continue
Complete
Abort

Instances

Instances details

Enum StreamCallbackResult Source #
Instance details Defined in System.PortAudio Methods succ :: StreamCallbackResult -> StreamCallbackResult # pred :: StreamCallbackResult -> StreamCallbackResult # toEnum :: Int -> StreamCallbackResult # fromEnum :: StreamCallbackResult -> Int # enumFrom :: StreamCallbackResult -> [StreamCallbackResult] # enumFromThen :: StreamCallbackResult -> StreamCallbackResult -> [StreamCallbackResult] # enumFromTo :: StreamCallbackResult -> StreamCallbackResult -> [StreamCallbackResult] # enumFromThenTo :: StreamCallbackResult -> StreamCallbackResult -> StreamCallbackResult -> [StreamCallbackResult] #
Eq StreamCallbackResult Source #
Instance details Defined in System.PortAudio Methods (==) :: StreamCallbackResult -> StreamCallbackResult -> Bool # (/=) :: StreamCallbackResult -> StreamCallbackResult -> Bool #
Ord StreamCallbackResult Source #
Instance details Defined in System.PortAudio Methods compare :: StreamCallbackResult -> StreamCallbackResult -> Ordering # (<) :: StreamCallbackResult -> StreamCallbackResult -> Bool # (<=) :: StreamCallbackResult -> StreamCallbackResult -> Bool # (>) :: StreamCallbackResult -> StreamCallbackResult -> Bool # (>=) :: StreamCallbackResult -> StreamCallbackResult -> Bool # max :: StreamCallbackResult -> StreamCallbackResult -> StreamCallbackResult # min :: StreamCallbackResult -> StreamCallbackResult -> StreamCallbackResult #
Show StreamCallbackResult Source #
Instance details Defined in System.PortAudio Methods showsPrec :: Int -> StreamCallbackResult -> ShowS # show :: StreamCallbackResult -> String # showList :: [StreamCallbackResult] -> ShowS #
Semigroup StreamCallbackResult Source #
Instance details Defined in System.PortAudio Methods (<>) :: StreamCallbackResult -> StreamCallbackResult -> StreamCallbackResult # sconcat :: NonEmpty StreamCallbackResult -> StreamCallbackResult # stimes :: Integral b => b -> StreamCallbackResult -> StreamCallbackResult #
Monoid StreamCallbackResult Source #
Instance details Defined in System.PortAudio Methods mempty :: StreamCallbackResult # mappend :: StreamCallbackResult -> StreamCallbackResult -> StreamCallbackResult # mconcat :: [StreamCallbackResult] -> StreamCallbackResult #

startStream :: Stream -> IO () Source #

stopStream :: Stream -> IO () Source #

withStartStream :: Stream -> IO r -> IO r Source #

isStreamStopped :: Stream -> IO Bool Source #

setStreamFinishedCallback :: Stream -> IO () -> IO () Source #

Stream parameters

data StreamParameters t a Source #

Instances

Instances details

Storable (StreamParameters t a) Source #

Instance details

Defined in System.PortAudio

Methods

sizeOf :: StreamParameters t a -> Int #

alignment :: StreamParameters t a -> Int #

peekElemOff :: Ptr (StreamParameters t a) -> Int -> IO (StreamParameters t a) #

pokeElemOff :: Ptr (StreamParameters t a) -> Int -> StreamParameters t a -> IO () #

peekByteOff :: Ptr b -> Int -> IO (StreamParameters t a) #

pokeByteOff :: Ptr b -> Int -> StreamParameters t a -> IO () #

peek :: Ptr (StreamParameters t a) -> IO (StreamParameters t a) #

poke :: Ptr (StreamParameters t a) -> StreamParameters t a -> IO () #

streamParameters :: forall t f a. (Applicative f, Foldable f, PortAudioSample a) => Device t -> Double -> Maybe (StreamParameters t (f a)) Source #

class PortAudioSample a Source #

Minimal complete definition

paSampleFormat

Instances

Instances details

PortAudioSample Float Source #
Instance details Defined in System.PortAudio Methods paSampleFormat :: proxy Float -> CULong
PortAudioSample Int8 Source #
Instance details Defined in System.PortAudio Methods paSampleFormat :: proxy Int8 -> CULong
PortAudioSample Int16 Source #
Instance details Defined in System.PortAudio Methods paSampleFormat :: proxy Int16 -> CULong
PortAudioSample Int32 Source #
Instance details Defined in System.PortAudio Methods paSampleFormat :: proxy Int32 -> CULong
PortAudioSample Word8 Source #
Instance details Defined in System.PortAudio Methods paSampleFormat :: proxy Word8 -> CULong

noConnection :: Maybe (StreamParameters t ()) Source #

This is Nothing, but it explicitly specifies the stream type with zero-width unit type.

Timestamps and status flags

data Status Source #

Constructors

Status
Fields currentTime :: !Double inputBufferAdcTime :: !Double outputBufferDacTime :: !Double inputUnderflow :: !Bool inputOverflow :: !Bool outputUnderflow :: !Bool outputOverflow :: !Bool primingOutput :: !Bool

Instances

Instances details

Eq Status Source #
Instance details Defined in System.PortAudio Methods (==) :: Status -> Status -> Bool # (/=) :: Status -> Status -> Bool #
Ord Status Source #
Instance details Defined in System.PortAudio Methods compare :: Status -> Status -> Ordering # (<) :: Status -> Status -> Bool # (<=) :: Status -> Status -> Bool # (>) :: Status -> Status -> Bool # (>=) :: Status -> Status -> Bool # max :: Status -> Status -> Status # min :: Status -> Status -> Status #
Show Status Source #
Instance details Defined in System.PortAudio Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #

Stream flags

data StreamFlags Source #

Instances

Instances details

Semigroup StreamFlags Source #
Instance details Defined in System.PortAudio Methods (<>) :: StreamFlags -> StreamFlags -> StreamFlags # sconcat :: NonEmpty StreamFlags -> StreamFlags # stimes :: Integral b => b -> StreamFlags -> StreamFlags #
Monoid StreamFlags Source #
Instance details Defined in System.PortAudio Methods mempty :: StreamFlags # mappend :: StreamFlags -> StreamFlags -> StreamFlags # mconcat :: [StreamFlags] -> StreamFlags #

clipOff :: StreamFlags Source #

ditherOff :: StreamFlags Source #

neverDropInput :: StreamFlags Source #

primeOutputBuffersUsingStreamCallback :: StreamFlags Source #

NotInitialized
UnanticipatedHostError
InvalidChannelCount
InvalidSampleRate
InvalidDevice
InvalidFlag
SampleFormatNotSupported
BadIODeviceCombination
InsufficientMemory
BufferTooBig
BufferTooSmall
NullCallback
BadStreamPtr
TimedOut
InternalError
DeviceUnavailable
IncompatibleHostApiSpecificStreamInfo
StreamIsStopped
StreamIsNotStopped
InputOverflowed
OutputUnderflowed
HostApiNotFound
InvalidHostApi
CanNotReadFromACallbackStream
CanNotWriteToACallbackStream
CanNotReadFromAnOutputOnlyStream
CanNotWriteToAnInputOnlyStream
IncompatibleStreamHostApi
BadBufferPtr