Class AudioDestination

All Implemented Interfaces:
X3DChildNode, X3DNode, AudioDestination, X3DSoundDestinationNode, X3DSoundNode

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

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. 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 org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
  • Field Details

    • CHANNELCOUNTMODE_MAX

      public static final String CHANNELCOUNTMODE_MAX
      Tooltip: X3D version of "max" in Web Audio API. SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "MAX" (Java syntax) or MAX (XML syntax).
      See Also:
    • CHANNELCOUNTMODE_MAX_ALIAS

      public static final String CHANNELCOUNTMODE_MAX_ALIAS
      SFString SFString enumeration value "MAX" has alias "max"
      See Also:
    • CHANNELCOUNTMODE_CLAMPED_MAX

      public static final String CHANNELCOUNTMODE_CLAMPED_MAX
      Tooltip: X3D version of "clamped-max" in Web Audio API. SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "CLAMPED_MAX" (Java syntax) or CLAMPED_MAX (XML syntax).
      See Also:
    • CHANNELCOUNTMODE_CLAMPED_MAX_ALIAS

      public static final String CHANNELCOUNTMODE_CLAMPED_MAX_ALIAS
      SFString SFString enumeration value "CLAMPED_MAX" has alias "clamped-max"
      See Also:
    • CHANNELCOUNTMODE_EXPLICIT

      public static final String CHANNELCOUNTMODE_EXPLICIT
      Tooltip: X3D version of "explicit" in Web Audio API. SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "EXPLICIT" (Java syntax) or EXPLICIT (XML syntax).
      See Also:
    • CHANNELCOUNTMODE_EXPLICIT_ALIAS

      public static final String CHANNELCOUNTMODE_EXPLICIT_ALIAS
      SFString SFString enumeration value "EXPLICIT" has alias "explicit"
      See Also:
    • CHANNELINTERPRETATION_SPEAKERS

      public static final String CHANNELINTERPRETATION_SPEAKERS
      Tooltip: X3D version of "speakers" in Web Audio API. SFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "SPEAKERS" (Java syntax) or SPEAKERS (XML syntax).
      See Also:
    • CHANNELINTERPRETATION_DISCRETE

      public static final String CHANNELINTERPRETATION_DISCRETE
      Tooltip: X3D version of "discrete" in Web Audio API. SFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "DISCRETE" (Java syntax) or DISCRETE (XML syntax).
      See Also:
    • NAME

      public static final String NAME
      String constant NAME provides name of this element: AudioDestination.
      See Also:
    • COMPONENT

      public static final String COMPONENT
      String constant COMPONENT defines X3D component for the AudioDestination element: Sound
      See Also:
    • LEVEL

      public static final int LEVEL
      Integer constant LEVEL provides default X3D Sound component level for this element: 2
      See Also:
    • CHANNELCOUNTMODE_DEFAULT_VALUE

      public static final String CHANNELCOUNTMODE_DEFAULT_VALUE
      SFString field named channelCountMode has default value "MAX" (Java syntax) or MAX (XML syntax).
      See Also:
    • CHANNELINTERPRETATION_DEFAULT_VALUE

      public static final String CHANNELINTERPRETATION_DEFAULT_VALUE
      SFString field named channelInterpretation has default value "SPEAKERS" (Java syntax) or SPEAKERS (XML syntax).
      See Also:
    • DESCRIPTION_DEFAULT_VALUE

      public static final String DESCRIPTION_DEFAULT_VALUE
      SFString field named description has default value equal to an empty string.
      See Also:
    • ENABLED_DEFAULT_VALUE

      public static final boolean ENABLED_DEFAULT_VALUE
      SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
      See Also:
    • GAIN_DEFAULT_VALUE

      public static final float GAIN_DEFAULT_VALUE
      SFFloat field named gain has default value 1f (Java syntax) or 1 (XML syntax).
      See Also:
    • IS_DEFAULT_VALUE

      public static final IS IS_DEFAULT_VALUE
      SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
    • MAXCHANNELCOUNT_DEFAULT_VALUE

      public static final int MAXCHANNELCOUNT_DEFAULT_VALUE
      SFInt32 field named maxChannelCount has default value 2 (Java syntax) or 2 (XML syntax).
      See Also:
    • MEDIADEVICEID_DEFAULT_VALUE

      public static final String MEDIADEVICEID_DEFAULT_VALUE
      SFString field named mediaDeviceID has default value equal to an empty string.
      See Also:
    • METADATA_DEFAULT_VALUE

      public static final X3DMetadataObject METADATA_DEFAULT_VALUE
      SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
    • containerField_DEFAULT_VALUE

      public static final String containerField_DEFAULT_VALUE
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      See Also:
    • fromField_CHANNELCOUNT

      public static final String fromField_CHANNELCOUNT
      fromField ROUTE name for SFInt32 field named channelCount.
      See Also:
    • fromField_CHANNELCOUNTMODE

      public static final String fromField_CHANNELCOUNTMODE
      fromField ROUTE name for SFString field named channelCountMode.
      See Also:
    • toField_CHANNELCOUNTMODE

      public static final String toField_CHANNELCOUNTMODE
      toField ROUTE name for SFString field named channelCountMode.
      See Also:
    • fromField_CHANNELINTERPRETATION

      public static final String fromField_CHANNELINTERPRETATION
      fromField ROUTE name for SFString field named channelInterpretation.
      See Also:
    • toField_CHANNELINTERPRETATION

      public static final String toField_CHANNELINTERPRETATION
      toField ROUTE name for SFString field named channelInterpretation.
      See Also:
    • fromField_CHILDREN

      public static final String fromField_CHILDREN
      fromField ROUTE name for MFNode field named children.
      See Also:
    • toField_CHILDREN

      public static final String toField_CHILDREN
      toField ROUTE name for MFNode field named children.
      See Also:
    • fromField_DESCRIPTION

      public static final String fromField_DESCRIPTION
      fromField ROUTE name for SFString field named description.
      See Also:
    • toField_DESCRIPTION

      public static final String toField_DESCRIPTION
      toField ROUTE name for SFString field named description.
      See Also:
    • fromField_ENABLED

      public static final String fromField_ENABLED
      fromField ROUTE name for SFBool field named enabled.
      See Also:
    • toField_ENABLED

      public static final String toField_ENABLED
      toField ROUTE name for SFBool field named enabled.
      See Also:
    • fromField_GAIN

      public static final String fromField_GAIN
      fromField ROUTE name for SFFloat field named gain.
      See Also:
    • toField_GAIN

      public static final String toField_GAIN
      toField ROUTE name for SFFloat field named gain.
      See Also:
    • fromField_IS

      public static final String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
    • fromField_ISACTIVE

      public static final String fromField_ISACTIVE
      fromField ROUTE name for SFBool field named isActive.
      See Also:
    • fromField_MAXCHANNELCOUNT

      public static final String fromField_MAXCHANNELCOUNT
      fromField ROUTE name for SFInt32 field named maxChannelCount.
      See Also:
    • toField_MAXCHANNELCOUNT

      public static final String toField_MAXCHANNELCOUNT
      toField ROUTE name for SFInt32 field named maxChannelCount.
      See Also:
    • fromField_MEDIADEVICEID

      public static final String fromField_MEDIADEVICEID
      fromField ROUTE name for SFString field named mediaDeviceID.
      See Also:
    • toField_MEDIADEVICEID

      public static final String toField_MEDIADEVICEID
      toField ROUTE name for SFString field named mediaDeviceID.
      See Also:
    • fromField_METADATA

      public static final String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:
    • toField_METADATA

      public static final String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
  • Constructor Details

    • AudioDestination

      public AudioDestination()
      Constructor for AudioDestination to initialize member variables with default values.
    • AudioDestination

      public AudioDestination(String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node
  • Method Details