Package org.web3d.x3d.sai.Sound
Interface X3DSoundSourceNode
- All Superinterfaces:
X3DChildNode
,X3DNode
,X3DTimeDependentNode
- All Known Subinterfaces:
AudioBufferSource
,AudioClip
,ListenerPoint
,MicrophoneSource
,MovieTexture
,OscillatorSource
,StreamAudioSource
- All Known Implementing Classes:
AudioBufferSource
,AudioClip
,ListenerPoint
,MicrophoneSource
,MovieTexture
,OscillatorSource
,StreamAudioSource
public interface X3DSoundSourceNode extends X3DTimeDependentNode
Nodes implementing X3DSoundSourceNode are allowed as children of Sound node.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
-
Method Summary
Modifier and Type Method Description java.lang.String
getDescription()
Provide String value from inputOutput SFString field named description.double
getElapsedTime()
Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.boolean
getEnabled()
Provide boolean value from inputOutput SFBool field named enabled.float
getGain()
Provide float value from inputOutput SFFloat field named gain.boolean
getIsActive()
Provide boolean value from outputOnly SFBool field named isActive.boolean
getIsPaused()
Provide boolean value from outputOnly SFBool field named isPaused.X3DMetadataObject
getMetadata()
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.double
getPauseTime()
Provide double value in seconds from inputOutput SFTime field named pauseTime.double
getResumeTime()
Provide double value in seconds from inputOutput SFTime field named resumeTime.double
getStartTime()
Provide double value in seconds from inputOutput SFTime field named startTime.double
getStopTime()
Provide double value in seconds from inputOutput SFTime field named stopTime.X3DSoundSourceNode
setDescription(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named description.X3DSoundSourceNode
setEnabled(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named enabled.X3DSoundSourceNode
setGain(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named gain.X3DSoundSourceNode
setMetadata(X3DMetadataObject newValue)
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.X3DSoundSourceNode
setPauseTime(double newValue)
Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.X3DSoundSourceNode
setResumeTime(double newValue)
Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.X3DSoundSourceNode
setStartTime(double newValue)
Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.X3DSoundSourceNode
setStopTime(double newValue)
Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.
-
Method Details
-
getDescription
java.lang.String getDescription()Provide String value from inputOutput SFString field named description.- Specified by:
getDescription
in interfaceX3DTimeDependentNode
- Returns:
- value of description field
-
setDescription
Accessor method to assign String value to inputOutput SFString field named description.- Specified by:
setDescription
in interfaceX3DTimeDependentNode
- Parameters:
newValue
- is new value for the description field.- Returns:
X3DSoundSourceNode
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getElapsedTime
double getElapsedTime()Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.- Specified by:
getElapsedTime
in interfaceX3DTimeDependentNode
- Returns:
- value of elapsedTime field
-
getEnabled
boolean getEnabled()Provide boolean value from inputOutput SFBool field named enabled.- Returns:
- value of enabled field
-
setEnabled
Accessor method to assign boolean value to inputOutput SFBool field named enabled.- Parameters:
newValue
- is new value for the enabled field.- Returns:
X3DSoundSourceNode
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getGain
float getGain()Provide float value from inputOutput SFFloat field named gain.- Returns:
- value of gain field
-
setGain
Accessor method to assign float value to inputOutput SFFloat field named gain.- Parameters:
newValue
- is new value for the gain field.- Returns:
X3DSoundSourceNode
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIsActive
boolean getIsActive()Provide boolean value from outputOnly SFBool field named isActive.- Specified by:
getIsActive
in interfaceX3DTimeDependentNode
- Returns:
- value of isActive field
-
getIsPaused
boolean getIsPaused()Provide boolean value from outputOnly SFBool field named isPaused.- Specified by:
getIsPaused
in interfaceX3DTimeDependentNode
- Returns:
- value of isPaused field
-
getMetadata
X3DMetadataObject getMetadata()Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DTimeDependentNode
- Returns:
- value of metadata field
- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DTimeDependentNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
X3DSoundSourceNode
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- X3D Scene Authoring Hints: Metadata Nodes
-
getPauseTime
double getPauseTime()Provide double value in seconds from inputOutput SFTime field named pauseTime.- Specified by:
getPauseTime
in interfaceX3DTimeDependentNode
- Returns:
- value of pauseTime field
-
setPauseTime
Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.- Specified by:
setPauseTime
in interfaceX3DTimeDependentNode
- Parameters:
newValue
- is new value for the pauseTime field.- Returns:
X3DSoundSourceNode
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getResumeTime
double getResumeTime()Provide double value in seconds from inputOutput SFTime field named resumeTime.- Specified by:
getResumeTime
in interfaceX3DTimeDependentNode
- Returns:
- value of resumeTime field
-
setResumeTime
Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.- Specified by:
setResumeTime
in interfaceX3DTimeDependentNode
- Parameters:
newValue
- is new value for the resumeTime field.- Returns:
X3DSoundSourceNode
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getStartTime
double getStartTime()Provide double value in seconds from inputOutput SFTime field named startTime.- Specified by:
getStartTime
in interfaceX3DTimeDependentNode
- Returns:
- value of startTime field
-
setStartTime
Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.- Specified by:
setStartTime
in interfaceX3DTimeDependentNode
- Parameters:
newValue
- is new value for the startTime field.- Returns:
X3DSoundSourceNode
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getStopTime
double getStopTime()Provide double value in seconds from inputOutput SFTime field named stopTime.- Specified by:
getStopTime
in interfaceX3DTimeDependentNode
- Returns:
- value of stopTime field
-
setStopTime
Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.- Specified by:
setStopTime
in interfaceX3DTimeDependentNode
- Parameters:
newValue
- is new value for the stopTime field.- Returns:
X3DSoundSourceNode
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-