JackMiniMix-0.1: control JackMiniMixSource codeContentsIndex
Sound.JackMiniMix
Description

This is a module to control JackMiniMix, a GPL mixer for the Jack Audio Connection Kit using OpenSoundControl (OSC).

JackMiniMix was written by Nicholas J Humfrey. http://www.aelius.com/njh/jackminimix/

OSC was developed at CNMAT by Adrian Freed and Matt Wright. http://opensoundcontrol.org/

The documentation was mostly taken from the source of JackMiniMix by Humfrey.

This module requires that the JackMiniMix program be installed.

For general usage, use the camel case functions; they're easier. The functions with underscores in the name need to be called using the withJackMiniMix function; the camelCase ones already include it.

Synopsis
withJackMiniMix :: Int -> (UDP -> IO a) -> IO a
channel_count :: Transport t => t -> IO OSC
channelCount :: Int -> IO OSC
get_channel_gain :: Transport t => t -> Int -> IO OSC
getChannelGain :: Int -> Int -> IO OSC
set_channel_gain :: Transport t => t -> Int -> Double -> IO OSC
setChannelGain :: Int -> Int -> Double -> IO OSC
get_channel_label :: Transport t => t -> Int -> IO OSC
getChannelLabel :: Int -> Int -> IO OSC
set_channel_label :: Transport t => t -> Int -> String -> IO OSC
setChannelLabel :: Int -> Int -> String -> IO OSC
ping :: Transport t => t -> IO OSC
pingMixer :: Int -> IO OSC
Documentation
withJackMiniMix :: Int -> (UDP -> IO a) -> IO aSource
Bracket JackMiniMix communication.
channel_count :: Transport t => t -> IO OSCSource
channelCountSource
:: Intthe port number
-> IO OSC

Returns the number of stereo input channels that the mixer has.

The OSC message:

/mixer/get_channel_count - Get the number of channels

replies with:

/mixer/channel_count (i)

get_channel_gain :: Transport t => t -> Int -> IO OSCSource
getChannelGainSource
:: Intthe port number
-> Intthe channel
-> IO OSC

Returns the gain (in decibels) of channel.

The OSC message:

/mixer/channel/get_gain (i) - Get gain of channel i

replies with:

/mixer/channel/gain (if)

channel is the number of the channel (in range 1 to total number of channels).

set_channel_gain :: Transport t => t -> Int -> Double -> IO OSCSource
setChannelGainSource
:: Intthe port number
-> Intthe channel number
-> Doublethe new gain
-> IO OSC

Sets the gain of channel channel to gain dB.

The OSC message:

/mixer/channel/set_gain (if) - Set the gain of channel i to f dB

replies with:

/mixer/channel/gain (if)

channel is the number of the channel (in range 1 to total number of channels).

gain is the gain (in decibels) to set the channel to (in range -90 to 90 dB).

get_channel_label :: Transport t => t -> Int -> IO OSCSource
getChannelLabelSource
:: Intthe port number
-> Intthe channel
-> IO OSC

Returns the label (string) of channel number channel.

The OSC message:

/mixer/channel/get_label (i) - Get the label of channel i

replies with:

/mixer/channel/label (is)

channel is the number of the channel (in range 1 to total number of channels).

set_channel_label :: Transport t => t -> Int -> String -> IO OSCSource
setChannelLabelSource
:: Intthe port number
-> Intthe channel
-> Stringthe new channel label
-> IO OSC

Sets the label (string) of channel number channel to label.

The OSC message:

/mixer/channel/set_label (is) - Set the label of channel i to s

replies with:

/mixer/channel/label (is)

channel is the number of the channel (in range 1 to total number of channels).

label is the new label for the channel.

ping :: Transport t => t -> IO OSCSource
pingMixerSource
:: Intthe port number
-> IO OSC

Pings the mixer to see if it is there.

The OSC message:

/ping - Check mixer is still there

replies with:

/pong

Produced by Haddock version 2.6.0