HB (HappyBrackets API)

java.lang.Object
- net.happybrackets.device.HB

```
public class HB
extends java.lang.Object
```
HB is the main controller class for a HappyBrackets program. It is accessed from an HBAction's HBAction.action(HB) method, where users can play sounds, create network listeners, send network messages, and perform other actions.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HB.AccessMode`
`static class`	`HB.DeviceType` The Type of Hardware that this instance of HappyBrackets is running on
`static interface`	`HB.StatusChangedListener`

Field Summary

Fields
Modifier and Type	Field and Description
`net.beadsproject.beads.core.AudioContext`	`ac` The `AudioContext` used by HappyBrackets.
`static BroadcastManager`	`broadcast` The `BroadcastManager`object used to communicate with other devices using 1-many broadcasts.
`net.beadsproject.beads.ugens.Clock`	`clock` The `Clock` used by HappyBrackets.
`net.beadsproject.beads.ugens.Envelope`	`clockInterval` The `Envelope` that controls the clock interval.
`NetworkCommunication`	`controller` The `NetworkCommunication` object used to communicate with the controller.
`static HB`	`HBInstance`
`net.beadsproject.beads.ugens.Envelope`	`masterGainEnv` The `Envelope` used to control the master gain.
`net.beadsproject.beads.ugens.PolyLimit`	`pl` The `PolyLimit` that controls polyphony.
`java.util.Random`	`rng` A random number generator for general use.
`java.util.Hashtable<java.lang.Class<? extends Sensor>,Sensor>`	`sensors` A `Hashtable` to store sensors.
`java.util.Hashtable<java.lang.String,java.lang.Object>`	`share` A `Hashtable` to store generic objects.
`Synchronizer`	`synch` The `Synchronizer` object used to manage time synch between devices.

Constructor Summary

