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
,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.
X3D node tooltip: (X3D version 4.0 draft) [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.\.
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.
X3D node tooltip: (X3D version 4.0 draft) [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.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CHANNELCOUNTMODE_CLAMPED_MAX
SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "clamped-max" (Java syntax) or clamped-max (XML syntax).static java.lang.String
CHANNELCOUNTMODE_DEFAULT_VALUE
SFString field named channelCountMode has default value "max" (Java syntax) or max (XML syntax).static java.lang.String
CHANNELCOUNTMODE_EXPLICIT
SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "explicit" (Java syntax) or explicit (XML syntax).static java.lang.String
CHANNELCOUNTMODE_MAX
SFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "max" (Java syntax) or max (XML syntax).static java.lang.String
CHANNELINTERPRETATION_DEFAULT_VALUE
SFString field named channelInterpretation has default value "speakers" (Java syntax) or speakers (XML syntax).static java.lang.String
CHANNELINTERPRETATION_DISCRETE
SFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "discrete" (Java syntax) or discrete (XML syntax).static java.lang.String
CHANNELINTERPRETATION_SPEAKERS
SFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "speakers" (Java syntax) or speakers (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the StreamAudioSource element: Soundstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static java.lang.String
DESCRIPTION_DEFAULT_VALUE
SFString field named description has default value equal to an empty string.static boolean
ENABLED_DEFAULT_VALUE
SFBool field named enabled has default value true (Java syntax) or true (XML syntax).static java.lang.String
fromField_CHANNELCOUNT
fromField ROUTE name for SFInt32 field named channelCount.static java.lang.String
fromField_CHANNELCOUNTMODE
fromField ROUTE name for SFString field named channelCountMode.static java.lang.String
fromField_CHANNELINTERPRETATION
fromField ROUTE name for SFString field named channelInterpretation.static java.lang.String
fromField_DESCRIPTION
fromField ROUTE name for SFString field named description.static java.lang.String
fromField_ELAPSEDTIME
fromField ROUTE name for SFTime field named elapsedTime.static java.lang.String
fromField_ENABLED
fromField ROUTE name for SFBool field named enabled.static java.lang.String
fromField_GAIN
fromField ROUTE name for SFFloat field named gain.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_ISACTIVE
fromField ROUTE name for SFBool field named isActive.static java.lang.String
fromField_ISPAUSED
fromField ROUTE name for SFBool field named isPaused.static java.lang.String
fromField_LENGTH
fromField ROUTE name for SFInt32 field named length.static java.lang.String
fromField_MEDIASTREAM
fromField ROUTE name for MFFloat field named mediaStream.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_PAUSETIME
fromField ROUTE name for SFTime field named pauseTime.static java.lang.String
fromField_RESUMETIME
fromField ROUTE name for SFTime field named resumeTime.static java.lang.String
fromField_STARTTIME
fromField ROUTE name for SFTime field named startTime.static java.lang.String
fromField_STOPTIME
fromField ROUTE name for SFTime field named stopTime.static float
GAIN_DEFAULT_VALUE
SFFloat field named gain has default value 1f (Java syntax) or 1 (XML syntax).static IS
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D Sound component level for this element: 2static java.util.ArrayList<java.lang.Float>
MEDIASTREAM_DEFAULT_VALUE
MFFloat field named mediaStream has default value equal to an empty list.static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: StreamAudioSource.static double
PAUSETIME_DEFAULT_VALUE
SFTime field named pauseTime has default value 0 (Java syntax) or 0 (XML syntax).static double
RESUMETIME_DEFAULT_VALUE
SFTime field named resumeTime has default value 0 (Java syntax) or 0 (XML syntax).static double
STARTTIME_DEFAULT_VALUE
SFTime field named startTime has default value 0 (Java syntax) or 0 (XML syntax).static double
STOPTIME_DEFAULT_VALUE
SFTime field named stopTime has default value 0 (Java syntax) or 0 (XML syntax).static java.lang.String
toField_CHANNELCOUNTMODE
toField ROUTE name for SFString field named channelCountMode.static java.lang.String
toField_CHANNELINTERPRETATION
toField ROUTE name for SFString field named channelInterpretation.static java.lang.String
toField_DESCRIPTION
toField ROUTE name for SFString field named description.static java.lang.String
toField_ENABLED
toField ROUTE name for SFBool field named enabled.static java.lang.String
toField_GAIN
toField ROUTE name for SFFloat field named gain.static java.lang.String
toField_MEDIASTREAM
toField ROUTE name for MFFloat field named mediaStream.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_PAUSETIME
toField ROUTE name for SFTime field named pauseTime.static java.lang.String
toField_RESUMETIME
toField ROUTE name for SFTime field named resumeTime.static java.lang.String
toField_STARTTIME
toField ROUTE name for SFTime field named startTime.static java.lang.String
toField_STOPTIME
toField ROUTE name for SFTime field named stopTime.Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description StreamAudioSource()
Constructor for StreamAudioSource to initialize member variables with default values.StreamAudioSource(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description StreamAudioSource
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.StreamAudioSource
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.StreamAudioSource
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.StreamAudioSource
addMediaStream(float newValue)
Add singleton float value to MFFloat mediaStream field.StreamAudioSource
addMediaStream(SFFloat newValue)
Add singleton SFFloat value to MFFloat mediaStream field.StreamAudioSource
clearIS()
Utility method to clear SFNode value of IS field.StreamAudioSource
clearMediaStream()
Utility method to clear MFFloat value of mediaStream field.StreamAudioSource
clearMetadata()
Utility method to clear SFNode value of metadata field.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteNode
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.int
getChannelCount()
Provide int value from outputOnly SFInt32 field named channelCount.java.lang.String
getChannelCountMode()
Provide String enumeration value (baseType SFString) ["max" | "clamped-max" | "explicit"] from inputOutput SFString field named channelCountMode.java.lang.String
getChannelInterpretation()
Provide String enumeration value (baseType SFString) ["speakers" | "discrete"] from inputOutput SFString field named channelInterpretation.java.lang.String
getComponent()
Defines X3D component for the StreamAudioSource element: Soundint
getComponentLevel()
Provides default X3D component level for this element: 2java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.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.java.lang.String
getElementName()
Provides name of this element: StreamAudioSourceboolean
getEnabled()
Provide boolean value from inputOutput SFBool field named enabled.java.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.float
getGain()
Provide float value from inputOutput SFFloat field named gain.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.float[]
getMediaStream()
Provide array of Float results within allowed range of [-1,1] from inputOutput MFFloat field named mediaStream.java.util.ArrayList<java.lang.Float>
getMediaStreamList()
Utility method to get ArrayList value of MFFloat mediaStream field, similar togetMediaStream()
.java.lang.String
getMediaStreamString()
Utility method to get String value of MFFloat mediaStream field, similar togetMediaStream()
.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.java.lang.String
getUSE()
Provide String value from inputOutput SFString field named USE.boolean
hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.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(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.void
initialize()
Initialize all member variables to default values.StreamAudioSource
setChannelCountMode(java.lang.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 tosetChannelCountMode(String)
.StreamAudioSource
setChannelInterpretation(java.lang.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 tosetChannelInterpretation(String)
.StreamAudioSource
setCssClass(java.lang.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 tosetCssClass(String)
.StreamAudioSource
setDEF(java.lang.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 tosetDEF(String)
.StreamAudioSource
setDescription(java.lang.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 tosetDescription(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 tosetEnabled(boolean)
.StreamAudioSource
setGain(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetGain(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 tosetGain(float)
.StreamAudioSource
setIS(IS newValue)
Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.StreamAudioSource
setMediaStream(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetMediaStream(float[])
.StreamAudioSource
setMediaStream(float[] newValue)
Accessor method to assign Float array to inputOutput MFFloat field named mediaStream.StreamAudioSource
setMediaStream(int[] newValue)
Assign floating-point array value of MFFloat mediaStream field, similar tosetMediaStream(float[])
.StreamAudioSource
setMediaStream(java.util.ArrayList<java.lang.Float> newValue)
Assign ArrayList value of MFFloat mediaStream field, similar tosetMediaStream(float[])
.StreamAudioSource
setMediaStream(MFFloat newValue)
Assign typed object value to MFFloat mediaStream field, similar tosetMediaStream(float[])
.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 tosetPauseTime(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 tosetResumeTime(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 tosetStartTime(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 tosetStopTime(double)
.StreamAudioSource
setUSE(java.lang.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 tosetUSE(String)
.StreamAudioSource
setUSE(StreamAudioSource DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.String
validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, 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, setParent, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
CHANNELCOUNTMODE_MAX
public static final java.lang.String CHANNELCOUNTMODE_MAXSFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "max" (Java syntax) or max (XML syntax). -
CHANNELCOUNTMODE_CLAMPED_MAX
public static final java.lang.String CHANNELCOUNTMODE_CLAMPED_MAXSFString 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). -
CHANNELCOUNTMODE_EXPLICIT
public static final java.lang.String CHANNELCOUNTMODE_EXPLICITSFString field named channelCountMode with X3DUOM simpleType channelCountModeChoices and with X3DUOM baseType SFString can equal this value "explicit" (Java syntax) or explicit (XML syntax). -
CHANNELINTERPRETATION_SPEAKERS
public static final java.lang.String CHANNELINTERPRETATION_SPEAKERSSFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "speakers" (Java syntax) or speakers (XML syntax). -
CHANNELINTERPRETATION_DISCRETE
public static final java.lang.String CHANNELINTERPRETATION_DISCRETESFString field named channelInterpretation with X3DUOM simpleType channelInterpretationChoices and with X3DUOM baseType SFString can equal this value "discrete" (Java syntax) or discrete (XML syntax). -
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: StreamAudioSource.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the StreamAudioSource element: Sound- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D Sound component level for this element: 2- See Also:
- Constant Field Values
-
CHANNELCOUNTMODE_DEFAULT_VALUE
public static final java.lang.String CHANNELCOUNTMODE_DEFAULT_VALUESFString field named channelCountMode has default value "max" (Java syntax) or max (XML syntax).- See Also:
- Constant Field Values
-
CHANNELINTERPRETATION_DEFAULT_VALUE
public static final java.lang.String CHANNELINTERPRETATION_DEFAULT_VALUESFString field named channelInterpretation has default value "speakers" (Java syntax) or speakers (XML syntax).- See Also:
- Constant Field Values
-
DESCRIPTION_DEFAULT_VALUE
public static final java.lang.String DESCRIPTION_DEFAULT_VALUESFString 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_VALUESFBool 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_VALUESFFloat field named gain has default value 1f (Java syntax) or 1 (XML syntax).- See Also:
- Constant Field Values
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
MEDIASTREAM_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.Float> MEDIASTREAM_DEFAULT_VALUEMFFloat field named mediaStream has default value equal to an empty list. -
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_VALUESFTime 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_VALUESFTime 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_VALUESFTime 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_VALUESFTime field named stopTime has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
containerField_DEFAULT_VALUE
public static final java.lang.String containerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes. -
fromField_CHANNELCOUNT
public static final java.lang.String fromField_CHANNELCOUNTfromField ROUTE name for SFInt32 field named channelCount.- See Also:
- Constant Field Values
-
fromField_CHANNELCOUNTMODE
public static final java.lang.String fromField_CHANNELCOUNTMODEfromField ROUTE name for SFString field named channelCountMode.- See Also:
- Constant Field Values
-
toField_CHANNELCOUNTMODE
public static final java.lang.String toField_CHANNELCOUNTMODEtoField ROUTE name for SFString field named channelCountMode.- See Also:
- Constant Field Values
-
fromField_CHANNELINTERPRETATION
public static final java.lang.String fromField_CHANNELINTERPRETATIONfromField ROUTE name for SFString field named channelInterpretation.- See Also:
- Constant Field Values
-
toField_CHANNELINTERPRETATION
public static final java.lang.String toField_CHANNELINTERPRETATIONtoField ROUTE name for SFString field named channelInterpretation.- See Also:
- Constant Field Values
-
fromField_DESCRIPTION
public static final java.lang.String fromField_DESCRIPTIONfromField ROUTE name for SFString field named description.- See Also:
- Constant Field Values
-
toField_DESCRIPTION
public static final java.lang.String toField_DESCRIPTIONtoField ROUTE name for SFString field named description.- See Also:
- Constant Field Values
-
fromField_ELAPSEDTIME
public static final java.lang.String fromField_ELAPSEDTIMEfromField ROUTE name for SFTime field named elapsedTime.- See Also:
- Constant Field Values
-
fromField_ENABLED
public static final java.lang.String fromField_ENABLEDfromField ROUTE name for SFBool field named enabled.- See Also:
- Constant Field Values
-
toField_ENABLED
public static final java.lang.String toField_ENABLEDtoField ROUTE name for SFBool field named enabled.- See Also:
- Constant Field Values
-
fromField_GAIN
public static final java.lang.String fromField_GAINfromField ROUTE name for SFFloat field named gain.- See Also:
- Constant Field Values
-
toField_GAIN
public static final java.lang.String toField_GAINtoField ROUTE name for SFFloat field named gain.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_ISACTIVE
public static final java.lang.String fromField_ISACTIVEfromField ROUTE name for SFBool field named isActive.- See Also:
- Constant Field Values
-
fromField_ISPAUSED
public static final java.lang.String fromField_ISPAUSEDfromField ROUTE name for SFBool field named isPaused.- See Also:
- Constant Field Values
-
fromField_LENGTH
public static final java.lang.String fromField_LENGTHfromField ROUTE name for SFInt32 field named length.- See Also:
- Constant Field Values
-
fromField_MEDIASTREAM
public static final java.lang.String fromField_MEDIASTREAMfromField ROUTE name for MFFloat field named mediaStream.- See Also:
- Constant Field Values
-
toField_MEDIASTREAM
public static final java.lang.String toField_MEDIASTREAMtoField ROUTE name for MFFloat field named mediaStream.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_PAUSETIME
public static final java.lang.String fromField_PAUSETIMEfromField ROUTE name for SFTime field named pauseTime.- See Also:
- Constant Field Values
-
toField_PAUSETIME
public static final java.lang.String toField_PAUSETIMEtoField ROUTE name for SFTime field named pauseTime.- See Also:
- Constant Field Values
-
fromField_RESUMETIME
public static final java.lang.String fromField_RESUMETIMEfromField ROUTE name for SFTime field named resumeTime.- See Also:
- Constant Field Values
-
toField_RESUMETIME
public static final java.lang.String toField_RESUMETIMEtoField ROUTE name for SFTime field named resumeTime.- See Also:
- Constant Field Values
-
fromField_STARTTIME
public static final java.lang.String fromField_STARTTIMEfromField ROUTE name for SFTime field named startTime.- See Also:
- Constant Field Values
-
toField_STARTTIME
public static final java.lang.String toField_STARTTIMEtoField ROUTE name for SFTime field named startTime.- See Also:
- Constant Field Values
-
fromField_STOPTIME
public static final java.lang.String fromField_STOPTIMEfromField ROUTE name for SFTime field named stopTime.- See Also:
- Constant Field Values
-
toField_STOPTIME
public static final java.lang.String toField_STOPTIMEtoField ROUTE name for SFTime field named stopTime.- See Also:
- Constant Field Values
-
-
Constructor Details
-
StreamAudioSource
public StreamAudioSource()Constructor for StreamAudioSource to initialize member variables with default values. -
StreamAudioSource
public StreamAudioSource(java.lang.String DEFlabel)Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
-
Method Details
-
getElementName
public final java.lang.String getElementName()Provides name of this element: StreamAudioSource- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the StreamAudioSource element: Sound- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 2- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
-
getAccessType
public java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
getContainerFieldDefault
public final java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
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 interfaceStreamAudioSource
- Returns:
- value of channelCount field
-
getChannelCountMode
public java.lang.String getChannelCountMode()Provide String enumeration value (baseType SFString) ["max" | "clamped-max" | "explicit"] from inputOutput SFString field named channelCountMode.
Tooltip: channelCountMode determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.- 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 interfaceStreamAudioSource
- Returns:
- value of channelCountMode field
-
setChannelCountMode
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 interfaceStreamAudioSource
- 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
Assign typed object value to SFString channelCountMode field, similar tosetChannelCountMode(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 java.lang.String getChannelInterpretation()Provide String enumeration value (baseType SFString) ["speakers" | "discrete"] from inputOutput SFString field named channelInterpretation.
Tooltip: channelInterpretation determines how individual channels are treated when up-mixing and down-mixing connections to any inputs.- 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 interfaceStreamAudioSource
- Returns:
- value of channelInterpretation field
-
setChannelInterpretation
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 interfaceStreamAudioSource
- 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
Assign typed object value to SFString channelInterpretation field, similar tosetChannelInterpretation(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 java.lang.String getDescription()Provide String value from inputOutput SFString field named description.
Tooltip: Author-provided prose that describes intended purpose of the url asset.- Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).
- Specified by:
getDescription
in interfaceStreamAudioSource
- Specified by:
getDescription
in interfaceX3DSoundSourceNode
- Specified by:
getDescription
in interfaceX3DTimeDependentNode
- Returns:
- value of description field
-
setDescription
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 interfaceStreamAudioSource
- Specified by:
setDescription
in interfaceX3DSoundSourceNode
- Specified by:
setDescription
in interfaceX3DTimeDependentNode
- 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
Assign typed object value to SFString description field, similar tosetDescription(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 interfaceStreamAudioSource
- Specified by:
getElapsedTime
in interfaceX3DSoundSourceNode
- Specified by:
getElapsedTime
in interfaceX3DTimeDependentNode
- 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 interfaceStreamAudioSource
- Specified by:
getEnabled
in interfaceX3DSoundSourceNode
- Returns:
- value of enabled field
-
setEnabled
Accessor method to assign boolean value to inputOutput SFBool field named enabled.
Tooltip: Enables/disables node operation. *- Specified by:
setEnabled
in interfaceStreamAudioSource
- Specified by:
setEnabled
in interfaceX3DSoundSourceNode
- 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
Assign typed object value to SFBool enabled field, similar tosetEnabled(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 interfaceStreamAudioSource
- Specified by:
getGain
in interfaceX3DSoundSourceNode
- Returns:
- value of gain field
-
setGain
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 interfaceStreamAudioSource
- Specified by:
setGain
in interfaceX3DSoundSourceNode
- 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
Assign typed object value to SFFloat gain field, similar tosetGain(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
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetGain(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
Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- 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
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 interfaceStreamAudioSource
- Specified by:
getIsActive
in interfaceX3DSoundSourceNode
- Specified by:
getIsActive
in interfaceX3DTimeDependentNode
- 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 interfaceStreamAudioSource
- Specified by:
getIsPaused
in interfaceX3DSoundSourceNode
- Specified by:
getIsPaused
in interfaceX3DTimeDependentNode
- 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 interfaceStreamAudioSource
- Returns:
- value of length field
-
getMediaStream
public float[] getMediaStream()Provide array of Float results within allowed range of [-1,1] from inputOutput MFFloat field named mediaStream.- Specified by:
getMediaStream
in interfaceStreamAudioSource
- Returns:
- value of mediaStream field
-
getMediaStreamList
public java.util.ArrayList<java.lang.Float> getMediaStreamList()Utility method to get ArrayList value of MFFloat mediaStream field, similar togetMediaStream()
.- Returns:
- value of mediaStream field
-
getMediaStreamString
public java.lang.String getMediaStreamString()Utility method to get String value of MFFloat mediaStream field, similar togetMediaStream()
.- Returns:
- value of mediaStream field
-
setMediaStream
Accessor method to assign Float array to inputOutput MFFloat field named mediaStream.- Specified by:
setMediaStream
in interfaceStreamAudioSource
- Parameters:
newValue
- is new value for the mediaStream field.- Returns:
StreamAudioSource
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMediaStream
Assign typed object value to MFFloat mediaStream field, similar tosetMediaStream(float[])
.- Parameters:
newValue
- is new value for the mediaStream field.- Returns:
StreamAudioSource
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMediaStream
Assign ArrayList value of MFFloat mediaStream field, similar tosetMediaStream(float[])
.- Parameters:
newValue
- is new value for the mediaStream field.- Returns:
StreamAudioSource
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearMediaStream
Utility method to clear MFFloat value of mediaStream field.- Returns:
StreamAudioSource
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMediaStream
Assign floating-point array value of MFFloat mediaStream field, similar tosetMediaStream(float[])
.- Parameters:
newValue
- is new value for the mediaStream field.- Returns:
StreamAudioSource
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addMediaStream
Add singleton float value to MFFloat mediaStream field.- Parameters:
newValue
- is new value to add to the mediaStream field.- Returns:
StreamAudioSource
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addMediaStream
Add singleton SFFloat value to MFFloat mediaStream field.- Parameters:
newValue
- is new value to add to the mediaStream field.- Returns:
StreamAudioSource
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMediaStream
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetMediaStream(float[])
.- Parameters:
newArray
- 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).
-
getMetadata
Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceStreamAudioSource
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DSoundSourceNode
- Specified by:
getMetadata
in interfaceX3DTimeDependentNode
- Returns:
- value of metadata field
- See Also:
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
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 interfaceStreamAudioSource
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DSoundSourceNode
- Specified by:
setMetadata
in interfaceX3DTimeDependentNode
- Specified by:
setMetadata
in classX3DConcreteNode
- 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/X3Dv4Draft/ISO-IEC19775-1v4-WD2/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
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
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- 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 interfaceStreamAudioSource
- Specified by:
getPauseTime
in interfaceX3DSoundSourceNode
- Specified by:
getPauseTime
in interfaceX3DTimeDependentNode
- Returns:
- value of pauseTime field
-
setPauseTime
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 interfaceStreamAudioSource
- Specified by:
setPauseTime
in interfaceX3DSoundSourceNode
- Specified by:
setPauseTime
in interfaceX3DTimeDependentNode
- 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
Assign typed object value to SFTime pauseTime field, similar tosetPauseTime(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 interfaceStreamAudioSource
- Specified by:
getResumeTime
in interfaceX3DSoundSourceNode
- Specified by:
getResumeTime
in interfaceX3DTimeDependentNode
- Returns:
- value of resumeTime field
-
setResumeTime
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 interfaceStreamAudioSource
- Specified by:
setResumeTime
in interfaceX3DSoundSourceNode
- Specified by:
setResumeTime
in interfaceX3DTimeDependentNode
- 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
Assign typed object value to SFTime resumeTime field, similar tosetResumeTime(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 interfaceStreamAudioSource
- Specified by:
getStartTime
in interfaceX3DSoundSourceNode
- Specified by:
getStartTime
in interfaceX3DTimeDependentNode
- Returns:
- value of startTime field
-
setStartTime
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 interfaceStreamAudioSource
- Specified by:
setStartTime
in interfaceX3DSoundSourceNode
- Specified by:
setStartTime
in interfaceX3DTimeDependentNode
- 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
Assign typed object value to SFTime startTime field, similar tosetStartTime(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 interfaceStreamAudioSource
- Specified by:
getStopTime
in interfaceX3DSoundSourceNode
- Specified by:
getStopTime
in interfaceX3DTimeDependentNode
- Returns:
- value of stopTime field
-
setStopTime
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 interfaceStreamAudioSource
- Specified by:
setStopTime
in interfaceX3DSoundSourceNode
- Specified by:
setStopTime
in interfaceX3DTimeDependentNode
- 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
Assign typed object value to SFTime stopTime field, similar tosetStopTime(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).
-
getDEF
public java.lang.String getDEF()Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- 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 classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
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 classX3DConcreteNode
- 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
Assign typed object value to SFString DEF field, similar tosetDEF(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 java.lang.String getUSE()Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- 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
Assign typed object value to SFString USE field, similar tosetUSE(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 java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by Cascading Style Sheets (CSS) and XML stylesheets.- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- 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:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(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).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
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
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
StreamAudioSource
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
StreamAudioSource
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- 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 java.lang.String toStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3D.FILE_EXTENSION_X3D
,X3D.FILE_EXTENSION_XML
,X3D.toStringXML()
,X3D.toFileXML(String)
,X3D.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
X3D.FILE_EXTENSION_CLASSICVRML
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
-
toStringVRML97
public java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- 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
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 classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorScene()
,X3DConcreteElement.findAncestorX3D()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorScene() to check entire scene graph, or findAncestorX3D() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorScene()
,X3DConcreteElement.findAncestorX3D()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
findElementByNameValue(String, String)
-
findNodeByDEF
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 classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorScene()
,X3DConcreteElement.findAncestorX3D()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
findNodeByDEF(String)
-
validate
public java.lang.String validate()Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-