hsc3-process-0.0.0: Create and control scsynth processesSource codeContentsIndex
Sound.SC3.Server.Process.Options
Contents
Server options
Realtime options
Non-Realtime options
Synopsis
data Verbosity
= Silent
| Quiet
| Normal
| Verbose
| VeryVerbose
| ExtremelyVerbose
data ServerOptions = ServerOptions {
serverProgram :: FilePath
numberOfControlBusChannels :: Int
numberOfAudioBusChannels :: Int
numberOfInputBusChannels :: Int
numberOfOutputBusChannels :: Int
blockSize :: Int
numberOfSampleBuffers :: Int
maxNumberOfNodes :: Int
maxNumberOfSynthDefs :: Int
realtimeMemorySize :: Int
numberOfWireBuffers :: Int
numberOfRandomSeeds :: Int
loadSynthDefs :: Bool
verbosity :: Verbosity
}
defaultServerOptions :: ServerOptions
realTimeMemorySize :: ServerOptions -> Int
_realTimeMemorySize :: Accessor ServerOptions Int
data RTOptions = RTOptions {
udpPortNumber :: Int
tcpPortNumber :: Int
useZeroconf :: Bool
maxNumberOfLogins :: Int
sessionPassword :: Maybe String
hardwareDeviceName :: Maybe String
hardwareBufferSize :: Int
hardwareSampleRate :: Int
inputStreamsEnabled :: Maybe Int
outputStreamsEnabled :: Maybe Int
}
defaultRTOptions :: RTOptions
defaultRTOptionsUDP :: RTOptions
defaultRTOptionsTCP :: RTOptions
data NRTOptions = NRTOptions {
commandFilePath :: Maybe FilePath
inputFilePath :: Maybe FilePath
outputFilePath :: FilePath
outputSampleRate :: Int
outputHeaderFormat :: String
outputSampleFormat :: String
}
defaultNRTOptions :: NRTOptions
Documentation
data Verbosity Source
Used with the verbosity field in ServerOptions.
Constructors
Silent
Quiet
Normal
Verbose
VeryVerbose
ExtremelyVerbose
show/hide Instances
Server options
data ServerOptions Source
Specify general server options used both in realtime and non-realtime mode.
Constructors
ServerOptions
serverProgram :: FilePathPath to the scsynth program
numberOfControlBusChannels :: IntNumber of allocated control bus channels
numberOfAudioBusChannels :: IntNumber of allocated audio bus channels
numberOfInputBusChannels :: IntNumber of physical input channels
numberOfOutputBusChannels :: IntNumber of physical output channels
blockSize :: IntSynthesis block size
numberOfSampleBuffers :: IntNumber of allocated sample buffers
maxNumberOfNodes :: IntMaximum number of synthesis nodes
maxNumberOfSynthDefs :: IntMaximum number of synth definitions
realtimeMemorySize :: IntRealtime memory size in bytes
numberOfWireBuffers :: IntNumber of unit generator connection buffers
numberOfRandomSeeds :: IntNumber of random number generator seeds
loadSynthDefs :: BoolIf True, load synth definitions from synthdefs directory on startup
verbosity :: VerbosityVerbosity level
show/hide Instances
defaultServerOptions :: ServerOptionsSource
Default server options.
realTimeMemorySize :: ServerOptions -> IntSource
_realTimeMemorySize :: Accessor ServerOptions IntSource
Realtime options
data RTOptions Source
Realtime server options, parameterized by the OpenSoundControl Transport to be used.
Constructors
RTOptions
udpPortNumber :: IntUDP port number (one of udpPortNumber and tcpPortNumber must be non-zero)
tcpPortNumber :: IntTCP port number (one of udpPortNumber and tcpPortNumber must be non-zero)
useZeroconf :: BoolIf True, publish scsynth service through Zeroconf
maxNumberOfLogins :: IntMax number of supported logins if sessionPassword is set
sessionPassword :: Maybe StringSession password Audio device control
hardwareDeviceName :: Maybe StringHardware device name (JACK client:server name on Linux)
hardwareBufferSize :: IntHardware buffer size (no effect with JACK)
hardwareSampleRate :: IntHardware buffer size (no effect with JACK)
inputStreamsEnabled :: Maybe IntEnabled input streams (CoreAudio only)
outputStreamsEnabled :: Maybe IntEnabled output streams (CoreAudio only)
show/hide Instances
defaultRTOptions :: RTOptionsSource
Default realtime server options.
defaultRTOptionsUDP :: RTOptionsSource
Default realtime server options (UDP transport).
defaultRTOptionsTCP :: RTOptionsSource
Default realtime server options (TCP transport).
Non-Realtime options
data NRTOptions Source
Non-realtime server options.
Constructors
NRTOptions
commandFilePath :: Maybe FilePathPath to OSC command file (Nothing for stdin)
inputFilePath :: Maybe FilePathPath to input sound file (Nothing for no audio input)
outputFilePath :: FilePathPath to output sound file
outputSampleRate :: IntOutput sound file sample rate
outputHeaderFormat :: StringOutput sound file header format
outputSampleFormat :: StringOutput sound file sample format
show/hide Instances
defaultNRTOptions :: NRTOptionsSource
Default non-realtime server options.
Produced by Haddock version 2.4.2