Constructors
Constructor and Description
`HB(net.beadsproject.beads.core.AudioContext _ac)` Creates the HB.
`HB(net.beadsproject.beads.core.AudioContext _ac, HB.AccessMode _am)` Creates the HB.
`HB(net.beadsproject.beads.core.AudioContext _ac, HB.AccessMode _am, boolean start_network)` Creates the HB.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBroadcastListener(de.sciss.net.OSCListener listener)` Add a new `OSCListener`, listening to broadcasts.
`void`	`addControllerListener(de.sciss.net.OSCListener listener)` Add a new `OSCListener`, listening to incoming messages from the controller.
`boolean`	`addDeviceAddress(java.lang.String name, java.net.InetAddress address)` Associate a device name with an `InetAddress`
`void`	`addDeviceConnectedEventListener(DeviceConnectedEventListener listener)` Add a `DeviceConnectedEventListener` to be informed when a new device is detected on the network
`void`	`addStatusChangedListener(HB.StatusChangedListener listener)` Add Listeners for status change event
`static void`	`adjustScheduleTime(double amount, long duration)` Adjust the `HBScheduler` scheduler time
`void`	`attemptHBActionFromClassName(java.lang.String class_name)` Attempts to load the given class as an `HBAction`.
`void`	`broadcast(java.lang.String string, java.lang.Object... args)` Broadcast an `OSCMessage` msg over the multicast group.
`void`	`clearRegisteredVariable(java.lang.String name)` Erases @`Object` with the given name from the registered memory store.
`void`	`clearSound()` Clears all of the audio that is currently playing (connected to output).
`static Clock`	`createClock(double interval)` Create a new Clock using HappyBrackets scheduler
`static DynamicControl`	`createControlBuddyPair(java.lang.Object parent_sketch, ControlType control_type, java.lang.String name, java.lang.Object initial_value, java.lang.Object min_value, java.lang.Object max_value)` A dynamic control pair that can be accessed from outside it is created with the sketch object that contains it along with the type only a single dynamic control is returned becasue the buddy is a mirror
`static DynamicControl`	`createDynamicControl(ControlType control_type, java.lang.String name)` A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
`static DynamicControl`	`createDynamicControl(ControlType control_type, java.lang.String name, java.lang.Object initial_value)` A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
`static DynamicControl`	`createDynamicControl(ControlType control_type, java.lang.String name, java.lang.Object initial_value, java.lang.Object min_value, java.lang.Object max_value)` A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
`static DynamicControl`	`createDynamicControl(java.lang.Object parent_sketch, ControlType control_type, java.lang.String name)` A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
`static DynamicControl`	`createDynamicControl(java.lang.Object parent_sketch, ControlType control_type, java.lang.String name, java.lang.Object initial_value)` A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
`static DynamicControl`	`createDynamicControl(java.lang.Object parent_sketch, ControlType control_type, java.lang.String name, java.lang.Object initial_value, java.lang.Object min_value, java.lang.Object max_value)` A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
`static de.sciss.net.OSCMessage`	`createOSCMessage(java.lang.String name, java.lang.Object... args)` Creates a valid OSC message.
`static HB.DeviceType`	`detectDeviceType()` Detect the type of device we are running by reading specific files through filesystem If detected, the new `HB.DeviceType` is stored
`void`	`doAtTime(java.lang.Runnable runnable, long time)` Causes an action to be implemented at the given, synchronized time.
`void`	`fadeOutClearSound(float fadeTime)` Like `clearSound()` but with a fade out of the specified duration before clearing.
`void`	`fadeOutReset(float fadeTime)` Like `reset()` but with a fade out of the specified duration before clearing.
`Sensor`	`findSensor(java.lang.Class sensorClass)`
`static void`	`flashLed(int num_blinks, int interval)` FLash the onboard LED
`java.lang.String`	`friendlyName()` Returns a freindly name for the device.
`java.lang.Object`	`get(java.lang.String s)` Gets an @`Object` with the given name from the global memory store.
`static net.beadsproject.beads.core.UGen`	`getAccelerometer_X()` Return a UGen that is mapped to Accelerometer X value
`static net.beadsproject.beads.core.UGen`	`getAccelerometer_X(double scale_min, double scale_max)` Return a UGen that is mapped to Accelerometer X value
`static net.beadsproject.beads.core.UGen`	`getAccelerometer_Y()` Return a UGen that is mapped to Accelerometer Y value
`static net.beadsproject.beads.core.UGen`	`getAccelerometer_Y(double scale_min, double scale_max)` Return a UGen that is mapped to Accelerometer Y value
`static net.beadsproject.beads.core.UGen`	`getAccelerometer_Z()` Return a UGen that is mapped to Accelerometer Z value
`static net.beadsproject.beads.core.UGen`	`getAccelerometer_Z(double scale_min, double scale_max)` Return a UGen that is mapped to Accelerometer Z value
`static net.beadsproject.beads.core.UGen`	`getAudioOutput()` Get the default HappyBrackets audio output as a UGen
`net.beadsproject.beads.core.Bead`	`getBead(java.lang.String s)` Gets an object of type @`Bead` from the global memory store.
`java.net.InetAddress`	`getDeviceAddress(java.lang.String name)` Return the `InetAddress` associated with this device name that we can address that device with If the device is this, then it will return the loopback address
`static HB.DeviceType`	`getDeviceType()` The Type of Device this instance of HappyBrackets is running on
`float`	`getFloat(java.lang.String s)` Gets an object of type float from the global memory store.
`float`	`getFloatArg(de.sciss.net.OSCMessage m, int index)` Gets a float arg from an `OSCMessage`.
`static double`	`getFutureSchedulerTime(double milliseconds)` Get a scheduler time in the future from `getSchedulerTime()`.
`float`	`getGain()` Get the current gain of the device
`static net.beadsproject.beads.core.UGen`	`getGyroscopePitch()` Return a UGen that is mapped to Gyroscope Pitch value
`static net.beadsproject.beads.core.UGen`	`getGyroscopeRoll()` Return a UGen that is mapped to Gyroscope Roll value
`static net.beadsproject.beads.core.UGen`	`getGyroscopeYaw()` Return a UGen that is mapped to Gyroscope Yaw value
`int`	`getInt(java.lang.String s)` Gets an object of type int from the global memory store.
`java.util.Collection<java.lang.String>`	`getKnownDeviceNames()` Get the names of the devices that we know are on the network.
`MuteControl`	`getMuteControl()` Return the Mute Control
`static int`	`getNumOutChannels()` Get the number of audio channels on the default HappyBrackets audio output This parameter is dependant upon the configuration of the device
`java.lang.Object`	`getRegisteredVariable(java.lang.String name)` Gets an @`Object` with the given name from the registered memory store.
`static HBScheduler`	`getScheduler()` Get the global `HBScheduler`
`static double`	`getSchedulerTime()` Get the amount of time elapsed since we set reference time in `HBScheduler`
`java.net.InetAddress`	`getSendingController(java.lang.Object classObject)` Get the `InetAddress` of the controller that sent the class If the class was loaded on startup it will be null
`Sensor`	`getSensor(java.lang.Class sensorClass)` Gets the sensor with the given sensor ID.
`java.lang.String`	`getStatus()` Returns the current status @`String` of the device.
`java.lang.String`	`getString(java.lang.String s)` Gets an object of type @`String` from the global memory store.
`long`	`getSynchTime()` Returns the system time adjusted according to the result of any device synch attempts.
`net.beadsproject.beads.core.UGen`	`getUGen(java.lang.String s)` Gets an object of type @`UGen` from the global memory store.
`boolean`	`hasClassesLoaded()` Determine if we have any classes Loaded
`static boolean`	`isEnableSimulators()` Return whether we will displaysimulator sensors if no hardware sensor is found
`static boolean`	`isOurAddress(java.net.InetAddress address)` Detect whether this `InetAddress` is actually this device
`boolean`	`messageIs(de.sciss.net.OSCMessage m, java.lang.String match)` Checks for an exact match to a string.
`boolean`	`muteAudio(boolean mute)` Perform a mute or Unmute of Output
`int`	`myConnectPort()`
`int`	`myIndex()` Returns the assigned ID of the current device.
`java.lang.String`	`pattern(net.beadsproject.beads.core.Bead pattern)` Adds a new pattern `Bead` object to the `Clock`.
`java.lang.Object`	`perm(java.lang.String id, java.lang.Object o)` Stores an object in the global memory store.
`void`	`pullConfigFileFromController()` Notifies the device that it should try to pull the device config file from the controller.
`void`	`put(java.lang.String s, java.lang.Object o)` Puts an `Object` into the global memory store with a given name.
`static void`	`rebootDevice()` Reboots the device immediately.
`void`	`registerVariable(java.lang.String name, java.lang.Object value)` Puts an `Object` into the global memory store with a given name.
`void`	`reset()`
`void`	`resetLeaveSounding()` Like `reset()` except that any sounds currently playing are kept.
`static boolean`	`runDebug(java.lang.Class<?> action_class)` Run HB in a debug mode so we can debug sample code in INtelliJ run the command like this: HB.runDebug(MethodHandles.lookup().lookupClass());
`static boolean`	`sendScheduleChange(double amount, long duration, java.util.Collection<java.lang.String> targets)` Send a schedule adjustment message to one or more devices.
`static boolean`	`sendScheduleSetTime(double new_time, java.util.Collection<java.lang.String> targets)` Send a Schedule Set time to one or more targets
`static void`	`sendStatus(java.lang.String status)` Static version of `sendStatus(String)`.
`void`	`sendToController(java.lang.String string, java.lang.Object... args)` Send an `OSCMessage` to the controller.
`static boolean`	`setDeviceLedValue(boolean on)` Return the Integer value required to turn the onboard LED on or off based on stored `HB.DeviceType`
`static void`	`setEnableSimulators(boolean enableSimulators)` Set whether we will displaysimulator sensors if no hardware sensor is found
`void`	`setFriendlyName(java.lang.String name)` We will set the friendly of the device here.
`void`	`setGain(float new_gain, float millseconds)` Set the output gain of the device in an envelope.
`void`	`setMyIndex(int val)` We will set the index of the device here.
`static void`	`setScheduleTime(double new_time)` Set the global `HBScheduler` scheduled time to this time
`void`	`setStatus(java.lang.String s)` Sets the status @`String` of this device.
`void`	`setTCPServerPort(int tcpServerPort)` Set the TCP Osc Port given to us by operating system We will pass it to the controller so it knows how to connect to us
`void`	`setUseEncryption(boolean enable)` Whether we will use encryption in transferring class data
`static void`	`shutdownDevice()`
`java.lang.String`	`sound(net.beadsproject.beads.core.UGen snd)` Adds a sound to the audio output.
`void`	`startAudio()` Causes audio processing to start.
`void`	`sychronisedBleep(double schedule_time)` Perform a bleep at the network scheduled time.
`void`	`syncAudioStart(int intervalForSyncAction)` Causes the audio to start at a given synchronised time on all devices.
`static double`	`synchroniseClocks()` Synchronise `HBScheduler` timer with the system time on next tick
`static double`	`synchroniseClocks(long slew_time)` Synchronise global `HBScheduler` timer with the system time
`void`	`testBleep()` Produces a single short test bleep on the device.
`void`	`testBleep3()` Produces a short series of 3 bleeps on the device.
`void`	`testBleep6()` Produces a short series of 6 bleeps on the device to indicate an error.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HBInstance
```
public static HB HBInstance
```
  - ac
```
public final net.beadsproject.beads.core.AudioContext ac
```
    The AudioContext used by HappyBrackets. This is autorun by default from the start script, but that can be controlled by a commandline flag.
  - clock
```
public final net.beadsproject.beads.ugens.Clock clock
```
    The Clock used by HappyBrackets. This is up and running, with a default interval of 500ms and default "ticks per beat" of 16.
  - clockInterval
```
public final net.beadsproject.beads.ugens.Envelope clockInterval
```
    The Envelope that controls the clock interval. Default value is 500ms.
  - pl
```
public final net.beadsproject.beads.ugens.PolyLimit pl
```
    The PolyLimit that controls polyphony. This is used for sounds added with the sound(UGen) method. Default number of voices is 4.
  - masterGainEnv
```
public final net.beadsproject.beads.ugens.Envelope masterGainEnv
```
    The Envelope used to control the master gain. Default value is 1.
  - sensors
```
public final java.util.Hashtable<java.lang.Class<? extends Sensor>,Sensor> sensors
```
    A Hashtable to store sensors.
  - share
```
public final java.util.Hashtable<java.lang.String,java.lang.Object> share
```
    A Hashtable to store generic objects.
  - rng
```
public final java.util.Random rng
```
    A random number generator for general use.
  - controller
```
public final NetworkCommunication controller
```
    The NetworkCommunication object used to communicate with the controller. The important methods are provided directly from HB, e.g., sendToController(String, Object...) and addControllerListener(OSCListener).
  - broadcast
```
public static BroadcastManager broadcast
```
    The BroadcastManagerobject used to communicate with other devices using 1-many broadcasts. The important methods are provided directly from HB, e.g., broadcast(String, Object...) and addBroadcastListener(OSCListener).
  - synch
```
public final Synchronizer synch
```
    The Synchronizer object used to manage time synch between devices. The important methods are provided directly from HB, e.g., doAtTime(Runnable, long) and getSynchTime().
- Constructor Detail
  - HB
```
public HB(net.beadsproject.beads.core.AudioContext _ac)
   throws java.io.IOException
