com.sun.j3d.audioengines.javasound
Class JSSample

java.lang.Object
  extended by com.sun.j3d.audioengines.Sample
      extended by com.sun.j3d.audioengines.javasound.JSSample
Direct Known Subclasses:
JSPositionalSample

 class JSSample
extends Sample

The Sample Class extended for Java Sound Mixer specific audio device.


Field Summary
(package private)  long attackLength
           
(package private) static int BUFFERED_AUDIO_DATA
          Sound data specified as Buffered is copied by the AudioDevice driver implementation.
(package private) static int BUFFERED_MIDI_DATA
           
(package private)  JSChannel channel
           
(package private)  float currentRateRatio
           
(package private)  long dataOffset
          Offset pointer within currently playing sample data
(package private)  int dataType
          sound data types: BUFFERED (cached) or STREAMING (non-cached)
(package private)  long loopLength
           
(package private)  long loopStartOffset
           
(package private) static int NULL_SAMPLE
           
(package private)  long positionDeactivated
           
(package private)  boolean rampRateFlag
           
(package private)  float rateRatio
           
(package private)  long releaseLength
           
(package private)  long sampleLength
           
(package private) static int STREAMING_AUDIO_DATA
          Sound Data Types Samples can be processed as streaming or buffered data.
(package private) static int STREAMING_MIDI_DATA
          MIDI data TODO: differentiate between STREAMING and BUFFERED MIDI data right now all MIDI data is buffered
(package private)  float targetRateRatio
           
(package private)  long timeDeactivated
           
(package private) static int UNSUPPORTED_DATA_TYPE
           
 
Fields inherited from class com.sun.j3d.audioengines.Sample
angularDistance, angularFilterCutoff, angularFilterType, angularGain, attenuationDistance, attenuationGain, backAttenuationDistance, backAttenuationGain, debugFlag, direction, dirtyFlags, duration, DURATION_UNKNOWN, gain, internalErrors, loopCount, LOW_PASS, mute, NO_FILTERING, numberOfChannels, obstructionFilterCutoff, obstructionFilterType, obstructionGain, occlusionFilterCutoff, occlusionFilterType, occlusionGain, position, rateScaleFactor, soundData, soundType, vworldXfrm, vwXfrmFlag
 
Constructor Summary
JSSample()
           
 
Method Summary
 void clear()
          Clears/re-initialize fields associated with sample data for this sound, and frees any device specific data associated with this sample.
(package private)  float getCurrentRateRatio()
           
(package private)  int getDataType()
           
(package private)  boolean getFilterFlag()
           
(package private)  float getFilterFreq()
           
(package private)  boolean getRampRateFlag()
           
(package private)  float getTargetRateRatio()
           
(package private)  boolean load(MediaContainer soundData)
           
 void render(int dirtyFlags, View view, AuralParameters attribs)
           
(package private)  void reset()
           
(package private)  void setCurrentRateRatio(float ratio)
           
(package private)  void setDataType(int type)
           
(package private)  void setRampRateFlag(boolean flag)
           
(package private)  void setTargetRateRatio(float ratio)
           
 
Methods inherited from class com.sun.j3d.audioengines.Sample
debugPrint, debugPrintln, getDirtyFlags, getDuration, getGain, getLoopCount, getMuteFlag, getNumberOfChannelsUsed, getObstructionGain, getOcclusionGain, getRateScaleFactor, getSoundData, getSoundType, getStartTime, getVWrldXfrmFlag, setAngularAttenuation, setDirection, setDirtyFlags, setDistanceGain, setGain, setLoopCount, setMuteFlag, setObstructionFilter, setObstructionGain, setOcclusionFilter, setOcclusionGain, setPosition, setRateScaleFactor, setSoundData, setSoundType, setVWrldXfrmFlag
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STREAMING_AUDIO_DATA

static final int STREAMING_AUDIO_DATA
Sound Data Types Samples can be processed as streaming or buffered data. Fully spatializing sound sources may require data to be buffered. Sound data specified as Streaming is not copied by the AudioDevice driver implementation. It is up the application to ensure that this data is continuously accessible during sound rendering. Futhermore, full sound spatialization may not be possible, for all AudioDevice implementations on unbuffered sound data.

See Also:
Constant Field Values

BUFFERED_AUDIO_DATA

static final int BUFFERED_AUDIO_DATA
Sound data specified as Buffered is copied by the AudioDevice driver implementation.

See Also:
Constant Field Values

STREAMING_MIDI_DATA

static final int STREAMING_MIDI_DATA
MIDI data TODO: differentiate between STREAMING and BUFFERED MIDI data right now all MIDI data is buffered

See Also:
Constant Field Values

BUFFERED_MIDI_DATA

static final int BUFFERED_MIDI_DATA
See Also:
Constant Field Values

UNSUPPORTED_DATA_TYPE

static final int UNSUPPORTED_DATA_TYPE
See Also:
Constant Field Values

NULL_SAMPLE

static final int NULL_SAMPLE
See Also:
Constant Field Values

dataType

int dataType
sound data types: BUFFERED (cached) or STREAMING (non-cached)


channel

JSChannel channel

dataOffset

long dataOffset
Offset pointer within currently playing sample data


timeDeactivated

long timeDeactivated

positionDeactivated

long positionDeactivated

sampleLength

long sampleLength

loopStartOffset

long loopStartOffset

loopLength

long loopLength

attackLength

long attackLength

releaseLength

long releaseLength

rateRatio

float rateRatio

currentRateRatio

float currentRateRatio

targetRateRatio

float targetRateRatio

rampRateFlag

boolean rampRateFlag
Constructor Detail

JSSample

public JSSample()
Method Detail

render

public void render(int dirtyFlags,
                   View view,
                   AuralParameters attribs)
Overrides:
render in class Sample

clear

public void clear()
Clears/re-initialize fields associated with sample data for this sound, and frees any device specific data associated with this sample.

Overrides:
clear in class Sample

load

boolean load(MediaContainer soundData)

reset

void reset()

getFilterFlag

boolean getFilterFlag()

getFilterFreq

float getFilterFreq()

setCurrentRateRatio

void setCurrentRateRatio(float ratio)

getCurrentRateRatio

float getCurrentRateRatio()

setTargetRateRatio

void setTargetRateRatio(float ratio)

getTargetRateRatio

float getTargetRateRatio()

setRampRateFlag

void setRampRateFlag(boolean flag)

getRampRateFlag

boolean getRampRateFlag()

setDataType

void setDataType(int type)

getDataType

int getDataType()


Copyright 1996-2008 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.