Sound.SC3.Server.Process.Options

Contents

Synopsis

Documentation

Used with the verbosity field in ServerOptions.

Constructors

Silent
Quiet
Normal
Verbose
VeryVerbose
ExtremelyVerbose

Instances

Enum Verbosity
Eq Verbosity
Read Verbosity
Show Verbosity
Option Verbosity

Server options

data ServerOptions Source

Specify general server options used both in realtime and non-realtime mode.

Constructors

ServerOptions

Fields

serverProgram :: FilePath: Path to the scsynth program
numberOfControlBusChannels :: Int: Number of allocated control bus channels
numberOfAudioBusChannels :: Int: Number of allocated audio bus channels
numberOfInputBusChannels :: Int: Number of physical input channels
numberOfOutputBusChannels :: Int: Number of physical output channels
blockSize :: Int: Synthesis block size
numberOfSampleBuffers :: Int: Number of allocated sample buffers
maxNumberOfNodes :: Int: Maximum number of synthesis nodes
maxNumberOfSynthDefs :: Int: Maximum number of synth definitions
realtimeMemorySize :: Int: Realtime memory size in bytes
numberOfWireBuffers :: Int: Number of unit generator connection buffers
numberOfRandomSeeds :: Int: Number of random number generator seeds
loadSynthDefs :: Bool: If True, load synth definitions from synthdefs directory on startup
verbosity :: Verbosity: Verbosity level
ugenPluginPath :: Maybe [FilePath]: List of UGen plugin search paths
restrictedPath :: Maybe FilePath: Sandbox path to restrict OSC command filesystem access

Instances

Eq ServerOptions
Show ServerOptions

defaultServerOptions :: ServerOptions Source

Default server options.

_restrictedPath :: T ServerOptions (Maybe FilePath)Source

_ugenPluginPath :: T ServerOptions (Maybe ([] FilePath))Source

_verbosity :: T ServerOptions Verbosity Source

_loadSynthDefs :: T ServerOptions Bool Source

_numberOfRandomSeeds :: T ServerOptions Int Source

_numberOfWireBuffers :: T ServerOptions Int Source

_realtimeMemorySize :: T ServerOptions Int Source

_maxNumberOfSynthDefs :: T ServerOptions Int Source

_maxNumberOfNodes :: T ServerOptions Int Source

_numberOfSampleBuffers :: T ServerOptions Int Source

_blockSize :: T ServerOptions Int Source

_numberOfOutputBusChannels :: T ServerOptions Int Source

_numberOfInputBusChannels :: T ServerOptions Int Source

_numberOfAudioBusChannels :: T ServerOptions Int Source

_numberOfControlBusChannels :: T ServerOptions Int Source

_serverProgram :: T ServerOptions FilePath Source

realTimeMemorySize :: ServerOptions -> Int Source

_realTimeMemorySize :: Accessor ServerOptions Int Source

Realtime options

data RTOptions Source

Realtime server options, parameterized by the OpenSoundControl Transport to be used.

Constructors

RTOptions

Fields

udpPortNumber :: Int: UDP port number (one of udpPortNumber and tcpPortNumber must be non-zero)
tcpPortNumber :: Int: TCP port number (one of udpPortNumber and tcpPortNumber must be non-zero)
useZeroconf :: Bool: If True, publish scsynth service through Zeroconf
maxNumberOfLogins :: Int: Max number of supported logins if sessionPassword is set
sessionPassword :: Maybe String: Session password Audio device control
hardwareDeviceName :: Maybe String: Hardware device name (JACK client:server name on Linux)
hardwareBufferSize :: Int: Hardware buffer size (no effect with JACK)
hardwareSampleRate :: Int: Hardware buffer size (no effect with JACK)
inputStreamsEnabled :: Maybe Int: Enabled input streams (CoreAudio only)
outputStreamsEnabled :: Maybe Int: Enabled output streams (CoreAudio only)

Instances

Eq RTOptions
Show RTOptions

defaultRTOptions :: RTOptions Source

Default realtime server options.

_outputStreamsEnabled :: T RTOptions (Maybe Int)Source

_inputStreamsEnabled :: T RTOptions (Maybe Int)Source

_hardwareSampleRate :: T RTOptions Int Source

_hardwareBufferSize :: T RTOptions Int Source

_hardwareDeviceName :: T RTOptions (Maybe String)Source

_sessionPassword :: T RTOptions (Maybe String)Source

_maxNumberOfLogins :: T RTOptions Int Source

_useZeroconf :: T RTOptions Bool Source

_tcpPortNumber :: T RTOptions Int Source

_udpPortNumber :: T RTOptions Int Source

defaultRTOptionsUDP :: RTOptions Source

Default realtime server options (UDP transport).

defaultRTOptionsTCP :: RTOptions Source

Default realtime server options (TCP transport).

Non-Realtime options

data NRTOptions Source

Non-realtime server options.

Constructors

NRTOptions

Fields

commandFilePath :: Maybe FilePath: Path to OSC command file (Nothing for stdin)
inputFilePath :: Maybe FilePath: Path to input sound file (Nothing for no audio input)
outputFilePath :: FilePath: Path to output sound file
outputSampleRate :: Int: Output sound file sample rate
outputHeaderFormat :: String: Output sound file header format
outputSampleFormat :: String: Output sound file sample format

Instances

Eq NRTOptions
Show NRTOptions

defaultNRTOptions :: NRTOptions Source

Default non-realtime server options.

_outputSampleFormat :: T NRTOptions String Source

_outputHeaderFormat :: T NRTOptions String Source

_outputSampleRate :: T NRTOptions Int Source

_outputFilePath :: T NRTOptions FilePath Source

_inputFilePath :: T NRTOptions (Maybe FilePath)Source

_commandFilePath :: T NRTOptions (Maybe FilePath)Source