All Superinterfaces:: X3DChildNode, X3DNode, X3DSoundNode, X3DSoundSourceNode, X3DTimeDependentNode, X3DUrlObject

All Known Implementing Classes:: BufferAudioSource

public interface BufferAudioSource extends X3DSoundSourceNode, X3DUrlObject

BufferAudioSource node represents a memory-resident audio asset that can contain one or more channels.

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. BufferAudioSource node tooltip: [X3DSoundSourceNode] BufferAudioSource 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).

Warning: for longer sounds, such as music soundtracks, streaming such as StreamAudioSource should be used.
Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#AudioBufferSourceNode

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

Method Summary

Modifier and Type

Method

Description

double

getAutoRefresh()

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

double

getAutoRefreshTimeLimit()

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

float[]

getBuffer()

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

double

getBufferDuration()

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

int

getBufferlength()

Provide int value from outputOnly SFInt32 field named bufferlength.

int

getChannelCount()

Provide int value from outputOnly SFInt32 field named channelCount.

String

getChannelCountMode()

Provide String enumeration value (baseType SFString) ["MAX" | "CLAMPED_MAX" | "EXPLICIT"] from inputOutput SFString field named channelCountMode.

String

getChannelInterpretation()

Provide String enumeration value (baseType SFString) ["SPEAKERS" | "DISCRETE"] from inputOutput SFString field named channelInterpretation.

String

getDescription()

Provide String value from inputOutput SFString field named description.

float

getDetune()

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

double

getElapsedTime()

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

boolean

getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

float

getGain()

Provide float value from inputOutput SFFloat field named gain.

boolean

getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

boolean

getIsPaused()

Provide boolean value from outputOnly SFBool field named isPaused.

int

getLength()

Provide int value within allowed range of [0,infinity) from outputOnly SFInt32 field named length.

boolean

getLoad()

Provide boolean value from inputOutput SFBool field named load.

boolean

getLoop()

Provide boolean value from inputOutput SFBool field named loop.

float

getLoopEnd()

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

float

getLoopStart()

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

X3DMetadataObject

getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

int

getNumberOfChannels()

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

double

getPauseTime()

Provide double value in seconds from inputOutput SFTime field named pauseTime.

float

getPlaybackRate()

Provide float value from inputOutput SFFloat field named playbackRate.

double

getResumeTime()

Provide double value in seconds from inputOutput SFTime field named resumeTime.

float

getSampleRate()

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

double

getStartTime()

Provide double value in seconds from inputOutput SFTime field named startTime.

double

getStopTime()

Provide double value in seconds from inputOutput SFTime field named stopTime.

String[]

getUrl()

Provide array of String results from inputOutput MFString field named url.

BufferAudioSource

