Interface X3DSoundProcessingNode

All Superinterfaces:
X3DChildNode, X3DNode, X3DSoundNode, X3DTimeDependentNode
All Known Subinterfaces:
Analyser, BiquadFilter, Convolver, Delay, DynamicsCompressor, Gain, WaveShaper
All Known Implementing Classes:
Analyser, BiquadFilter, Convolver, Delay, DynamicsCompressor, Gain, WaveShaper

public interface X3DSoundProcessingNode extends X3DTimeDependentNode, X3DSoundNode
Base type for all sound processing nodes, which are used to enhance audio with filtering, delaying, changing gain, etc.


Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification, X3D Abstract Specification, X3D Tooltips, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Provide int value from outputOnly SFInt32 field named channelCount.
    Provide String enumeration value (baseType SFString) ["max" | "clamped-max" | "explicit"] from inputOutput SFString field named channelCountMode.
    Provide String enumeration value (baseType SFString) ["speakers" | "discrete"] from inputOutput SFString field named channelInterpretation.
    Provide String value from inputOutput SFString field named description.
    double
    Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.
    boolean
    Provide boolean value from inputOutput SFBool field named enabled.
    float
    Provide float value from inputOutput SFFloat field named gain.
    boolean
    Provide boolean value from outputOnly SFBool field named isActive.
    boolean
    Provide boolean value from outputOnly SFBool field named isPaused.
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    double
    Provide double value in seconds from inputOutput SFTime field named pauseTime.
    double
    Provide double value in seconds from inputOutput SFTime field named resumeTime.
    double
    Provide double value in seconds from inputOutput SFTime field named startTime.
    double
    Provide double value in seconds from inputOutput SFTime field named stopTime.
    double
    Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named tailTime.
    Accessor method to assign String enumeration value ("max" | "clamped-max" | "explicit") to inputOutput SFString field named channelCountMode.
    Accessor method to assign String enumeration value ("speakers" | "discrete") to inputOutput SFString field named channelInterpretation.
    setDescription​(String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    setEnabled​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    setGain​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named gain.
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    setPauseTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
    setResumeTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
    setStartTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.
    setStopTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.
    setTailTime​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named tailTime.
  • Method Details

    • getChannelCount

      int getChannelCount()
      Provide int value from outputOnly SFInt32 field named channelCount.
      Returns:
      value of channelCount field
    • getChannelCountMode

      String getChannelCountMode()
      Provide String enumeration value (baseType SFString) ["max" | "clamped-max" | "explicit"] from inputOutput SFString field named channelCountMode.
      Returns:
      value of channelCountMode field
    • setChannelCountMode

      X3DSoundProcessingNode setChannelCountMode(String newValue)
      Accessor method to assign String enumeration value ("max" | "clamped-max" | "explicit") to inputOutput SFString field named channelCountMode.
      Parameters:
      newValue - is new value for the channelCountMode field.
      Returns:
      X3DSoundProcessingNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getChannelInterpretation

      String getChannelInterpretation()
      Provide String enumeration value (baseType SFString) ["speakers" | "discrete"] from inputOutput SFString field named channelInterpretation.
      Returns:
      value of channelInterpretation field
    • setChannelInterpretation

      X3DSoundProcessingNode setChannelInterpretation(String newValue)
      Accessor method to assign String enumeration value ("speakers" | "discrete") to inputOutput SFString field named channelInterpretation.
      Parameters:
      newValue - is new value for the channelInterpretation field.
      Returns:
      X3DSoundProcessingNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDescription

      String getDescription()
      Provide String value from inputOutput SFString field named description.
      Specified by:
      getDescription in interface X3DSoundNode
      Specified by:
      getDescription in interface X3DTimeDependentNode
      Returns:
      value of description field
    • setDescription

      X3DSoundProcessingNode setDescription(String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.
      Specified by:
      setDescription in interface X3DSoundNode
      Specified by:
      setDescription in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      X3DSoundProcessingNode - 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 interface X3DTimeDependentNode
      Returns:
      value of elapsedTime field
    • getEnabled

      boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.
      Specified by:
      getEnabled in interface X3DSoundNode
      Returns:
      value of enabled field
    • setEnabled

      X3DSoundProcessingNode setEnabled(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named enabled.
      Specified by:
      setEnabled in interface X3DSoundNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      X3DSoundProcessingNode - 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

      X3DSoundProcessingNode setGain(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named gain.
      Parameters:
      newValue - is new value for the gain field.
      Returns:
      X3DSoundProcessingNode - 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 interface X3DTimeDependentNode
      Returns:
      value of isActive field
    • getIsPaused

      boolean getIsPaused()
      Provide boolean value from outputOnly SFBool field named isPaused.
      Specified by:
      getIsPaused in interface X3DTimeDependentNode
      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 interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSoundNode
      Specified by:
      getMetadata in interface X3DTimeDependentNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      X3DSoundProcessingNode setMetadata(X3DMetadataObject newValue)
      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 interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSoundNode
      Specified by:
      setMetadata in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      X3DSoundProcessingNode - 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 interface X3DTimeDependentNode
      Returns:
      value of pauseTime field
    • setPauseTime

      X3DSoundProcessingNode setPauseTime(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
      Specified by:
      setPauseTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the pauseTime field.
      Returns:
      X3DSoundProcessingNode - 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 interface X3DTimeDependentNode
      Returns:
      value of resumeTime field
    • setResumeTime

      X3DSoundProcessingNode setResumeTime(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
      Specified by:
      setResumeTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the resumeTime field.
      Returns:
      X3DSoundProcessingNode - 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 interface X3DTimeDependentNode
      Returns:
      value of startTime field
    • setStartTime

      X3DSoundProcessingNode setStartTime(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.
      Specified by:
      setStartTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the startTime field.
      Returns:
      X3DSoundProcessingNode - 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 interface X3DTimeDependentNode
      Returns:
      value of stopTime field
    • setStopTime

      X3DSoundProcessingNode setStopTime(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.
      Specified by:
      setStopTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the stopTime field.
      Returns:
      X3DSoundProcessingNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTailTime

      double getTailTime()
      Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named tailTime.
      Returns:
      value of tailTime field
    • setTailTime

      X3DSoundProcessingNode setTailTime(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named tailTime.
      Parameters:
      newValue - is new value for the tailTime field.
      Returns:
      X3DSoundProcessingNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).