```
    Creates the HB.
    
    Parameters:
    
    _ac - the AudioContext for audio.
    
    Throws:
    
    java.io.IOException - if any of the core network set up fails. Could happen if port is already in use, or if setting up multicast fails.
  - HB
```
public HB(net.beadsproject.beads.core.AudioContext _ac,
          HB.AccessMode _am)
   throws java.io.IOException
```
    Creates the HB.
    
    Parameters:
    
    _ac - the AudioContext for audio.
    
    _am - The access mode.
    
    Throws:
    
    java.io.IOException - if any of the core network set up fails. Could happen if port is already in use, or if setting up multicast fails.
  - HB
```
public HB(net.beadsproject.beads.core.AudioContext _ac,
          HB.AccessMode _am,
          boolean start_network)
   throws java.io.IOException
```
    Creates the HB.
    
    Parameters:
    
    _ac - the AudioContext for audio.
    
    _am - The access mode.
    
    start_network - true if we are to start networking
    
    Throws:
    
    java.io.IOException - if any of the core network set up fails. Could happen if port is already in use, or if setting up multicast fails.
- Method Detail
  - getMuteControl
```
public MuteControl getMuteControl()
```
    Return the Mute Control
    
    Returns:
    
    the Mute Control
  - isEnableSimulators
```
public static boolean isEnableSimulators()
```
    Return whether we will displaysimulator sensors if no hardware sensor is found
    
    Returns:
    
    true if we will display
  - setEnableSimulators
```
public static void setEnableSimulators(boolean enableSimulators)
```
    Set whether we will displaysimulator sensors if no hardware sensor is found
    
    Parameters:
    
    enableSimulators - true if we want to display simulator controls
  - setTCPServerPort
```
public void setTCPServerPort(int tcpServerPort)
```
    Set the TCP Osc Port given to us by operating system We will pass it to the controller so it knows how to connect to us
    
    Parameters:
    
    tcpServerPort - the Port we need to connect to TCP server
  - setUseEncryption
```
public void setUseEncryption(boolean enable)
```
    Whether we will use encryption in transferring class data
    
    Parameters:
    
    enable - true if we want to use encryption
  - getSendingController
```
public java.net.InetAddress getSendingController(java.lang.Object classObject)
```
    Get the InetAddress of the controller that sent the class If the class was loaded on startup it will be null
    
    Parameters:
    
    classObject - the class that was sent by the controller
    
    Returns:
    
    Address of controller that sent the class. If was a startup class, then returns null
  - hasClassesLoaded
```
public boolean hasClassesLoaded()
```
    Determine if we have any classes Loaded
    
    Returns:
    
    true if we have any classes loaded
  - addStatusChangedListener
```
public void addStatusChangedListener(HB.StatusChangedListener listener)
```
    Add Listeners for status change event
    
    Parameters:
    
    listener - The listener to add
  - setDeviceLedValue
```
public static boolean setDeviceLedValue(boolean on)
```
    Return the Integer value required to turn the onboard LED on or off based on stored HB.DeviceType
    
    Parameters:
    
    on - true if turning LED on, false if Turning Off
    
    Returns:
    
    true if able to send value
  - getDeviceType
```
public static HB.DeviceType getDeviceType()
```
    The Type of Device this instance of HappyBrackets is running on
    
    Returns:
    
    the Type of Device
  - detectDeviceType
```
public static HB.DeviceType detectDeviceType()
```
    Detect the type of device we are running by reading specific files through filesystem If detected, the new HB.DeviceType is stored
    
    Returns:
    
    new deviceType detected. If none dected, whatever has been set previously
  - muteAudio
```
public boolean muteAudio(boolean mute)
```
    Perform a mute or Unmute of Output
    
    Parameters:
    
    mute - true if we want to mute
    
    Returns:
    
    the value of previous mute state.
  - runDebug
```
public static boolean runDebug(java.lang.Class<?> action_class)
                        throws java.lang.Exception