setAutoRefresh(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.

BufferAudioSource

setAutoRefreshTimeLimit(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.

BufferAudioSource

setBuffer(float[] newValue)

Accessor method to assign float array to inputOutput MFFloat field named buffer.

BufferAudioSource

setBufferDuration(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named bufferDuration.

BufferAudioSource

setChannelCountMode(String newValue)

Accessor method to assign String enumeration value ("MAX" | "CLAMPED_MAX" | "EXPLICIT") to inputOutput SFString field named channelCountMode.

BufferAudioSource

setChannelInterpretation(String newValue)

Accessor method to assign String enumeration value ("SPEAKERS" | "DISCRETE") to inputOutput SFString field named channelInterpretation.

BufferAudioSource

setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

BufferAudioSource

setDetune(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named detune.

BufferAudioSource

setEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named enabled.

BufferAudioSource

setGain(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named gain.

BufferAudioSource

setLoad(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named load.

BufferAudioSource

setLoop(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named loop.

BufferAudioSource

setLoopEnd(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named loopEnd.

BufferAudioSource

setLoopStart(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named loopStart.

BufferAudioSource

setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

BufferAudioSource

setNumberOfChannels(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named numberOfChannels.

BufferAudioSource

setPauseTime(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.

BufferAudioSource

setPlaybackRate(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named playbackRate.

BufferAudioSource

setResumeTime(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.

BufferAudioSource

setSampleRate(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named sampleRate.

BufferAudioSource

setStartTime(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.

BufferAudioSource

setStopTime(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.

BufferAudioSource

setUrl(String[] newValue)

Accessor method to assign String array to inputOutput MFString field named url.

Method Details
- getAutoRefresh
  double getAutoRefresh()
  
  Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefresh.
  
  Tooltip: autoRefresh defines interval in seconds before automatic reload of current url asset is performed.
  
  Hint: if preceding file loading fails or load field is false, no refresh is performed.
  
  Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
  
  Warning: automatically reloading content has security considerations and needs to be considered carefully.
  
  Specified by:
  
  getAutoRefresh in interface X3DUrlObject
  
  Returns:
  
  value of autoRefresh field
- setAutoRefresh
  BufferAudioSource setAutoRefresh(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.
  
  Tooltip: autoRefresh defines interval in seconds before automatic reload of current url asset is performed.
  
  Hint: if preceding file loading fails or load field is false, no refresh is performed.
  
  Hint: repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
  
  Warning: automatically reloading content has security considerations and needs to be considered carefully.
  
  Specified by:
  
  setAutoRefresh in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the autoRefresh field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getAutoRefreshTimeLimit
  double getAutoRefreshTimeLimit()
  
  Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named autoRefreshTimeLimit.
  
  Tooltip: autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.
  
  Hint: Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
  
  Warning: automatically reloading content has security considerations and needs to be considered carefully.
  
  Specified by:
  
  getAutoRefreshTimeLimit in interface X3DUrlObject
  
  Returns:
  
  value of autoRefreshTimeLimit field
- setAutoRefreshTimeLimit
  BufferAudioSource setAutoRefreshTimeLimit(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.
  
  Tooltip: autoRefreshTimeLimit defines maximum duration that automatic refresh activity can occur.
  
  Hint: Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
  
  Warning: automatically reloading content has security considerations and needs to be considered carefully.
  
  Specified by:
  
  setAutoRefreshTimeLimit in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the autoRefreshTimeLimit field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getBuffer
  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.
  
  Hint: Wikipedia Pulse-Code Modulation (PCM) https://en.wikipedia.org/wiki/Pulse-code_modulation
  
  Returns:
  
  value of buffer field
- setBuffer
  BufferAudioSource 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.
  
  Hint: Wikipedia Pulse-Code Modulation (PCM) https://en.wikipedia.org/wiki/Pulse-code_modulation
  
  Parameters:
  
  newValue - is new value for the buffer field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getBufferDuration
  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.
  
  Returns:
  
  value of bufferDuration field
- setBufferDuration
  BufferAudioSource 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.
  
  Parameters:
  
  newValue - is new value for the bufferDuration field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getBufferlength
  
  int getBufferlength()
  
  Provide int value from outputOnly SFInt32 field named bufferlength.
  
  Returns:
  
  value of bufferlength field
- getChannelCount
  int getChannelCount()
  
  Provide int value from outputOnly SFInt32 field named channelCount.
  
  Tooltip: [0,+infinity) channelCount reports number of channels provided by input nodes.
  
  Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcount
  
  Returns:
  
  value of channelCount field
- getChannelCountMode
  String getChannelCountMode()
  
  Provide String enumeration value (baseType SFString) ["MAX" | "CLAMPED_MAX" | "EXPLICIT"] from inputOutput SFString field named channelCountMode.
  
  Tooltip: channelCountMode determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.
  
  Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode
  
  Returns:
  
  value of channelCountMode field
- setChannelCountMode
  BufferAudioSource 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.
  
  Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode
  
  Parameters:
  
  newValue - is new value for the channelCountMode field.
  
  Returns:
  
  BufferAudioSource - 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.
  
  Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation
  
  Returns:
  
  value of channelInterpretation field
- setChannelInterpretation
  BufferAudioSource 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.
  
  Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation
  
  Parameters:
  
  newValue - is new value for the channelInterpretation field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getDescription
  String getDescription()
  
  Provide String value from inputOutput SFString field named description.
  
  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 X3DSoundNode
  
  Specified by:
  
  getDescription in interface X3DSoundSourceNode
  
  Specified by:
  
  getDescription in interface X3DTimeDependentNode
  
  Specified by:
  
  getDescription in interface X3DUrlObject
  
  Returns:
  
  value of description field
- setDescription
  BufferAudioSource 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 X3DSoundNode
  
  Specified by:
  
  setDescription in interface X3DSoundSourceNode
  
  Specified by:
  
  setDescription in interface X3DTimeDependentNode
  
  Specified by:
  
  setDescription in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getDetune
  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).
  
  Returns:
  
  value of detune field
- setDetune
  BufferAudioSource 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).
  
  Parameters:
  
  newValue - is new value for the detune field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getElapsedTime
  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 X3DSoundSourceNode
  
  Specified by:
  
  getElapsedTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of elapsedTime field
- getEnabled
  
  boolean getEnabled()
  
  Provide boolean value from inputOutput SFBool field named enabled.
  
  Tooltip: Enables/disables node operation. *
  
  Specified by:
  
  getEnabled in interface X3DSoundNode
  
  Specified by:
  
  getEnabled in interface X3DSoundSourceNode
  
  Returns:
  
  value of enabled field
- setEnabled
  
  BufferAudioSource 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 X3DSoundNode
  
  Specified by:
  
  setEnabled in interface X3DSoundSourceNode
  
  Parameters:
  
  newValue - is new value for the enabled field.
  
  Returns:
  
  BufferAudioSource - 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 X3DSoundSourceNode
  
  Returns:
  
  value of gain field
- setGain
  BufferAudioSource 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 X3DSoundSourceNode
  
  Parameters:
  
  newValue - is new value for the gain field.
  
  Returns:
  
  BufferAudioSource - 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 X3DSoundSourceNode
  
  Specified by:
  
  getIsActive in interface X3DTimeDependentNode
  
  Returns:
  
  value of isActive field
- getIsPaused
  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 X3DSoundSourceNode
  
  Specified by:
  
  getIsPaused in interface X3DTimeDependentNode
  
  Returns:
  
  value of isPaused field
- getLength
  
  int getLength()
  
  Provide int value within allowed range of [0,infinity) from outputOnly SFInt32 field named length.
  
  Returns:
  
  value of length field
- getLoad
  boolean getLoad()
  
  Provide boolean value from inputOutput SFBool field named load.
  
  Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.
  
  Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
  
  Hint: use a separate LoadSensor node to detect when loading is complete.
  
  Specified by:
  
  getLoad in interface X3DUrlObject
  
  Returns:
  
  value of load field
- setLoad
  BufferAudioSource setLoad(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named load.
  
  Tooltip: load=true means load immediately, load=false means defer loading or else unload a previously loaded scene.
  
  Hint: allows author to design when Inline loading occurs via user interaction, event chains or scripting.
  
  Hint: use a separate LoadSensor node to detect when loading is complete.
  
  Specified by:
  
  setLoad in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the load field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getLoop
  
  boolean getLoop()
  
  Provide boolean value from inputOutput SFBool field named loop.
  
  Tooltip: Repeat indefinitely when loop=true, repeat only once when loop=false. *
  
  Returns:
  
  value of loop field
- setLoop
  
  BufferAudioSource 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. *
  
  Parameters:
  
  newValue - is new value for the loop field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getLoopEnd
  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.
  
  Returns:
  
  value of loopEnd field
- setLoopEnd
  BufferAudioSource 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.
  
  Parameters:
  
  newValue - is new value for the loopEnd field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getLoopStart
  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.
  
  Returns:
  
  value of loopStart field
- setLoopStart
  BufferAudioSource 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.
  
  Parameters:
  
  newValue - is new value for the loopStart field.
  
  Returns:
  
  BufferAudioSource - 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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
  
  Specified by:
  
  getMetadata in interface X3DChildNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Specified by:
  
  getMetadata in interface X3DSoundNode
  
  Specified by:
  
  getMetadata in interface X3DSoundSourceNode
  
  Specified by:
  
  getMetadata in interface X3DTimeDependentNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  BufferAudioSource 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.
  
  Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata
  
  Specified by:
  
  setMetadata in interface X3DChildNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in interface X3DSoundNode
  
  Specified by:
  
  setMetadata in interface X3DSoundSourceNode
  
  Specified by:
  
  setMetadata in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  BufferAudioSource - 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
- getNumberOfChannels
  
  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. *
  
  Returns:
  
  value of numberOfChannels field
- setNumberOfChannels
  
  BufferAudioSource 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. *
  
  Parameters:
  
  newValue - is new value for the numberOfChannels field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getPauseTime
  double getPauseTime()
  
  Provide double value in seconds from inputOutput SFTime field named pauseTime.
  
  Tooltip: When time now >= 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 X3DSoundSourceNode
  
  Specified by:
  
  getPauseTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of pauseTime field
- setPauseTime
  BufferAudioSource setPauseTime(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
  
  Tooltip: When time now >= 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 X3DSoundSourceNode
  
  Specified by:
  
  setPauseTime in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the pauseTime field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getPlaybackRate
  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.
  
  Returns:
  
  value of playbackRate field
- setPlaybackRate
  BufferAudioSource 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.
  
  Parameters:
  
  newValue - is new value for the playbackRate field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getResumeTime
  double getResumeTime()
  
  Provide double value in seconds from inputOutput SFTime field named resumeTime.
  
  Tooltip: When resumeTime becomes <= 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 X3DSoundSourceNode
  
  Specified by:
  
  getResumeTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of resumeTime field
- setResumeTime
  BufferAudioSource setResumeTime(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
  
  Tooltip: When resumeTime becomes <= 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 X3DSoundSourceNode
  
  Specified by:
  
  setResumeTime in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the resumeTime field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getSampleRate
  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
  
  Returns:
  
  value of sampleRate field
- setSampleRate
  BufferAudioSource 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
  
  Parameters:
  
  newValue - is new value for the sampleRate field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getStartTime
  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 X3DSoundSourceNode
  
  Specified by:
  
  getStartTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of startTime field
- setStartTime
  BufferAudioSource 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 X3DSoundSourceNode
  
  Specified by:
  
  setStartTime in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the startTime field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getStopTime
  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 X3DSoundSourceNode
  
  Specified by:
  
  getStopTime in interface X3DTimeDependentNode
  
  Returns:
  
  value of stopTime field
- setStopTime
  BufferAudioSource 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 X3DSoundSourceNode
  
  Specified by:
  
  setStopTime in interface X3DTimeDependentNode
  
  Parameters:
  
  newValue - is new value for the stopTime field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getUrl
  String[] getUrl()
  
  Provide array of String results from inputOutput MFString field named url.
  
  Tooltip: Location and filename of sound file. Support for .wav format is required, .midi format is recommended, other formats are optional.
  
  Hint: MFString arrays can have multiple values, so separate each individual string by quote marks. "https://www.web3d.org" "https://www.web3d.org/about" "etc."
  
  Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
  
  Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
  
  Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
  
  Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
  
  Specified by:
  
  getUrl in interface X3DUrlObject
  
  Returns:
  
  value of url field
- setUrl
  BufferAudioSource setUrl(String[] newValue)
  
  Accessor method to assign String array to inputOutput MFString field named url.
  
  Tooltip: Location and filename of sound file. Support for .wav format is required, .midi format is recommended, other formats are optional.
  
  Hint: MFString arrays can have multiple values, so separate each individual string by quote marks. "https://www.web3d.org" "https://www.web3d.org/about" "etc."
  
  Hint: alternative XML encoding for quotation mark " is " (which is an example of a character entity).
  
  Warning: strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https url addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
  
  Hint: can replace embedded blank(s) in url queries with %20 for each blank character.
  
  Hint: X3D Scene Authoring Hints, urls https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls
  
  Specified by:
  
  setUrl in interface X3DUrlObject
  
  Parameters:
  
  newValue - is new value for the url field.
  
  Returns:
  
  BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface BufferAudioSource

Method Summary

Method Details

getAutoRefresh

setAutoRefresh

getAutoRefreshTimeLimit

setAutoRefreshTimeLimit

getBuffer

setBuffer

getBufferDuration

setBufferDuration

getBufferlength

getChannelCount

getChannelCountMode

setChannelCountMode

getChannelInterpretation

setChannelInterpretation

getDescription

setDescription

getDetune

setDetune

getElapsedTime

getEnabled

setEnabled

getGain

setGain

getIsActive

getIsPaused

getLength

getLoad

setLoad

getLoop

setLoop

getLoopEnd

setLoopEnd

getLoopStart

setLoopStart

getMetadata

setMetadata

getNumberOfChannels

setNumberOfChannels

getPauseTime

setPauseTime

getPlaybackRate

setPlaybackRate

getResumeTime

setResumeTime

getSampleRate

setSampleRate

getStartTime

setStartTime

getStopTime

setStopTime

getUrl

setUrl