PlonkSetup:
Filter:
PlonkSetup/Classes (extension) | Setup

PlonkSetup
ExtensionExtension

Scaffolding structure to hold instrument definitions and other performance parts

Description

A wrapper around a dictionary that allows to outline and run a complex set of sound definitions. All configuration and actual sound and interaction definitions should be in a set of files living in the project directory. There is a prototype directory in this quark's directory called protoSetup. Feel free to copy it to a place of your choice and fill it with your beautiful code.

Class Methods

.new

Returns a new instance of PlonkSetup.

Arguments:

path

the path to all your beautiful sound definitions and related files. Should also include a config.scd file with a dictionary (see examples below).

projectName

the name of your project. not super important but a should be a String or Symbol.

Instance Methods

.startup

Needs to be called to create everything. Loads the config file internally and starts the server.

Configuration

.loadConfig

Manually (re-)load config file.

Arguments:

force

Set to true to reload the config file.

.config

Access config file.

Introspection

.path

the path to your setup.

.server

the sound server.

.assetsDir

the assets directory in which e.g. sound files are stored.

.projectName

the name of the project

Sound

.sounds

.soundHelpers

Dictionaries holding sounds and sound helpers in the form of PlonkSoundSupport. To create a new sound resp. soundHelper, call this method and it will create a PlonkSoundSupport that you can populate.

Arguments:

key

.stopAllSounds

.playAllSounds

Start/Stop playback of all sounds.

.sync

Sync the server. Only possible inside a Task or Routine.

.startServer

Manually start the server. Called internally by startup

.proxyspace

a proxyspace to hold all NodeProxies for this setup

Logging

.log

logging mechanism.

Arguments:

who

a symbol determining the category of the process to be logged.

msg

the message

urgence

if true, message will be shown independant of the current verbosity level of the category.

.activateVerbose

.deactivateVerbose

(de)activate verbose levels.

Arguments:

who

a symbol determining which log messages should or should not be displayed.

.verbose

Arguments:

who

a symbol determining which log messages should or should not be displayed.

level

set to false to stop displaying methods

.verboseLevels

an Array of all verbose Symbols.

.systemName

the system name as it is extracted from the system.

Prototyping

.dict

an Event to possibly hold your prototyping elements.

.at

return something from dict

Arguments:

selector

the key under which the element is stored

.put

put something into dict

Arguments:

selector

the key under which the element should be stored

value

the element to be stored

Examples

helpfile source: HelpSource/Classes/PlonkSetup.schelp
link::PlonkSetup/Classes/PlonkSetup::