```
    Run HB in a debug mode so we can debug sample code in INtelliJ run the command like this: HB.runDebug(MethodHandles.lookup().lookupClass());
    
    Parameters:
    
    action_class - The class that we are debugging. use MethodHandles.lookup().lookupClass()
    
    Returns:
    
    true if we are debugging
    
    Throws:
    
    java.io.IOException - if there is a problem with the debug
    
    java.lang.Exception
  - broadcast
```
public void broadcast(java.lang.String string,
                      java.lang.Object... args)
```
    Broadcast an OSCMessage msg over the multicast group.
    
    Parameters:
    
    string - the message string to send.
    
    args - the args to the message.
  - createOSCMessage
```
public static de.sciss.net.OSCMessage createOSCMessage(java.lang.String name,
                                                       java.lang.Object... args)
```
    Creates a valid OSC message. It converts invalid types to OSC compatible EG, doubles to floats, boolean to int, long to int
    
    Parameters:
    
    name - OSC Message name
    
    args - arguments
    
    Returns:
    
    OSCMessage
  - sendToController
```
public void sendToController(java.lang.String string,
                             java.lang.Object... args)
```
    Send an OSCMessage to the controller. The controller already responds to certain OSCMessages that are already generated automatically. Best not to interefere with these. This function is only really useful if you are going to modify your controller program.
    
    Parameters:
    
    string - the message string to send.
    
    args - the args of the message.
  - addBroadcastListener
```
public void addBroadcastListener(de.sciss.net.OSCListener listener)
```
    Add a new OSCListener, listening to broadcasts.
    
    Parameters:
    
    listener - the new OSCListener.
  - addControllerListener
```
public void addControllerListener(de.sciss.net.OSCListener listener)
```
    Add a new OSCListener, listening to incoming messages from the controller.
    
    Parameters:
    
    listener - the new listener.
  - syncAudioStart
```
public void syncAudioStart(int intervalForSyncAction)
```
    Causes the audio to start at a given synchronised time on all devices.
    
    Parameters:
    
    intervalForSyncAction - time at which to sync, according to the agreed clock time
  - getSynchTime
```
public long getSynchTime()
```
    Returns the system time adjusted according to the result of any device synch attempts.
    
    Returns:
    
    corrected time as long, in millseconds since 1st Jan 1970.
  - doAtTime
```
public void doAtTime(java.lang.Runnable runnable,
                     long time)
```
    Causes an action to be implemented at the given, synchronized time.
    
    Parameters:
    
    runnable - the action to perform.
    
    time - the time at which to perform the action, in millseconds since 1st Jan 1970.
  - startAudio
```
public void startAudio()
```
    Causes audio processing to start. By default, audio runs on startup. This is a commandline flag to DeviceMain.
  - pullConfigFileFromController
```
public void pullConfigFileFromController()
                                  throws java.io.IOException
```
    Notifies the device that it should try to pull the device config file from the controller.
    
    Throws:
    
    java.io.IOException - if the HTTP connection fails.
  - messageIs
```
public boolean messageIs(de.sciss.net.OSCMessage m,
                         java.lang.String match)
```
    Checks for an exact match to a string.
    
    Parameters:
    
    m - the message to check.
    
    match - the string to check for.
    
    Returns:
    
    true if match.
  - getFloatArg
```
public float getFloatArg(de.sciss.net.OSCMessage m,
                         int index)
