AudioEngineThread (Java 3D Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.lang.Thread
- - org.scijava.java3d.audioengines.AudioEngineThread

All Implemented Interfaces:

Runnable
```
public class AudioEngineThread
extends Thread
```
The Thread Class extended for Audio Device engines that must process calls dynamically, in 'real-time" to asynchronously change engine parameters.
NOTE: this class is probably not needed for those Audio Device implementations that handle all dynamic parameters in the low-level audio library.

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Thread
  Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`active` This indicates that this thread has been activated by MC
`protected Object[]`	`args` The arguments passed in for this thread
`protected int`	`classification` The classification of this thread.
`protected static boolean`	`debugFlag`
`protected int`	`instanceNum`
`protected long`	`lastWaitTimestamp` Use to assign threadOpts WAIT_ALL_THREADS
`protected static int`	`NOTIFY_AND_WAIT` This runMonitor action notifies MasterControl that this thread has completed and wait.
`protected static int`	`numInstances` Some variables used to name threads correctly
`protected long`	`referenceTime` The time values passed into this thread
`protected static int`	`RUN` This runMonitor action tells the thread to run N number of iterations.
`protected boolean`	`running` This indicates that this thread is alive and running
`protected boolean`	`started` This indicates that this thread is ready
`protected static int`	`STOP` This runMonitor action tells the thread to stop running
`protected int`	`type` The type of this thread.
`protected static int`	`UPDATE_THREAD`
`protected boolean`	`userStop` Flag to indicate that user initiate a thread stop
`protected static int`	`WAIT` This runMonitor action puts the thread into an initial wait state
`protected boolean`	`waiting` Flag to indicate that this thread is waiting to be notify
`protected static int`	`WORK_THREAD` The classification types.

Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors
Constructor and Description

AudioEngineThread(ThreadGroup t, String threadName)
This constructor simply assigns the given id.

Constructors
Constructor and Description
`AudioEngineThread(ThreadGroup t, String threadName)` This constructor simply assigns the given id.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cleanup()`
`protected void`	`debugPrint(String message)`
`void`	`doWork()` This method is defined by all slave threads to implement one iteration of work.
`void`	`finish()` This causes the threads run method to exit.
`void`	`initialize()` This initializes this thread.
`void`	`run()`
`void`	`runMonitor(int action, long referenceTime, Object[] args)`
`void`	`shutdown()`

Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

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

- Field Detail
  - debugFlag
```
protected static final boolean debugFlag
```
    See Also:
    
    Constant Field Values
  - WORK_THREAD
```
protected static final int WORK_THREAD
```
    The classification types.
    
    See Also:
    
    Constant Field Values
  - UPDATE_THREAD
```
protected static final int UPDATE_THREAD
```
    See Also:
    
    Constant Field Values
  - WAIT
```
protected static final int WAIT
```
    This runMonitor action puts the thread into an initial wait state
    
    See Also:
    
    Constant Field Values
  - NOTIFY_AND_WAIT
```
protected static final int NOTIFY_AND_WAIT
```
    This runMonitor action notifies MasterControl that this thread has completed and wait.
    
    See Also:
    
    Constant Field Values
  - RUN
```
protected static final int RUN
```
    This runMonitor action tells the thread to run N number of iterations.
    
    See Also:
    
    Constant Field Values
  - STOP
```
protected static final int STOP
```
    This runMonitor action tells the thread to stop running
    
    See Also:
    
    Constant Field Values
  - active
```
protected boolean active
```
    This indicates that this thread has been activated by MC
  - running
```
protected boolean running
```
    This indicates that this thread is alive and running
  - started
```
protected boolean started
```
    This indicates that this thread is ready
  - referenceTime
```
protected long referenceTime
```
    The time values passed into this thread
  - lastWaitTimestamp
```
protected long lastWaitTimestamp
```
    Use to assign threadOpts WAIT_ALL_THREADS
  - type
```
protected int type
```
    The type of this thread. It is one of the above constants.
  - classification
```
protected int classification
```
    The classification of this thread. It is one of the above constants.
  - args
```
protected Object[] args
```
    The arguments passed in for this thread
  - userStop
```
protected boolean userStop
```
    Flag to indicate that user initiate a thread stop
  - waiting
```
protected boolean waiting
```
    Flag to indicate that this thread is waiting to be notify
  - numInstances
```
protected static int numInstances
```
    Some variables used to name threads correctly
  - instanceNum
```
protected int instanceNum
```
- Constructor Detail
  - AudioEngineThread
```
public AudioEngineThread(ThreadGroup t,
                         String threadName)
```
    This constructor simply assigns the given id.
- Method Detail
  - debugPrint
```
protected void debugPrint(String message)
```
  - doWork
```
public void doWork()
```
    This method is defined by all slave threads to implement one iteration of work.
  - initialize
```
public void initialize()
```
    This initializes this thread. Once this method returns, the thread is ready to do work.
  - finish
```
public void finish()
```
    This causes the threads run method to exit.
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
    
    Overrides:
    
    run in class Thread
  - runMonitor
```
public void runMonitor(int action,
                       long referenceTime,
                       Object[] args)
```
  - shutdown
```
public void shutdown()
```
  - cleanup
```
public void cleanup()
```

Class AudioEngineThread

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class java.lang.Thread

Constructor Summary

Method Summary

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Field Detail

debugFlag

WORK_THREAD

UPDATE_THREAD

WAIT

NOTIFY_AND_WAIT

RUN

STOP

active

running

started

referenceTime

lastWaitTimestamp

type

classification

args

userStop

waiting

numInstances

instanceNum

Constructor Detail

AudioEngineThread

Method Detail

debugPrint

doWork

initialize

finish

run

runMonitor

shutdown

cleanup