Sound.Pulse.Mainloop

Maintianer : ongy Stability : experimental

This module provides Haskell abstractions over the pulse mainloop-api https://freedesktop.org/software/pulseaudio/doxygen/mainloop-api_8h.html.

There is also a simple implementation for this in Simple.

Documentation

class PAMainloop a where

The main class for a pulseaudio mainloop abstraction.

Minimal complete definition

ioNew, ioEnable, ioFree, ioSetDestroy, timeNew, timeRestart, timeFree, timeSetDestroy, deferNew, deferEnable, deferFree, deferSetDestroy, quitLoop

Associated Types

data PAIOEvent a :: *

Pulseaudio IO event. Will have to wait for an Fd to become ready (w.r.t. to flags)

data PATimeEvent a :: *

Pulseaudio Time event. Should fire at a specified time.

data PADeferEvent a :: *

Pulseaudio Defer event. Should be handled before other events. May be disabled.

Methods

ioNew :: a -> Fd -> [PAIOEventFlags] -> ([PAIOEventFlags] -> IO ()) -> IO (PAIOEvent a)

Create a new PAIOEvent and set it to listen for specified events.

ioEnable :: PAIOEvent a -> [PAIOEventFlags] -> IO ()

Modify the events an IOEvent is waiting on.

ioFree :: PAIOEvent a -> IO ()

Delete an IOEvent.

ioSetDestroy :: PAIOEvent a -> IO () -> IO ()

Set the destroy handler of an IOEvent. The handler should be called, when the event is deleted.

timeNew :: a -> PATime -> (PATime -> IO ()) -> IO (PATimeEvent a)

Create a new PATimeEvent. This should fire at the given time.

timeRestart :: PATimeEvent a -> PATime -> IO ()

Set a new time when the PATimeEvent should fire. This may require requeing.

timeFree :: PATimeEvent a -> IO ()

Delete a PATimeEvent.

timeSetDestroy :: PATimeEvent a -> IO () -> IO ()

Set the destroy handler.

deferNew :: a -> IO () -> IO (PADeferEvent a)

Create a new PADefereEvent. This should be fired before any other events.

deferEnable :: PADeferEvent a -> Bool -> IO ()

Enable or disable a PADefereEvent.

deferFree :: PADeferEvent a -> IO ()

Delete the event.

deferSetDestroy :: PADeferEvent a -> IO () -> IO ()

Set the destroy handler for the event.

quitLoop :: a -> Int -> IO ()

Quit the mainloop and return the given int.

Instances

PAMainloop MainloopImpl

Associated Types

data PAIOEvent MainloopImpl :: *

data PATimeEvent MainloopImpl :: *

data PADeferEvent MainloopImpl :: *

Methods

ioNew :: MainloopImpl -> Fd -> [PAIOEventFlags] -> ([PAIOEventFlags] -> IO ()) -> IO (PAIOEvent MainloopImpl)

ioEnable :: PAIOEvent MainloopImpl -> [PAIOEventFlags] -> IO ()

ioFree :: PAIOEvent MainloopImpl -> IO ()

ioSetDestroy :: PAIOEvent MainloopImpl -> IO () -> IO ()

timeNew :: MainloopImpl -> PATime -> (PATime -> IO ()) -> IO (PATimeEvent MainloopImpl)

timeRestart :: PATimeEvent MainloopImpl -> PATime -> IO ()

timeFree :: PATimeEvent MainloopImpl -> IO ()

timeSetDestroy :: PATimeEvent MainloopImpl -> IO () -> IO ()

deferNew :: MainloopImpl -> IO () -> IO (PADeferEvent MainloopImpl)

deferEnable :: PADeferEvent MainloopImpl -> Bool -> IO ()

deferFree :: PADeferEvent MainloopImpl -> IO ()

deferSetDestroy :: PADeferEvent MainloopImpl -> IO () -> IO ()

quitLoop :: MainloopImpl -> Int -> IO ()

data PAIOEventFlags

Events that PAIOEvents may wait for. At my current level of testing, it looks like libpulse only uses Input (and I guess output when writing to the server)

Constructors

PAIOEventNull

No Event (this is for compatibility, should never show up)

PAIOEventInput

Fd went ready for reading

PAIOEventOutput

Fd went ready for writing

PAIOEventHangup

Fd got a hangup (see poll documentation)

PAIOEventError

Fd got an error (see poll documentation)

Instances

Eq PAIOEventFlags

Methods

(==) :: PAIOEventFlags -> PAIOEventFlags -> Bool

(/=) :: PAIOEventFlags -> PAIOEventFlags -> Bool

Show PAIOEventFlags

Methods

showsPrec :: Int -> PAIOEventFlags -> ShowS

show :: PAIOEventFlags -> String

showList :: [PAIOEventFlags] -> ShowS

data PAMainloopApi a

The type used to encapsule a PAMainloop in a C compatible struct of FunPtrs.

Instances

Storable (PAMainloopApi a)

Methods

sizeOf :: PAMainloopApi a -> Int

alignment :: PAMainloopApi a -> Int

peekElemOff :: Ptr (PAMainloopApi a) -> Int -> IO (PAMainloopApi a)

pokeElemOff :: Ptr (PAMainloopApi a) -> Int -> PAMainloopApi a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (PAMainloopApi a)

pokeByteOff :: Ptr b -> Int -> PAMainloopApi a -> IO ()

peek :: Ptr (PAMainloopApi a) -> IO (PAMainloopApi a)

poke :: Ptr (PAMainloopApi a) -> PAMainloopApi a -> IO ()

getMainloopApi :: PAMainloop a => a -> IO (PAMainloopApi a)

Warning! This leaks a bit of memory when it's Garbage collected, because the FunPtrs created for the PulseApi cannot be collected at that point. Currently there is no way to properly free them, but this should only be called once per application, so this will be a known Bug for now.