```
    Gets a float arg from an OSCMessage. Accesses the arg as a float even if the arg is type int.
    
    Parameters:
    
    m - the message.
    
    index - the index of the argument.
    
    Returns:
    
    a float argument.
  - sychronisedBleep
```
public void sychronisedBleep(double schedule_time)
```
    Perform a bleep at the network scheduled time. After sending message, will send a status message
    
    Parameters:
    
    schedule_time - the time on the global HBScheduler to action message
  - testBleep
```
public void testBleep()
```
    Produces a single short test bleep on the device. Assumes audio is running.
  - flashLed
```
public static void flashLed(int num_blinks,
                            int interval)
```
    FLash the onboard LED
    
    Parameters:
    
    num_blinks - the number of times the LED wil blink on and Off
    
    interval - The interval between blinks
  - testBleep3
```
public void testBleep3()
```
    Produces a short series of 3 bleeps on the device. Assumes audio is running.
  - testBleep6
```
public void testBleep6()
```
    Produces a short series of 6 bleeps on the device to indicate an error. Assumes audio is running.
  - attemptHBActionFromClassName
```
public void attemptHBActionFromClassName(java.lang.String class_name)
```
    Attempts to load the given class as an HBAction. If an HBAction can be found matching the fully qualified Java classname then this is loaded and its HBAction.action(HB) method is run.
    
    Parameters:
    
    class_name - The class name
  - getSensor
```
public Sensor getSensor(java.lang.Class sensorClass)
```
    Gets the sensor with the given sensor ID. This will attempt to make a connection with the given sensor. Note that this function will be deprecated in 3.0 deprecated use findSensor(java.lang.Class) instead.
    
    Parameters:
    
    sensorClass - the class of the Sensor you want returned
    
    Returns:
    
    the returned Sensor, if one can be found
  - findSensor
```
public Sensor findSensor(java.lang.Class sensorClass)
                  throws SensorNotFoundException
```
    Parameters:
    
    sensorClass - the class of the Sensor you want returned
    
    Returns:
    
    the returned Sensor
    
    Throws:
    
    SensorNotFoundException - if sensor type not found
  - put
```
public void put(java.lang.String s,
                java.lang.Object o)
```
    Puts an Object into the global memory store with a given name. This overwrites any object that was previously stored with the given name.
    
    Parameters:
    
    s - String name to store the object with.
    
    o - Object to store.
  - registerVariable
```
public void registerVariable(java.lang.String name,
                             java.lang.Object value)
```
    Puts an Object into the global memory store with a given name. This overwrites any object that was previously stored with the given name. Values does not get reset, however, is still volatile
    
    Parameters:
    
    name - String name to store the object with.
    
    value - Object to store.
  - getRegisteredVariable
```
public java.lang.Object getRegisteredVariable(java.lang.String name)
```
    Gets an @Object with the given name from the registered memory store. Returns null if there is no object with this name.
    
    Parameters:
    
    name - String name object is mapped as
    
    Returns:
    
    an @Object or null if there is no object.
  - clearRegisteredVariable
```
public void clearRegisteredVariable(java.lang.String name)
```
    Erases @Object with the given name from the registered memory store.
    
    Parameters:
    
    name - String name object is mapped as
  - get
```
public java.lang.Object get(java.lang.String s)
```
    Gets an @Object with the given name from the global memory store. Returns null if there is no object with this name.
    
    Parameters:
    
    s - the name of the object.
    
    Returns:
    
    an @Object or null if there is no object.
  - getInt
```
public int getInt(java.lang.String s)
```
    Gets an object of type int from the global memory store.
    
    Parameters:
    
    s - the name of the int.
    
    Returns:
    
    the int, or null if there is no object.
    
    Throws:
    
    java.lang.ClassCastException - if the stored object is not an int.
  - getFloat
```
public float getFloat(java.lang.String s)
```
    Gets an object of type float from the global memory store.
    
    Parameters:
    
    s - the name of the float.
    
    Returns:
    
    the float, or null if there is no object.
    
    Throws:
    
    java.lang.ClassCastException - if the stored object is not a float.
  - getString
```
public java.lang.String getString(java.lang.String s)
```
    Gets an object of type @String from the global memory store.
    
    Parameters:
    
    s - the name of the @String.
    
    Returns:
    
    the @String, or null if there is no object.
    
    Throws:
    
    java.lang.ClassCastException - if the stored object is not a @String.
  - getUGen
```
public net.beadsproject.beads.core.UGen getUGen(java.lang.String s)
```
    Gets an object of type @UGen from the global memory store.
    
    Parameters:
    
    s - the name of the @UGen.
    
    Returns:
    
    the @UGen, or null if there is no object.
    
    Throws:
    
    java.lang.ClassCastException - if the stored object is not a @UGen.
  - getBead
```
public net.beadsproject.beads.core.Bead getBead(java.lang.String s)
```
    Gets an object of type @Bead from the global memory store.
    
    Parameters:
    
    s - the name of the @Bead.
    
    Returns:
    
    the @Bead, or null if there is no object.
    
    Throws:
    
    java.lang.ClassCastException - if the stored object is not a @Bead.
  - perm
```
public java.lang.Object perm(java.lang.String id,
                             java.lang.Object o)
