Package org.web3d.x3d.sai.Sound

Interface ChannelSelector

All Superinterfaces:
X3DChildNode, X3DNode, X3DSoundChannelNode, X3DSoundNode
All Known Implementing Classes:
ChannelSelector
public interface ChannelSelector
extends X3DSoundChannelNode
ChannelSelector selects a single channel output from all input channels.

X3D node tooltip: (X3D version 4.0 draft) [X3DSoundChannelNode] ChannelSelector selects a single channel output from all input channels.
  • Hint: ChannelSelector is a utility node to complement ChannelSplitter.

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: ChannelSelector, X3D Tooltips: ChannelSelector, X3D Scene Authoring Hints

  • Method Summary

    Modifier and Type Method Description
    int getChannelCount()
    Provide int value from outputOnly SFInt32 field named channelCount.
    java.lang.String getChannelCountMode()
    Provide String enumeration value (baseType SFString) ["max" | "clamped-max" | "explicit"] from inputOutput SFString field named channelCountMode.
    java.lang.String getChannelInterpretation()
    Provide String enumeration value (baseType SFString) ["speakers" | "discrete"] from inputOutput SFString field named channelInterpretation.
    int getChannelSelection()
    Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named channelSelection.
    java.lang.String getDescription()
    Provide String value from inputOutput SFString field named description.
    boolean getEnabled()
    Provide boolean value from inputOutput SFBool field named enabled.
    float getGain()
    Provide float value from inputOutput SFFloat field named gain.
    X3DMetadataObject getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    ChannelSelector setChannelCountMode​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("max" | "clamped-max" | "explicit") to inputOutput SFString field named channelCountMode.
    ChannelSelector setChannelInterpretation​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("speakers" | "discrete") to inputOutput SFString field named channelInterpretation.
    ChannelSelector setChannelSelection​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named channelSelection.
    ChannelSelector setDescription​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    ChannelSelector setEnabled​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    ChannelSelector setGain​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named gain.
    ChannelSelector setMetadata​(X3DMetadataObject newValue)
    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.

      Tooltip: [0,+infinity) channelCount reports number of channels provided by input nodes.
      Specified by:
      getChannelCount in interface X3DSoundChannelNode
      Returns:
      value of channelCount field

    • getChannelCountMode

      java.lang.String getChannelCountMode()
      Provide String enumeration value (baseType SFString) ["max" | "clamped-max" | "explicit"] from inputOutput SFString field named channelCountMode.

      Tooltip: channelCountMode determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.
      Specified by:
      getChannelCountMode in interface X3DSoundChannelNode
      Returns:
      value of channelCountMode field

    • setChannelCountMode

      ChannelSelector setChannelCountMode​(java.lang.String newValue)
      Accessor method to assign String enumeration value ("max" | "clamped-max" | "explicit") to inputOutput SFString field named channelCountMode.

      Tooltip: channelCountMode determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.
      Specified by:
      setChannelCountMode in interface X3DSoundChannelNode
      Parameters:
      newValue - is new value for the channelCountMode field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getChannelInterpretation

      java.lang.String getChannelInterpretation()
      Provide String enumeration value (baseType SFString) ["speakers" | "discrete"] from inputOutput SFString field named channelInterpretation.

      Tooltip: channelInterpretation determines how individual channels are treated when up-mixing and down-mixing connections to any inputs.
      Specified by:
      getChannelInterpretation in interface X3DSoundChannelNode
      Returns:
      value of channelInterpretation field

    • setChannelInterpretation

      ChannelSelector setChannelInterpretation​(java.lang.String newValue)
      Accessor method to assign String enumeration value ("speakers" | "discrete") to inputOutput SFString field named channelInterpretation.

      Tooltip: channelInterpretation determines how individual channels are treated when up-mixing and down-mixing connections to any inputs.
      Specified by:
      setChannelInterpretation in interface X3DSoundChannelNode
      Parameters:
      newValue - is new value for the channelInterpretation field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getChannelSelection

      int getChannelSelection()
      Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named channelSelection.

      Tooltip: [0,+infinity) channelSelection is single channel of interest from those provided by input nodes. *
      Returns:
      value of channelSelection field

    • setChannelSelection

      ChannelSelector setChannelSelection​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named channelSelection.

      Tooltip: [0,+infinity) channelSelection is single channel of interest from those provided by input nodes. *
      Parameters:
      newValue - is new value for the channelSelection field.
      Returns:
      ChannelSelector - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getDescription

      java.lang.String getDescription()
      Provide 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 X3DSoundChannelNode
      Specified by:
      getDescription in interface X3DSoundNode
      Returns:
      value of description field

    • setDescription

      ChannelSelector setDescription​(java.lang.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 X3DSoundChannelNode
      Specified by:
      setDescription in interface X3DSoundNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      ChannelSelector - 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.

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

    • setEnabled

      ChannelSelector 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 X3DSoundChannelNode
      Specified by:
      setEnabled in interface X3DSoundNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      ChannelSelector - 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.

      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.
      • Hint: Negative gain factors negate the input signal.
      Specified by:
      getGain in interface X3DSoundChannelNode
      Specified by:
      getGain in interface X3DSoundNode
      Returns:
      value of gain field

    • setGain

      ChannelSelector 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.
      • Hint: Negative gain factors negate the input signal.
      Specified by:
      setGain in interface X3DSoundChannelNode
      Specified by:
      setGain in interface X3DSoundNode
      Parameters:
      newValue - is new value for the gain field.
      Returns:
      ChannelSelector - 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.

      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 X3DSoundChannelNode
      Specified by:
      getMetadata in interface X3DSoundNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes

    • setMetadata

      ChannelSelector 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 X3DSoundChannelNode
      Specified by:
      setMetadata in interface X3DSoundNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      ChannelSelector - 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