Vivid.Actions.Class

A VividAction m => m a can either be run immediately, be scheduled to run at a precise future time, or be used for non-realtime synthesis.

Note that at the moment VividAction has MonadIO, but this won't be true in upcoming versions (as early as the next release) - so don't get used to it!

Documentation

class (Monad m, MonadIO m) => VividAction m where

Minimal complete definition

callBS, sync, waitForSync, wait, getTime, newBufferId, newNodeId, newSyncId, fork, defineSD

Methods

callOSC :: OSC -> m ()

Send an OSC message to the SuperCollider server

callBS :: ByteString -> m ()

Send a ByteString to the SuperCollider server. You usually want to use call instead.

sync :: m ()

Blocks until the server finishes processing commands

waitForSync :: SyncId -> m ()

As the user, you probably don't want to use this:

Many commands already include a "sync" -- e.g. makeBuffer already syncs.

When you do want to do an explicit sync you probably want to use sync instead, or callOSCAndSync

wait :: RealFrac n => n -> m ()

Wait, in seconds

getTime :: m Timestamp

newBufferId :: m BufferId

newNodeId :: m NodeId

newSyncId :: m SyncId

fork :: m () -> m ()

defineSD :: SynthDef a -> m ()

Send a synth definition to be loaded on the SC server

Note that this is sort of optional -- if you don't call it, it'll be called the first time you call synth with the SynthDef

callOSCAndSync :: VividAction m => OSC -> m ()

Send an OSC message and wait for it to complete before returning