```
    Stores an object in the global memory store. The object is stored only if you haven't already created something with that name. If you have, then the new object is not stored and the existing object is returned instead. Returns either the existing stored object or the new object.
    
    Parameters:
    
    id - ID String of the object to store.
    
    o - the object.
    
    Returns:
    
    either the new stored object or the existing object if something previously stored there.
  - pattern
```
public java.lang.String pattern(net.beadsproject.beads.core.Bead pattern)
```
    Adds a new pattern Bead object to the Clock. This will be removed using reset() or resetLeaveSounding(), or can be specifically removed by killing the Bead.
    
    Parameters:
    
    pattern - to play.
    
    Returns:
    
    returns a string of the form "patternX" that can be used to store the pattern in global memory.
  - sound
```
public java.lang.String sound(net.beadsproject.beads.core.UGen snd)
```
    Adds a sound to the audio output. The sound, in the form of any @UGen, is played immediately. It can be killed by calling reset(), or by manually destroying the sound with a Bead.kill() message. Note that the system automatically limits the number of sounds added using a @PolyLimit object.
    
    Parameters:
    
    snd - the sound to play.
    
    Returns:
    
    returns a string of the form "sndX" that can be used to store the pattern in global memory.
  - clearSound
```
public void clearSound()
```
    Clears all of the audio that is currently playing (connected to output). Warning, this leaves dependents and patterns. Just cleans the audio signal chain. If you want to completely clear all objects, use reset() and if you want to clear everything except the sound, use resetLeaveSounding().
  - reset
```
public void reset()
```
  - resetLeaveSounding
```
public void resetLeaveSounding()
```
    Like reset() except that any sounds currently playing are kept. This includes everything that is in the global memory store, all patterns, all dependents, all sensor behaviours and all controller listener behaviours.
  - getAudioOutput
```
public static net.beadsproject.beads.core.UGen getAudioOutput()
```
    Get the default HappyBrackets audio output as a UGen
    
    Returns:
    
    the default HappyBrackets audio Output Ugen
  - getNumOutChannels
```
public static int getNumOutChannels()
```
    Get the number of audio channels on the default HappyBrackets audio output
    This parameter is dependant upon the configuration of the device
    
    Returns:
    
    the number of channels
  - fadeOutClearSound
```
public void fadeOutClearSound(float fadeTime)
```
    Like clearSound() but with a fade out of the specified duration before clearing.
    
    Parameters:
    
    fadeTime - the fade out time in milliseconds.
  - fadeOutReset
```
public void fadeOutReset(float fadeTime)
```
    Like reset() but with a fade out of the specified duration before clearing.
    
    Parameters:
    
    fadeTime - the fade out time in milliseconds.
  - myIndex
```
public int myIndex()
```
    Returns the assigned ID of the current device. The ID is a non-negative integer. The controller assigns IDs to devices based on either a look-up table in a file of known devices (mapping hostnames to IDs), or by assigning new integers on the fly. The ID of a device that has not yet been assigned an ID from the controller is -1.
    
    Returns:
    
    the ID of this device, as assigned by the current controller.
  - myConnectPort
```
public int myConnectPort()
```
  - setMyIndex
```
public void setMyIndex(int val)
```
    We will set the index of the device here. It may be set by a controller
    
    Parameters:
    
    val - new value
  - friendlyName
```
public java.lang.String friendlyName()
```
    Returns a freindly name for the device. This is assigned by controller if it is in the known config It makes it easier to determine which device we want than the hostname - eg Dancer1 is easier to read than hb-001d43201188
    
    Returns:
    
    the friendly name if assigned.
  - setFriendlyName
```
public void setFriendlyName(java.lang.String name)
```
    We will set the friendly of the device here. It may be set by a controller
    
    Parameters:
    
    name - the friendly name
  - rebootDevice
```
public static void rebootDevice()
```
    Reboots the device immediately.
  - shutdownDevice
```
public static void shutdownDevice()
```
  - sendStatus
```
public static void sendStatus(java.lang.String status)
```
    Static version of sendStatus(String).
    
    Parameters:
    
    status - the status message we are sending
  - setStatus
```
public void setStatus(java.lang.String s)
```
    Sets the status @String of this device. The status string is sent to the controller and is reported in the device's list item. Note that certain application behaviours automatically set the device status, such as when the device has been assigned and ID, or when a new @HBAction has been loaded onto the device.
    
    Parameters:
    
    s - the status of the device.
  - setGain
```
public void setGain(float new_gain,
                    float millseconds)
```
    Set the output gain of the device in an envelope.
    
    Parameters:
    
    new_gain - the new target gain to set device to
    
    millseconds - the duration of the segment to reach the new gain in milliseconds
  - getGain
```
public float getGain()
```
    Get the current gain of the device
    
    Returns:
    
    the current masterGain envelope value
  - getStatus
```
public java.lang.String getStatus()
```
    Returns the current status @String of the device.
    
    Returns:
    
    the status of the device.
  - createDynamicControl
```
public static DynamicControl createDynamicControl(java.lang.Object parent_sketch,
                                                  ControlType control_type,
                                                  java.lang.String name,
                                                  java.lang.Object initial_value)
```
    A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
    
    Parameters:
    
    parent_sketch - the object calling - typically this
    
    control_type - The type of control you want to create
    
    name - The name we will give to differentiate between different controls in this class
    
    initial_value - The initial value of the control
    
    Returns:
    
    Creates a DynamicControl for sending values to other sketches
  - createDynamicControl
```
public static DynamicControl createDynamicControl(java.lang.Object parent_sketch,
                                                  ControlType control_type,
                                                  java.lang.String name)
```
    A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
    
    Parameters:
    
    parent_sketch - the object calling - typically this
    
    control_type - The type of control you want to create
    
    name - The name we will give to differentiate between different controls in this class
    
    Returns:
    
    Creates a DynamicControl for sending values to other sketches
  - createDynamicControl
```
public static DynamicControl createDynamicControl(java.lang.Object parent_sketch,
                                                  ControlType control_type,
                                                  java.lang.String name,
                                                  java.lang.Object initial_value,
                                                  java.lang.Object min_value,
                                                  java.lang.Object max_value)
