jack-0.6.1: Bindings for the JACK Audio Connection Kit

Safe HaskellSafe-Infered

Sound.JACK

Contents

Description

The Jack module defines types and functions that allows you to use the JACK Audio Connection Kit.

Synopsis

general stuff

data Client Source

Handles of Jack clients

newClientSource

Arguments

:: ThrowsStatus e 
=> String

name of the JACK server

-> String

name of the client

-> ExceptionalT e IO Client 

Constructs a new Jack client.

newClientDefaultSource

Arguments

:: ThrowsStatus e 
=> String

name of the client

-> ExceptionalT e IO Client 

Creates a new JACK client with the default server

withClientSource

Arguments

:: ThrowsStatus e 
=> String

name of the JACK server

-> String

name of the client

-> (Client -> ExceptionalT e IO a) 
-> ExceptionalT e IO a 

Run a block of code with a newly allocated client. Do not use the client outside the block.

withClientDefaultSource

Arguments

:: ThrowsStatus e 
=> String

name of the client

-> (Client -> ExceptionalT e IO a) 
-> ExceptionalT e IO a 

clientClose :: ThrowsErrno e => Client -> PortSet -> ExceptionalT e IO ()Source

closes the given Jack client without causing any trouble (hopefully)

getPortsSource

Arguments

:: Client

the Jack client

-> IO [String]

the names as a list of strings

returns the names of all existing ports of the given Jack client

activate :: ThrowsErrno e => Client -> ExceptionalT e IO ()Source

activates the given Jack client

class PortType typ Source

Jack Port Type

Instances

PortType CFloat 
PortType EventBuffer 

data Input Source

Handles of Jack input ports

Instances

data Output Source

Handles of Jack output ports

Instances

data Port typ dir Source

newPortSource

Arguments

:: (PortType typ, Direction dir, ThrowsPortRegister e) 
=> Client

Jack client

-> String

name of the input port

-> ExceptionalT e IO (Port typ dir) 

Better use withPort that also handles freeing the port.

withPortSource

Arguments

:: (PortType typ, Direction dir, ThrowsPortRegister e, ThrowsErrno e) 
=> Client

Jack client

-> String

name of the input port

-> (Port typ dir -> ExceptionalT e IO a) 
-> ExceptionalT e IO a 

Creates a new port for the given client and delete it after usage. The port manages audio or MIDI data in input or output direction depending on the Port type. Usually the required port type can be inferred from following actions that use that port.

Do not use the port outside the enclosed block.

data PortSet Source

A collection of mixed types of ports. It is mainly needed for freeing all allocated ports.

Instances

setOfPort :: (PortType typ, Direction dir) => Port typ dir -> PortSetSource

setOfPorts :: (PortType typ, Direction dir) => [Port typ dir] -> PortSetSource

newtype NFrames Source

represents absolute frame time

Constructors

NFrames CUInt 

Exceptions