Bus (LOCI Javadocs 0-SNAPSHOT API)

java.lang.Object
- de.sciss.jcollider.Bus

All Implemented Interfaces:

Constants
```
public class Bus
extends Object
implements Constants
```
Mimics SCLang's Bus class, that is, it's a client side representation of an audio or control bus

Version:

0.31, 08-Oct-07

Author:

Hanns Holger Rutz

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Bus.GetCompletionAction` Interface describing an action to take place after an asynchronous bus query is completed.

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
`Bus(Server server)` Creates an mono audio bus on the server at index 0.
`Bus(Server server, Object rate)`
`Bus(Server server, Object rate, int index)`
`Bus(Server server, Object rate, int index, int numChannels)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`alloc()`
`static Bus`	`alloc(Server server, Object rate)`
`static Bus`	`alloc(Server server, Object rate, int numChannels)`
`static Bus`	`audio(Server server)`
`static Bus`	`audio(Server server, int numChannels)`
`static Bus`	`control(Server server)`
`static Bus`	`control(Server server, int numChannels)`
`boolean`	`equals(Object o)`
`void`	`fill(float value)`
`void`	`fill(int[] numChans, float[] values)`
`void`	`fill(int[] offsets, int[] numChans, float[] values)`
`void`	`fill(int offset, int numChans, float value)`
`de.sciss.net.OSCMessage`	`fillMsg(float value)`
`de.sciss.net.OSCMessage`	`fillMsg(int[] numChans, float[] values)`
`de.sciss.net.OSCMessage`	`fillMsg(int[] offsets, int[] numChans, float[] values)`
`de.sciss.net.OSCMessage`	`fillMsg(int offset, int numChans, float value)`
`void`	`free()`
`void`	`get(Bus.GetCompletionAction action)`
`void`	`get(int[] offsets, Bus.GetCompletionAction action)`
`void`	`get(int offset, Bus.GetCompletionAction action)`
`int`	`getIndex()`
`de.sciss.net.OSCMessage`	`getMsg()`
`de.sciss.net.OSCMessage`	`getMsg(int[] offsets)`
`void`	`getn(int[] offsets, int[] numChans, Bus.GetCompletionAction action)`
`de.sciss.net.OSCMessage`	`getnMsg()`
`de.sciss.net.OSCMessage`	`getnMsg(int numChans)`
`de.sciss.net.OSCMessage`	`getnMsg(int[] offsets, int[] numChans)`
`de.sciss.net.OSCMessage`	`getnMsg(int offset, int numChans)`
`int`	`getNumChannels()`
`Object`	`getRate()`
`Server`	`getServer()`
`int`	`hashCode()`
`boolean`	`isAudioOut()` Queries whether this bus is playing audio onto the hardware audio interface channels.
`void`	`printOn(PrintStream stream)`
`void`	`realloc()`
`void`	`set(float value)`
`void`	`set(int[] offsets, float[] values)`
`de.sciss.net.OSCMessage`	`setMsg(float value)` Set the value of a monophonic bus.
`de.sciss.net.OSCMessage`	`setMsg(int[] offsets, float[] values)`
`void`	`setn(float[] values)`
`void`	`setn(int[] offsets, float[][] values)`
`de.sciss.net.OSCMessage`	`setnMsg(float[] values)`
`de.sciss.net.OSCMessage`	`setnMsg(int[] offsets, float[][] values)`
`String`	`toString()`

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

Constructor Detail

Bus
```
public Bus(Server server)
```
Creates an mono audio bus on the server at index 0. This does not use the server's allocators.

Parameters:

server - the Server on which the bus resides

Bus

public Bus(Server server,
           Object rate)

Bus

public Bus(Server server,
           Object rate,
           int index)

Bus

public Bus(Server server,
           Object rate,
           int index,
           int numChannels)

Method Detail

control

public static Bus control(Server server)

control

public static Bus control(Server server,
                          int numChannels)

audio

public static Bus audio(Server server)

audio

