Synth (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- de.sciss.jcollider.Node
- - de.sciss.jcollider.Synth

All Implemented Interfaces:

Constants, TreeNode
```
public class Synth
extends Node
```
Mimics SCLang's Synth class, that is, it's a client side representation of a synth in the synthesis graph

Version:

0.33, 12-Jul-08

Author:

Hanns Holger Rutz

Field Summary
- Fields inherited from interface de.sciss.jcollider.Constants
  kAddAfter, kAddBefore, kAddReplace, kAddToHead, kAddToTail, kAudioRate, kControlRate, kDemandRate, kDoneFree, kDoneFreeAll, kDoneFreeAllPred, kDoneFreeAllSucc, kDoneFreeGroup, kDoneFreePausePred, kDoneFreePauseSucc, kDoneFreePred, kDoneFreePredGroup, kDoneFreePredGroupDeep, kDoneFreeSucc, kDoneFreeSuccGroup, kDoneFreeSuccGroupDeep, kDoneNothing, kDonePause, kDumpBoth, kDumpHex, kDumpOff, kDumpText, kHeaderAIFF, kHeaderIRCAM, kHeaderNeXT, kHeaderRaw, kHeaderWAVE, kSampleALaw, kSampleDouble, kSampleFloat, kSampleInt16, kSampleInt24, kSampleInt32, kSampleInt8, kSampleMuLaw, kScalarRate

Constructor Summary

Constructors
Constructor and Description
`Synth(String defName, Node target)`
`Synth(String defName, String[] argNames, float[] argValues, Node target)`
`Synth(String defName, String[] argNames, float[] argValues, Node target, int addAction)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`de.sciss.net.OSCMessage`	`addAfterMsg(Node aNode, String[] argNames, float[] argValues)`
`de.sciss.net.OSCMessage`	`addBeforeMsg(Node aNode, String[] argNames, float[] argValues)`
`de.sciss.net.OSCMessage`	`addReplaceMsg(Node aNode, String[] argNames, float[] argValues)`
`de.sciss.net.OSCMessage`	`addToHeadMsg(Group aGroup, String[] argNames, float[] argValues)`
`de.sciss.net.OSCMessage`	`addToTailMsg(Group aGroup, String[] argNames, float[] argValues)`
`static Synth`	`after(Node aNode, String defName)`
`static Synth`	`after(Node aNode, String defName, String[] argNames, float[] argValues)`
`static Synth`	`basicNew(String defName, Server server)`
`static Synth`	`basicNew(String defName, Server server, int nodeID)`
`static Synth`	`before(Node aNode, String defName)`
`static Synth`	`before(Node aNode, String defName, String[] argNames, float[] argValues)`
`Enumeration`	`children()`
`float`	`get(int index)` Queries the current value of a synth control.
`float[]`	`get(int[] indices)` Queries different current values of a synth control.
`float`	`get(String name)` Queries the current value of a synth control.
`float[]`	`get(String[] names)` Queries different current values of a synth control.
`boolean`	`getAllowsChildren()`
`TreeNode`	`getChildAt(int childIndex)`
`int`	`getChildCount()`
`String`	`getDefName()`
`int`	`getIndex(TreeNode node)`
`de.sciss.net.OSCMessage`	`getMsg(int index)`
`de.sciss.net.OSCMessage`	`getMsg(int[] indices)`
`de.sciss.net.OSCMessage`	`getMsg(String name)`
`de.sciss.net.OSCMessage`	`getMsg(String[] names)`
`float[]`	`getn(int[] indices, int[] counts)` Queries different ranges of current values of the synth's controls.
`float[]`	`getn(int index, int count)` Queries a range of current values of the synth's controls.
`float[]`	`getn(String[] names, int[] counts)` Queries different ranges of current values of the synth's controls.
`float[]`	`getn(String name, int count)` Queries a range of current values of the synth's controls.
`de.sciss.net.OSCMessage`	`getnMsg(int[] indices, int[] counts)`
`de.sciss.net.OSCMessage`	`getnMsg(int index, int count)`
`de.sciss.net.OSCMessage`	`getnMsg(String[] names, int[] counts)`
`de.sciss.net.OSCMessage`	`getnMsg(String name, int count)`
`static void`	`grain(String defName, Node target)`
`static void`	`grain(String defName, String[] argNames, float[] argValues, Node target)`
`static void`	`grain(String defName, String[] argNames, float[] argValues, Node target, int addAction)`
`static Synth`	`head(Group aGroup, String defName)`
`static Synth`	`head(Node aGroup, String defName, String[] argNames, float[] argValues)`
`boolean`	`isLeaf()`
`de.sciss.net.OSCMessage`	`newMsg()`
`de.sciss.net.OSCMessage`	`newMsg(Node target)`
`de.sciss.net.OSCMessage`	`newMsg(Node target, String[] argNames, float[] argValues)`
`de.sciss.net.OSCMessage`	`newMsg(Node target, String[] argNames, float[] argValues, int addAction)`
`static Synth`	`newPaused(String defName, String[] argNames, float[] argValues, Node target)`
`static Synth`	`newPaused(String defName, String[] argNames, float[] argValues, Node target, int addAction)`
`static Synth`	`replace(Node nodeToReplace, String defName)`
`static Synth`	`replace(Node nodeToReplace, String defName, String[] argNames, float[] argValues)`
`static Synth`	`tail(Group aGroup, String defName)`
`static Synth`	`tail(Node aGroup, String defName, String[] argNames, float[] argValues)`
`String`	`toString()`

Methods inherited from class de.sciss.jcollider.Node
equals, fill, fill, fillMsg, fillMsg, free, freeMsg, getGroup, getName, getNodeID, getParent, getPredNode, getServer, getSuccNode, hashCode, isPlaying, isRunning, map, map, map, map, map, mapMsg, mapMsg, mapMsg, mapMsg, mapMsg, mapn, mapn, mapn, mapn, mapnMsg, mapnMsg, mapnMsg, mapnMsg, moveAfter, moveAfterMsg, moveBefore, moveBeforeMsg, moveToHead, moveToHeadMsg, moveToTail, moveToTailMsg, printOn, query, query, queryMsg, register, register, release, release, releaseMsg, releaseMsg, run, run, runMsg, runMsg, set, set, set, set, setGroup, setMsg, setMsg, setMsg, setMsg, setn, setn, setName, setnMsg, setnMsg, setPlaying, setPredNode, setRunning, setSuccNode, trace, traceMsg

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

Constructor Detail

Synth

public Synth(String defName,
             Node target)
      throws IOException

Throws:: IOException

Synth

public Synth(String defName,
             String[] argNames,
             float[] argValues,
             Node target)
      throws IOException

Throws:: IOException

Synth

public Synth(String defName,
             String[] argNames,
             float[] argValues,
             Node target,
             int addAction)
      throws IOException

Throws:: IOException

Method Detail

grain

public static void grain(String defName,
                         Node target)
                  throws IOException

Throws:: IOException

grain

public static void grain(String defName,
                         String[] argNames,
                         float[] argValues,
                         Node target)
                  throws IOException

Throws:: IOException

grain

public static void grain(String defName,
                         String[] argNames,
                         float[] argValues,
                         Node target,
                         int addAction)
                  throws IOException

Throws:: IOException

getDefName
```
public String getDefName()
```

newMsg

public de.sciss.net.OSCMessage newMsg()

newMsg

public de.sciss.net.OSCMessage newMsg(Node target)

newMsg

public de.sciss.net.OSCMessage newMsg(Node target,
                                      String[] argNames,
                                      float[] argValues)

newMsg

public de.sciss.net.OSCMessage newMsg(Node target,
                                      String[] argNames,
                                      float[] argValues,
                                      int addAction)

newPaused

public static Synth newPaused(String defName,
                              String[] argNames,
                              float[] argValues,
                              Node target)
                       throws IOException

Throws:: IOException

newPaused

public static Synth newPaused(String defName,
                              String[] argNames,
                              float[] argValues,
                              Node target,
                              int addAction)
                       throws IOException

Throws:: IOException

basicNew

public static Synth basicNew(String defName,
                             Server server)

basicNew

public static Synth basicNew(String defName,
                             Server server,
                             int nodeID)

after

public static Synth after(Node aNode,
                          String defName)
                   throws IOException

Throws:: IOException

after

public static Synth after(Node aNode,
                          String defName,
                          String[] argNames,
                          float[] argValues)
                   throws IOException

Throws:: IOException

before

public static Synth before(Node aNode,
                           String defName)
                    throws IOException

Throws:: IOException

before

public static Synth before(Node aNode,
                           String defName,
                           String[] argNames,
                           float[] argValues)
                    throws IOException

Throws:: IOException

head

public static Synth head(Group aGroup,
                         String defName)
                  throws IOException

Throws:: IOException

head

public static Synth head(Node aGroup,
                         String defName,
                         String[] argNames,
                         float[] argValues)
                  throws IOException

Throws:: IOException

tail

public static Synth tail(Group aGroup,
                         String defName)
                  throws IOException

Throws:: IOException

tail

public static Synth tail(Node aGroup,
                         String defName,
                         String[] argNames,
                         float[] argValues)
                  throws IOException

Throws:: IOException

replace

public static Synth replace(Node nodeToReplace,
                            String defName)
                     throws IOException

Throws:: IOException

replace

public static Synth replace(Node nodeToReplace,
                            String defName,
                            String[] argNames,
                            float[] argValues)
                     throws IOException

Throws:: IOException

addToHeadMsg

public de.sciss.net.OSCMessage addToHeadMsg(Group aGroup,
                                            String[] argNames,
                                            float[] argValues)

addToTailMsg

public de.sciss.net.OSCMessage addToTailMsg(Group aGroup,
                                            String[] argNames,
                                            float[] argValues)

addAfterMsg

public de.sciss.net.OSCMessage addAfterMsg(Node aNode,
                                           String[] argNames,
                                           float[] argValues)

addBeforeMsg

public de.sciss.net.OSCMessage addBeforeMsg(Node aNode,
                                            String[] argNames,
                                            float[] argValues)

addReplaceMsg

public de.sciss.net.OSCMessage addReplaceMsg(Node aNode,
                                             String[] argNames,
                                             float[] argValues)

get
```
public float get(int index)
          throws IOException
```
Queries the current value of a synth control.

Parameters:

index - the index of the control to query

Returns:

the curresponding control value

Throws:

IOException - when an error occurs sending the message, or when a timeout or failure occurs with scsynth processing the message

get
```
public float[] get(int[] indices)
            throws IOException
```
Queries different current values of a synth control.

Parameters:

indices - the indices of the controls to query

Returns:

the curresponding control values, or null if a timeout or failure occurs with scsynth processing the message

Throws:

IOException - when an error occurs sending the message

get
```
public float get(String name)
          throws IOException
```
Queries the current value of a synth control.

Parameters:

name - the name of the control to query

Returns:

the curresponding control value

Throws:

IOException - when an error occurs sending the message, or when a timeout or failure occurs with scsynth processing the message

get
```
public float[] get(String[] names)
            throws IOException
```
Queries different current values of a synth control.

Parameters:

names - the names of the controls to query

Returns:

the curresponding control values, or null if a timeout or failure occurs with scsynth processing the message

Throws:

IOException - when an error occurs sending the message

getMsg

public de.sciss.net.OSCMessage getMsg(int index)

getMsg

public de.sciss.net.OSCMessage getMsg(int[] indices)

getMsg

public de.sciss.net.OSCMessage getMsg(String name)

getMsg

public de.sciss.net.OSCMessage getMsg(String[] names)

getn
```
public float[] getn(int index,
                    int count)
             throws IOException
```
Queries a range of current values of the synth's controls.

Parameters:

index - the start index of the controls to query

count - the number of successive controls to query

Returns:

the curresponding control values or null, when a timeout or failure occurs with scsynth processing the message

Throws:

IOException - when an error occurs sending the message

getn
```
public float[] getn(String name,
                    int count)
             throws IOException
```
Queries a range of current values of the synth's controls.

Parameters:

name - the name of the first control to query

count - the number of successive controls to query

Returns:

the curresponding control values or null, when a timeout or failure occurs with scsynth processing the message

Throws:

IOException - when an error occurs sending the message

getn
```
public float[] getn(int[] indices,
                    int[] counts)
             throws IOException
```
Queries different ranges of current values of the synth's controls.

Parameters:

indices - the start indices of the controls to query

counts - for each start index, the number of successive controls to query

Returns:

the curresponding control values, or null if a timeout or failure occurs with scsynth processing the message

Throws:

IOException - when an error occurs sending the message

getn
```
public float[] getn(String[] names,
                    int[] counts)
             throws IOException
```
Queries different ranges of current values of the synth's controls.

Parameters:

names - the start names of the controls to query

counts - for each start name, the number of successive controls to query

Returns:

the curresponding control values, or null if a timeout or failure occurs with scsynth processing the message

Throws:

IOException - when an error occurs sending the message

getnMsg

public de.sciss.net.OSCMessage getnMsg(int index,
                                       int count)

getnMsg

public de.sciss.net.OSCMessage getnMsg(int[] indices,
                                       int[] counts)

getnMsg

public de.sciss.net.OSCMessage getnMsg(String name,
                                       int count)

getnMsg

public de.sciss.net.OSCMessage getnMsg(String[] names,
                                       int[] counts)

toString
```
public String toString()
```
Overrides:

toString in class Object

getChildAt

public TreeNode getChildAt(int childIndex)

getChildCount
```
public int getChildCount()
```

getIndex
```
public int getIndex(TreeNode node)
```

getAllowsChildren
```
public boolean getAllowsChildren()
```

isLeaf
```
public boolean isLeaf()
```

children
```
public Enumeration children()
```

Class Synth

Field Summary

Fields inherited from interface de.sciss.jcollider.Constants

Constructor Summary

Method Summary

Methods inherited from class de.sciss.jcollider.Node

Methods inherited from class java.lang.Object

Constructor Detail

Synth

Synth

Synth

Method Detail

grain

grain

grain

getDefName

newMsg

newMsg

newMsg

newMsg

newPaused

newPaused

basicNew

basicNew

after

after

before

before

head

head

tail

tail

replace

replace

addToHeadMsg

addToTailMsg

addAfterMsg

addBeforeMsg

addReplaceMsg

get

get

get

get

getMsg

getMsg

getMsg

getMsg

getn

getn

getn

getn

getnMsg

getnMsg

getnMsg

getnMsg

toString

getChildAt

getChildCount

getIndex

getAllowsChildren

isLeaf

children