Class BufferAudioSource

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Sound.BufferAudioSource

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DUrlObject, BufferAudioSource, X3DSoundNode, X3DSoundSourceNode, X3DTimeDependentNode

public class BufferAudioSource
extends X3DConcreteNode
implements BufferAudioSource

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 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: BufferAudioSource
• X3D Tooltips: BufferAudioSource
• X3D Scene Authoring Hints

Field Summary

Fields

Modifier and Type	Field	Description
static final double	AUTOREFRESH_DEFAULT_VALUE	SFTime field named autoRefresh has default value 0 (Java syntax) or 0 (XML syntax).
static final double	AUTOREFRESHTIMELIMIT_DEFAULT_VALUE	SFTime field named autoRefreshTimeLimit has default value 3600 (Java syntax) or 3600 (XML syntax).
static final ArrayList<Float>	BUFFER_DEFAULT_VALUE	MFFloat field named buffer has default value equal to an empty list.
static final double	BUFFERDURATION_DEFAULT_VALUE	SFTime field named bufferDuration has default value 0 (Java syntax) or 0 (XML syntax).
static final String	CHANNELCOUNTMODE_CLAMPED_MAX	Tooltip: X3D version of "clamped-max" in Web Audio API.
static final String	CHANNELCOUNTMODE_CLAMPED_MAX_ALIAS	SFString SFString enumeration value "CLAMPED_MAX" has alias "clamped-max"
static final String	CHANNELCOUNTMODE_DEFAULT_VALUE	SFString field named channelCountMode has default value "MAX" (Java syntax) or MAX (XML syntax).
static final String	CHANNELCOUNTMODE_EXPLICIT	Tooltip: X3D version of "explicit" in Web Audio API.
static final String	CHANNELCOUNTMODE_EXPLICIT_ALIAS	SFString SFString enumeration value "EXPLICIT" has alias "explicit"
static final String	CHANNELCOUNTMODE_MAX	Tooltip: X3D version of "max" in Web Audio API.
static final String	CHANNELCOUNTMODE_MAX_ALIAS	SFString SFString enumeration value "MAX" has alias "max"
static final String	CHANNELINTERPRETATION_DEFAULT_VALUE	SFString field named channelInterpretation has default value "SPEAKERS" (Java syntax) or SPEAKERS (XML syntax).
static final String	CHANNELINTERPRETATION_DISCRETE	Tooltip: X3D version of "discrete" in Web Audio API.
static final String	CHANNELINTERPRETATION_SPEAKERS	Tooltip: X3D version of "speakers" in Web Audio API.
static final String	COMPONENT	String constant COMPONENT defines X3D component for the BufferAudioSource element: Sound
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	DESCRIPTION_DEFAULT_VALUE	SFString field named description has default value equal to an empty string.
static final float	DETUNE_DEFAULT_VALUE	SFFloat field named detune has default value 0f (Java syntax) or 0 (XML syntax).
static final boolean	ENABLED_DEFAULT_VALUE	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static final String	fromField_AUTOREFRESH	fromField ROUTE name for SFTime field named autoRefresh.
static final String	fromField_AUTOREFRESHTIMELIMIT	fromField ROUTE name for SFTime field named autoRefreshTimeLimit.
static final String	fromField_BUFFER	fromField ROUTE name for MFFloat field named buffer.
static final String	fromField_BUFFERDURATION	fromField ROUTE name for SFTime field named bufferDuration.
static final String	fromField_BUFFERLENGTH	fromField ROUTE name for SFInt32 field named bufferlength.
static final String	fromField_CHANNELCOUNT	fromField ROUTE name for SFInt32 field named channelCount.
static final String	fromField_CHANNELCOUNTMODE	fromField ROUTE name for SFString field named channelCountMode.
static final String	fromField_CHANNELINTERPRETATION	fromField ROUTE name for SFString field named channelInterpretation.
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_DETUNE	fromField ROUTE name for SFFloat field named detune.
static final String	fromField_ELAPSEDTIME	fromField ROUTE name for SFTime field named elapsedTime.
static final String	fromField_ENABLED	fromField ROUTE name for SFBool field named enabled.
static final String	fromField_GAIN	fromField ROUTE name for SFFloat field named gain.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_ISACTIVE	fromField ROUTE name for SFBool field named isActive.
static final String	fromField_ISPAUSED	fromField ROUTE name for SFBool field named isPaused.
static final String	fromField_LENGTH	fromField ROUTE name for SFInt32 field named length.
static final String	fromField_LOAD	fromField ROUTE name for SFBool field named load.
static final String	fromField_LOOP	fromField ROUTE name for SFBool field named loop.
static final String	fromField_LOOPEND	fromField ROUTE name for SFFloat field named loopEnd.
static final String	fromField_LOOPSTART	fromField ROUTE name for SFFloat field named loopStart.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_NUMBEROFCHANNELS	fromField ROUTE name for SFInt32 field named numberOfChannels.
static final String	fromField_PAUSETIME	fromField ROUTE name for SFTime field named pauseTime.
static final String	fromField_PLAYBACKRATE	fromField ROUTE name for SFFloat field named playbackRate.
static final String	fromField_RESUMETIME	fromField ROUTE name for SFTime field named resumeTime.
static final String	fromField_SAMPLERATE	fromField ROUTE name for SFFloat field named sampleRate.
static final String	fromField_STARTTIME	fromField ROUTE name for SFTime field named startTime.
static final String	fromField_STOPTIME	fromField ROUTE name for SFTime field named stopTime.
static final String	fromField_URL	fromField ROUTE name for MFString field named url.
static final float	GAIN_DEFAULT_VALUE	SFFloat field named gain has default value 1f (Java syntax) or 1 (XML syntax).
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D Sound component level for this element: 2
static final boolean	LOAD_DEFAULT_VALUE	SFBool field named load has default value true (Java syntax) or true (XML syntax).
static final boolean	LOOP_DEFAULT_VALUE	SFBool field named loop has default value false (Java syntax) or false (XML syntax).
static final float	LOOPEND_DEFAULT_VALUE	SFFloat field named loopEnd has default value 0f (Java syntax) or 0 (XML syntax).
static final float	LOOPSTART_DEFAULT_VALUE	SFFloat field named loopStart has default value 0f (Java syntax) or 0 (XML syntax).
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	NAME	String constant NAME provides name of this element: BufferAudioSource.
static final int	NUMBEROFCHANNELS_DEFAULT_VALUE	SFInt32 field named numberOfChannels has default value 0 (Java syntax) or 0 (XML syntax).
static final double	PAUSETIME_DEFAULT_VALUE	SFTime field named pauseTime has default value 0 (Java syntax) or 0 (XML syntax).
static final float	PLAYBACKRATE_DEFAULT_VALUE	SFFloat field named playbackRate has default value 1f (Java syntax) or 1 (XML syntax).
static final double	RESUMETIME_DEFAULT_VALUE	SFTime field named resumeTime has default value 0 (Java syntax) or 0 (XML syntax).
static final float	SAMPLERATE_DEFAULT_VALUE	SFFloat field named sampleRate has default value 0f (Java syntax) or 0 (XML syntax).
static final double	STARTTIME_DEFAULT_VALUE	SFTime field named startTime has default value 0 (Java syntax) or 0 (XML syntax).
static final double	STOPTIME_DEFAULT_VALUE	SFTime field named stopTime has default value 0 (Java syntax) or 0 (XML syntax).
static final String	toField_AUTOREFRESH	toField ROUTE name for SFTime field named autoRefresh.
static final String	toField_AUTOREFRESHTIMELIMIT	toField ROUTE name for SFTime field named autoRefreshTimeLimit.
static final String	toField_BUFFER	toField ROUTE name for MFFloat field named buffer.
static final String	toField_BUFFERDURATION	toField ROUTE name for SFTime field named bufferDuration.
static final String	toField_CHANNELCOUNTMODE	toField ROUTE name for SFString field named channelCountMode.
static final String	toField_CHANNELINTERPRETATION	toField ROUTE name for SFString field named channelInterpretation.
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_DETUNE	toField ROUTE name for SFFloat field named detune.
static final String	toField_ENABLED	toField ROUTE name for SFBool field named enabled.
static final String	toField_GAIN	toField ROUTE name for SFFloat field named gain.
static final String	toField_LOAD	toField ROUTE name for SFBool field named load.
static final String	toField_LOOP	toField ROUTE name for SFBool field named loop.
static final String	toField_LOOPEND	toField ROUTE name for SFFloat field named loopEnd.
static final String	toField_LOOPSTART	toField ROUTE name for SFFloat field named loopStart.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_NUMBEROFCHANNELS	toField ROUTE name for SFInt32 field named numberOfChannels.
static final String	toField_PAUSETIME	toField ROUTE name for SFTime field named pauseTime.
static final String	toField_PLAYBACKRATE	toField ROUTE name for SFFloat field named playbackRate.
static final String	toField_RESUMETIME	toField ROUTE name for SFTime field named resumeTime.
static final String	toField_SAMPLERATE	toField ROUTE name for SFFloat field named sampleRate.
static final String	toField_STARTTIME	toField ROUTE name for SFTime field named startTime.
static final String	toField_STOPTIME	toField ROUTE name for SFTime field named stopTime.
static final String	toField_URL	toField ROUTE name for MFString field named url.
static final ArrayList<String>	URL_DEFAULT_VALUE	MFString field named url has default value equal to an empty list.

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