public static Bus audio(Server server,
                        int numChannels)

alloc

public static Bus alloc(Server server,
                        Object rate)

alloc

public static Bus alloc(Server server,
                        Object rate,
                        int numChannels)

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

toString in class Object

getRate
```
public Object getRate()
```

getNumChannels
```
public int getNumChannels()
```

getIndex
```
public int getIndex()
```

getServer
```
public Server getServer()
```

set

public void set(float value)
         throws IOException

Throws:: IOException

set

public void set(int[] offsets,
                float[] values)
         throws IOException

Throws:: IOException

setMsg
```
public de.sciss.net.OSCMessage setMsg(float value)
```
Set the value of a monophonic bus. For multichannel busses, use setnMsg instead.

setMsg

public de.sciss.net.OSCMessage setMsg(int[] offsets,
                                      float[] values)

setn

public void setn(float[] values)
          throws IOException

Throws:: IOException

setn

public void setn(int[] offsets,
                 float[][] values)
          throws IOException

Throws:: IOException

setnMsg

public de.sciss.net.OSCMessage setnMsg(float[] values)

setnMsg

public de.sciss.net.OSCMessage setnMsg(int[] offsets,
                                       float[][] values)

fill

public void fill(float value)
          throws IOException

Throws:: IOException

fill

public void fill(int offset,
                 int numChans,
                 float value)
          throws IOException

Throws:: IOException

fill

public void fill(int[] numChans,
                 float[] values)
          throws IOException

Throws:: IOException

fill

public void fill(int[] offsets,
                 int[] numChans,
                 float[] values)
          throws IOException

Throws:: IOException

fillMsg

public de.sciss.net.OSCMessage fillMsg(float value)

fillMsg

public de.sciss.net.OSCMessage fillMsg(int offset,
                                       int numChans,
                                       float value)

fillMsg

public de.sciss.net.OSCMessage fillMsg(int[] numChans,
                                       float[] values)

fillMsg

public de.sciss.net.OSCMessage fillMsg(int[] offsets,
                                       int[] numChans,
                                       float[] values)

get

public void get(Bus.GetCompletionAction action)
         throws IOException

Throws:: IOException

get

public void get(int offset,
                Bus.GetCompletionAction action)
         throws IOException

Throws:: IOException

get

public void get(int[] offsets,
                Bus.GetCompletionAction action)
         throws IOException

Throws:: IOException

getn

public void getn(int[] offsets,
                 int[] numChans,
                 Bus.GetCompletionAction action)
          throws IOException

Throws:: IOException

getMsg

public de.sciss.net.OSCMessage getMsg()

getMsg

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

getnMsg

public de.sciss.net.OSCMessage getnMsg()

getnMsg

public de.sciss.net.OSCMessage getnMsg(int numChans)

getnMsg

public de.sciss.net.OSCMessage getnMsg(int offset,
                                       int numChans)

getnMsg

public de.sciss.net.OSCMessage getnMsg(int[] offsets,
                                       int[] numChans)

free
```
public void free()
```

alloc
```
public void alloc()
```

realloc
```
public void realloc()
```

printOn

public void printOn(PrintStream stream)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

isAudioOut
```
public boolean isAudioOut()
```
Queries whether this bus is playing audio onto the hardware audio interface channels.

Returns:

true if this bus plays audio on audible interface channels, false otherwise

Class Bus

Nested Class Summary

Field Summary

Fields inherited from interface de.sciss.jcollider.Constants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Bus

Bus

Bus

Bus

Method Detail

control

control

audio

audio

alloc

alloc

toString

getRate

getNumChannels

getIndex

getServer

set

set

setMsg

setMsg

setn

setn

setnMsg

setnMsg

fill

fill

fill

fill

fillMsg

fillMsg

fillMsg

fillMsg

get

get

get

getn

getMsg

getMsg

getnMsg

getnMsg

getnMsg

getnMsg

free

alloc

realloc

printOn

equals

hashCode

isAudioOut