Safe Haskell	Safe-Inferred

Sound.SC3.Server.Process.Options

Synopsis

Documentation

data Verbosity Source

Used with the verbosity field in ServerOptions.

Constructors

Silent
Quiet
Normal
Verbose
VeryVerbose
ExtremelyVerbose

Instances

Enum Verbosity
Eq Verbosity
Read Verbosity
Show Verbosity
Default Verbosity
Option Verbosity

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
Default ServerOptions

defaultServerOptions :: ServerOptions Source

Default server options.

fromBuildDirectory :: FilePath -> ServerOptions -> ServerOptions Source

Run scsynth from a SuperCollider build directory.

Since 0.8.0

fromPrefix :: FilePath -> ServerOptions -> ServerOptions Source

Run scsynth from a Linux installation prefix.

Since 0.8.0

fromApplicationBundle :: FilePath -> ServerOptions -> ServerOptions Source

Run scsynth from an OSX application bundle.

Since 0.8.0

data NetworkPort Source

Network port.

Constructors

UDPPort Int
TCPPort Int

Instances

Eq NetworkPort
Show NetworkPort
Default NetworkPort
Option NetworkPort

defaultUDPPort :: NetworkPort Source

Default UDP port.

defaultTCPPort :: NetworkPort Source

Default TCP port.

data RTOptions Source

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

Constructors

RTOptions

Fields

networkPort :: NetworkPort: Network port
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 (see also jackDeviceName)
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
Default RTOptions

onPort :: NetworkPort -> RTOptions Source

Create RTOptions with a specific network port.

Since 0.8.0

jackDeviceName Source

Arguments

:: Maybe String	Optional JACK server name
-> String	JACK client name
-> String	Hardware device name

Create a JACK hardware device name from an optional server name and a client name.

Since 0.8.0

withJackDeviceName Source

Arguments

:: Maybe String	Optional JACK server name
-> String	JACK client name
-> RTOptions	Options to modify
-> RTOptions	Modified options

Modify options to use a jack device name based on an optional server name and a client name.

Since 0.8.0

defaultRTOptions :: RTOptions Source

Default realtime server options.

defaultRTOptionsUDP :: RTOptions Source

Deprecated: Use 'onPort defaultUDPPort' instead

Default realtime server options (UDP transport).

defaultRTOptionsTCP :: RTOptions Source

Deprecated: Use 'onPort defaultTCPPort' instead

Default realtime server options (TCP transport).

data NRTOptions Source

Non-realtime server options.

Constructors

NRTOptions
Fields 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 outputSoundFileFormat :: SoundFileFormat Output sound file header format (since 0.8.0) outputSampleFormat :: SampleFormat Output sound file sample format

Instances

Eq NRTOptions
Show NRTOptions
Default NRTOptions

defaultNRTOptions :: NRTOptions Source

Default non-realtime server options.