containerField_ALLOWED_VALUES, containerFieldOverride, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

Constructor	Description
BufferAudioSource()	Constructor for BufferAudioSource to initialize member variables with default values.
BufferAudioSource(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
BufferAudioSource	addBuffer(float newValue)	Add singleton float value to MFFloat buffer field.
BufferAudioSource	addBuffer(SFFloat newValue)	Add singleton SFFloat value to MFFloat buffer field.
BufferAudioSource	addComments(String newComment)	Add comment as String to contained commentsList.
BufferAudioSource	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
BufferAudioSource	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
BufferAudioSource	addUrl(String newValue)	Add singleton String value to MFString url field.
BufferAudioSource	addUrl(SFString newValue)	Add singleton SFString value to MFString url field.
BufferAudioSource	clearBuffer()	Utility method to clear MFFloat value of buffer field.
BufferAudioSource	clearIS()	Utility method to clear SFNode value of IS field.
BufferAudioSource	clearMetadata()	Utility method to clear SFNode value of metadata field.
BufferAudioSource	clearUrl()	Utility method to clear MFString value of url field.
X3DConcreteElement	findElementByNameValue(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.
X3DConcreteElement	findElementByNameValue(String nameValue, 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.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
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.
ArrayList<Float>	getBufferList()	Utility method to get ArrayList value of MFFloat buffer field, similar to getBuffer().
String	getBufferString()	Utility method to get String value of MFFloat buffer field, similar to getBuffer().
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.
static String	getChannelCountModeAlias(String channelCountModeValue)	Get alias for this channelCountMode
String	getChannelInterpretation()	Provide String enumeration value (baseType SFString) ["SPEAKERS" | "DISCRETE"] from inputOutput SFString field named channelInterpretation.
final String	getComponent()	Defines X3D component for the BufferAudioSource element: Sound
final int	getComponentLevel()	Provides default X3D component level for this element: 2
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
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.
final String	getElementName()	Provides name of this element: BufferAudioSource
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
float	getGain()	Provide float value from inputOutput SFFloat field named gain.
String	getHtmlID()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
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.
ArrayList<String>	getUrlList()	Utility method to get ArrayList value of MFString url field, similar to getUrl().
String	getUrlString()	Utility method to get String value of MFString url field, similar to getUrl().
String	getUSE()	Provide String value from inputOutput SFString field named USE.
static boolean	hasChannelCountModeAlias(String channelCountMode)	Whether a alias exists for this channelCountMode
boolean	hasElementByNameValue(String nameValue, 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.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
final void	initialize()	Initialize all member variables to default values.
BufferAudioSource	setAutoRefresh(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefresh.
BufferAudioSource	setAutoRefresh(SFTime newValue)	Assign typed object value to SFTime autoRefresh field, similar to setAutoRefresh(double).
BufferAudioSource	setAutoRefreshTimeLimit(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named autoRefreshTimeLimit.
BufferAudioSource	setAutoRefreshTimeLimit(SFTime newValue)	Assign typed object value to SFTime autoRefreshTimeLimit field, similar to setAutoRefreshTimeLimit(double).
BufferAudioSource	setBuffer(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBuffer(float[]).
BufferAudioSource	setBuffer(float[] newValue)	Accessor method to assign Float array to inputOutput MFFloat field named buffer.
BufferAudioSource	setBuffer(int[] newValue)	Assign floating-point array value of MFFloat buffer field, similar to setBuffer(float[]).
BufferAudioSource	setBuffer(ArrayList<Float> newValue)	Assign ArrayList value of MFFloat buffer field, similar to setBuffer(float[]).
BufferAudioSource	setBuffer(MFFloat newValue)	Assign typed object value to MFFloat buffer field, similar to setBuffer(float[]).
BufferAudioSource	setBufferDuration(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named bufferDuration.
BufferAudioSource	setBufferDuration(SFTime newValue)	Assign typed object value to SFTime bufferDuration field, similar to setBufferDuration(double).
BufferAudioSource	setChannelCountMode(String newValue)	Accessor method to assign String enumeration value ("MAX" | "CLAMPED_MAX" | "EXPLICIT") to inputOutput SFString field named channelCountMode.
BufferAudioSource	setChannelCountMode(SFString newValue)	Assign typed object value to SFString channelCountMode field, similar to setChannelCountMode(String).
BufferAudioSource	setChannelInterpretation(String newValue)	Accessor method to assign String enumeration value ("SPEAKERS" | "DISCRETE") to inputOutput SFString field named channelInterpretation.
BufferAudioSource	setChannelInterpretation(SFString newValue)	Assign typed object value to SFString channelInterpretation field, similar to setChannelInterpretation(String).
final BufferAudioSource	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
BufferAudioSource	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final BufferAudioSource	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
BufferAudioSource	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final BufferAudioSource	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
BufferAudioSource	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
BufferAudioSource	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
BufferAudioSource	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
BufferAudioSource	setDetune(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setDetune(float).
BufferAudioSource	setDetune(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named detune.
BufferAudioSource	setDetune(SFFloat newValue)	Assign typed object value to SFFloat detune field, similar to setDetune(float).
BufferAudioSource	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
BufferAudioSource	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
BufferAudioSource	setGain(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setGain(float).
BufferAudioSource	setGain(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named gain.
BufferAudioSource	setGain(SFFloat newValue)	Assign typed object value to SFFloat gain field, similar to setGain(float).
final BufferAudioSource	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
BufferAudioSource	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
BufferAudioSource	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
BufferAudioSource	setLoad(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named load.
BufferAudioSource	setLoad(SFBool newValue)	Assign typed object value to SFBool load field, similar to setLoad(boolean).
BufferAudioSource	setLoop(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named loop.
BufferAudioSource	setLoop(SFBool newValue)	Assign typed object value to SFBool loop field, similar to setLoop(boolean).
BufferAudioSource	setLoopEnd(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setLoopEnd(float).
BufferAudioSource	setLoopEnd(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named loopEnd.
BufferAudioSource	setLoopEnd(SFFloat newValue)	Assign typed object value to SFFloat loopEnd field, similar to setLoopEnd(float).
BufferAudioSource	setLoopStart(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setLoopStart(float).
BufferAudioSource	setLoopStart(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named loopStart.
BufferAudioSource	setLoopStart(SFFloat newValue)	Assign typed object value to SFFloat loopStart field, similar to setLoopStart(float).
BufferAudioSource	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
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	setNumberOfChannels(SFInt32 newValue)	Assign typed object value to SFInt32 numberOfChannels field, similar to setNumberOfChannels(int).
BufferAudioSource	setPauseTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
BufferAudioSource	setPauseTime(SFTime newValue)	Assign typed object value to SFTime pauseTime field, similar to setPauseTime(double).
BufferAudioSource	setPlaybackRate(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setPlaybackRate(float).
BufferAudioSource	setPlaybackRate(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named playbackRate.
BufferAudioSource	setPlaybackRate(SFFloat newValue)	Assign typed object value to SFFloat playbackRate field, similar to setPlaybackRate(float).
BufferAudioSource	setResumeTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
BufferAudioSource	setResumeTime(SFTime newValue)	Assign typed object value to SFTime resumeTime field, similar to setResumeTime(double).
BufferAudioSource	setSampleRate(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setSampleRate(float).
BufferAudioSource	setSampleRate(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named sampleRate.
BufferAudioSource	setSampleRate(SFFloat newValue)	Assign typed object value to SFFloat sampleRate field, similar to setSampleRate(float).
BufferAudioSource	setStartTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.
BufferAudioSource	setStartTime(SFTime newValue)	Assign typed object value to SFTime startTime field, similar to setStartTime(double).
BufferAudioSource	setStopTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.
BufferAudioSource	setStopTime(SFTime newValue)	Assign typed object value to SFTime stopTime field, similar to setStopTime(double).
BufferAudioSource	setUrl(String newValue)	Assign singleton String value to MFString url field, similar to setUrl(String[]).
BufferAudioSource	setUrl(String[] newValue)	Accessor method to assign String array to inputOutput MFString field named url.
BufferAudioSource	setUrl(ArrayList<String> newValue)	Assign ArrayList value of MFString url field, similar to setUrl(String[]).
BufferAudioSource	setUrl(MFString newValue)	Assign typed object value to MFString url field, similar to setUrl(String[]).
BufferAudioSource	setUrl(SFString newValue)	Assign single SFString object value to MFString url field, similar to setUrl(String[]).
final BufferAudioSource	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
BufferAudioSource	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
BufferAudioSource	setUSE(BufferAudioSource DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
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.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

getContainerFieldAllowedValues, getContainerFieldOverride, getName, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlID, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CHANNELCOUNTMODE_MAX

public static final String CHANNELCOUNTMODE_MAX

Tooltip: X3D version of "max" in Web Audio API. SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "MAX" (Java syntax) or MAX (XML syntax).

See Also:

• CHANNELCOUNTMODE_MAX_ALIAS
• XML Schema: channelCountModeChoices
• https://www.w3.org/TR/webaudio/#enumdef-channelcountmode
• Constant Field Values

CHANNELCOUNTMODE_MAX_ALIAS

public static final String CHANNELCOUNTMODE_MAX_ALIAS

SFString SFString enumeration value "MAX" has alias "max"

See Also:

• CHANNELCOUNTMODE_MAX
• Constant Field Values

CHANNELCOUNTMODE_CLAMPED_MAX

public static final String CHANNELCOUNTMODE_CLAMPED_MAX

Tooltip: X3D version of "clamped-max" in Web Audio API. SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "CLAMPED_MAX" (Java syntax) or CLAMPED_MAX (XML syntax).

See Also:

• CHANNELCOUNTMODE_CLAMPED_MAX_ALIAS
• XML Schema: channelCountModeChoices
• https://www.w3.org/TR/webaudio/#enumdef-channelcountmode
• Constant Field Values

CHANNELCOUNTMODE_CLAMPED_MAX_ALIAS

public static final String CHANNELCOUNTMODE_CLAMPED_MAX_ALIAS

SFString SFString enumeration value "CLAMPED_MAX" has alias "clamped-max"

See Also:

• CHANNELCOUNTMODE_CLAMPED_MAX
• Constant Field Values

CHANNELCOUNTMODE_EXPLICIT

public static final String CHANNELCOUNTMODE_EXPLICIT

Tooltip: X3D version of "explicit" in Web Audio API. SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "EXPLICIT" (Java syntax) or EXPLICIT (XML syntax).

See Also:

• CHANNELCOUNTMODE_EXPLICIT_ALIAS
• XML Schema: channelCountModeChoices
• https://www.w3.org/TR/webaudio/#enumdef-channelcountmode
• Constant Field Values

CHANNELCOUNTMODE_EXPLICIT_ALIAS

public static final String CHANNELCOUNTMODE_EXPLICIT_ALIAS

SFString SFString enumeration value "EXPLICIT" has alias "explicit"

See Also:

• CHANNELCOUNTMODE_EXPLICIT
• Constant Field Values

CHANNELINTERPRETATION_SPEAKERS

public static final String CHANNELINTERPRETATION_SPEAKERS

Tooltip: X3D version of "speakers" in Web Audio API. SFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "SPEAKERS" (Java syntax) or SPEAKERS (XML syntax).

See Also:

• XML Schema: channelInterpretationChoices
• https://www.w3.org/TR/webaudio/#enumdef-channelinterpretation
• Constant Field Values

CHANNELINTERPRETATION_DISCRETE

public static final String CHANNELINTERPRETATION_DISCRETE

Tooltip: X3D version of "discrete" in Web Audio API. SFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "DISCRETE" (Java syntax) or DISCRETE (XML syntax).

See Also:

• XML Schema: channelInterpretationChoices
• https://www.w3.org/TR/webaudio/#enumdef-channelinterpretation
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: BufferAudioSource.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the BufferAudioSource 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

AUTOREFRESH_DEFAULT_VALUE

public static final double AUTOREFRESH_DEFAULT_VALUE

SFTime field named autoRefresh has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

AUTOREFRESHTIMELIMIT_DEFAULT_VALUE

public static final double AUTOREFRESHTIMELIMIT_DEFAULT_VALUE

SFTime field named autoRefreshTimeLimit has default value 3600 (Java syntax) or 3600 (XML syntax).

See Also:

• Constant Field Values

BUFFER_DEFAULT_VALUE

public static final ArrayList<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 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 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 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).

LOAD_DEFAULT_VALUE

public static final boolean LOAD_DEFAULT_VALUE

SFBool field named load has default value true (Java syntax) or true (XML syntax).

See Also:

• Constant Field Values

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

URL_DEFAULT_VALUE

public static final ArrayList<String> URL_DEFAULT_VALUE

MFString field named url has default value equal to an empty list.

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type X3DUOM containerFieldChoicesSoundSource

See Also:

• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_AUTOREFRESH

public static final String fromField_AUTOREFRESH

fromField ROUTE name for SFTime field named autoRefresh.

See Also:

• Constant Field Values

toField_AUTOREFRESH

public static final String toField_AUTOREFRESH

toField ROUTE name for SFTime field named autoRefresh.

See Also:

• Constant Field Values

fromField_AUTOREFRESHTIMELIMIT

public static final String fromField_AUTOREFRESHTIMELIMIT

fromField ROUTE name for SFTime field named autoRefreshTimeLimit.

See Also:

• Constant Field Values

toField_AUTOREFRESHTIMELIMIT

public static final String toField_AUTOREFRESHTIMELIMIT

toField ROUTE name for SFTime field named autoRefreshTimeLimit.

See Also:

• Constant Field Values

fromField_BUFFER

public static final String fromField_BUFFER

fromField ROUTE name for MFFloat field named buffer.

See Also:

• Constant Field Values

toField_BUFFER

public static final String toField_BUFFER

toField ROUTE name for MFFloat field named buffer.

See Also:

• Constant Field Values

fromField_BUFFERDURATION

public static final String fromField_BUFFERDURATION

fromField ROUTE name for SFTime field named bufferDuration.

See Also:

• Constant Field Values

toField_BUFFERDURATION

public static final String toField_BUFFERDURATION

toField ROUTE name for SFTime field named bufferDuration.

See Also:

• Constant Field Values

fromField_BUFFERLENGTH

public static final String fromField_BUFFERLENGTH

fromField ROUTE name for SFInt32 field named bufferlength.

See Also:

• Constant Field Values

fromField_CHANNELCOUNT

public static final String fromField_CHANNELCOUNT

fromField ROUTE name for SFInt32 field named channelCount.

See Also:

• Constant Field Values

fromField_CHANNELCOUNTMODE

public static final String fromField_CHANNELCOUNTMODE

fromField ROUTE name for SFString field named channelCountMode.

See Also:

• Constant Field Values

toField_CHANNELCOUNTMODE

public static final String toField_CHANNELCOUNTMODE

toField ROUTE name for SFString field named channelCountMode.

See Also:

• Constant Field Values

fromField_CHANNELINTERPRETATION

public static final String fromField_CHANNELINTERPRETATION

fromField ROUTE name for SFString field named channelInterpretation.

See Also:

• Constant Field Values

toField_CHANNELINTERPRETATION

public static final String toField_CHANNELINTERPRETATION

toField ROUTE name for SFString field named channelInterpretation.

See Also:

• Constant Field Values

fromField_DESCRIPTION

public static final String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

toField_DESCRIPTION

public static final String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

fromField_DETUNE

public static final String fromField_DETUNE

fromField ROUTE name for SFFloat field named detune.

See Also:

• Constant Field Values

toField_DETUNE

public static final String toField_DETUNE

toField ROUTE name for SFFloat field named detune.

See Also:

• Constant Field Values

fromField_ELAPSEDTIME

public static final String fromField_ELAPSEDTIME

fromField ROUTE name for SFTime field named elapsedTime.

See Also:

• Constant Field Values

fromField_ENABLED

public static final String fromField_ENABLED

fromField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

toField_ENABLED

public static final String toField_ENABLED

toField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

fromField_GAIN

public static final String fromField_GAIN

fromField ROUTE name for SFFloat field named gain.

See Also:

• Constant Field Values

toField_GAIN

public static final String toField_GAIN

toField ROUTE name for SFFloat field named gain.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_ISACTIVE

public static final String fromField_ISACTIVE

fromField ROUTE name for SFBool field named isActive.

See Also:

• Constant Field Values

fromField_ISPAUSED

public static final String fromField_ISPAUSED

fromField ROUTE name for SFBool field named isPaused.

See Also:

• Constant Field Values

fromField_LENGTH

public static final String fromField_LENGTH

fromField ROUTE name for SFInt32 field named length.

See Also:

• Constant Field Values

fromField_LOAD

public static final String fromField_LOAD

fromField ROUTE name for SFBool field named load.

See Also:

• Constant Field Values

toField_LOAD

public static final String toField_LOAD

toField ROUTE name for SFBool field named load.

See Also:

• Constant Field Values

fromField_LOOP

public static final String fromField_LOOP

fromField ROUTE name for SFBool field named loop.

See Also:

• Constant Field Values

toField_LOOP

public static final String toField_LOOP

toField ROUTE name for SFBool field named loop.

See Also:

• Constant Field Values

fromField_LOOPEND

public static final String fromField_LOOPEND

fromField ROUTE name for SFFloat field named loopEnd.

See Also:

• Constant Field Values

toField_LOOPEND

public static final String toField_LOOPEND

toField ROUTE name for SFFloat field named loopEnd.

See Also:

• Constant Field Values

fromField_LOOPSTART

public static final String fromField_LOOPSTART

fromField ROUTE name for SFFloat field named loopStart.

See Also:

• Constant Field Values

toField_LOOPSTART

public static final String toField_LOOPSTART

toField ROUTE name for SFFloat field named loopStart.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_NUMBEROFCHANNELS

public static final String fromField_NUMBEROFCHANNELS

fromField ROUTE name for SFInt32 field named numberOfChannels.

See Also:

• Constant Field Values

toField_NUMBEROFCHANNELS

public static final String toField_NUMBEROFCHANNELS

toField ROUTE name for SFInt32 field named numberOfChannels.

See Also:

• Constant Field Values

fromField_PAUSETIME

public static final String fromField_PAUSETIME

fromField ROUTE name for SFTime field named pauseTime.

See Also:

• Constant Field Values

toField_PAUSETIME

public static final String toField_PAUSETIME

toField ROUTE name for SFTime field named pauseTime.

See Also:

• Constant Field Values

fromField_PLAYBACKRATE

public static final String fromField_PLAYBACKRATE

fromField ROUTE name for SFFloat field named playbackRate.

See Also:

• Constant Field Values

toField_PLAYBACKRATE

public static final String toField_PLAYBACKRATE

toField ROUTE name for SFFloat field named playbackRate.

See Also:

• Constant Field Values

fromField_RESUMETIME

public static final String fromField_RESUMETIME

fromField ROUTE name for SFTime field named resumeTime.

See Also:

• Constant Field Values

toField_RESUMETIME

public static final String toField_RESUMETIME

toField ROUTE name for SFTime field named resumeTime.

See Also:

• Constant Field Values

fromField_SAMPLERATE

public static final String fromField_SAMPLERATE

fromField ROUTE name for SFFloat field named sampleRate.

See Also:

• Constant Field Values

toField_SAMPLERATE

public static final String toField_SAMPLERATE

toField ROUTE name for SFFloat field named sampleRate.

See Also:

• Constant Field Values

fromField_STARTTIME

public static final String fromField_STARTTIME

fromField ROUTE name for SFTime field named startTime.

See Also:

• Constant Field Values

toField_STARTTIME

public static final String toField_STARTTIME

toField ROUTE name for SFTime field named startTime.

See Also:

• Constant Field Values

fromField_STOPTIME

public static final String fromField_STOPTIME

fromField ROUTE name for SFTime field named stopTime.

See Also:

• Constant Field Values

toField_STOPTIME

public static final String toField_STOPTIME

toField ROUTE name for SFTime field named stopTime.

See Also:

• Constant Field Values

fromField_URL

public static final String fromField_URL

fromField ROUTE name for MFString field named url.

See Also:

• Constant Field Values

toField_URL

public static final String toField_URL

toField ROUTE name for MFString field named url.

See Also:

• Constant Field Values

Constructor Details

BufferAudioSource

public BufferAudioSource()

Constructor for BufferAudioSource to initialize member variables with default values.

BufferAudioSource

public BufferAudioSource(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

getChannelCountModeAlias

public static String getChannelCountModeAlias(String channelCountModeValue)

Get alias for this channelCountMode

Parameters:

channelCountModeValue - of interest

Returns:

alias value, otherwise empty string if not found

hasChannelCountModeAlias

public static boolean hasChannelCountModeAlias(String channelCountMode)

Whether a alias exists for this channelCountMode

Parameters:

channelCountMode - of interest

Returns:

true if found

getElementName

public final String getElementName()

Provides name of this element: BufferAudioSource

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the BufferAudioSource 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 String getFieldType(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 String getAccessType(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 String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)

initialize

public final void initialize()

Initialize all member variables to default values.

Overrides:

initialize in class X3DConcreteNode

getAutoRefresh

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

Specified by:

getAutoRefresh in interface X3DUrlObject

Returns:

value of autoRefresh field

setAutoRefresh

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

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

setAutoRefresh

public BufferAudioSource setAutoRefresh(SFTime newValue)

Assign typed object value to SFTime autoRefresh field, similar to setAutoRefresh(double).

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

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

Specified by:

getAutoRefreshTimeLimit in interface X3DUrlObject

Returns:

value of autoRefreshTimeLimit field

setAutoRefreshTimeLimit

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

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

setAutoRefreshTimeLimit

public BufferAudioSource setAutoRefreshTimeLimit(SFTime newValue)

Assign typed object value to SFTime autoRefreshTimeLimit field, similar to setAutoRefreshTimeLimit(double).

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

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.

• Hint: Wikipedia Pulse-Code Modulation (PCM) https://en.wikipedia.org/wiki/Pulse-code_modulation

Specified by:

getBuffer in interface BufferAudioSource

Returns:

value of buffer field

getBufferList

public ArrayList<Float> getBufferList()

Utility method to get ArrayList value of MFFloat buffer field, similar to getBuffer().

Returns:

value of buffer field

getBufferString

public String getBufferString()

Utility method to get String value of MFFloat buffer field, similar to getBuffer().

Returns:

value of buffer field

setBuffer

public 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

Specified by:

setBuffer in interface BufferAudioSource

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

setBuffer

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBuffer

public BufferAudioSource setBuffer(ArrayList<Float> newValue)

Assign ArrayList value of MFFloat buffer field, similar to setBuffer(float[]).

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

clearBuffer

public BufferAudioSource clearBuffer()

Utility method to clear MFFloat value of buffer field. This method does not initialize withBUFFER_DEFAULT_VALUE.

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setBuffer

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addBuffer

public BufferAudioSource addBuffer(float newValue)

Add singleton float value to MFFloat buffer field.

Parameters:

newValue - is new value to add to the buffer field.

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addBuffer

public BufferAudioSource addBuffer(SFFloat newValue)

Add singleton SFFloat value to MFFloat buffer field.

Parameters:

newValue - is new value to add to the buffer field.

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBuffer

public BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource

Returns:

value of bufferDuration field

setBufferDuration

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

Specified by:

setBufferDuration in interface BufferAudioSource

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

setBufferDuration

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getBufferlength

public int getBufferlength()

Provide int value from outputOnly SFInt32 field named bufferlength.

Specified by:

getBufferlength in interface BufferAudioSource

Returns:

value of bufferlength field

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.

• Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcount

Specified by:

getChannelCount in interface BufferAudioSource

Returns:

value of channelCount field

getChannelCountMode

public 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

Available enumeration values for string comparison: MAX, CLAMPED_MAX, EXPLICIT.

Specified by:

getChannelCountMode in interface BufferAudioSource

Returns:

value of channelCountMode field

setChannelCountMode

public BufferAudioSource setChannelCountMode(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.

• Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelcountmode

Specified by:

setChannelCountMode in interface BufferAudioSource

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

setChannelCountMode

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getChannelInterpretation

public 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

Available enumeration values for string comparison: SPEAKERS, DISCRETE.

Specified by:

getChannelInterpretation in interface BufferAudioSource

Returns:

value of channelInterpretation field

setChannelInterpretation

public BufferAudioSource setChannelInterpretation(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.

• Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#dom-audionode-channelinterpretation

Specified by:

setChannelInterpretation in interface BufferAudioSource

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

setChannelInterpretation

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDescription

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

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

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

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

setDescription

public BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource

Returns:

value of detune field

setDetune

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

Specified by:

setDetune in interface BufferAudioSource

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

setDetune

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDetune

public BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource

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 BufferAudioSource

Specified by:

getEnabled in interface X3DSoundNode

Specified by:

getEnabled in interface X3DSoundSourceNode

Returns:

value of enabled field

setEnabled

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

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

setEnabled

public BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource

Specified by:

getGain in interface X3DSoundSourceNode

Returns:

value of gain field

setGain

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

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

setGain

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setGain

public BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource clearIS()

Utility method to clear SFNode value of IS field.

Returns:

BufferAudioSource - 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 BufferAudioSource

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 BufferAudioSource

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 BufferAudioSource

Returns:

value of length field

getLoad

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

Specified by:

getLoad in interface X3DUrlObject

Returns:

value of load field

setLoad

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

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

setLoad

public BufferAudioSource setLoad(SFBool newValue)

Assign typed object value to SFBool load field, similar to setLoad(boolean).

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

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 BufferAudioSource

Returns:

value of loop field

setLoop

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

Specified by:

setLoop in interface BufferAudioSource

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

setLoop

public BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource

Returns:

value of loopEnd field

setLoopEnd

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

Specified by:

setLoopEnd in interface BufferAudioSource

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

setLoopEnd

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setLoopEnd

public BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource

Returns:

value of loopStart field

setLoopStart

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

Specified by:

setLoopStart in interface BufferAudioSource

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

setLoopStart

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setLoopStart

public BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource

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:

• 
  
  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
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

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

Specified by:

setMetadata in interface BufferAudioSource

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

Specified by:

setMetadata in class X3DConcreteNode

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:

• 
  
  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
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public BufferAudioSource clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource

Returns:

value of numberOfChannels field

setNumberOfChannels

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

Specified by:

setNumberOfChannels in interface BufferAudioSource

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

setNumberOfChannels

public BufferAudioSource 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:

BufferAudioSource - 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 >= 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 BufferAudioSource

Specified by:

getPauseTime in interface X3DSoundSourceNode

Specified by:

getPauseTime in interface X3DTimeDependentNode

Returns:

value of pauseTime field

setPauseTime

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

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

setPauseTime

public BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource

Returns:

value of playbackRate field

setPlaybackRate

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

Specified by:

setPlaybackRate in interface BufferAudioSource

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

setPlaybackRate

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setPlaybackRate

public BufferAudioSource 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:

BufferAudioSource - 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 <= 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 BufferAudioSource

Specified by:

getResumeTime in interface X3DSoundSourceNode

Specified by:

getResumeTime in interface X3DTimeDependentNode

Returns:

value of resumeTime field

setResumeTime

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

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

setResumeTime

public BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource

Returns:

value of sampleRate field

setSampleRate

public 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

Specified by:

setSampleRate in interface BufferAudioSource

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

setSampleRate

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSampleRate

public BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource

Specified by:

getStartTime in interface X3DSoundSourceNode

Specified by:

getStartTime in interface X3DTimeDependentNode

Returns:

value of startTime field

setStartTime

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

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

setStartTime

public BufferAudioSource 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:

BufferAudioSource - 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 BufferAudioSource

Specified by:

getStopTime in interface X3DSoundSourceNode

Specified by:

getStopTime in interface X3DTimeDependentNode

Returns:

value of stopTime field

setStopTime

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

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

setStopTime

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUrl

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

Specified by:

getUrl in interface X3DUrlObject

Returns:

value of url field

getUrlList

public ArrayList<String> getUrlList()

Utility method to get ArrayList value of MFString url field, similar to getUrl().

Returns:

value of url field

getUrlString

public String getUrlString()

Utility method to get String value of MFString url field, similar to getUrl().

Returns:

value of url field

setUrl

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

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

setUrl

public BufferAudioSource setUrl(MFString newValue)

Assign typed object value to MFString url field, similar to setUrl(String[]).

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

setUrl

public BufferAudioSource setUrl(SFString newValue)

Assign single SFString object value to MFString url field, similar to setUrl(String[]).

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

setUrl

public BufferAudioSource setUrl(String newValue)

Assign singleton String value to MFString url field, similar to setUrl(String[]).

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

setUrl

public BufferAudioSource setUrl(ArrayList<String> newValue)

Assign ArrayList value of MFString url field, similar to setUrl(String[]).

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

clearUrl

public BufferAudioSource clearUrl()

Utility method to clear MFString value of url field. This method does not initialize withURL_DEFAULT_VALUE.

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addUrl

public BufferAudioSource addUrl(String newValue)

Add singleton String value to MFString url field.

Parameters:

newValue - is new value to add to the url field.

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

addUrl

public BufferAudioSource addUrl(SFString newValue)

Add singleton SFString value to MFString url field.

Parameters:

newValue - is new value to add to the url field.

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)

getDEF

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

• Hint: descriptive DEF names improve clarity and help document a model.
• Hint: well-defined names can simplify design and debugging through improved author understanding.
• Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final BufferAudioSource setDEF(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.

• Hint: descriptive DEF names improve clarity and help document a model.
• Hint: well-defined names can simplify design and debugging through improved author understanding.
• Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUSE

public 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 BufferAudioSource setUSE(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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final BufferAudioSource setCssClass(String newValue)

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

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getHtmlID

public String getHtmlID()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlID in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public final BufferAudioSource setHtmlID(String newValue)

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

Specified by:

setHtmlID in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

public BufferAudioSource setHtmlID(SFString newValue)

Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).

Parameters:

newValue - is new value for the id field.

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final BufferAudioSource setCssStyle(String newValue)

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

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public BufferAudioSource setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public BufferAudioSource setUSE(BufferAudioSource 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:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public BufferAudioSource addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public BufferAudioSource addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public BufferAudioSource addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

BufferAudioSource - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

public 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 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 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(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(String nameValue,
 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(String nameValue,
 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(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(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 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. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)