Package org.web3d.x3d.jsail.Sound

Class StreamAudioSource

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.Sound.StreamAudioSource

All Implemented Interfaces:

X3DChildNode, X3DNode, StreamAudioSource, X3DSoundNode, X3DSoundSourceNode, X3DTimeDependentNode

public class StreamAudioSource
extends X3DConcreteNode
implements StreamAudioSource

StreamAudioSource operates as an audio source whose media is received from a MediaStream obtained using the WebRTC or Media Capture and Streams APIs.

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. StreamAudioSource node tooltip: [X3DSoundSourceNode] StreamAudioSource operates as an audio source whose media is received from a MediaStream obtained using the WebRTC or Media Capture and Streams APIs. This media source might originate from a remote microphone or sound-processing channed provided by a remote peer on a WebRTC call.\.

• Hint: W3C Web Audio API https://www.w3.org/TR/webaudio/#mediastreamaudiosourcenode

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

Field Summary

Fields

Modifier and Type	Field	Description
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 StreamAudioSource 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 boolean	ENABLED_DEFAULT_VALUE	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
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_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_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_PAUSETIME	fromField ROUTE name for SFTime field named pauseTime.
static final String	fromField_RESUMETIME	fromField ROUTE name for SFTime field named resumeTime.
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_STREAMIDENTIFIER	fromField ROUTE name for SFString field named streamIdentifier.
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 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: StreamAudioSource.
static final double	PAUSETIME_DEFAULT_VALUE	SFTime field named pauseTime has default value 0 (Java syntax) or 0 (XML syntax).
static final double	RESUMETIME_DEFAULT_VALUE	SFTime field named resumeTime has default value 0 (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	STREAMIDENTIFIER_DEFAULT_VALUE	SFString field named streamIdentifier has default value equal to an empty string.
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_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_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_PAUSETIME	toField ROUTE name for SFTime field named pauseTime.
static final String	toField_RESUMETIME	toField ROUTE name for SFTime field named resumeTime.
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_STREAMIDENTIFIER	toField ROUTE name for SFString field named streamIdentifier.

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
StreamAudioSource()	Constructor for StreamAudioSource to initialize member variables with default values.
StreamAudioSource(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
StreamAudioSource	addComments(String newComment)	Add comment as String to contained commentsList.
StreamAudioSource	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
StreamAudioSource	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
StreamAudioSource	clearIS()	Utility method to clear SFNode value of IS field.
StreamAudioSource	clearMetadata()	Utility method to clear SFNode value of metadata 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.
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 StreamAudioSource 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.
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: StreamAudioSource
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.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
double	getPauseTime()	Provide double value in seconds from inputOutput SFTime field named pauseTime.
double	getResumeTime()	Provide double value in seconds from inputOutput SFTime field named resumeTime.
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	getStreamIdentifier()	Provide String value from inputOutput SFString field named streamIdentifier.
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.
StreamAudioSource	setChannelCountMode(String newValue)	Accessor method to assign String enumeration value ("MAX" | "CLAMPED_MAX" | "EXPLICIT") to inputOutput SFString field named channelCountMode.
StreamAudioSource	setChannelCountMode(SFString newValue)	Assign typed object value to SFString channelCountMode field, similar to setChannelCountMode(String).
StreamAudioSource	setChannelInterpretation(String newValue)	Accessor method to assign String enumeration value ("SPEAKERS" | "DISCRETE") to inputOutput SFString field named channelInterpretation.
StreamAudioSource	setChannelInterpretation(SFString newValue)	Assign typed object value to SFString channelInterpretation field, similar to setChannelInterpretation(String).
final StreamAudioSource	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
StreamAudioSource	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final StreamAudioSource	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
StreamAudioSource	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final StreamAudioSource	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
StreamAudioSource	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
StreamAudioSource	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
StreamAudioSource	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
StreamAudioSource	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
StreamAudioSource	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
StreamAudioSource	setGain(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setGain(float).
StreamAudioSource	setGain(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named gain.
StreamAudioSource	setGain(SFFloat newValue)	Assign typed object value to SFFloat gain field, similar to setGain(float).
final StreamAudioSource	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
StreamAudioSource	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
StreamAudioSource	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
StreamAudioSource	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
StreamAudioSource	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
StreamAudioSource	setPauseTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
StreamAudioSource	setPauseTime(SFTime newValue)	Assign typed object value to SFTime pauseTime field, similar to setPauseTime(double).
StreamAudioSource	setResumeTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
StreamAudioSource	setResumeTime(SFTime newValue)	Assign typed object value to SFTime resumeTime field, similar to setResumeTime(double).
StreamAudioSource	setStartTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.
StreamAudioSource	setStartTime(SFTime newValue)	Assign typed object value to SFTime startTime field, similar to setStartTime(double).
StreamAudioSource	setStopTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.
StreamAudioSource	setStopTime(SFTime newValue)	Assign typed object value to SFTime stopTime field, similar to setStopTime(double).
StreamAudioSource	setStreamIdentifier(String newValue)	Accessor method to assign String value to inputOutput SFString field named streamIdentifier.
StreamAudioSource	setStreamIdentifier(SFString newValue)	Assign typed object value to SFString streamIdentifier field, similar to setStreamIdentifier(String).
final StreamAudioSource	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
StreamAudioSource	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
StreamAudioSource	setUSE(StreamAudioSource 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: StreamAudioSource.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

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

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

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

METADATA_DEFAULT_VALUE

public static final X3DMetadataObject METADATA_DEFAULT_VALUE

SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).

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

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

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

STREAMIDENTIFIER_DEFAULT_VALUE

public static final String STREAMIDENTIFIER_DEFAULT_VALUE

SFString field named streamIdentifier has default value equal to an empty string.

See Also:

• Constant Field Values

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_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_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_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_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_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_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_STREAMIDENTIFIER

public static final String fromField_STREAMIDENTIFIER

fromField ROUTE name for SFString field named streamIdentifier.

See Also:

• Constant Field Values

toField_STREAMIDENTIFIER

public static final String toField_STREAMIDENTIFIER

toField ROUTE name for SFString field named streamIdentifier.

See Also:

• Constant Field Values

Constructor Details

StreamAudioSource

public StreamAudioSource()

Constructor for StreamAudioSource to initialize member variables with default values.

StreamAudioSource

public StreamAudioSource(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: StreamAudioSource

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the StreamAudioSource 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

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 StreamAudioSource

Returns:

value of channelCountMode field

setChannelCountMode

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

Parameters:

newValue - is new value for the channelCountMode field.

Returns:

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

setChannelCountMode

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

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

Returns:

value of channelInterpretation field

setChannelInterpretation

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

Parameters:

newValue - is new value for the channelInterpretation field.

Returns:

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

setChannelInterpretation

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

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

Specified by:

getDescription in interface X3DSoundNode

Specified by:

getDescription in interface X3DSoundSourceNode

Specified by:

getDescription in interface X3DTimeDependentNode

Returns:

value of description field

setDescription

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

Specified by:

setDescription in interface X3DSoundNode

Specified by:

setDescription in interface X3DSoundSourceNode

Specified by:

setDescription in interface X3DTimeDependentNode

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

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

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

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 StreamAudioSource

Specified by:

getEnabled in interface X3DSoundNode

Specified by:

getEnabled in interface X3DSoundSourceNode

Returns:

value of enabled field

setEnabled

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

Specified by:

setEnabled in interface X3DSoundNode

Specified by:

setEnabled in interface X3DSoundSourceNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

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

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

Specified by:

getGain in interface X3DSoundSourceNode

Returns:

value of gain field

setGain

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

Specified by:

setGain in interface X3DSoundSourceNode

Parameters:

newValue - is new value for the gain field.

Returns:

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

setGain

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

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

setGain

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

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

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

Utility method to clear SFNode value of IS field.

Returns:

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

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 StreamAudioSource

Specified by:

getIsPaused in interface X3DSoundSourceNode

Specified by:

getIsPaused in interface X3DTimeDependentNode

Returns:

value of isPaused field

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 StreamAudioSource

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

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:

StreamAudioSource - 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 StreamAudioSource clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

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

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 StreamAudioSource

Specified by:

getPauseTime in interface X3DSoundSourceNode

Specified by:

getPauseTime in interface X3DTimeDependentNode

Returns:

value of pauseTime field

setPauseTime

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

Specified by:

setPauseTime in interface X3DSoundSourceNode

Specified by:

setPauseTime in interface X3DTimeDependentNode

Parameters:

newValue - is new value for the pauseTime field.

Returns:

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

setPauseTime

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

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

Specified by:

getResumeTime in interface X3DSoundSourceNode

Specified by:

getResumeTime in interface X3DTimeDependentNode

Returns:

value of resumeTime field

setResumeTime

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

Specified by:

setResumeTime in interface X3DSoundSourceNode

Specified by:

setResumeTime in interface X3DTimeDependentNode

Parameters:

newValue - is new value for the resumeTime field.

Returns:

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

setResumeTime

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

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

Specified by:

getStartTime in interface X3DSoundSourceNode

Specified by:

getStartTime in interface X3DTimeDependentNode

Returns:

value of startTime field

setStartTime

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

Specified by:

setStartTime in interface X3DSoundSourceNode

Specified by:

setStartTime in interface X3DTimeDependentNode

Parameters:

newValue - is new value for the startTime field.

Returns:

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

setStartTime

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

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

Specified by:

getStopTime in interface X3DSoundSourceNode

Specified by:

getStopTime in interface X3DTimeDependentNode

Returns:

value of stopTime field

setStopTime

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

Specified by:

setStopTime in interface X3DSoundSourceNode

Specified by:

setStopTime in interface X3DTimeDependentNode

Parameters:

newValue - is new value for the stopTime field.

Returns:

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

setStopTime

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

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

getStreamIdentifier

public String getStreamIdentifier()

Provide String value from inputOutput SFString field named streamIdentifier.

Tooltip: Stream identification TBD

• Hint: W3C Media Capture and Streams https://www.w3.org/TR/mediacapture-streams

Specified by:

getStreamIdentifier in interface StreamAudioSource

Returns:

value of streamIdentifier field

setStreamIdentifier

public StreamAudioSource setStreamIdentifier(String newValue)

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

Tooltip: Stream identification TBD

• Hint: W3C Media Capture and Streams https://www.w3.org/TR/mediacapture-streams

Specified by:

setStreamIdentifier in interface StreamAudioSource

Parameters:

newValue - is new value for the streamIdentifier field.

Returns:

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

setStreamIdentifier

public StreamAudioSource setStreamIdentifier(SFString newValue)

Assign typed object value to SFString streamIdentifier field, similar to setStreamIdentifier(String).

Parameters:

newValue - is new value for the streamIdentifier field.

Returns:

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

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

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

setDEF

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

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

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

setUSE

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

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

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

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

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

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

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

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

setUSE

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

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

addComments

public StreamAudioSource addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

StreamAudioSource - 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 StreamAudioSource addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public StreamAudioSource addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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