Class AudioBufferSource

java.lang.Object
All Implemented Interfaces:
X3DChildNode, X3DNode, AudioBufferSource, X3DSoundSourceNode, X3DTimeDependentNode

public class AudioBufferSource
extends X3DConcreteNode
implements AudioBufferSource
AudioBufferSource node represents a memory-resident audio asset that can contain one or more channels.

X3D node tooltip: (X3D version 4.0 draft) [X3DSoundSourceNode] AudioBufferSource node represents a memory-resident audio asset that can contain one or more channels. Typically the length of the Pulse Coded Modulation (PCM) data is expected to be fairly short (usually somewhat less than a minute).
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:
X3D Abstract Specification: AudioBufferSource, X3D Tooltips: AudioBufferSource, X3D Scene Authoring Hints
  • Field Details

    • CHANNELCOUNTMODE_MAX

      public static final java.lang.String CHANNELCOUNTMODE_MAX
      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:
      XML Schema: channelCountModeChoices, Constant Field Values
    • CHANNELCOUNTMODE_CLAMPED_MAX

      public static final java.lang.String CHANNELCOUNTMODE_CLAMPED_MAX
      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:
      XML Schema: channelCountModeChoices, Constant Field Values
    • CHANNELCOUNTMODE_EXPLICIT

      public static final java.lang.String CHANNELCOUNTMODE_EXPLICIT
      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:
      XML Schema: channelCountModeChoices, Constant Field Values
    • CHANNELINTERPRETATION_SPEAKERS

      public static final java.lang.String CHANNELINTERPRETATION_SPEAKERS
      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:
      XML Schema: channelInterpretationChoices, Constant Field Values
    • CHANNELINTERPRETATION_DISCRETE

      public static final java.lang.String CHANNELINTERPRETATION_DISCRETE
      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:
      XML Schema: channelInterpretationChoices, Constant Field Values
    • NAME

      public static final java.lang.String NAME
      String constant NAME provides name of this element: AudioBufferSource.
      See Also:
      Constant Field Values
    • COMPONENT

      public static final java.lang.String COMPONENT
      String constant COMPONENT defines X3D component for the AudioBufferSource element: Sound
      See Also:
      Constant Field Values
    • LEVEL

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

      public static final java.util.ArrayList<java.lang.Float> BUFFER_DEFAULT_VALUE
      MFFloat field named buffer has default value equal to an empty list.
    • BUFFERDURATION_DEFAULT_VALUE

      public static final double BUFFERDURATION_DEFAULT_VALUE
      SFTime field named bufferDuration has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • CHANNELCOUNTMODE_DEFAULT_VALUE

      public static final java.lang.String CHANNELCOUNTMODE_DEFAULT_VALUE
      SFString field named channelCountMode has default value "max" (Java syntax) or max (XML syntax).
      See Also:
      Constant Field Values
    • CHANNELINTERPRETATION_DEFAULT_VALUE

      public static final java.lang.String CHANNELINTERPRETATION_DEFAULT_VALUE
      SFString field named channelInterpretation has default value "speakers" (Java syntax) or speakers (XML syntax).
      See Also:
      Constant Field Values
    • DESCRIPTION_DEFAULT_VALUE

      public static final java.lang.String DESCRIPTION_DEFAULT_VALUE
      SFString field named description has default value equal to an empty string.
      See Also:
      Constant Field Values
    • DETUNE_DEFAULT_VALUE

      public static final float DETUNE_DEFAULT_VALUE
      SFFloat field named detune has default value 0f (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • 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:
      Constant Field Values
    • 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:
      Constant Field Values
    • IS_DEFAULT_VALUE

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

      public static final boolean LOOP_DEFAULT_VALUE
      SFBool field named loop has default value false (Java syntax) or false (XML syntax).
      See Also:
      Constant Field Values
    • LOOPEND_DEFAULT_VALUE

      public static final float LOOPEND_DEFAULT_VALUE
      SFFloat field named loopEnd has default value 0f (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • LOOPSTART_DEFAULT_VALUE

      public static final float LOOPSTART_DEFAULT_VALUE
      SFFloat field named loopStart has default value 0f (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • METADATA_DEFAULT_VALUE

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

      public static final int NUMBEROFCHANNELS_DEFAULT_VALUE
      SFInt32 field named numberOfChannels has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • PAUSETIME_DEFAULT_VALUE

      public static final double PAUSETIME_DEFAULT_VALUE
      SFTime field named pauseTime has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • PLAYBACKRATE_DEFAULT_VALUE

      public static final float PLAYBACKRATE_DEFAULT_VALUE
      SFFloat field named playbackRate has default value 1f (Java syntax) or 1 (XML syntax).
      See Also:
      Constant Field Values
    • RESUMETIME_DEFAULT_VALUE

      public static final double RESUMETIME_DEFAULT_VALUE
      SFTime field named resumeTime has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • SAMPLERATE_DEFAULT_VALUE

      public static final float SAMPLERATE_DEFAULT_VALUE
      SFFloat field named sampleRate has default value 0f (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • STARTTIME_DEFAULT_VALUE

      public static final double STARTTIME_DEFAULT_VALUE
      SFTime field named startTime has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • STOPTIME_DEFAULT_VALUE

      public static final double STOPTIME_DEFAULT_VALUE
      SFTime field named stopTime has default value 0 (Java syntax) or 0 (XML syntax).
      See Also:
      Constant Field Values
    • containerField_DEFAULT_VALUE

      public static final java.lang.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:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM), Constant Field Values
    • fromField_BUFFER

      public static final java.lang.String fromField_BUFFER
      fromField ROUTE name for MFFloat field named buffer.
      See Also:
      Constant Field Values
    • toField_BUFFER

      public static final java.lang.String toField_BUFFER
      toField ROUTE name for MFFloat field named buffer.
      See Also:
      Constant Field Values
    • fromField_BUFFERDURATION

      public static final java.lang.String fromField_BUFFERDURATION
      fromField ROUTE name for SFTime field named bufferDuration.
      See Also:
      Constant Field Values
    • toField_BUFFERDURATION

      public static final java.lang.String toField_BUFFERDURATION
      toField ROUTE name for SFTime field named bufferDuration.
      See Also:
      Constant Field Values
    • fromField_CHANNELCOUNT

      public static final java.lang.String fromField_CHANNELCOUNT
      fromField ROUTE name for SFInt32 field named channelCount.
      See Also:
      Constant Field Values
    • fromField_CHANNELCOUNTMODE

      public static final java.lang.String fromField_CHANNELCOUNTMODE
      fromField ROUTE name for SFString field named channelCountMode.
      See Also:
      Constant Field Values
    • toField_CHANNELCOUNTMODE

      public static final java.lang.String toField_CHANNELCOUNTMODE
      toField ROUTE name for SFString field named channelCountMode.
      See Also:
      Constant Field Values
    • fromField_CHANNELINTERPRETATION

      public static final java.lang.String fromField_CHANNELINTERPRETATION
      fromField ROUTE name for SFString field named channelInterpretation.
      See Also:
      Constant Field Values
    • toField_CHANNELINTERPRETATION

      public static final java.lang.String toField_CHANNELINTERPRETATION
      toField ROUTE name for SFString field named channelInterpretation.
      See Also:
      Constant Field Values
    • fromField_DESCRIPTION

      public static final java.lang.String fromField_DESCRIPTION
      fromField ROUTE name for SFString field named description.
      See Also:
      Constant Field Values
    • toField_DESCRIPTION

      public static final java.lang.String toField_DESCRIPTION
      toField ROUTE name for SFString field named description.
      See Also:
      Constant Field Values
    • fromField_DETUNE

      public static final java.lang.String fromField_DETUNE
      fromField ROUTE name for SFFloat field named detune.
      See Also:
      Constant Field Values
    • toField_DETUNE

      public static final java.lang.String toField_DETUNE
      toField ROUTE name for SFFloat field named detune.
      See Also:
      Constant Field Values
    • fromField_ELAPSEDTIME

      public static final java.lang.String fromField_ELAPSEDTIME
      fromField ROUTE name for SFTime field named elapsedTime.
      See Also:
      Constant Field Values
    • fromField_ENABLED

      public static final java.lang.String fromField_ENABLED
      fromField ROUTE name for SFBool field named enabled.
      See Also:
      Constant Field Values
    • toField_ENABLED

      public static final java.lang.String toField_ENABLED
      toField ROUTE name for SFBool field named enabled.
      See Also:
      Constant Field Values
    • fromField_GAIN

      public static final java.lang.String fromField_GAIN
      fromField ROUTE name for SFFloat field named gain.
      See Also:
      Constant Field Values
    • toField_GAIN

      public static final java.lang.String toField_GAIN
      toField ROUTE name for SFFloat field named gain.
      See Also:
      Constant Field Values
    • fromField_IS

      public static final java.lang.String fromField_IS
      fromField ROUTE name for SFNode field named IS.
      See Also:
      Constant Field Values
    • fromField_ISACTIVE

      public static final java.lang.String fromField_ISACTIVE
      fromField ROUTE name for SFBool field named isActive.
      See Also:
      Constant Field Values
    • fromField_ISPAUSED

      public static final java.lang.String fromField_ISPAUSED
      fromField ROUTE name for SFBool field named isPaused.
      See Also:
      Constant Field Values
    • fromField_LENGTH

      public static final java.lang.String fromField_LENGTH
      fromField ROUTE name for SFInt32 field named length.
      See Also:
      Constant Field Values
    • fromField_LOOP

      public static final java.lang.String fromField_LOOP
      fromField ROUTE name for SFBool field named loop.
      See Also:
      Constant Field Values
    • toField_LOOP

      public static final java.lang.String toField_LOOP
      toField ROUTE name for SFBool field named loop.
      See Also:
      Constant Field Values
    • fromField_LOOPEND

      public static final java.lang.String fromField_LOOPEND
      fromField ROUTE name for SFFloat field named loopEnd.
      See Also:
      Constant Field Values
    • toField_LOOPEND

      public static final java.lang.String toField_LOOPEND
      toField ROUTE name for SFFloat field named loopEnd.
      See Also:
      Constant Field Values
    • fromField_LOOPSTART

      public static final java.lang.String fromField_LOOPSTART
      fromField ROUTE name for SFFloat field named loopStart.
      See Also:
      Constant Field Values
    • toField_LOOPSTART

      public static final java.lang.String toField_LOOPSTART
      toField ROUTE name for SFFloat field named loopStart.
      See Also:
      Constant Field Values
    • fromField_METADATA

      public static final java.lang.String fromField_METADATA
      fromField ROUTE name for SFNode field named metadata.
      See Also:
      Constant Field Values
    • toField_METADATA

      public static final java.lang.String toField_METADATA
      toField ROUTE name for SFNode field named metadata.
      See Also:
      Constant Field Values
    • fromField_NUMBEROFCHANNELS

      public static final java.lang.String fromField_NUMBEROFCHANNELS
      fromField ROUTE name for SFInt32 field named numberOfChannels.
      See Also:
      Constant Field Values
    • toField_NUMBEROFCHANNELS

      public static final java.lang.String toField_NUMBEROFCHANNELS
      toField ROUTE name for SFInt32 field named numberOfChannels.
      See Also:
      Constant Field Values
    • fromField_PAUSETIME

      public static final java.lang.String fromField_PAUSETIME
      fromField ROUTE name for SFTime field named pauseTime.
      See Also:
      Constant Field Values
    • toField_PAUSETIME

      public static final java.lang.String toField_PAUSETIME
      toField ROUTE name for SFTime field named pauseTime.
      See Also:
      Constant Field Values
    • fromField_PLAYBACKRATE

      public static final java.lang.String fromField_PLAYBACKRATE
      fromField ROUTE name for SFFloat field named playbackRate.
      See Also:
      Constant Field Values
    • toField_PLAYBACKRATE

      public static final java.lang.String toField_PLAYBACKRATE
      toField ROUTE name for SFFloat field named playbackRate.
      See Also:
      Constant Field Values
    • fromField_RESUMETIME

      public static final java.lang.String fromField_RESUMETIME
      fromField ROUTE name for SFTime field named resumeTime.
      See Also:
      Constant Field Values
    • toField_RESUMETIME

      public static final java.lang.String toField_RESUMETIME
      toField ROUTE name for SFTime field named resumeTime.
      See Also:
      Constant Field Values
    • fromField_SAMPLERATE

      public static final java.lang.String fromField_SAMPLERATE
      fromField ROUTE name for SFFloat field named sampleRate.
      See Also:
      Constant Field Values
    • toField_SAMPLERATE

      public static final java.lang.String toField_SAMPLERATE
      toField ROUTE name for SFFloat field named sampleRate.
      See Also:
      Constant Field Values
    • fromField_STARTTIME

      public static final java.lang.String fromField_STARTTIME
      fromField ROUTE name for SFTime field named startTime.
      See Also:
      Constant Field Values
    • toField_STARTTIME

      public static final java.lang.String toField_STARTTIME
      toField ROUTE name for SFTime field named startTime.
      See Also:
      Constant Field Values
    • fromField_STOPTIME

      public static final java.lang.String fromField_STOPTIME
      fromField ROUTE name for SFTime field named stopTime.
      See Also:
      Constant Field Values
    • toField_STOPTIME

      public static final java.lang.String toField_STOPTIME
      toField ROUTE name for SFTime field named stopTime.
      See Also:
      Constant Field Values
  • Constructor Details

    • AudioBufferSource

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

      public AudioBufferSource​(java.lang.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

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: AudioBufferSource
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the AudioBufferSource element: Sound
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element
    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 2
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public java.lang.String getFieldType​(java.lang.String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • getAccessType

      public java.lang.String getAccessType​(java.lang.String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      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.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode
    • getBuffer

      public float[] getBuffer()
      Provide array of Float results within allowed range of [-1,1] from inputOutput MFFloat field named buffer.

      Tooltip: buffer is a memory-resident audio asset that can contain one or more channels. buffer data format is non-interleaved 32-bit floating-point linear PCM values with a normal range of [−1,1], but values are not limited to this range.
      Specified by:
      getBuffer in interface AudioBufferSource
      Returns:
      value of buffer field
    • getBufferList

      public java.util.ArrayList<java.lang.Float> getBufferList()
      Utility method to get ArrayList value of MFFloat buffer field, similar to getBuffer().
      Returns:
      value of buffer field
    • getBufferString

      public java.lang.String getBufferString()
      Utility method to get String value of MFFloat buffer field, similar to getBuffer().
      Returns:
      value of buffer field
    • setBuffer

      public AudioBufferSource setBuffer​(float[] newValue)
      Accessor method to assign Float array to inputOutput MFFloat field named buffer.

      Tooltip: buffer is a memory-resident audio asset that can contain one or more channels. buffer data format is non-interleaved 32-bit floating-point linear PCM values with a normal range of [−1,1], but values are not limited to this range.
      Specified by:
      setBuffer in interface AudioBufferSource
      Parameters:
      newValue - is new value for the buffer field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBuffer

      public AudioBufferSource setBuffer​(MFFloat newValue)
      Assign typed object value to MFFloat buffer field, similar to setBuffer(float[]).
      Parameters:
      newValue - is new value for the buffer field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBuffer

      public AudioBufferSource setBuffer​(java.util.ArrayList<java.lang.Float> newValue)
      Assign ArrayList value of MFFloat buffer field, similar to setBuffer(float[]).
      Parameters:
      newValue - is new value for the buffer field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearBuffer

      public AudioBufferSource clearBuffer()
      Utility method to clear MFFloat value of buffer field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setBuffer

      public AudioBufferSource setBuffer​(int[] newValue)
      Assign floating-point array value of MFFloat buffer field, similar to setBuffer(float[]).
      Parameters:
      newValue - is new value for the buffer field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addBuffer

      public AudioBufferSource addBuffer​(float newValue)
      Add singleton float value to MFFloat buffer field.
      Parameters:
      newValue - is new value to add to the buffer field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addBuffer

      public AudioBufferSource addBuffer​(SFFloat newValue)
      Add singleton SFFloat value to MFFloat buffer field.
      Parameters:
      newValue - is new value to add to the buffer field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBuffer

      public AudioBufferSource setBuffer​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBuffer(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getBufferDuration

      public double getBufferDuration()
      Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named bufferDuration.

      Tooltip: [0,+infinity) bufferDuration is duration in seconds to use from buffer field.
      • Hint: duration is a nonnegative SFTime duration interval, not an absolute clock time.
      Specified by:
      getBufferDuration in interface AudioBufferSource
      Returns:
      value of bufferDuration field
    • setBufferDuration

      public AudioBufferSource setBufferDuration​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named bufferDuration.

      Tooltip: [0,+infinity) bufferDuration is duration in seconds to use from buffer field.
      • Hint: duration is a nonnegative SFTime duration interval, not an absolute clock time.
      Specified by:
      setBufferDuration in interface AudioBufferSource
      Parameters:
      newValue - is new value for the bufferDuration field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBufferDuration

      public AudioBufferSource setBufferDuration​(SFTime newValue)
      Assign typed object value to SFTime bufferDuration field, similar to setBufferDuration(double).
      Parameters:
      newValue - is new value for the bufferDuration field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getChannelCount

      public 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 AudioBufferSource
      Returns:
      value of channelCount field
    • getChannelCountMode

      public 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.

      Available enumeration values for string comparison: MAX, CLAMPED_MAX, EXPLICIT.
      Specified by:
      getChannelCountMode in interface AudioBufferSource
      Returns:
      value of channelCountMode field
    • setChannelCountMode

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

      Warning: authors can only choose from a strict list of enumeration values (MAX, CLAMPED_MAX, EXPLICIT).

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

      public AudioBufferSource setChannelCountMode​(SFString newValue)
      Assign typed object value to SFString channelCountMode field, similar to setChannelCountMode(String).
      Parameters:
      newValue - is new value for the channelCountMode field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getChannelInterpretation

      public 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.

      Available enumeration values for string comparison: SPEAKERS, DISCRETE.
      Specified by:
      getChannelInterpretation in interface AudioBufferSource
      Returns:
      value of channelInterpretation field
    • setChannelInterpretation

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

      Warning: authors can only choose from a strict list of enumeration values (SPEAKERS, DISCRETE).

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

      public AudioBufferSource setChannelInterpretation​(SFString newValue)
      Assign typed object value to SFString channelInterpretation field, similar to setChannelInterpretation(String).
      Parameters:
      newValue - is new value for the channelInterpretation field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDescription

      public 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 &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      getDescription in interface AudioBufferSource
      Specified by:
      getDescription in interface X3DSoundSourceNode
      Specified by:
      getDescription in interface X3DTimeDependentNode
      Returns:
      value of description field
    • setDescription

      public AudioBufferSource 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 &#38; for & ampersand character, or &#34; for " quotation-mark character).
      Specified by:
      setDescription in interface AudioBufferSource
      Specified by:
      setDescription in interface X3DSoundSourceNode
      Specified by:
      setDescription in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the description field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDescription

      public AudioBufferSource setDescription​(SFString newValue)
      Assign typed object value to SFString description field, similar to setDescription(String).
      Parameters:
      newValue - is new value for the description field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDetune

      public float getDetune()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named detune.

      Tooltip: (0,+infinity) The detune field forms a compound field together with playbackRate that together determine a computedPlaybackRate value.
      • Hint: computedPlaybackRate(t) = playbackRate(t) * pow(2, detune(t) / 1200).
      Specified by:
      getDetune in interface AudioBufferSource
      Returns:
      value of detune field
    • setDetune

      public AudioBufferSource setDetune​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named detune.

      Tooltip: (0,+infinity) The detune field forms a compound field together with playbackRate that together determine a computedPlaybackRate value.
      • Hint: computedPlaybackRate(t) = playbackRate(t) * pow(2, detune(t) / 1200).
      Specified by:
      setDetune in interface AudioBufferSource
      Parameters:
      newValue - is new value for the detune field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDetune

      public AudioBufferSource setDetune​(SFFloat newValue)
      Assign typed object value to SFFloat detune field, similar to setDetune(float).
      Parameters:
      newValue - is new value for the detune field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDetune

      public AudioBufferSource setDetune​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setDetune(float).
      Parameters:
      newValue - is new value for field
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getElapsedTime

      public double getElapsedTime()
      Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named elapsedTime.

      Tooltip: [0,+infinity) Current elapsed time since AudioClip activated/running, cumulative in seconds, and not counting any paused time.
      • Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
      • Hint: elapsedTime is a nonnegative SFTime duration interval, not an absolute clock time.
      Specified by:
      getElapsedTime in interface AudioBufferSource
      Specified by:
      getElapsedTime in interface X3DSoundSourceNode
      Specified by:
      getElapsedTime in interface X3DTimeDependentNode
      Returns:
      value of elapsedTime field
    • getEnabled

      public boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.

      Tooltip: Enables/disables node operation. *
      Specified by:
      getEnabled in interface AudioBufferSource
      Specified by:
      getEnabled in interface X3DSoundSourceNode
      Returns:
      value of enabled field
    • setEnabled

      public AudioBufferSource 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 AudioBufferSource
      Specified by:
      setEnabled in interface X3DSoundSourceNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setEnabled

      public AudioBufferSource setEnabled​(SFBool newValue)
      Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getGain

      public 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 AudioBufferSource
      Specified by:
      getGain in interface X3DSoundSourceNode
      Returns:
      value of gain field
    • setGain

      public AudioBufferSource 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 AudioBufferSource
      Specified by:
      setGain in interface X3DSoundSourceNode
      Parameters:
      newValue - is new value for the gain field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGain

      public AudioBufferSource setGain​(SFFloat newValue)
      Assign typed object value to SFFloat gain field, similar to setGain(float).
      Parameters:
      newValue - is new value for the gain field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGain

      public AudioBufferSource setGain​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setGain(float).
      Parameters:
      newValue - is new value for field
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getIS

      public IS getIS()
      Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • setIS

      public AudioBufferSource setIS​(IS newValue)
      Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • clearIS

      public AudioBufferSource clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
      getIS()
    • getIsActive

      public 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 AudioBufferSource
      Specified by:
      getIsActive in interface X3DSoundSourceNode
      Specified by:
      getIsActive in interface X3DTimeDependentNode
      Returns:
      value of isActive field
    • getIsPaused

      public boolean getIsPaused()
      Provide boolean value from outputOnly SFBool field named isPaused.

      Tooltip: isPaused true/false events are sent when AudioClip is paused/resumed.
      • 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:
      getIsPaused in interface AudioBufferSource
      Specified by:
      getIsPaused in interface X3DSoundSourceNode
      Specified by:
      getIsPaused in interface X3DTimeDependentNode
      Returns:
      value of isPaused field
    • getLength

      public int getLength()
      Provide int value within allowed range of [0,infinity) from outputOnly SFInt32 field named length.
      Specified by:
      getLength in interface AudioBufferSource
      Returns:
      value of length field
    • getLoop

      public boolean getLoop()
      Provide boolean value from inputOutput SFBool field named loop.

      Tooltip: Repeat indefinitely when loop=true, repeat only once when loop=false. *
      Specified by:
      getLoop in interface AudioBufferSource
      Returns:
      value of loop field
    • setLoop

      public AudioBufferSource setLoop​(boolean newValue)
      Accessor method to assign boolean value to inputOutput SFBool field named loop.

      Tooltip: Repeat indefinitely when loop=true, repeat only once when loop=false. *
      Specified by:
      setLoop in interface AudioBufferSource
      Parameters:
      newValue - is new value for the loop field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLoop

      public AudioBufferSource setLoop​(SFBool newValue)
      Assign typed object value to SFBool loop field, similar to setLoop(boolean).
      Parameters:
      newValue - is new value for the loop field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getLoopEnd

      public float getLoopEnd()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named loopEnd.

      Tooltip: [0,+infinity) loopEnd field is optional playhead position where looping ends if loop=true. If loopEnd value is zero, or if loopEnd is greater than duration of buffer, looping ends at buffer end.
      • Hint: loopEnd represents a nonnegative SFTime duration interval, not an absolute clock time.
      Specified by:
      getLoopEnd in interface AudioBufferSource
      Returns:
      value of loopEnd field
    • setLoopEnd

      public AudioBufferSource setLoopEnd​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named loopEnd.

      Tooltip: [0,+infinity) loopEnd field is optional playhead position where looping ends if loop=true. If loopEnd value is zero, or if loopEnd is greater than duration of buffer, looping ends at buffer end.
      • Hint: loopEnd represents a nonnegative SFTime duration interval, not an absolute clock time.
      Specified by:
      setLoopEnd in interface AudioBufferSource
      Parameters:
      newValue - is new value for the loopEnd field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLoopEnd

      public AudioBufferSource setLoopEnd​(SFFloat newValue)
      Assign typed object value to SFFloat loopEnd field, similar to setLoopEnd(float).
      Parameters:
      newValue - is new value for the loopEnd field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLoopEnd

      public AudioBufferSource setLoopEnd​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setLoopEnd(float).
      Parameters:
      newValue - is new value for field
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getLoopStart

      public float getLoopStart()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named loopStart.

      Tooltip: [0,+infinity) loopStart field is optional playhead position where looping begins if loop=true. If loopStart is greater than duration of buffer, looping starts at buffer end.
      • Hint: loopStart represents a nonnegative SFTime duration interval, not an absolute clock time.
      Specified by:
      getLoopStart in interface AudioBufferSource
      Returns:
      value of loopStart field
    • setLoopStart

      public AudioBufferSource setLoopStart​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named loopStart.

      Tooltip: [0,+infinity) loopStart field is optional playhead position where looping begins if loop=true. If loopStart is greater than duration of buffer, looping starts at buffer end.
      • Hint: loopStart represents a nonnegative SFTime duration interval, not an absolute clock time.
      Specified by:
      setLoopStart in interface AudioBufferSource
      Parameters:
      newValue - is new value for the loopStart field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLoopStart

      public AudioBufferSource setLoopStart​(SFFloat newValue)
      Assign typed object value to SFFloat loopStart field, similar to setLoopStart(float).
      Parameters:
      newValue - is new value for the loopStart field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setLoopStart

      public AudioBufferSource setLoopStart​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setLoopStart(float).
      Parameters:
      newValue - is new value for field
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

      public 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 AudioBufferSource
      Specified by:
      getMetadata in interface X3DChildNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DSoundSourceNode
      Specified by:
      getMetadata in interface X3DTimeDependentNode
      Returns:
      value of metadata field
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public AudioBufferSource 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 AudioBufferSource
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSoundSourceNode
      Specified by:
      setMetadata in interface X3DTimeDependentNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata , X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

      public AudioBufferSource clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public AudioBufferSource setMetadata​(ProtoInstance newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata( org.web3d.x3d.sai.Core.X3DMetadataObject)
    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • getNumberOfChannels

      public int getNumberOfChannels()
      Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named numberOfChannels.

      Tooltip: [0,+infinity) numberOfChannels is number of audio channels found in this buffer source. *
      Specified by:
      getNumberOfChannels in interface AudioBufferSource
      Returns:
      value of numberOfChannels field
    • setNumberOfChannels

      public AudioBufferSource setNumberOfChannels​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named numberOfChannels.

      Tooltip: [0,+infinity) numberOfChannels is number of audio channels found in this buffer source. *
      Specified by:
      setNumberOfChannels in interface AudioBufferSource
      Parameters:
      newValue - is new value for the numberOfChannels field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setNumberOfChannels

      public AudioBufferSource setNumberOfChannels​(SFInt32 newValue)
      Assign typed object value to SFInt32 numberOfChannels field, similar to setNumberOfChannels(int).
      Parameters:
      newValue - is new value for the numberOfChannels field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getPauseTime

      public double getPauseTime()
      Provide double value in seconds from inputOutput SFTime field named pauseTime.

      Tooltip: When time now &gt;= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      getPauseTime in interface AudioBufferSource
      Specified by:
      getPauseTime in interface X3DSoundSourceNode
      Specified by:
      getPauseTime in interface X3DTimeDependentNode
      Returns:
      value of pauseTime field
    • setPauseTime

      public AudioBufferSource setPauseTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.

      Tooltip: When time now &gt;= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      setPauseTime in interface AudioBufferSource
      Specified by:
      setPauseTime in interface X3DSoundSourceNode
      Specified by:
      setPauseTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the pauseTime field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPauseTime

      public AudioBufferSource setPauseTime​(SFTime newValue)
      Assign typed object value to SFTime pauseTime field, similar to setPauseTime(double).
      Parameters:
      newValue - is new value for the pauseTime field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getPlaybackRate

      public float getPlaybackRate()
      Provide float value from inputOutput SFFloat field named playbackRate.

      Tooltip: (-infinity,+infinity) playbackRate field is speed at which to render the audio stream, and forms a compound field together with detune field
      • Hint: negative values play in reverse.
      Specified by:
      getPlaybackRate in interface AudioBufferSource
      Returns:
      value of playbackRate field
    • setPlaybackRate

      public AudioBufferSource setPlaybackRate​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named playbackRate.

      Tooltip: (-infinity,+infinity) playbackRate field is speed at which to render the audio stream, and forms a compound field together with detune field
      • Hint: negative values play in reverse.
      Specified by:
      setPlaybackRate in interface AudioBufferSource
      Parameters:
      newValue - is new value for the playbackRate field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPlaybackRate

      public AudioBufferSource setPlaybackRate​(SFFloat newValue)
      Assign typed object value to SFFloat playbackRate field, similar to setPlaybackRate(float).
      Parameters:
      newValue - is new value for the playbackRate field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPlaybackRate

      public AudioBufferSource setPlaybackRate​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setPlaybackRate(float).
      Parameters:
      newValue - is new value for field
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getResumeTime

      public double getResumeTime()
      Provide double value in seconds from inputOutput SFTime field named resumeTime.

      Tooltip: When resumeTime becomes &lt;= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      getResumeTime in interface AudioBufferSource
      Specified by:
      getResumeTime in interface X3DSoundSourceNode
      Specified by:
      getResumeTime in interface X3DTimeDependentNode
      Returns:
      value of resumeTime field
    • setResumeTime

      public AudioBufferSource setResumeTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.

      Tooltip: When resumeTime becomes &lt;= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      setResumeTime in interface AudioBufferSource
      Specified by:
      setResumeTime in interface X3DSoundSourceNode
      Specified by:
      setResumeTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the resumeTime field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setResumeTime

      public AudioBufferSource setResumeTime​(SFTime newValue)
      Assign typed object value to SFTime resumeTime field, similar to setResumeTime(double).
      Parameters:
      newValue - is new value for the resumeTime field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSampleRate

      public float getSampleRate()
      Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named sampleRate.

      Tooltip: (-infinity,+infinity) sampleRate field is sample-frames per second.
      • Hint: sample-rate converters (variable speed processors) are not supported in real-time processing.
      • Hint: Nyquist frequency is half this sampleRate value.
      • Hint: Wikipedia Nyquist frequency https://en.wikipedia.org/wiki/Nyquist_frequency
      Specified by:
      getSampleRate in interface AudioBufferSource
      Returns:
      value of sampleRate field
    • setSampleRate

      public AudioBufferSource setSampleRate​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named sampleRate.

      Tooltip: (-infinity,+infinity) sampleRate field is sample-frames per second.
      • Hint: sample-rate converters (variable speed processors) are not supported in real-time processing.
      • Hint: Nyquist frequency is half this sampleRate value.
      • Hint: Wikipedia Nyquist frequency https://en.wikipedia.org/wiki/Nyquist_frequency
      Specified by:
      setSampleRate in interface AudioBufferSource
      Parameters:
      newValue - is new value for the sampleRate field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSampleRate

      public AudioBufferSource setSampleRate​(SFFloat newValue)
      Assign typed object value to SFFloat sampleRate field, similar to setSampleRate(float).
      Parameters:
      newValue - is new value for the sampleRate field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSampleRate

      public AudioBufferSource setSampleRate​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSampleRate(float).
      Parameters:
      newValue - is new value for field
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getStartTime

      public double getStartTime()
      Provide double value in seconds from inputOutput SFTime field named startTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      getStartTime in interface AudioBufferSource
      Specified by:
      getStartTime in interface X3DSoundSourceNode
      Specified by:
      getStartTime in interface X3DTimeDependentNode
      Returns:
      value of startTime field
    • setStartTime

      public AudioBufferSource setStartTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      Specified by:
      setStartTime in interface AudioBufferSource
      Specified by:
      setStartTime in interface X3DSoundSourceNode
      Specified by:
      setStartTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the startTime field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStartTime

      public AudioBufferSource setStartTime​(SFTime newValue)
      Assign typed object value to SFTime startTime field, similar to setStartTime(double).
      Parameters:
      newValue - is new value for the startTime field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getStopTime

      public double getStopTime()
      Provide double value in seconds from inputOutput SFTime field named stopTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      • Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
      • Warning: An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
      Specified by:
      getStopTime in interface AudioBufferSource
      Specified by:
      getStopTime in interface X3DSoundSourceNode
      Specified by:
      getStopTime in interface X3DTimeDependentNode
      Returns:
      value of stopTime field
    • setStopTime

      public AudioBufferSource setStopTime​(double newValue)
      Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.

      Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
      • Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
      • Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
      • Warning: An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
      Specified by:
      setStopTime in interface AudioBufferSource
      Specified by:
      setStopTime in interface X3DSoundSourceNode
      Specified by:
      setStopTime in interface X3DTimeDependentNode
      Parameters:
      newValue - is new value for the stopTime field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setStopTime

      public AudioBufferSource setStopTime​(SFTime newValue)
      Assign typed object value to SFTime stopTime field, similar to setStopTime(double).
      Parameters:
      newValue - is new value for the stopTime field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDEF

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final AudioBufferSource setDEF​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public AudioBufferSource setDEF​(SFString newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUSE

      public java.lang.String getUSE()
      Provide String value from inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

      public final AudioBufferSource setUSE​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public AudioBufferSource setUSE​(SFString newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssClass

      public java.lang.String getCssClass()
      Provide String value from inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final AudioBufferSource setCssClass​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public AudioBufferSource setCssClass​(SFString newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public AudioBufferSource setUSE​(AudioBufferSource DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public AudioBufferSource addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public AudioBufferSource addComments​(java.lang.String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public AudioBufferSource addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      AudioBufferSource - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3D.FILE_EXTENSION_X3D, X3D.FILE_EXTENSION_XML, X3D.toStringXML(), X3D.toFileXML(String), X3D.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public java.lang.String toStringClassicVRML​(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3D.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public java.lang.String toStringVRML97​(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3D.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
      findElementByNameValue(String, String)
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorScene(), X3DConcreteElement.findAncestorX3D()
    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:
      findNodeByDEF(String)
    • validate

      public java.lang.String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)