Sound.SC3.Server.Process

This module includes utilities for spawning an external scsynth process, either for realtime or non-realtime execution.

Documentation

module Sound.SC3.Server.Process.Options

class OpenTransport t where

Helper class for polymorphic opening of network connections.

Methods

openTransport :: RTOptions -> String -> IO t

Open a transport to scsynth based on the given RTOptions and a hostname.

Instances

OpenTransport TCP

OpenTransport UDP

data OutputHandler

Handle output of external scsynth processes.

Constructors

OutputHandler

Fields

onPutString :: String -> IO ()

Handle one line of normal output

onPutError :: String -> IO ()

Handle one line of error output

defaultOutputHandler :: OutputHandler

Default IO handler, writing to stdout and stderr, respectively.

withSynth :: (Transport t, OpenTransport t) => ServerOptions -> RTOptions -> OutputHandler -> (t -> IO a) -> IO a

Execute a realtime instance of scsynth with Transport t.

The spawned scsynth is sent a /quit message after the supplied action returns.

NOTE: When compiling executables with GHC, the -threaded option should be passed, otherwise the I/O handlers will not work correctly.

withNRT :: ServerOptions -> NRTOptions -> OutputHandler -> (Handle -> IO a) -> IO a

Execute a non-realtime instance of scsynth and return ExitCode when the process exists.