All Superinterfaces:: X3DChildNode, X3DNode, X3DSoundNode, X3DSoundProcessingNode, X3DTimeDependentNode

All Known Implementing Classes:: DynamicsCompressor

public interface DynamicsCompressor extends X3DSoundProcessingNode

DynamicsCompressor node implements a dynamics compression effect, lowering volume of loudest parts of signal and raising volume of softest parts.

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. DynamicsCompressor node tooltip: [X3DSoundProcessingNode] DynamicsCompressor node implements a dynamics compression effect, lowering volume of loudest parts of signal and raising volume of softest parts.

Hint: W3C Web Audio API w3.org/TR/webaudio/#dynamicscompressornode

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

See Also:

Method Summary

Modifier and Type

Method

Description

void

addChildren(X3DNode[] newValue)

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

double

getAttack()

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

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.

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

getKnee()

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

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.

float

getRatio()

Provide float value within allowed range of [1,20] from inputOutput SFFloat field named ratio.

float

getReduction()

Provide float value within allowed range of (-infinity,0] from outputOnly SFFloat field named reduction.

double

getRelease()

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

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.

double

getTailTime()

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

float

getThreshold()

Provide float value within allowed range of [-100,0] from inputOutput SFFloat field named threshold.

DynamicsCompressor

setAttack(double newValue)

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

DynamicsCompressor

setChannelCountMode(String newValue)

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

DynamicsCompressor

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

DynamicsCompressor

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.

DynamicsCompressor

setDescription(String newValue)

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

DynamicsCompressor

setEnabled(boolean newValue)

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

DynamicsCompressor

setGain(float newValue)

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

DynamicsCompressor

setKnee(float newValue)

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

DynamicsCompressor

setMetadata(X3DMetadataObject newValue)

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

DynamicsCompressor

setPauseTime(double newValue)

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

DynamicsCompressor

setRatio(float newValue)

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

DynamicsCompressor

setRelease(double newValue)

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

DynamicsCompressor

setResumeTime(double newValue)

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

DynamicsCompressor

setStartTime(double newValue)

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

DynamicsCompressor

setStopTime(double newValue)

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

DynamicsCompressor

setTailTime(double newValue)

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

DynamicsCompressor

setThreshold(float newValue)

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

Method Details
- getAttack
  
  double getAttack()
  
  Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named attack.
  
  Tooltip: [0,+infinity) The attack field is the duration of time (in seconds) to reduce the gain by 10dB. *
  
  Returns:
  
  value of attack field
- setAttack
  
  DynamicsCompressor setAttack(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named attack.
  
  Tooltip: [0,+infinity) The attack field is the duration of time (in seconds) to reduce the gain by 10dB. *
  
  Parameters:
  
  newValue - is new value for the attack field.
  
  Returns:
  
  DynamicsCompressor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- 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
  DynamicsCompressor 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:
  
  DynamicsCompressor - 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
  DynamicsCompressor 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:
  
  DynamicsCompressor - 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
  DynamicsCompressor 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:
  
  DynamicsCompressor - 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
  DynamicsCompressor 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:
  
  DynamicsCompressor - 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
  
  DynamicsCompressor 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:
  
  DynamicsCompressor - 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
  DynamicsCompressor 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:
  
  DynamicsCompressor - 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
- getKnee
  
  float getKnee()
  
  Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named knee.
  
  Tooltip: [0,+infinity) knee field contains a decibel value representing range above threshold where the curve smoothly transitions to compressed portion. *
  
  Returns:
  
  value of knee field
- setKnee
  
  DynamicsCompressor setKnee(float newValue)
  
  Accessor method to assign float value to inputOutput SFFloat field named knee.
  
  Tooltip: [0,+infinity) knee field contains a decibel value representing range above threshold where the curve smoothly transitions to compressed portion. *
  
  Parameters:
  
  newValue - is new value for the knee field.
  
  Returns:
  
  DynamicsCompressor - 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
  DynamicsCompressor 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:
  
  DynamicsCompressor - 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
- 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
  DynamicsCompressor 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:
  
  DynamicsCompressor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getRatio
  
  float getRatio()
  
  Provide float value within allowed range of [1,20] from inputOutput SFFloat field named ratio.
  
  Tooltip: [0,+infinity) ratio field represents amount of input change, in dB, needed for 1 dB change in output. *
  
  Returns:
  
  value of ratio field
- setRatio
  
  DynamicsCompressor setRatio(float newValue)
  
  Accessor method to assign float value to inputOutput SFFloat field named ratio.
  
  Tooltip: [0,+infinity) ratio field represents amount of input change, in dB, needed for 1 dB change in output. *
  
  Parameters:
  
  newValue - is new value for the ratio field.
  
  Returns:
  
  DynamicsCompressor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getReduction
  
  float getReduction()
  
  Provide float value within allowed range of (-infinity,0] from outputOnly SFFloat field named reduction.
  
  Tooltip: [0,+infinity) reduction field provides amount of gain reduction in dB currently applied by compressor to signal. If fed no signal, then value is 0 (no gain reduction). *
  
  Returns:
  
  value of reduction field
- getRelease
  
  double getRelease()
  
  Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named release.
  
  Tooltip: [0,+infinity) release field represents amount of time (in seconds) to increase gain by 10dB. *
  
  Returns:
  
  value of release field
- setRelease
  
  DynamicsCompressor setRelease(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named release.
  
  Tooltip: [0,+infinity) release field represents amount of time (in seconds) to increase gain by 10dB. *
  
  Parameters:
  
  newValue - is new value for the release field.
  
  Returns:
  
  DynamicsCompressor - 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
  DynamicsCompressor 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:
  
  DynamicsCompressor - 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
  DynamicsCompressor 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:
  
  DynamicsCompressor - 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
  DynamicsCompressor 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:
  
  DynamicsCompressor - 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. *
  
  Specified by:
  
  getTailTime in interface X3DSoundProcessingNode
  
  Returns:
  
  value of tailTime field
- setTailTime
  
  DynamicsCompressor 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. *
  
  Specified by:
  
  setTailTime in interface X3DSoundProcessingNode
  
  Parameters:
  
  newValue - is new value for the tailTime field.
  
  Returns:
  
  DynamicsCompressor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getThreshold
  
  float getThreshold()
  
  Provide float value within allowed range of [-100,0] from inputOutput SFFloat field named threshold.
  
  Tooltip: [0,+infinity) threshold field represents decibel value above which compression starts taking effect. *
  
  Returns:
  
  value of threshold field
- setThreshold
  
  DynamicsCompressor setThreshold(float newValue)
  
  Accessor method to assign float value to inputOutput SFFloat field named threshold.
  
  Tooltip: [0,+infinity) threshold field represents decibel value above which compression starts taking effect. *
  
  Parameters:
  
  newValue - is new value for the threshold field.
  
  Returns:
  
  DynamicsCompressor - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface DynamicsCompressor

Method Summary

Method Details

getAttack

setAttack

getChannelCount

getChannelCountMode

setChannelCountMode

getChannelInterpretation

setChannelInterpretation

getChildren

setChildren

addChildren

setChildren

getDescription

setDescription

getElapsedTime

getEnabled

setEnabled

getGain

setGain

getIsActive

getIsPaused

getKnee

setKnee

getMetadata

setMetadata

getPauseTime

setPauseTime

getRatio

setRatio

getReduction

getRelease

setRelease

getResumeTime

setResumeTime

getStartTime

setStartTime

getStopTime

setStopTime

getTailTime

setTailTime

getThreshold

setThreshold