Package org.web3d.x3d.sai.Sound

Interface Analyser

All Superinterfaces:

X3DChildNode, X3DNode, X3DSoundNode, X3DSoundProcessingNode, X3DTimeDependentNode

All Known Implementing Classes:

Analyser

public interface Analyser
extends X3DSoundProcessingNode

Analyser provides real-time frequency and time-domain analysis information, without any change to the input.

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. Analyser node tooltip: [X3DSoundProcessingNode] Analyser provides real-time frequency and time-domain analysis information, without any change to the input.

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

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

See Also:

• SAI Java Specification
• X3D Abstract Specification: Analyser
• X3D Tooltips: Analyser
• X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method	Description
void	addChildren(X3DNode[] newValue)	Add array of children nodes to array of existing nodes (if any).
int	getChannelCount()	Provide int value from outputOnly SFInt32 field named channelCount.
String	getChannelCountMode()	Provide String enumeration value (baseType SFString) ["MAX" | "CLAMPED_MAX" | "EXPLICIT"] from inputOutput SFString field named channelCountMode.
String	getChannelInterpretation()	Provide String enumeration value (baseType SFString) ["SPEAKERS" | "DISCRETE"] from inputOutput SFString field named channelInterpretation.
X3DNode[]	getChildren()	Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper, from inputOutput MFNode field children.
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.
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
int	getFftSize()	Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named fftSize.
int	getFrequencyBinCount()	Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named frequencyBinCount.
float	getGain()	Provide float value from inputOutput SFFloat field named gain.
boolean	getIsActive()	Provide boolean value from outputOnly SFBool field named isActive.
boolean	getIsPaused()	Provide boolean value from outputOnly SFBool field named isPaused.
float	getMaxDecibels()	Provide float value from inputOutput SFFloat field named maxDecibels.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float	getMinDecibels()	Provide float value from inputOutput SFFloat field named minDecibels.
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.
float	getSmoothingTimeConstant()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named smoothingTimeConstant.
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.
double	getTailTime()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named tailTime.
Analyser	setChannelCountMode(String newValue)	Accessor method to assign String enumeration value ("MAX" | "CLAMPED_MAX" | "EXPLICIT") to inputOutput SFString field named channelCountMode.
Analyser	setChannelInterpretation(String newValue)	Accessor method to assign String enumeration value ("SPEAKERS" | "DISCRETE") to inputOutput SFString field named channelInterpretation.
void	setChildren(X3DNode newValue)	Set single children node, replacing prior array of existing nodes (if any).
Analyser	setChildren(X3DNode[] newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.
Analyser	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
Analyser	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
Analyser	setFftSize(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named fftSize.
Analyser	setFrequencyBinCount(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named frequencyBinCount.
Analyser	setGain(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named gain.
Analyser	setMaxDecibels(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named maxDecibels.
Analyser	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Analyser	setMinDecibels(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named minDecibels.
Analyser	setPauseTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named pauseTime.
Analyser	setResumeTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named resumeTime.
Analyser	setSmoothingTimeConstant(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named smoothingTimeConstant.
Analyser	setStartTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named startTime.
Analyser	setStopTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named stopTime.
Analyser	setTailTime(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named tailTime.

Method Details

getChannelCount

int getChannelCount()

Provide int value from outputOnly SFInt32 field named channelCount.

Tooltip: [0,+infinity) channelCount reports number of channels provided by input nodes.

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

Specified by:

getChannelCount in interface X3DSoundProcessingNode

Returns:

value of channelCount field

getChannelCountMode

String getChannelCountMode()

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

Tooltip: channelCountMode determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.

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

Specified by:

getChannelCountMode in interface X3DSoundProcessingNode

Returns:

value of channelCountMode field

setChannelCountMode

Analyser setChannelCountMode(String newValue)

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

Tooltip: channelCountMode determines how individual channels are counted when up-mixing and down-mixing connections to any inputs.

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

Specified by:

setChannelCountMode in interface X3DSoundProcessingNode

Parameters:

newValue - is new value for the channelCountMode field.

Returns:

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

getChannelInterpretation

String getChannelInterpretation()

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

Tooltip: channelInterpretation determines how individual channels are treated when up-mixing and down-mixing connections to any inputs.

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

Specified by:

getChannelInterpretation in interface X3DSoundProcessingNode

Returns:

value of channelInterpretation field

setChannelInterpretation

Analyser setChannelInterpretation(String newValue)

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

Tooltip: channelInterpretation determines how individual channels are treated when up-mixing and down-mixing connections to any inputs.

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

Specified by:

setChannelInterpretation in interface X3DSoundProcessingNode

Parameters:

newValue - is new value for the channelInterpretation field.

Returns:

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

getChildren

X3DNode[] getChildren()

Provide array of org.web3d.x3d.sai.Core.X3DNode results (using an array consisting of properly typed nodes or ProtoInstances) with acceptable node types limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper, from inputOutput MFNode field children.

Tooltip: [X3DSoundChannelNode|X3DSoundProcessingNode|X3DSoundSourceNode] The children field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputs children field, all channels are mixed together and merged prior to presentation.

• Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to override otherwise-incorrect defaults.
• Hint: can be original (DEF) or referenced (USE) nodes.

Warning: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.

Returns:

value of children field

See Also:

• Analyser
• AudioClip
• AudioDestination
• BiquadFilter
• BufferAudioSource
• ChannelMerger
• ChannelSelector
• ChannelSplitter
• Convolver
• Delay
• DynamicsCompressor
• Gain
• ListenerPointSource
• MicrophoneSource
• MovieTexture
• OscillatorSource
• Sound
• SpatialSound
• StreamAudioDestination
• StreamAudioSource
• WaveShaper

setChildren

Analyser setChildren(X3DNode[] newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DNode array (using an array consisting of properly typed nodes or ProtoInstances) to inputOutput MFNode field children.

Tooltip: [X3DSoundChannelNode|X3DSoundProcessingNode|X3DSoundSourceNode] The children field specifies audio-graph sound sources providing input signals for this node. If multiple input signals are provided by the inputs children field, all channels are mixed together and merged prior to presentation.

• Warning: contained AudioClip or MovieTexture nodes must have containerField='children' to override otherwise-incorrect defaults.
• Hint: can be original (DEF) or referenced (USE) nodes.

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.

Parameters:

newValue - is new value for the children field.

Returns:

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

addChildren

void addChildren(X3DNode[] newValue)

Add array of children nodes to array of existing nodes (if any).

Note: according to X3D Unified Object Model (X3DUOM), acceptable node types are limited to Analyser|AudioClip|AudioDestination|BiquadFilter|BufferAudioSource|ChannelMerger|ChannelSelector|ChannelSplitter|Convolver|Delay|DynamicsCompressor|Gain|ListenerPointSource|MicrophoneSource|MovieTexture|OscillatorSource|Sound|SpatialSound|StreamAudioDestination|StreamAudioSource|WaveShaper.

Parameters:

newValue - is new value array to be appended the children field.

setChildren

void setChildren(X3DNode newValue)

Set single children node, replacing prior array of existing nodes (if any).

Parameters:

newValue - is new node for the children field

getDescription

String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the url asset.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

getDescription in interface X3DSoundNode

Specified by:

getDescription in interface X3DSoundProcessingNode

Specified by:

getDescription in interface X3DTimeDependentNode

Returns:

value of description field

setDescription

Analyser setDescription(String newValue)

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

Tooltip: Author-provided prose that describes intended purpose of the url asset.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

setDescription in interface X3DSoundNode

Specified by:

setDescription in interface X3DSoundProcessingNode

Specified by:

setDescription in interface X3DTimeDependentNode

Parameters:

newValue - is new value for the description field.

Returns:

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

getElapsedTime

double getElapsedTime()

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

Tooltip: [0,+infinity) Current elapsed time since AudioClip activated/running, cumulative in seconds, and not counting any paused time.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
• Hint: elapsedTime is a nonnegative SFTime duration interval, not an absolute clock time.

Specified by:

getElapsedTime in interface X3DSoundProcessingNode

Specified by:

getElapsedTime in interface X3DTimeDependentNode

Returns:

value of elapsedTime field

getEnabled

boolean getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

Tooltip: Enables/disables node operation. *

Specified by:

getEnabled in interface X3DSoundNode

Specified by:

getEnabled in interface X3DSoundProcessingNode

Returns:

value of enabled field

setEnabled

Analyser setEnabled(boolean newValue)

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

Tooltip: Enables/disables node operation. *

Specified by:

setEnabled in interface X3DSoundNode

Specified by:

setEnabled in interface X3DSoundProcessingNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

getFftSize

int getFftSize()

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

Tooltip: (0,+infinity) fftSize represents size of Fast Fourier Transform (FFT) used to determine frequency domain.

• Hint: Fast Fourier Transform (FFT) https://en.wikipedia.org/wiki/Fast_Fourier_transform

Returns:

value of fftSize field

setFftSize

Analyser setFftSize(int newValue)

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

Tooltip: (0,+infinity) fftSize represents size of Fast Fourier Transform (FFT) used to determine frequency domain.

• Hint: Fast Fourier Transform (FFT) https://en.wikipedia.org/wiki/Fast_Fourier_transform

Parameters:

newValue - is new value for the fftSize field.

Returns:

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

getFrequencyBinCount

int getFrequencyBinCount()

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

Tooltip: (0,+infinity) frequencyBinCount is half of fftSize and generally equates to number of data values available for the visualization. *

Returns:

value of frequencyBinCount field

setFrequencyBinCount

Analyser setFrequencyBinCount(int newValue)

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

Tooltip: (0,+infinity) frequencyBinCount is half of fftSize and generally equates to number of data values available for the visualization. *

Parameters:

newValue - is new value for the frequencyBinCount field.

Returns:

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

getGain

float getGain()

Provide float value from inputOutput SFFloat field named gain.

Tooltip: (-infinity,+infinity) The gain field is a factor that represents the amount of linear amplification to apply to the output of the node.

• Warning: Decibel values shall not be used.
• Hint: Negative gain factors negate the input signal.

Specified by:

getGain in interface X3DSoundProcessingNode

Returns:

value of gain field

setGain

Analyser 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 X3DSoundProcessingNode

Parameters:

newValue - is new value for the gain field.

Returns:

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

getIsActive

boolean getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

Tooltip: isActive true/false events are sent when playback starts/stops.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

Specified by:

getIsActive in interface X3DSoundProcessingNode

Specified by:

getIsActive in interface X3DTimeDependentNode

Returns:

value of isActive field

getIsPaused

boolean getIsPaused()

Provide boolean value from outputOnly SFBool field named isPaused.

Tooltip: isPaused true/false events are sent when AudioClip is paused/resumed.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

Specified by:

getIsPaused in interface X3DSoundProcessingNode

Specified by:

getIsPaused in interface X3DTimeDependentNode

Returns:

value of isPaused field

getMaxDecibels

float getMaxDecibels()

Provide float value from inputOutput SFFloat field named maxDecibels.

Tooltip: (-infinity,+infinity) maxDecibels represents maximum power value in scaling range for FFT analysis data. *

Returns:

value of maxDecibels field

setMaxDecibels

Analyser setMaxDecibels(float newValue)

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

Tooltip: (-infinity,+infinity) maxDecibels represents maximum power value in scaling range for FFT analysis data. *

Parameters:

newValue - is new value for the maxDecibels field.

Returns:

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

getMetadata

X3DMetadataObject getMetadata()

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

Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.

• Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DSoundNode

Specified by:

getMetadata in interface X3DSoundProcessingNode

Specified by:

getMetadata in interface X3DTimeDependentNode

Returns:

value of metadata field

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

Analyser setMetadata(X3DMetadataObject newValue)

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

Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.

• Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS /Part01/components/core.html#Metadata

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DSoundNode

Specified by:

setMetadata in interface X3DSoundProcessingNode

Specified by:

setMetadata in interface X3DTimeDependentNode

Parameters:

newValue - is new value for the metadata field.

Returns:

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

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

getMinDecibels

float getMinDecibels()

Provide float value from inputOutput SFFloat field named minDecibels.

Tooltip: (-infinity,+infinity) minDecibels represents minimum power value in scaling range for FFT analysis data. *

Returns:

value of minDecibels field

setMinDecibels

Analyser setMinDecibels(float newValue)

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

Tooltip: (-infinity,+infinity) minDecibels represents minimum power value in scaling range for FFT analysis data. *

Parameters:

newValue - is new value for the minDecibels field.

Returns:

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

getPauseTime

double getPauseTime()

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

Tooltip: When time now >= pauseTime, isPaused becomes true and AudioClip becomes paused. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.

• Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.

Specified by:

getPauseTime in interface X3DSoundProcessingNode

Specified by:

getPauseTime in interface X3DTimeDependentNode

Returns:

value of pauseTime field

setPauseTime

Analyser 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 X3DSoundProcessingNode

Specified by:

setPauseTime in interface X3DTimeDependentNode

Parameters:

newValue - is new value for the pauseTime field.

Returns:

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

getResumeTime

double getResumeTime()

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

Tooltip: When resumeTime becomes <= time now, isPaused becomes false and AudioClip becomes active. Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.

• Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.

Specified by:

getResumeTime in interface X3DSoundProcessingNode

Specified by:

getResumeTime in interface X3DTimeDependentNode

Returns:

value of resumeTime field

setResumeTime

Analyser 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 X3DSoundProcessingNode

Specified by:

setResumeTime in interface X3DTimeDependentNode

Parameters:

newValue - is new value for the resumeTime field.

Returns:

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

getSmoothingTimeConstant

float getSmoothingTimeConstant()

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

Tooltip: (0,+infinity) smoothingTimeConstant represents averaging constant during last analysis frame. *

Returns:

value of smoothingTimeConstant field

setSmoothingTimeConstant

Analyser setSmoothingTimeConstant(float newValue)

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

Tooltip: (0,+infinity) smoothingTimeConstant represents averaging constant during last analysis frame. *

Parameters:

newValue - is new value for the smoothingTimeConstant field.

Returns:

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

getStartTime

double getStartTime()

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

Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.

• Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.

Specified by:

getStartTime in interface X3DSoundProcessingNode

Specified by:

getStartTime in interface X3DTimeDependentNode

Returns:

value of startTime field

setStartTime

Analyser 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 X3DSoundProcessingNode

Specified by:

setStartTime in interface X3DTimeDependentNode

Parameters:

newValue - is new value for the startTime field.

Returns:

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

getStopTime

double getStopTime()

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

Tooltip: Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.

• Hint: ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
• Warning: An active TimeSensor node ignores set_cycleInterval and set_startTime events.
• Warning: An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.

Specified by:

getStopTime in interface X3DSoundProcessingNode

Specified by:

getStopTime in interface X3DTimeDependentNode

Returns:

value of stopTime field

setStopTime

Analyser 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 X3DSoundProcessingNode

Specified by:

setStopTime in interface X3DTimeDependentNode

Parameters:

newValue - is new value for the stopTime field.

Returns:

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

getTailTime

double getTailTime()

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

Tooltip: [0,+infinity) tailTime is duration of time that a node continues to provide output signal after the input signal becomes silent.

• Hint: tailTime always has a value of zero for Analyser.

Specified by:

getTailTime in interface X3DSoundProcessingNode

Returns:

value of tailTime field

setTailTime

Analyser setTailTime(double newValue)

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

Tooltip: [0,+infinity) tailTime is duration of time that a node continues to provide output signal after the input signal becomes silent.

• Hint: tailTime always has a value of zero for Analyser.

Specified by:

setTailTime in interface X3DSoundProcessingNode

Parameters:

newValue - is new value for the tailTime field.

Returns:

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