diff --git a/doc/objects.md b/doc/objects.md index 20575c20d9819b0190b0cfa843b7ea07539480d5..98d0344f715937a40bb3bf321ea2b15b1b43eb69 100644 --- a/doc/objects.md +++ b/doc/objects.md @@ -17,7 +17,7 @@ There can be more than one bf-session object with the same name within the patch ## bf-instrument A bf-instrument represents a musical instrument within the bf-pd system. Each instrument joins a bf-session and can contain bf-params and bf-outputs. To create an instrument you should instantiate a bf-instrument with the name of your instrument, e.g. [bf-instrument myDrumMachine]. -The audio output of your instrument should be connected to the first inlet of bf-instrument object. The interface for has an *activity monitor* which shows a simple representation of the changing spectrum of the instrument's sound, and the activity for each bf-instrument in the bf-session appears in the *collaboration window*. (Note: you must also send your audio to [dac~] in order to hear it!) +The audio output of your instrument should be connected to the first inlet of bf-instrument object. The interface has an *activity monitor* which shows a simple representation of the changing spectrum of the instrument's sound, and the activity for each bf-instrument in the bf-session appears in the *collaboration window*. (Note: you must also send your audio to [dac~] in order to hear it!) The *collaboration window* can be opened with the toggle in the bf-instrument object. If musicians enter or leave the session you may need to close and re-open the collaboration window. @@ -29,9 +29,9 @@ The *collaboration window* can be opened with the toggle in the bf-instrument ob ## bf-param -A bf-param creates a user parameter within the bf-pd system. A bf-param can be controlled by the user of the bf-instrument it belongs to, and the bf-param will also be accessible to other instruments within the bf-session, via the collaboration window, if the user of the bf-instrument grants access. +A bf-param creates a user parameter within the bf-pd system. A bf-param can be controlled by the user of the bf-instrument it belongs to, and the bf-param will also be accessible to other instruments within the bf-session via the collaboration window, if the owner of the bf-instrument grants access. -A bf-param object has a user interface within the instrument patch itself, and it creates a user interface in the collaboration window of each musician in the session. +A bf-param object has a user interface within the instrument patch itself, and it also creates a user interface in the collaboration window of each musician in the session. A bf-param can be one of four *types*: * *cont* are numbers between 0.0 and 1.0. @@ -39,7 +39,7 @@ A bf-param can be one of four *types*: * *bool* can take values of 0 or 1. * *bang* are bang messages which are used to trigger actions. -A bf-param can be a single instance of its type or it can be a multiple, which creates an array of values within a single bf-param object. For example, a bf-param "8 bool" creates an interface with 8 toggles, and might be used to represent 8 on/off values in a drum machine sequencers. +A bf-param can be a single instance of its type or it can be a multiple, which creates an array of values within a single bf-param object. For example, a bf-param "8 bool" creates an interface with 8 toggles, and might be used to represent 8 on/off values in a drum machine sequencer. ###### Arguments: 1. The name of the instrument, e.g. "myDrumMachine". @@ -47,7 +47,7 @@ A bf-param can be a single instance of its type or it can be a multiple, which c 3. The dimensionality of the parameter, e.g. "8" 4. The type of the parameter, e.g. "bool" -So a parameter to store 8 drum machine note triggers would be: +So a bf-param with 8 drum machine note triggers would be: `[bf-param myDrumMachine kickOnOff 8 bool]` and creates this object within your patch: 