Interface X3DSoundChannelNode

All Superinterfaces:
X3DChildNode, X3DNode, X3DSoundNode
All Known Subinterfaces:
ChannelMerger, ChannelSelector, ChannelSplitter
All Known Implementing Classes:
ChannelMerger, ChannelSelector, ChannelSplitter

public interface X3DSoundChannelNode extends X3DSoundNode
Base type for all sound destination nodes, which represent the final destination of an audio signal and are what the user can ultimately hear.


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.
    boolean
    Provide boolean value from inputOutput SFBool field named enabled.
    float
    Provide float value from inputOutput SFFloat field named gain.
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    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.
  • 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

      X3DSoundChannelNode 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:
      X3DSoundChannelNode - 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

      X3DSoundChannelNode 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:
      X3DSoundChannelNode - 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
      Returns:
      value of description field
    • setDescription

      X3DSoundChannelNode setDescription(String newValue)
      Accessor method to assign String value to inputOutput SFString field named description.
      Specified by:
      setDescription in interface X3DSoundNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      X3DSoundChannelNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getEnabled

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

      X3DSoundChannelNode 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:
      X3DSoundChannelNode - 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

      X3DSoundChannelNode 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:
      X3DSoundChannelNode - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • 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
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      X3DSoundChannelNode 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
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      X3DSoundChannelNode - 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