Sound (Java 3D Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.java3d.SceneGraphObject
- - org.scijava.java3d.Node
  - - org.scijava.java3d.Leaf
    - - org.scijava.java3d.Sound

Direct Known Subclasses:

BackgroundSound, PointSound
```
public abstract class Sound
extends Leaf
```
Sound node is an abstract class that defines the properties common to all sound sources. A scene graph can contain multiple sounds. Associated with each sound source are: a reference to sound data, an amplitude scale factor, a release flag denoting that the sound associated with this node is to play to end when it is disabled, the number of times sound is to be repeated, the sound's state (on or off), a scheduling region, and a flag denoting if the sound is to continue playing "silently" even while it is inactive. Whenever the listener is within a sound node's scheduling bounds this sound is potentially audible.
Sound Data
Initial Gain
Loop
Release Flag
Continuous Flag
Enable Sound
Mute Sound
Pause Sound
Scheduling Bounds
Scheduling Bounding Leaf
Prioritize Sound
Duration
Number of Channels used on Audio Device to Play Sound
Preparing a Sound to be Played
Playing Status
See Also:

AudioDevice

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALLOW_CHANNELS_USED_READ` Specifies that this node allows access to its number of channels used by this sound.
`static int`	`ALLOW_CONT_PLAY_READ` Specifies that this node allows access to its object's continuous play information.
`static int`	`ALLOW_CONT_PLAY_WRITE` Specifies that this node allows writing to its object's continuous play information.
`static int`	`ALLOW_DURATION_READ` Specifies that this node allows access to its object's sound duration information.
`static int`	`ALLOW_ENABLE_READ` Specifies that this node allows access to its object's sound on information.
`static int`	`ALLOW_ENABLE_WRITE` Specifies that this node allows writing to its object's sound on information.
`static int`	`ALLOW_INITIAL_GAIN_READ` Specifies that this node allows access to its object's initial gain information.
`static int`	`ALLOW_INITIAL_GAIN_WRITE` Specifies that this node allows writing to its object's initial gain information.
`static int`	`ALLOW_IS_PLAYING_READ` Specifies that this node allows access to its object's sound audibly playing or playing silently status.
`static int`	`ALLOW_IS_READY_READ` Specifies that this node allows access to its object's sound status denoting if it is ready to be played 'immediately'.
`static int`	`ALLOW_LOOP_READ` Specifies that this node allows access to its object's loop information.
`static int`	`ALLOW_LOOP_WRITE` Specifies that this node allows writing to its object's loop information.
`static int`	`ALLOW_MUTE_READ` Specifies that this node allows access to its object's mute flag information.
`static int`	`ALLOW_MUTE_WRITE` Specifies that this node allows writing to its object's mute flag information.
`static int`	`ALLOW_PAUSE_READ` Specifies that this node allows access to its object's pause flag information.
`static int`	`ALLOW_PAUSE_WRITE` Specifies that this node allows writing to its object's pause flag information.
`static int`	`ALLOW_PRIORITY_READ` Specifies that this node allows read access to its priority order value.
`static int`	`ALLOW_PRIORITY_WRITE` Specifies that this node allows write access to its priority order value.
`static int`	`ALLOW_RATE_SCALE_FACTOR_READ` Specifies that this node allows access to its object's sample rate scale factor information.
`static int`	`ALLOW_RATE_SCALE_FACTOR_WRITE` Specifies that this node allows writing to its object's sample rate scale factor information.
`static int`	`ALLOW_RELEASE_READ` Specifies that this node allows access to its object's release flag information.
`static int`	`ALLOW_RELEASE_WRITE` Specifies that this node allows writing to its object's release flag information.
`static int`	`ALLOW_SCHEDULING_BOUNDS_READ` Specifies that this node allows read access to its scheduling bounds information.
`static int`	`ALLOW_SCHEDULING_BOUNDS_WRITE` Specifies that this node allows write access to its scheduling bounds information.
`static int`	`ALLOW_SOUND_DATA_READ` Specifies that this node allows access to its object's sound data information.
`static int`	`ALLOW_SOUND_DATA_WRITE` Specifies that this node allows writing to its object's sound data information.
`static int`	`DURATION_UNKNOWN` Denotes that the sound's duration could not be calculated.
`static int`	`INFINITE_LOOPS` When used as a loop count sound will loop an infinite number of time until explicitly stopped (setEnabled(false)).
`static float`	`NO_FILTER` Denotes that there is no filter value associated with object's distance or angular attenuation array.

Fields inherited from class org.scijava.java3d.Node
ALLOW_AUTO_COMPUTE_BOUNDS_READ, ALLOW_AUTO_COMPUTE_BOUNDS_WRITE, ALLOW_BOUNDS_READ, ALLOW_BOUNDS_WRITE, ALLOW_COLLIDABLE_READ, ALLOW_COLLIDABLE_WRITE, ALLOW_LOCAL_TO_VWORLD_READ, ALLOW_LOCALE_READ, ALLOW_PARENT_READ, ALLOW_PICKABLE_READ, ALLOW_PICKABLE_WRITE, ENABLE_COLLISION_REPORTING, ENABLE_PICK_REPORTING

Constructor Summary

Constructors
Constructor and Description
`Sound()` Constructs and initializes a new Sound node using default parameters.
`Sound(MediaContainer soundData, float initialGain)` Constructs and initializes a new Sound node object using the provided data and gain parameter values, and defaults for all other fields.
`Sound(MediaContainer soundData, float initialGain, int loopCount, boolean release, boolean continuous, boolean enable, Bounds region, float priority)` Constructs and initializes a new Sound node using provided parameter values.
`Sound(MediaContainer soundData, float initialGain, int loopCount, boolean release, boolean continuous, boolean enable, Bounds region, float priority, float rateFactor)` Constructs and initializes a new Sound node using provided parameter values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getContinuousEnable()` Retrieves sound's continuous play flag.
`long`	`getDuration()` Get the Sound's duration
`boolean`	`getEnable()` Retrieves sound's enabled flag.
`float`	`getInitialGain()` Get the overall gain applied to the sound data associated with source.
`int`	`getLoop()` Retrieves loop count for this sound
`boolean`	`getMute()` Retrieves sound Mute state.
`int`	`getNumberOfChannelsUsed()` Retrieves number of channels that are being used to render this sound on the audio device associated with the Virtual Universe's primary view.
`int`	`getNumberOfChannelsUsed(View view)` Retrieves number of channels that are being used to render this sound on the audio device associated with given view.
`boolean`	`getPause()` Retrieves the value of the Pause state flag.
`float`	`getPriority()` Retrieves sound's priority value.
`float`	`getRateScaleFactor()` Retrieves Sample Rate.
`boolean`	`getReleaseEnable()` Retrieves the release flag for sound associated with sound.
`BoundingLeaf`	`getSchedulingBoundingLeaf()` Retrieves the Sound node's scheduling bounding leaf.
`Bounds`	`getSchedulingBounds()` Retrieves the Sound node's scheduling bounds.
`MediaContainer`	`getSoundData()` Retrieves description/data associated with this sound source.
`boolean`	`isPlaying()` Retrieves sound's play status.
`boolean`	`isPlaying(View view)` Retrieves sound's play status.
`boolean`	`isPlayingSilently()` Retrieves sound's silent status.
`boolean`	`isPlayingSilently(View view)` Retrieves sound's silent status.
`boolean`	`isReady()` Retrieves sound's 'ready' status.
`boolean`	`isReady(View view)` Retrieves sound's 'ready' status.
`void`	`setContinuousEnable(boolean state)` Enables or disables continuous play flag.
`void`	`setEnable(boolean state)` Enable or disable sound.
`void`	`setInitialGain(float amplitude)` Set the overall gain scale factor applied to data associated with this source to increase or decrease its overall amplitude.
`void`	`setLoop(int loopCount)` Sets a sound's loop count.
`void`	`setMute(boolean state)` Set mute state flag.
`void`	`setPause(boolean state)` Pauses or resumes (paused) playing sound.
`void`	`setPriority(float priority)` Set sound's priority value.
`void`	`setRateScaleFactor(float scaleFactor)` Sets Sample Rate.
`void`	`setReleaseEnable(boolean state)` Enables or disables the release flag for the sound associated with this sound.
`void`	`setSchedulingBoundingLeaf(BoundingLeaf region)` Set the Sound's scheduling region to the specified bounding leaf.
`void`	`setSchedulingBounds(Bounds region)` Set the Sound's scheduling region to the specified bounds.
`void`	`setSoundData(MediaContainer soundData)` Sets fields that define the sound source data of this node.
`void`	`updateNodeReferences(NodeReferenceTable referenceTable)` Callback used to allow a node to check if any scene graph objects referenced by that node have been duplicated via a call to `cloneTree`.

Methods inherited from class org.scijava.java3d.Node
cloneNode, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, duplicateNode, getBounds, getBoundsAutoCompute, getCollidable, getLocale, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable

Methods inherited from class org.scijava.java3d.SceneGraphObject
clearCapability, clearCapabilityIsFrequent, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setName, setUserData, toString

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

- Field Detail
  - ALLOW_SOUND_DATA_READ
```
public static final int ALLOW_SOUND_DATA_READ
```
    Specifies that this node allows access to its object's sound data information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_SOUND_DATA_WRITE
```
public static final int ALLOW_SOUND_DATA_WRITE
```
    Specifies that this node allows writing to its object's sound data information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_INITIAL_GAIN_READ
```
public static final int ALLOW_INITIAL_GAIN_READ
```
    Specifies that this node allows access to its object's initial gain information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_INITIAL_GAIN_WRITE
```
public static final int ALLOW_INITIAL_GAIN_WRITE
```
    Specifies that this node allows writing to its object's initial gain information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_LOOP_READ
```
public static final int ALLOW_LOOP_READ
```
    Specifies that this node allows access to its object's loop information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_LOOP_WRITE
```
public static final int ALLOW_LOOP_WRITE
```
    Specifies that this node allows writing to its object's loop information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_RELEASE_READ
```
public static final int ALLOW_RELEASE_READ
```
    Specifies that this node allows access to its object's release flag information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_RELEASE_WRITE
```
public static final int ALLOW_RELEASE_WRITE
```
    Specifies that this node allows writing to its object's release flag information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_CONT_PLAY_READ
```
public static final int ALLOW_CONT_PLAY_READ
```
    Specifies that this node allows access to its object's continuous play information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_CONT_PLAY_WRITE
```
public static final int ALLOW_CONT_PLAY_WRITE
```
    Specifies that this node allows writing to its object's continuous play information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_ENABLE_READ
```
public static final int ALLOW_ENABLE_READ
```
    Specifies that this node allows access to its object's sound on information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_ENABLE_WRITE
```
public static final int ALLOW_ENABLE_WRITE
```
    Specifies that this node allows writing to its object's sound on information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_SCHEDULING_BOUNDS_READ
```
public static final int ALLOW_SCHEDULING_BOUNDS_READ
```
    Specifies that this node allows read access to its scheduling bounds information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_SCHEDULING_BOUNDS_WRITE
```
public static final int ALLOW_SCHEDULING_BOUNDS_WRITE
```
    Specifies that this node allows write access to its scheduling bounds information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_PRIORITY_READ
```
public static final int ALLOW_PRIORITY_READ
```
    Specifies that this node allows read access to its priority order value.
    
    See Also:
    
    Constant Field Values
  - ALLOW_PRIORITY_WRITE
```
public static final int ALLOW_PRIORITY_WRITE
```
    Specifies that this node allows write access to its priority order value.
    
    See Also:
    
    Constant Field Values
  - ALLOW_DURATION_READ
```
public static final int ALLOW_DURATION_READ
```
    Specifies that this node allows access to its object's sound duration information.
    
    See Also:
    
    Constant Field Values
  - ALLOW_IS_READY_READ
```
public static final int ALLOW_IS_READY_READ
```
    Specifies that this node allows access to its object's sound status denoting if it is ready to be played 'immediately'.
    
    See Also:
    
    Constant Field Values
  - ALLOW_IS_PLAYING_READ
```
public static final int ALLOW_IS_PLAYING_READ
```
    Specifies that this node allows access to its object's sound audibly playing or playing silently status.
    
    See Also:
    
    Constant Field Values
  - ALLOW_CHANNELS_USED_READ
```
public static final int ALLOW_CHANNELS_USED_READ
```
    Specifies that this node allows access to its number of channels used by this sound.
    
    See Also:
    
    Constant Field Values
  - ALLOW_MUTE_READ
```
public static final int ALLOW_MUTE_READ
```
    Specifies that this node allows access to its object's mute flag information.
    
    Since:
    
    Java 3D 1.3
    
    See Also:
    
    Constant Field Values
  - ALLOW_MUTE_WRITE
```
public static final int ALLOW_MUTE_WRITE
```
    Specifies that this node allows writing to its object's mute flag information.
    
    Since:
    
    Java 3D 1.3
    
    See Also:
    
    Constant Field Values
  - ALLOW_PAUSE_READ
```
public static final int ALLOW_PAUSE_READ
```
    Specifies that this node allows access to its object's pause flag information.
    
    Since:
    
    Java 3D 1.3
    
    See Also:
    
    Constant Field Values
  - ALLOW_PAUSE_WRITE
```
public static final int ALLOW_PAUSE_WRITE
```
    Specifies that this node allows writing to its object's pause flag information.
    
    Since:
    
    Java 3D 1.3
    
    See Also:
    
    Constant Field Values
  - ALLOW_RATE_SCALE_FACTOR_READ
```
public static final int ALLOW_RATE_SCALE_FACTOR_READ
```
    Specifies that this node allows access to its object's sample rate scale factor information.
    
    Since:
    
    Java 3D 1.3
    
    See Also:
    
    Constant Field Values
  - ALLOW_RATE_SCALE_FACTOR_WRITE
```
public static final int ALLOW_RATE_SCALE_FACTOR_WRITE
```
    Specifies that this node allows writing to its object's sample rate scale factor information.
    
    Since:
    
    Java 3D 1.3
    
    See Also:
    
    Constant Field Values
  - NO_FILTER
```
public static final float NO_FILTER
```
    Denotes that there is no filter value associated with object's distance or angular attenuation array.
    
    See Also:
    
    Constant Field Values
  - DURATION_UNKNOWN
```
public static final int DURATION_UNKNOWN
```
    Denotes that the sound's duration could not be calculated. A fall back for getDuration of a non-cached sound.
    
    See Also:
    
    Constant Field Values
  - INFINITE_LOOPS
```
public static final int INFINITE_LOOPS
```
    When used as a loop count sound will loop an infinite number of time until explicitly stopped (setEnabled(false)).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Sound
```
public Sound()
```
    Constructs and initializes a new Sound node using default parameters. The following defaults values are used:
  - Sound
```
public Sound(MediaContainer soundData,
             float initialGain)
```
    Constructs and initializes a new Sound node object using the provided data and gain parameter values, and defaults for all other fields. This constructor implicitly loads the sound data associated with this node if the implementation uses sound caching.
    
    Parameters:
    
    soundData - description of JMF source data used by this sound source
    
    initialGain - overall amplitude scale factor applied to sound source
  - Sound
```
public Sound(MediaContainer soundData,
             float initialGain,
             int loopCount,
             boolean release,
             boolean continuous,
             boolean enable,
             Bounds region,
             float priority)
```
    Constructs and initializes a new Sound node using provided parameter values.
    
    Parameters:
    
    soundData - description of JMF source data used by this sound source
    
    initialGain - overall amplitude scale factor applied to sound source
    
    loopCount - number of times sound is looped when played
    
    release - flag specifying whether the sound is to be played to end when stopped
    
    continuous - flag specifying whether the sound silently plays when disabled
    
    enable - flag specifying whether the sound is enabled
    
    region - scheduling bounds
    
    priority - defines playback priority if too many sounds started
  - Sound
```
public Sound(MediaContainer soundData,
             float initialGain,
             int loopCount,
             boolean release,
             boolean continuous,
             boolean enable,
             Bounds region,
             float priority,
             float rateFactor)
```
    Constructs and initializes a new Sound node using provided parameter values.
    
    Parameters:
    
    soundData - description of JMF source data used by this sound source
    
    initialGain - overall amplitude scale factor applied to sound source
    
    loopCount - number of times sound is looped when played
    
    release - flag specifying whether the sound is to be played to end when stopped
    
    continuous - flag specifying whether the sound silently plays when disabled
    
    enable - flag specifying whether the sound is enabled
    
    region - scheduling bounds
    
    priority - defines playback priority if too many sounds started
    
    rateFactor - defines playback sample rate scale factor
    
    Since:
    
    Java 3D 1.3
- Method Detail
  - setSoundData
```
public void setSoundData(MediaContainer soundData)
```
    Sets fields that define the sound source data of this node.
    
    Parameters:
    
    soundData - description of JMF source data used by this sound source
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - getSoundData
```
public MediaContainer getSoundData()
```
    Retrieves description/data associated with this sound source.
    
    Returns:
    
    soundData description of JMF source data used by this sound source
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - setInitialGain
```
public void setInitialGain(float amplitude)
```
    Set the overall gain scale factor applied to data associated with this source to increase or decrease its overall amplitude.
    
    Parameters:
    
    amplitude - (gain) scale factor
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - getInitialGain
```
public float getInitialGain()
```
    Get the overall gain applied to the sound data associated with source.
    
    Returns:
    
    overall gain scale factor applied to sound source data.
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - setLoop
```
public void setLoop(int loopCount)
```
    Sets a sound's loop count.
    
    Parameters:
    
    loopCount - number of times sound is looped during play
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - getLoop
```
public int getLoop()
```
    Retrieves loop count for this sound
    
    Returns:
    
    loop count
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - setReleaseEnable
```
public void setReleaseEnable(boolean state)
```
    Enables or disables the release flag for the sound associated with this sound.
    
    Parameters:
    
    state - release flag
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - getReleaseEnable
```
public boolean getReleaseEnable()
```
    Retrieves the release flag for sound associated with sound.
    
    Returns:
    
    sound's release flag
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - setContinuousEnable
```
public void setContinuousEnable(boolean state)
```
    Enables or disables continuous play flag.
    
    Parameters:
    
    state - denotes if deactivated sound silently continues playing
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - getContinuousEnable
```
public boolean getContinuousEnable()
```
    Retrieves sound's continuous play flag.
    
    Returns:
    
    flag denoting if deactivated sound silently continues playing
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - setEnable
```
public void setEnable(boolean state)
```
    Enable or disable sound.
    
    Parameters:
    
    state - enable (on/off) flag denotes if active sound is heard
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - getEnable
```
public boolean getEnable()
```
    Retrieves sound's enabled flag.
    
    Returns:
    
    sound enabled flag
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - setSchedulingBounds
```
public void setSchedulingBounds(Bounds region)
```
    Set the Sound's scheduling region to the specified bounds. This is used when the scheduling bounding leaf is set to null.
    
    Parameters:
    
    region - the bounds that contains the Sound's new scheduling region.
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - getSchedulingBounds
```
public Bounds getSchedulingBounds()
```
    Retrieves the Sound node's scheduling bounds.
    
    Returns:
    
    this Sound's scheduling bounds information
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - setSchedulingBoundingLeaf
```
public void setSchedulingBoundingLeaf(BoundingLeaf region)
```
    Set the Sound's scheduling region to the specified bounding leaf. When set to a value other than null, this overrides the scheduling bounds object.
    
    Parameters:
    
    region - the bounding leaf node used to specify the Sound node's new scheduling region.
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - getSchedulingBoundingLeaf
```
public BoundingLeaf getSchedulingBoundingLeaf()
```
    Retrieves the Sound node's scheduling bounding leaf.
    
    Returns:
    
    this Sound's scheduling bounding leaf information
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - setPriority
```
public void setPriority(float priority)
```
    Set sound's priority value.
    
    Parameters:
    
    priority - value used to order sound's importance for playback.
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - getPriority
```
public float getPriority()
```
    Retrieves sound's priority value.
    
    Returns:
    
    sound priority value
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - getDuration
```
public long getDuration()
```
    Get the Sound's duration
    
    Returns:
    
    this Sound's duration in milliseconds including repeated loops
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - isReady
```
public boolean isReady()
```
    Retrieves sound's 'ready' status. If this sound is fully prepared to begin playing (audibly or silently) on all initialized audio devices, this method returns true.
    
    Returns:
    
    flag denoting if sound is immediate playable or not
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - isReady
```
public boolean isReady(View view)
```
    Retrieves sound's 'ready' status. If this sound is fully prepared to begin playing (audibly or silently) on the audio device associated with this view, this method returns true.
    
    Parameters:
    
    view - the view on which to query the ready status.
    
    Returns:
    
    flag denoting if sound is immediate playable or not
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
    
    Since:
    
    Java 3D 1.3
  - isPlaying
```
public boolean isPlaying()
```
    Retrieves sound's play status. If this sound is audibly playing on any initialized audio device, this method returns true.
    
    Returns:
    
    flag denoting if sound is playing (potentially audible) or not
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - isPlaying
```
public boolean isPlaying(View view)
```
    Retrieves sound's play status. If this sound is audibly playing on the audio device associated with the given view, this method returns true.
    
    Parameters:
    
    view - the view on which to query the isPlaying status.
    
    Returns:
    
    flag denoting if sound is playing (potentially audible) or not
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
    
    Since:
    
    Java 3D 1.3
  - isPlayingSilently
```
public boolean isPlayingSilently()
```
    Retrieves sound's silent status. If this sound is silently playing on any initialized audio device, this method returns true.
    
    Returns:
    
    flag denoting if sound is silently playing (enabled but not active)
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - isPlayingSilently
```
public boolean isPlayingSilently(View view)
```
    Retrieves sound's silent status. If this sound is silently playing on the audio device associated with the given view, this method returns true. The isPlayingSilently state is affected by enable, mute, and continuous states as well as active status of sound.
    
    Parameters:
    
    view - the view on which to query the isPlayingSilently status.
    
    Returns:
    
    flag denoting if sound is silently playing (enabled but not active)
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
    
    Since:
    
    Java 3D 1.3
  - getNumberOfChannelsUsed
```
public int getNumberOfChannelsUsed()
```
    Retrieves number of channels that are being used to render this sound on the audio device associated with the Virtual Universe's primary view.
    
    Returns:
    
    number of channels used by sound; returns 0 if not playing
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
  - getNumberOfChannelsUsed
```
public int getNumberOfChannelsUsed(View view)
```
    Retrieves number of channels that are being used to render this sound on the audio device associated with given view.
    
    Parameters:
    
    view - the view on which to query the number of channels used.
    
    Returns:
    
    number of channels used by sound; returns 0 if not playing
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is
    
    Since:
    
    Java 3D 1.3 not set and this object is part of live or compiled scene graph
  - setMute
```
public void setMute(boolean state)
```
    Set mute state flag. If the sound is playing it will be set to play silently
    
    Parameters:
    
    state - flag
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
    
    Since:
    
    Java 3D 1.3
  - getMute
```
public boolean getMute()
```
    Retrieves sound Mute state. A return value of true does not imply that the sound has been started playing or is still playing silently.
    
    Returns:
    
    mute state flag
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
    
    Since:
    
    Java 3D 1.3
  - setPause
```
public void setPause(boolean state)
```
    Pauses or resumes (paused) playing sound.
    
    Parameters:
    
    state - pause flag
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
    
    Since:
    
    Java 3D 1.3
  - getPause
```
public boolean getPause()
```
    Retrieves the value of the Pause state flag. A return value of true does not imply that the sound was started playing and then paused.
    
    Returns:
    
    pause state
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
    
    Since:
    
    Java 3D 1.3
  - setRateScaleFactor
```
public void setRateScaleFactor(float scaleFactor)
```
    Sets Sample Rate. Changes (scales) the playback rate of a sound independent of Doppler rate changes - applied to ALL sound types. Affects device sample rate playback and thus affects both pitch and speed
    
    Parameters:
    
    scaleFactor - %%% describe this.
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
    
    Since:
    
    Java 3D 1.3
  - getRateScaleFactor
```
public float getRateScaleFactor()
```
    Retrieves Sample Rate.
    
    Returns:
    
    sample rate scale factor
    
    Throws:
    
    CapabilityNotSetException - if appropriate capability is not set and this object is part of live or compiled scene graph
    
    Since:
    
    Java 3D 1.3
  - updateNodeReferences
```
public void updateNodeReferences(NodeReferenceTable referenceTable)
```
    Callback used to allow a node to check if any scene graph objects referenced by that node have been duplicated via a call to cloneTree. This method is called by cloneTree after all nodes in the sub-graph have been duplicated. The cloned Leaf node's method will be called and the Leaf node can then look up any object references by using the getNewObjectReference method found in the NodeReferenceTable object. If a match is found, a reference to the corresponding object in the newly cloned sub-graph is returned. If no corresponding reference is found, either a DanglingReferenceException is thrown or a reference to the original object is returned depending on the value of the allowDanglingReferences parameter passed in the cloneTree call.
    NOTE: Applications should not call this method directly. It should only be called by the cloneTree method.
    
    Overrides:
    
    updateNodeReferences in class SceneGraphObject
    
    Parameters:
    
    referenceTable - a NodeReferenceTableObject that contains the getNewObjectReference method needed to search for new object instances.
    
    See Also:
    
    NodeReferenceTable, Node.cloneTree(), DanglingReferenceException

Class Sound

Field Summary

Fields inherited from class org.scijava.java3d.Node

Constructor Summary

Method Summary

Methods inherited from class org.scijava.java3d.Node

Methods inherited from class org.scijava.java3d.SceneGraphObject

Methods inherited from class java.lang.Object

Field Detail

ALLOW_SOUND_DATA_READ

ALLOW_SOUND_DATA_WRITE

ALLOW_INITIAL_GAIN_READ

ALLOW_INITIAL_GAIN_WRITE

ALLOW_LOOP_READ

ALLOW_LOOP_WRITE

ALLOW_RELEASE_READ

ALLOW_RELEASE_WRITE

ALLOW_CONT_PLAY_READ

ALLOW_CONT_PLAY_WRITE

ALLOW_ENABLE_READ

ALLOW_ENABLE_WRITE

ALLOW_SCHEDULING_BOUNDS_READ

ALLOW_SCHEDULING_BOUNDS_WRITE

ALLOW_PRIORITY_READ

ALLOW_PRIORITY_WRITE

ALLOW_DURATION_READ

ALLOW_IS_READY_READ

ALLOW_IS_PLAYING_READ

ALLOW_CHANNELS_USED_READ

ALLOW_MUTE_READ

ALLOW_MUTE_WRITE

ALLOW_PAUSE_READ

ALLOW_PAUSE_WRITE

ALLOW_RATE_SCALE_FACTOR_READ

ALLOW_RATE_SCALE_FACTOR_WRITE

NO_FILTER

DURATION_UNKNOWN

INFINITE_LOOPS

Constructor Detail

Sound

Sound

Sound

Sound

Method Detail

setSoundData

getSoundData

setInitialGain

getInitialGain

setLoop

getLoop

setReleaseEnable

getReleaseEnable

setContinuousEnable

getContinuousEnable

setEnable

getEnable

setSchedulingBounds

getSchedulingBounds

setSchedulingBoundingLeaf

getSchedulingBoundingLeaf

setPriority

getPriority

getDuration

isReady

isReady

isPlaying

isPlaying

isPlayingSilently

isPlayingSilently

getNumberOfChannelsUsed

getNumberOfChannelsUsed

setMute

getMute

setPause

getPause

setRateScaleFactor

getRateScaleFactor

updateNodeReferences