Auralizor

java.lang.Object
- org.das2.graph.Auralizor

```
public final class Auralizor
extends java.lang.Object
```
Stream QDataSet to the sound system, using DEPEND_0 to control sampling rate.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_POSITION`
`static java.lang.String`	`PROP_REPORT_PERIOD`
`static java.lang.String`	`PROP_SCALE`
`static java.lang.String`	`PROP_TIMESCALE`

Constructor Summary

Constructors
Constructor and Description

Auralizor(QDataSet ds)
create an Auralizor for rendering the dataset to the sound system.

Constructors
Constructor and Description
`Auralizor(QDataSet ds)` create an Auralizor for rendering the dataset to the sound system.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)`
`void`	`addPropertyChangeListener(java.lang.String propname, java.beans.PropertyChangeListener listener)`
`javax.swing.JPanel`	`getControlPanel()`
`Datum`	`getFramePosition()` return the actual instant being played, getting the position from the line.
`Datum`	`getPosition()`
`Datum`	`getReportPeriod()`
`double`	`getTimeScale()`
`boolean`	`isPlaying()`
`boolean`	`isScale()`
`void`	`playSound()` begin streaming the sound.
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)`
`void`	`removePropertyChangeListener(java.lang.String propname, java.beans.PropertyChangeListener listener)`
`void`	`reset()`
`void`	`setDataSet(QDataSet ds)` set the dataset to stream.
`void`	`setPlaying(boolean playing)`
`void`	`setPosition(Datum position)`
`void`	`setReportPeriod(Datum reportPeriod)` frequency reports are issued.
`void`	`setScale(boolean scale)`
`void`	`setTimeScale(double timeScale)` Speed or slow the sound by this much, greater than one speeds up, less than one slows down.
`void`	`start()` begin streaming the sound.

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

- Field Detail
  - PROP_POSITION
```
public static final java.lang.String PROP_POSITION
```
    See Also:
    
    Constant Field Values
  - PROP_SCALE
```
public static final java.lang.String PROP_SCALE
```
    See Also:
    
    Constant Field Values
  - PROP_TIMESCALE
```
public static final java.lang.String PROP_TIMESCALE
```
    See Also:
    
    Constant Field Values
  - PROP_REPORT_PERIOD
```
public static final java.lang.String PROP_REPORT_PERIOD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Auralizor
```
public Auralizor(QDataSet ds)
```
    create an Auralizor for rendering the dataset to the sound system.
    
    Parameters:
    
    ds - rank 1 dataset with DEPEND_0 convertible to seconds.
- Method Detail
  - setDataSet
```
public final void setDataSet(QDataSet ds)
```
    set the dataset to stream. The dataset should be rank 1 or a rank 2 waveform, and have DEPEND_0 which is convertible to seconds or be a time location unit.
    
    Parameters:
    
    ds - the rank 1 dataset with DEPEND_0 convertible to seconds or be a time location unit, or rank 2 waveform.
  - getControlPanel
```
public javax.swing.JPanel getControlPanel()
```
  - reset
```
public void reset()
```
  - getPosition
```
public Datum getPosition()
```
  - setPosition
```
public void setPosition(Datum position)
```
  - getFramePosition
```
public Datum getFramePosition()
```
    return the actual instant being played, getting the position from the line.
    
    Returns:
    
    the position as a Datum, in the same frame as DEPEND_0.
    
    See Also:
    
    DataLine.getLongFramePosition();
  - isScale
```
public boolean isScale()
```
  - setScale
```
public void setScale(boolean scale)
```
  - getTimeScale
```
public double getTimeScale()
```
  - setTimeScale
```
public void setTimeScale(double timeScale)
```
    Speed or slow the sound by this much, greater than one speeds up, less than one slows down.
    
    Parameters:
    
    timeScale -
  - getReportPeriod
```
public Datum getReportPeriod()
```
  - setReportPeriod
```
public void setReportPeriod(Datum reportPeriod)
```
    frequency reports are issued. Note this may be ignored.
    
    Parameters:
    
    reportPeriod -
  - isPlaying
```
public boolean isPlaying()
```
  - setPlaying
```
public void setPlaying(boolean playing)
```
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
```
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.lang.String propname,
                                      java.beans.PropertyChangeListener listener)
```
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
```
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.lang.String propname,
                                         java.beans.PropertyChangeListener listener)
```
  - start
```
public void start()
```
    begin streaming the sound. This will start the process on a separate thread and not block the current thread.
    
    See Also:
    
    playSound()
  - playSound
```
public void playSound()
```
    begin streaming the sound. This will block the current thread until complete.
    
    See Also:
    
    start()

Class Auralizor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_POSITION

PROP_SCALE

PROP_TIMESCALE

PROP_REPORT_PERIOD

Constructor Detail

Auralizor

Method Detail

setDataSet

getControlPanel

reset

getPosition

setPosition

getFramePosition

isScale

setScale

getTimeScale

setTimeScale

getReportPeriod

setReportPeriod

isPlaying

setPlaying

addPropertyChangeListener

addPropertyChangeListener

removePropertyChangeListener

removePropertyChangeListener

start

playSound