Interface OscillatorSource

All Superinterfaces:
X3DChildNode, X3DNode, X3DSoundNode, X3DSoundSourceNode, X3DTimeDependentNode
All Known Implementing Classes:
OscillatorSource
public interface OscillatorSource extends X3DSoundSourceNode
OscillatorSource node represents an audio source generating a periodic waveform, providing a constant tone.

OscillatorSource node tooltip: [X3DSoundSourceNode] OscillatorSource node represents an audio source generating a periodic waveform, providing a constant tone.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Provide ($javaType=String, isArrayType=false, isArrayListType=false, javaPrimitiveType=String, javaReferenceType=String, isX3dStatement=false, isClassX3dStatement=false) String value from inputOutput SFString field named description.
    float
    getDetune()
    Provide ($javaType=float, isArrayType=false, isArrayListType=false, javaPrimitiveType=float, javaReferenceType=float, isX3dStatement=false, isClassX3dStatement=false) float value within allowed range of [0,infinity) from inputOutput SFFloat field named detune.
    double
    getElapsedTime()
    Provide ($javaType=double, isArrayType=false, isArrayListType=false, javaPrimitiveType=double, javaReferenceType=double, isX3dStatement=false, isClassX3dStatement=false) double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.
    boolean
    getEnabled()
    Provide ($javaType=boolean, isArrayType=false, isArrayListType=false, javaPrimitiveType=boolean, javaReferenceType=boolean, isX3dStatement=false, isClassX3dStatement=false) boolean value from inputOutput SFBool field named enabled.
    float
    getFrequency()
    Provide ($javaType=float, isArrayType=false, isArrayListType=false, javaPrimitiveType=float, javaReferenceType=float, isX3dStatement=false, isClassX3dStatement=false) float value within allowed range of [0,infinity) from inputOutput SFFloat field named frequency.
    float
    getGain()
    Provide ($javaType=float, isArrayType=false, isArrayListType=false, javaPrimitiveType=float, javaReferenceType=float, isX3dStatement=false, isClassX3dStatement=false) float value from inputOutput SFFloat field named gain.
    boolean
    getIsActive()
    Provide ($javaType=boolean, isArrayType=false, isArrayListType=false, javaPrimitiveType=boolean, javaReferenceType=boolean, isX3dStatement=false, isClassX3dStatement=false) boolean value from outputOnly SFBool field named isActive.
    boolean
    getIsPaused()
    Provide ($javaType=boolean, isArrayType=false, isArrayListType=false, javaPrimitiveType=boolean, javaReferenceType=boolean, isX3dStatement=false, isClassX3dStatement=false) boolean value from outputOnly SFBool field named isPaused.
    X3DMetadataObject
    getMetadata()
    Provide ($javaType= org.web3d.x3d.sai.Core.X3DMetadataObject, isArrayType=false, isArrayListType=false, javaPrimitiveType= org.web3d.x3d.sai.Core.X3DMetadataObject, javaReferenceType= org.web3d.x3d.sai.Core.X3DMetadataObject, isX3dStatement=false, isClassX3dStatement=false) org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    double
    getPauseTime()
    Provide ($javaType=double, isArrayType=false, isArrayListType=false, javaPrimitiveType=double, javaReferenceType=double, isX3dStatement=false, isClassX3dStatement=false) double value in seconds from inputOutput SFTime field named pauseTime.
    PeriodicWave
    getPeriodicWave()
    Provide ($javaType= org.web3d.x3d.sai.Sound.PeriodicWave, isArrayType=false, isArrayListType=false, javaPrimitiveType= org.web3d.x3d.sai.Sound.PeriodicWave, javaReferenceType= org.web3d.x3d.sai.Sound.PeriodicWave, isX3dStatement=false, isClassX3dStatement=false) org.web3d.x3d.sai.Sound.PeriodicWave instance (using a properly typed node) from inputOutput SFNode field periodicWave.
    double
    getResumeTime()
    Provide ($javaType=double, isArrayType=false, isArrayListType=false, javaPrimitiveType=double, javaReferenceType=double, isX3dStatement=false, isClassX3dStatement=false) double value in seconds from inputOutput SFTime field named resumeTime.
    double
    getStartTime()
    Provide ($javaType=double, isArrayType=false, isArrayListType=false, javaPrimitiveType=double, javaReferenceType=double, isX3dStatement=false, isClassX3dStatement=false) double value in seconds from inputOutput SFTime field named startTime.
    double
    getStopTime()
    Provide ($javaType=double, isArrayType=false, isArrayListType=false, javaPrimitiveType=double, javaReferenceType=double, isX3dStatement=false, isClassX3dStatement=false) double value in seconds from inputOutput SFTime field named stopTime.
    OscillatorSource
    setDescription(String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    OscillatorSource
    setDetune(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named detune.
    OscillatorSource
    setEnabled(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    OscillatorSource
    setFrequency(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named frequency.
    OscillatorSource
    setGain(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named gain.
    OscillatorSource
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    OscillatorSource
    setPauseTime(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
    OscillatorSource
    setPeriodicWave(PeriodicWave newValue)
    Accessor method to assign org.web3d.x3d.sai.Sound.PeriodicWave instance (using a properly typed node) to inputOutput SFNode field periodicWave.
    OscillatorSource
    setResumeTime(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
    OscillatorSource
    setStartTime(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.
    OscillatorSource
    setStopTime(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.

  • Method Details

    • getDescription

      String getDescription()
      Provide ($javaType=String, isArrayType=false, isArrayListType=false, javaPrimitiveType=String, javaReferenceType=String, isX3dStatement=false, isClassX3dStatement=false) String value from inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the url asset.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      getDescription in interface X3DSoundNode
      Specified by:
      getDescription in interface X3DSoundSourceNode
      Specified by:
      getDescription in interface X3DTimeDependentNode
      Returns:
      value of description field

    • setDescription

      OscillatorSource setDescription(String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.

      Tooltip: Author-provided prose that describes intended purpose of the url asset.
      • Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
      Specified by:
      setDescription in interface X3DSoundNode
      Specified by:
      setDescription in interface X3DSoundSourceNode
      Specified by:
      setDescription in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      OscillatorSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDetune

      float getDetune()
      Provide ($javaType=float, isArrayType=false, isArrayListType=false, javaPrimitiveType=float, javaReferenceType=float, isX3dStatement=false, isClassX3dStatement=false) float value within allowed range of [0,infinity) from inputOutput SFFloat field named detune.

      Tooltip: (0,+infinity) The detune ffield is an a-rate AudioParam representing detuning of oscillation in cents (though the AudioParam returned is read-only, the value it represents is not). *
      Returns:
      value of detune field

    • setDetune

      OscillatorSource setDetune(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named detune.

      Tooltip: (0,+infinity) The detune ffield is an a-rate AudioParam representing detuning of oscillation in cents (though the AudioParam returned is read-only, the value it represents is not). *
      Parameters:
      newValue - is new value for the detune field.
      Returns:
      OscillatorSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getElapsedTime

      double getElapsedTime()
      Provide ($javaType=double, isArrayType=false, isArrayListType=false, javaPrimitiveType=double, javaReferenceType=double, isX3dStatement=false, isClassX3dStatement=false) double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.

      Tooltip: [0,+infinity) Current elapsed time since AudioClip activated/running, cumulative in seconds, and not counting any paused time.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      • Hint: elapsedTime is a nonnegative SFTime duration interval, not an absolute clock time.
      Specified by:
      getElapsedTime in interface X3DSoundSourceNode
      Specified by:
      getElapsedTime in interface X3DTimeDependentNode
      Returns:
      value of elapsedTime field

    • getEnabled

      boolean getEnabled()
      Provide ($javaType=boolean, isArrayType=false, isArrayListType=false, javaPrimitiveType=boolean, javaReferenceType=boolean, isX3dStatement=false, isClassX3dStatement=false) boolean value from inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      getEnabled in interface X3DSoundNode
      Specified by:
      getEnabled in interface X3DSoundSourceNode
      Returns:
      value of enabled field

    • setEnabled

      OscillatorSource setEnabled(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      setEnabled in interface X3DSoundNode
      Specified by:
      setEnabled in interface X3DSoundSourceNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      OscillatorSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getFrequency

      float getFrequency()
      Provide ($javaType=float, isArrayType=false, isArrayListType=false, javaPrimitiveType=float, javaReferenceType=float, isX3dStatement=false, isClassX3dStatement=false) float value within allowed range of [0,infinity) from inputOutput SFFloat field named frequency.

      Tooltip: The frequency of oscillation in hertz. The default value 440 Hz is a standard middle-A note. *
      Returns:
      value of frequency field

    • setFrequency

      OscillatorSource setFrequency(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named frequency.

      Tooltip: The frequency of oscillation in hertz. The default value 440 Hz is a standard middle-A note. *
      Parameters:
      newValue - is new value for the frequency field.
      Returns:
      OscillatorSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getGain

      float getGain()
      Provide ($javaType=float, isArrayType=false, isArrayListType=false, javaPrimitiveType=float, javaReferenceType=float, isX3dStatement=false, isClassX3dStatement=false) float value from inputOutput SFFloat field named gain.

      Tooltip: (-infinity,+infinity) The gain field is a factor that represents the amount of linear amplification to apply to the output of the node.
      • Warning: Decibel values shall not be used for this multiplicative factor.
      • Hint: Negative gain factors negate the input signal.
      Specified by:
      getGain in interface X3DSoundSourceNode
      Returns:
      value of gain field

    • setGain

      OscillatorSource setGain(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named gain.

      Tooltip: (-infinity,+infinity) The gain field is a factor that represents the amount of linear amplification to apply to the output of the node.
      • Warning: Decibel values shall not be used for this multiplicative factor.
      • Hint: Negative gain factors negate the input signal.
      Specified by:
      setGain in interface X3DSoundSourceNode
      Parameters:
      newValue - is new value for the gain field.
      Returns:
      OscillatorSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getIsActive

      boolean getIsActive()
      Provide ($javaType=boolean, isArrayType=false, isArrayListType=false, javaPrimitiveType=boolean, javaReferenceType=boolean, isX3dStatement=false, isClassX3dStatement=false) boolean value from outputOnly SFBool field named isActive.

      Tooltip: isActive true/false events are sent when playback starts/stops.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getIsActive in interface X3DSoundSourceNode
      Specified by:
      getIsActive in interface X3DTimeDependentNode
      Returns:
      value of isActive field

    • getIsPaused

      boolean getIsPaused()
      Provide ($javaType=boolean, isArrayType=false, isArrayListType=false, javaPrimitiveType=boolean, javaReferenceType=boolean, isX3dStatement=false, isClassX3dStatement=false) boolean value from outputOnly SFBool field named isPaused.

      Tooltip: isPaused true/false events are sent when AudioClip is paused/resumed.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      Specified by:
      getIsPaused in interface X3DSoundSourceNode
      Specified by:
      getIsPaused in interface X3DTimeDependentNode
      Returns:
      value of isPaused field

    • getMetadata

      X3DMetadataObject getMetadata()
      Provide ($javaType= org.web3d.x3d.sai.Core.X3DMetadataObject, isArrayType=false, isArrayListType=false, javaPrimitiveType= org.web3d.x3d.sai.Core.X3DMetadataObject, javaReferenceType= org.web3d.x3d.sai.Core.X3DMetadataObject, isX3dStatement=false, isClassX3dStatement=false) org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSoundNode
      Specified by:
      getMetadata in interface X3DSoundSourceNode
      Specified by:
      getMetadata in interface X3DTimeDependentNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      OscillatorSource setMetadata(X3DMetadataObject newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSoundNode
      Specified by:
      setMetadata in interface X3DSoundSourceNode
      Specified by:
      setMetadata in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      OscillatorSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getPauseTime

      double getPauseTime()
      Provide ($javaType=double, isArrayType=false, isArrayListType=false, javaPrimitiveType=double, javaReferenceType=double, isX3dStatement=false, isClassX3dStatement=false) double value in seconds from inputOutput SFTime field named pauseTime.

      Tooltip: When time now >= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      getPauseTime in interface X3DSoundSourceNode
      Specified by:
      getPauseTime in interface X3DTimeDependentNode
      Returns:
      value of pauseTime field

    • setPauseTime

      OscillatorSource setPauseTime(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.

      Tooltip: When time now >= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      setPauseTime in interface X3DSoundSourceNode
      Specified by:
      setPauseTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the pauseTime field.
      Returns:
      OscillatorSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getPeriodicWave

      PeriodicWave getPeriodicWave()
      Provide ($javaType= org.web3d.x3d.sai.Sound.PeriodicWave, isArrayType=false, isArrayListType=false, javaPrimitiveType= org.web3d.x3d.sai.Sound.PeriodicWave, javaReferenceType= org.web3d.x3d.sai.Sound.PeriodicWave, isX3dStatement=false, isClassX3dStatement=false) org.web3d.x3d.sai.Sound.PeriodicWave instance (using a properly typed node) from inputOutput SFNode field periodicWave.

      Tooltip: [PeriodicWave] The periodicWave field is an optional PeriodicWave node providing a regular or arbitrary periodic waveform.
      Returns:
      value of periodicWave field

    • setPeriodicWave

      OscillatorSource setPeriodicWave(PeriodicWave newValue)
      Accessor method to assign org.web3d.x3d.sai.Sound.PeriodicWave instance (using a properly typed node) to inputOutput SFNode field periodicWave.

      Tooltip: [PeriodicWave] The periodicWave field is an optional PeriodicWave node providing a regular or arbitrary periodic waveform.
      Parameters:
      newValue - is new value for the periodicWave field.
      Returns:
      OscillatorSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getResumeTime

      double getResumeTime()
      Provide ($javaType=double, isArrayType=false, isArrayListType=false, javaPrimitiveType=double, javaReferenceType=double, isX3dStatement=false, isClassX3dStatement=false) double value in seconds from inputOutput SFTime field named resumeTime.

      Tooltip: When resumeTime becomes <= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      getResumeTime in interface X3DSoundSourceNode
      Specified by:
      getResumeTime in interface X3DTimeDependentNode
      Returns:
      value of resumeTime field

    • setResumeTime

      OscillatorSource setResumeTime(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.

      Tooltip: When resumeTime becomes <= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      setResumeTime in interface X3DSoundSourceNode
      Specified by:
      setResumeTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the resumeTime field.
      Returns:
      OscillatorSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getStartTime

      double getStartTime()
      Provide ($javaType=double, isArrayType=false, isArrayListType=false, javaPrimitiveType=double, javaReferenceType=double, isX3dStatement=false, isClassX3dStatement=false) double value in seconds from inputOutput SFTime field named startTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      getStartTime in interface X3DSoundSourceNode
      Specified by:
      getStartTime in interface X3DTimeDependentNode
      Returns:
      value of startTime field

    • setStartTime

      OscillatorSource setStartTime(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      setStartTime in interface X3DSoundSourceNode
      Specified by:
      setStartTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the startTime field.
      Returns:
      OscillatorSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getStopTime

      double getStopTime()
      Provide ($javaType=double, isArrayType=false, isArrayListType=false, javaPrimitiveType=double, javaReferenceType=double, isX3dStatement=false, isClassX3dStatement=false) double value in seconds from inputOutput SFTime field named stopTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      • Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
      • Warning: An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
      Specified by:
      getStopTime in interface X3DSoundSourceNode
      Specified by:
      getStopTime in interface X3DTimeDependentNode
      Returns:
      value of stopTime field

    • setStopTime

      OscillatorSource setStopTime(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      • Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
      • Warning: An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
      Specified by:
      setStopTime in interface X3DSoundSourceNode
      Specified by:
      setStopTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the stopTime field.
      Returns:
      OscillatorSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).