Interface AudioDestination

All Superinterfaces:
X3DChildNode, X3DNode, X3DSoundDestinationNode, X3DSoundNode
All Known Implementing Classes:
AudioDestination

public interface AudioDestination extends X3DSoundDestinationNode
AudioDestination node represents the final audio destination and is what user ultimately hears, typically from the speakers of user device.

X3D node tooltip: (X3D version 4.0 draft) [X3DSoundDestinationNode] AudioDestination node represents the final audio destination and is what user ultimately hears, typically from the speakers of user device. An AudioDestinationNode representing the audio hardware end-point (the normal case) can potentially output more than 2 channels of audio if the audio hardware is multi-channel.
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: AudioDestination, X3D Tooltips: AudioDestination, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addChildren​(X3DNode[] newValue)
    Add array of children nodes to array of existing nodes (if any).
    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 array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper, from inputOutput MFNode field children.
    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.
    boolean
    Provide boolean value from outputOnly SFBool field named isActive.
    int
    Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named maxChannelCount.
    Provide String value from inputOutput SFString field named mediaDeviceID.
    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.
    void
    setChildren​(X3DNode newValue)
    Set single children node, replacing prior array of existing nodes (if any).
    setChildren​(X3DNode[] newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
    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.
    setMaxChannelCount​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named maxChannelCount.
    setMediaDeviceID​(String newValue)
    Accessor method to assign String value to inputOutput SFString field named mediaDeviceID.
    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 X3DSoundDestinationNode
      Returns:
      value of channelCount field
    • getChannelCountMode

      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 X3DSoundDestinationNode
      Returns:
      value of channelCountMode field
    • setChannelCountMode

      AudioDestination setChannelCountMode(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 X3DSoundDestinationNode
      Parameters:
      newValue - is new value for the channelCountMode field.
      Returns:
      AudioDestination - 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.

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

      AudioDestination setChannelInterpretation(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 X3DSoundDestinationNode
      Parameters:
      newValue - is new value for the channelInterpretation field.
      Returns:
      AudioDestination - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getChildren

      X3DNode[] getChildren()
      Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper, from inputOutput MFNode field children.

      Tooltip: [X3DSoundChannelNode|X3DSoundProcessingNode|X3DSoundSourceNode] The children field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputschildren field, all channels are mixed together and merged prior to presentation.
      • Hint: can be original (DEF) or USE nodes.


      Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
      Returns:
      value of children field
      See Also:
      Analyser, AudioClip, AudioDestination, BiquadFilter, BufferAudioSource, ChannelMerger, ChannelSelector, ChannelSplitter, Convolver, Delay, DynamicsCompressor, Gain, ListenerPointSource, MicrophoneSource, MovieTexture, OscillatorSource, Sound, SpatialSound, StreamAudioDestination, StreamAudioSource, WaveShaper
    • setChildren

      AudioDestination setChildren(X3DNode[] newValue)
      Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.

      Tooltip: [X3DSoundChannelNode|X3DSoundProcessingNode|X3DSoundSourceNode] The children field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputschildren field, all channels are mixed together and merged prior to presentation.
      • Hint: can be original (DEF) or USE nodes.


      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
      Parameters:
      newValue - is new value for the children field.
      Returns:
      AudioDestination - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addChildren

      void addChildren(X3DNode[] newValue)
      Add array of children nodes to array of existing nodes (if any).

      Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.
      Parameters:
      newValue - is new value array to be appended the children field.
    • setChildren

      void setChildren(X3DNode newValue)
      Set single children node, replacing prior array of existing nodes (if any).
      Parameters:
      newValue - is new node for the children field
    • getDescription

      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 X3DSoundDestinationNode
      Specified by:
      getDescription in interface X3DSoundNode
      Returns:
      value of description field
    • setDescription

      AudioDestination 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 X3DSoundDestinationNode
      Specified by:
      setDescription in interface X3DSoundNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      AudioDestination - 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 X3DSoundDestinationNode
      Specified by:
      getEnabled in interface X3DSoundNode
      Returns:
      value of enabled field
    • setEnabled

      AudioDestination 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 X3DSoundDestinationNode
      Specified by:
      setEnabled in interface X3DSoundNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      AudioDestination - 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 X3DSoundDestinationNode
      Returns:
      value of gain field
    • setGain

      AudioDestination 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 X3DSoundDestinationNode
      Parameters:
      newValue - is new value for the gain field.
      Returns:
      AudioDestination - 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.

      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 X3DSoundDestinationNode
      Returns:
      value of isActive field
    • getMaxChannelCount

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

      Tooltip: [0,+infinity) [maxChannelCount.
      Returns:
      value of maxChannelCount field
    • setMaxChannelCount

      AudioDestination setMaxChannelCount(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named maxChannelCount.

      Tooltip: [0,+infinity) [maxChannelCount.
      Parameters:
      newValue - is new value for the maxChannelCount field.
      Returns:
      AudioDestination - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMediaDeviceID

      String getMediaDeviceID()
      Provide String value from inputOutput SFString field named mediaDeviceID.

      Tooltip: mediaDeviceID field provides ID parameter functionality. (TODO experimental). *
      Specified by:
      getMediaDeviceID in interface X3DSoundDestinationNode
      Returns:
      value of mediaDeviceID field
    • setMediaDeviceID

      AudioDestination setMediaDeviceID(String newValue)
      Accessor method to assign String value to inputOutput SFString field named mediaDeviceID.

      Tooltip: mediaDeviceID field provides ID parameter functionality. (TODO experimental). *
      Specified by:
      setMediaDeviceID in interface X3DSoundDestinationNode
      Parameters:
      newValue - is new value for the mediaDeviceID field.
      Returns:
      AudioDestination - 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 X3DSoundDestinationNode
      Specified by:
      getMetadata in interface X3DSoundNode
      Returns:
      value of metadata field
      See Also:
      X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

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