```
    A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
    
    Parameters:
    
    parent_sketch - the object calling - typically this
    
    control_type - The type of control you want to create
    
    name - The name we will give to differentiate between different controls in this class
    
    initial_value - The initial value of the control
    
    min_value - The minimum value of the control
    
    max_value - The maximum value of the control
    
    Returns:
    
    Creates a DynamicControl for sending values to other sketches
  - createDynamicControl
```
public static DynamicControl createDynamicControl(ControlType control_type,
                                                  java.lang.String name,
                                                  java.lang.Object initial_value,
                                                  java.lang.Object min_value,
                                                  java.lang.Object max_value)
```
    A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
    
    Parameters:
    
    control_type - The type of control you want to create
    
    name - The name we will give to differentiate between different controls in this class
    
    initial_value - The initial value of the control
    
    min_value - The minimum value of the control
    
    max_value - The maximum value of the control
    
    Returns:
    
    Creates a DynamicControl for sending values to other sketches
  - createDynamicControl
```
public static DynamicControl createDynamicControl(ControlType control_type,
                                                  java.lang.String name,
                                                  java.lang.Object initial_value)
```
    A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
    
    Parameters:
    
    control_type - The type of control you want to create
    
    name - The name we will give to differentiate between different controls in this class
    
    initial_value - The initial value of the control
    
    Returns:
    
    Creates a DynamicControl for sending values to other sketches
  - createDynamicControl
```
public static DynamicControl createDynamicControl(ControlType control_type,
                                                  java.lang.String name)
```
    A dynamic control that can be accessed from outside it is created with the sketch object that contains it along with the type
    
    Parameters:
    
    control_type - The type of control you want to create
    
    name - The name we will give to differentiate between different controls in this class
    
    Returns:
    
    Creates a DynamicControl for sending values to other sketches
  - createControlBuddyPair
```
public static DynamicControl createControlBuddyPair(java.lang.Object parent_sketch,
                                                    ControlType control_type,
                                                    java.lang.String name,
                                                    java.lang.Object initial_value,
                                                    java.lang.Object min_value,
                                                    java.lang.Object max_value)
```
    A dynamic control pair that can be accessed from outside it is created with the sketch object that contains it along with the type only a single dynamic control is returned becasue the buddy is a mirror
    
    Parameters:
    
    parent_sketch - the object calling - typically this
    
    control_type - The type of control you want to create
    
    name - The name we will give to differentiate between different controls in this class
    
    initial_value - The initial value of the control
    
    min_value - The minimum value of the control
    
    max_value - The maximum value of the control
    
    Returns:
    
    Returns the text control object, so max and min are hidden.
  - createClock
```
public static Clock createClock(double interval)
```
    Create a new Clock using HappyBrackets scheduler
    
    Parameters:
    
    interval - int6erval in milliseconds. Can use fractions of a millisecond
    
    Returns:
    
    Clock object
  - getAccelerometer_X
```
public static net.beadsproject.beads.core.UGen getAccelerometer_X()
```
    Return a UGen that is mapped to Accelerometer X value
    
    Returns:
    
    UGen object mapped to the axis. If no accelerometer is found, will return a static with value 0
  - getAccelerometer_X
```
public static net.beadsproject.beads.core.UGen getAccelerometer_X(double scale_min,
                                                                  double scale_max)
```
    Return a UGen that is mapped to Accelerometer X value
    
    Parameters:
    
    scale_min - the value for axis pointing to ground
    
    scale_max - the value for axis pointing to sky
    
    Returns:
    
    UGen object mapped to the axis. If no accelerometer is found, will return a static with value 0
  - getAccelerometer_Y
```
public static net.beadsproject.beads.core.UGen getAccelerometer_Y()
```
    Return a UGen that is mapped to Accelerometer Y value
    
    Returns:
    
    UGen object mapped to the axis. If no accelerometer is found, will return a static with value 0
  - getAccelerometer_Y
```
public static net.beadsproject.beads.core.UGen getAccelerometer_Y(double scale_min,
                                                                  double scale_max)
```
    Return a UGen that is mapped to Accelerometer Y value
    
    Parameters:
    
    scale_min - the value for axis pointing to ground
    
    scale_max - the value for axis pointing to sky
    
    Returns:
    
    UGen object mapped to the axis. If no accelerometer is found, will return a static with value 0
  - getAccelerometer_Z
```
public static net.beadsproject.beads.core.UGen getAccelerometer_Z()
```
    Return a UGen that is mapped to Accelerometer Z value
    
    Returns:
    
    UGen object mapped to the axis. If no accelerometer is found, will return a static with value 0
  - getAccelerometer_Z
```
public static net.beadsproject.beads.core.UGen getAccelerometer_Z(double scale_min,
                                                                  double scale_max)
```
    Return a UGen that is mapped to Accelerometer Z value
    
    Parameters:
    
    scale_min - the value for axis pointing to ground
    
    scale_max - the value for axis pointing to sky
    
    Returns:
    
    UGen object mapped to the axis. If no accelerometer is found, will return a static with value 0
  - getGyroscopeYaw
```
public static net.beadsproject.beads.core.UGen getGyroscopeYaw()
```
    Return a UGen that is mapped to Gyroscope Yaw value
    
    Returns:
    
    UGen object mapped to the axis. If no gyroscope is found, will return a static with value 0
  - getGyroscopePitch
```
public static net.beadsproject.beads.core.UGen getGyroscopePitch()
```
    Return a UGen that is mapped to Gyroscope Pitch value
    
    Returns:
    
    UGen object mapped to the axis. If no gyroscope is found, will return a static with value 0
  - getGyroscopeRoll
```
public static net.beadsproject.beads.core.UGen getGyroscopeRoll()
```
    Return a UGen that is mapped to Gyroscope Roll value
    
    Returns:
    
    UGen object mapped to the axis. If no gyroscope is found, will return a static with value 0
  - getDeviceAddress
```
public java.net.InetAddress getDeviceAddress(java.lang.String name)
```
    Return the InetAddress associated with this device name that we can address that device with If the device is this, then it will return the loopback address
    
    Parameters:
    
    name - The name of the device we require the address of
    
    Returns:
    
    The address associated with the name. If not stored will return null
  - getKnownDeviceNames
```
public java.util.Collection<java.lang.String> getKnownDeviceNames()
```
    Get the names of the devices that we know are on the network. The devices can be targeted with Dynamic controls with ControlScope.TARGET using the device name. If you require the InetAddressof the device, for example, if you want to use OpenSoundControl, then use the device name in the function getDeviceAddress(String)
    
    Returns:
    
    a collection of device names that we know about
  - addDeviceConnectedEventListener
```
public void addDeviceConnectedEventListener(DeviceConnectedEventListener listener)
```
    Add a DeviceConnectedEventListener to be informed when a new device is detected on the network
    
    Parameters:
    
    listener - the listener that will be notified when a device is connected
  - addDeviceAddress
```
public boolean addDeviceAddress(java.lang.String name,
                                java.net.InetAddress address)
```
    Associate a device name with an InetAddress
    
    Parameters:
    
    name - The device name to use as a key
    
    address - the InetAddress to associate with the name
    
    Returns:
    
    true if the device was added or update
  - isOurAddress
```
public static boolean isOurAddress(java.net.InetAddress address)
```
    Detect whether this InetAddress is actually this device
    
    Parameters:
    
    address - the address we are testing for
    
    Returns:
    
    true if this is one of our addresses
  - getScheduler
```
public static HBScheduler getScheduler()
```
    Get the global HBScheduler
    
    Returns:
    
    The global scheduler
  - getSchedulerTime
```
public static double getSchedulerTime()
```
    Get the amount of time elapsed since we set reference time in HBScheduler
    
    Returns:
    
    the elapsed time in milliseconds
  - getFutureSchedulerTime
```
public static double getFutureSchedulerTime(double milliseconds)
```
    Get a scheduler time in the future from getSchedulerTime().
    
    Parameters:
    
    milliseconds - the number of milliseconds into the future we want the time for
    
    Returns:
    
    getSchedulerTime() + milliseconds
  - setScheduleTime
```
public static void setScheduleTime(double new_time)
```
    Set the global HBScheduler scheduled time to this time
    
    Parameters:
    
    new_time - the new time
  - adjustScheduleTime
```
public static void adjustScheduleTime(double amount,
                                      long duration)
```
    Adjust the HBScheduler scheduler time
    
    Parameters:
    
    amount - the amount of milliseconds we need to adjust our time by. A positive amount will advance the scheduler
    
    duration - the number of milliseconds over which we want this change to occur so we don't just get a jump
  - synchroniseClocks
```
public static double synchroniseClocks()
```
    Synchronise HBScheduler timer with the system time on next tick
    
    Returns:
    
    the number of milliseconds we will be moving scheduler
  - synchroniseClocks
```
public static double synchroniseClocks(long slew_time)
```
    Synchronise global HBScheduler timer with the system time
    
    Parameters:
    
    slew_time - the amount of milliseconds that we want to take to complete it
    
    Returns:
    
    the number of milliseconds we will be moving scheduler
  - sendScheduleChange
```
public static boolean sendScheduleChange(double amount,
                                         long duration,
                                         java.util.Collection<java.lang.String> targets)
```
    Send a schedule adjustment message to one or more devices. Will set adjust HBScheduler on that device
    
    Parameters:
    
    amount - the amount of milliseconds we need to adjust our time by. A positive amount will advance the scheduler
    
    duration - the number of milliseconds over which we want this change to occur so we don't just get a jump
    
    targets - The names of HB devices. If this is null, will send a broadcast
    
    Returns:
    
    true if able to send to at least one address
  - sendScheduleSetTime
```
public static boolean sendScheduleSetTime(double new_time,
                                          java.util.Collection<java.lang.String> targets)
```
    Send a Schedule Set time to one or more targets
    
    Parameters:
    
    new_time - the new time to set our device scheduler to
    
    targets - The names of HB devices. If this is null, will send a broadcast
    
    Returns:
    
    true if able to send to at least one address

Class HB

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HBInstance

ac

clock

clockInterval

pl

masterGainEnv

sensors

share

rng

controller

broadcast

synch

Constructor Detail

HB

HB

HB

Method Detail

getMuteControl

isEnableSimulators

setEnableSimulators

setTCPServerPort

setUseEncryption

getSendingController

hasClassesLoaded

addStatusChangedListener

setDeviceLedValue

getDeviceType

detectDeviceType

muteAudio

runDebug

broadcast

createOSCMessage

sendToController

addBroadcastListener

addControllerListener

syncAudioStart

getSynchTime

doAtTime

startAudio

pullConfigFileFromController

messageIs

getFloatArg

sychronisedBleep

testBleep

flashLed

testBleep3

testBleep6

attemptHBActionFromClassName

getSensor

findSensor

put

registerVariable

getRegisteredVariable

clearRegisteredVariable

get

getInt

getFloat

getString

getUGen

getBead

perm

pattern

sound

clearSound

reset

resetLeaveSounding

getAudioOutput

getNumOutChannels

fadeOutClearSound

fadeOutReset

myIndex

myConnectPort

setMyIndex