x_ite 8.8.6 → 8.9.0

package/docs/_posts/components/Sound/Convolver.md

@@ -13,54 +13,178 @@ tags: [Convolver, Sound]
 
 ## Overview
 
-Convolver ...
+Convolver performs a linear convolution on a given AudioBuffer, often used to achieve a reverberation effect.
 
-The Convolver node belongs to the **Sound** component and its default container field is *children.* It is available since X3D version 4.0 or later.
+The Convolver node belongs to the **Sound** component and its default container field is *children.* It is available from X3D version 4.0 or higher.
 
 ## Hierarchy
 
 ```
 + X3DNode
+  + X3DChildNode
+   + X3DTimeDependentNode
+     + X3DSoundProcessingNode
+       + Convolver
 ```
 
 ## Fields
 
 ### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
 
+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-CD1/Part01/components/core.html#Metadata){:target="_blank"}
+
 ### SFString [in, out] **description** ""
 
+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 &amp;#38; for &amp; ampersand character, or &amp;#34; for " quotation-mark character).
+
 ### SFBool [in, out] **enabled** TRUE
 
-### SFFloat [in, out] **gain** <small></small>
+Enables/disables node operation.
+
+### SFFloat [in, out] **gain** 1 <small>(-∞,∞)</small>
+
+The *gain* field is a factor that represents the amount of linear amplification to apply to the output of the node.
+
+#### Hint
+
+- Negative *gain* factors negate the input signal.
+
+#### Warning
+
+- Decibel values shall not be used.
+
+### MFFloat [in, out] **buffer** [ ] <small>[−1,1]</small>
+
+*buffer* is a memory-resident audio asset that can contain one or more channels. *buffer* data format is non-interleaved 32-bit floating-point linear PCM values with a normal range of [−1,1], but values are not limited to this range.
+
+#### Hint
 
-### MFFloat [in, out] **buffer** <small></small>
+- [Wikipedia Pulse-Code Modulation (PCM)](https://en.wikipedia.org/wiki/Pulse-code_modulation){:target="_blank"}
 
 ### SFBool [in, out] **normalize** FALSE
 
-### SFTime [in, out] **tailTime** <small></small>
+*normalize* controls whether or not the impulse response from the buffer is scaled by an equal-power normalization when the buffer field is set
+
+### SFTime [in, out] **tailTime** 0 <small>[0,∞)</small>
+
+*tailTime* is duration of time that a node continues to provide output signal after the input signal becomes silent.
 
 ### SFInt32 [out] **channelCount**
 
-### SFString [in, out] **channelCountMode** <small></small>
+*channelCount* reports number of channels provided by input nodes.
+
+#### Hint
+
+- [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dom-audionode-channelcount){:target="_blank"}
+
+### SFString [in, out] **channelCountMode** "MAX" <small>["MAX", "CLAMPED-MAX", "EXPLICIT"]</small>
+
+*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){:target="_blank"}
+
+### SFString [in, out] **channelInterpretation** "SPEAKERS" <small>["SPEAKERS", "DISCRETE"]</small>
+
+*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){:target="_blank"}
+
+### SFTime [in, out] **startTime** 0 <small>(-∞,∞)</small>
+
+Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
+
+#### Hint
 
-### SFString [in, out] **channelInterpretation** <small></small>
+- ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
 
-### SFTime [in, out] **startTime** <small>(-∞,∞)</small>
+### SFTime [in, out] **resumeTime** 0 <small>(-∞,∞)</small>
 
-### SFTime [in, out] **resumeTime** <small>(-∞,∞)</small>
+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.
 
-### SFTime [in, out] **pauseTime** <small>(-∞,∞)</small>
+#### Hint
 
-### SFTime [in, out] **stopTime** <small>(-∞,∞)</small>
+- ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
+
+### SFTime [in, out] **pauseTime** 0 <small>(-∞,∞)</small>
+
+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.
+
+### SFTime [in, out] **stopTime** 0 <small>(-∞,∞)</small>
+
+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.
+
+#### Warnings
+
+- An active TimeSensor node ignores set_cycleInterval and set_startTime events.
+- An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
 
 ### SFBool [out] **isPaused**
 
+*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.
+
 ### SFBool [out] **isActive**
 
+*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.
+
 ### SFTime [out] **elapsedTime**
 
-### MFNode [in, out] **children** <small></small>
+Current elapsed time since AudioClip activated/running, cumulative in seconds, and not counting any paused time.
+
+#### Hint
+
+- *elapsedTime* is a nonnegative SFTime duration interval, not an absolute clock 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.
+
+### MFNode [in, out] **children** [ ] <small>[X3DSoundChannelNode,X3DSoundProcessingNode,X3DSoundSourceNode]</small>
+
+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.
+
+#### Hint
+
+- Can be original (DEF) or referenced (USE) nodes.
+
+#### Warning
+
+- Contained AudioClip or MovieTexture nodes must have `containerField='children'` to override otherwise-incorrect defaults.
+
+## Advisories
+
+### Hints
+
+- Potential modifications include chorus effects, reverberation, and telephone-like speech.
+- [W3C Web Audio API](https://www.w3.org/TR/webaudio/#ConvolverNode){:target="_blank"}
 
-## External Links
+## See Also
 
-- [X3D Specification of Convolver](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#Convolver){:target="_blank"}
+- [X3D Specification of Convolver node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#Convolver){:target="_blank"}

package/docs/_posts/components/Sound/Delay.md

@@ -13,54 +13,173 @@ tags: [Delay, Sound]
 
 ## Overview
 
-Delay ...
+Delay causes a time delay between the arrival of input data and subsequent propagation to the output.
 
-The Delay node belongs to the **Sound** component and its default container field is *children.* It is available since X3D version 4.0 or later.
+The Delay node belongs to the **Sound** component and its default container field is *children.* It is available from X3D version 4.0 or higher.
 
 ## Hierarchy
 
 ```
 + X3DNode
+  + X3DChildNode
+   + X3DTimeDependentNode
+     + X3DSoundProcessingNode
+       + Delay
 ```
 
 ## Fields
 
 ### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
 
+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-CD1/Part01/components/core.html#Metadata){:target="_blank"}
+
 ### SFString [in, out] **description** ""
 
+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 &amp;#38; for &amp; ampersand character, or &amp;#34; for " quotation-mark character).
+
 ### SFBool [in, out] **enabled** TRUE
 
-### SFFloat [in, out] **gain** <small></small>
+Enables/disables node operation.
+
+### SFFloat [in, out] **gain** 1 <small>(-∞,∞)</small>
+
+The *gain* field is a factor that represents the amount of linear amplification to apply to the output of the node.
+
+#### Hint
+
+- Negative *gain* factors negate the input signal.
+
+#### Warning
+
+- Decibel values shall not be used.
+
+### SFTime [in, out] **delayTime** 0 <small>[0,∞)</small>
+
+*delayTime* is duration of delay (in seconds) to apply.
+
+### SFTime [in, out] **maxDelayTime** 1 <small>[0,∞)</small>
 
-### SFTime [in, out] **delayTime** <small></small>
+*maxDelayTime* is duration of maximum amount of delay (in seconds) that can be applied.
 
-### SFTime [in, out] **maxDelayTime** <small></small>
+### SFTime [in, out] **tailTime** 0 <small>[0,∞)</small>
 
-### SFTime [in, out] **tailTime** <small></small>
+*tailTime* is duration of time that a node continues to provide output signal after the input signal becomes silent.
 
 ### SFInt32 [out] **channelCount**
 
-### SFString [in, out] **channelCountMode** <small></small>
+*channelCount* reports number of channels provided by input nodes.
+
+#### Hint
+
+- [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dom-audionode-channelcount){:target="_blank"}
+
+### SFString [in, out] **channelCountMode** "MAX" <small>["MAX", "CLAMPED-MAX", "EXPLICIT"]</small>
+
+*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){:target="_blank"}
+
+### SFString [in, out] **channelInterpretation** "SPEAKERS" <small>["SPEAKERS", "DISCRETE"]</small>
+
+*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){:target="_blank"}
+
+### SFTime [in, out] **startTime** 0 <small>(-∞,∞)</small>
+
+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.
 
-### SFString [in, out] **channelInterpretation** <small></small>
+### SFTime [in, out] **resumeTime** 0 <small>(-∞,∞)</small>
 
-### SFTime [in, out] **startTime** <small>(-∞,∞)</small>
+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.
 
-### SFTime [in, out] **resumeTime** <small>(-∞,∞)</small>
+#### Hint
 
-### SFTime [in, out] **pauseTime** <small>(-∞,∞)</small>
+- ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
 
-### SFTime [in, out] **stopTime** <small>(-∞,∞)</small>
+### SFTime [in, out] **pauseTime** 0 <small>(-∞,∞)</small>
+
+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.
+
+### SFTime [in, out] **stopTime** 0 <small>(-∞,∞)</small>
+
+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.
+
+#### Warnings
+
+- An active TimeSensor node ignores set_cycleInterval and set_startTime events.
+- An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
 
 ### SFBool [out] **isPaused**
 
+*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.
+
 ### SFBool [out] **isActive**
 
+*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.
+
 ### SFTime [out] **elapsedTime**
 
-### MFNode [in, out] **children** <small></small>
+Current elapsed time since AudioClip activated/running, cumulative in seconds, and not counting any paused time.
+
+#### Hint
+
+- *elapsedTime* is a nonnegative SFTime duration interval, not an absolute clock 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.
+
+### MFNode [in, out] **children** [ ] <small>[X3DSoundChannelNode,X3DSoundProcessingNode,X3DSoundSourceNode]</small>
+
+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.
+
+#### Hint
+
+- Can be original (DEF) or referenced (USE) nodes.
+
+#### Warning
+
+- Contained AudioClip or MovieTexture nodes must have `containerField='children'` to override otherwise-incorrect defaults.
+
+## Advisories
+
+### Hint
+
+- [W3C Web Audio API](https://www.w3.org/TR/webaudio/#DelayNode){:target="_blank"}
 
-## External Links
+## See Also
 
-- [X3D Specification of Delay](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#Delay){:target="_blank"}
+- [X3D Specification of Delay node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#Delay){:target="_blank"}

package/docs/_posts/components/Sound/DynamicsCompressor.md

@@ -13,62 +13,189 @@ tags: [DynamicsCompressor, Sound]
 
 ## Overview
 
-DynamicsCompressor ...
+DynamicsCompressor node implements a dynamics compression effect, lowering volume of loudest parts of signal and raising volume of softest parts.
 
-The DynamicsCompressor node belongs to the **Sound** component and its default container field is *children.* It is available since X3D version 4.0 or later.
+The DynamicsCompressor node belongs to the **Sound** component and its default container field is *children.* It is available from X3D version 4.0 or higher.
 
 ## Hierarchy
 
 ```
 + X3DNode
+  + X3DChildNode
+   + X3DTimeDependentNode
+     + X3DSoundProcessingNode
+       + DynamicsCompressor
 ```
 
 ## Fields
 
 ### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
 
+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-CD1/Part01/components/core.html#Metadata){:target="_blank"}
+
 ### SFString [in, out] **description** ""
 
+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 &amp;#38; for &amp; ampersand character, or &amp;#34; for " quotation-mark character).
+
 ### SFBool [in, out] **enabled** TRUE
 
-### SFFloat [in, out] **gain** <small></small>
+Enables/disables node operation.
+
+### SFFloat [in, out] **gain** 1 <small>(-∞,∞)</small>
+
+The *gain* field is a factor that represents the amount of linear amplification to apply to the output of the node.
+
+#### Hint
+
+- Negative *gain* factors negate the input signal.
+
+#### Warning
+
+- Decibel values shall not be used.
+
+### SFFloat [in, out] **attack** 0.003 <small>[0,∞)</small>
+
+The *attack* field is the duration of time (in seconds) to reduce the gain by 10dB.
+
+### SFFloat [in, out] **knee** 30 <small>[0,∞)</small>
+
+*knee* field contains a decibel value representing range above threshold where the curve smoothly transitions to compressed portion.
 
-### SFFloat [in, out] **attack** <small></small>
+### SFFloat [in, out] **ratio** 12 <small>[0,∞)</small>
 
-### SFFloat [in, out] **knee** <small></small>
+*ratio* field represents amount of input change, in dB, needed for 1 dB change in output.
 
-### SFFloat [in, out] **ratio** <small></small>
+### SFFloat [in, out] **reduction** 0 <small>[0,∞)</small>
 
-### SFFloat [in, out] **reduction** <small></small>
+*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*)
 
-### SFTime [in, out] **release** <small></small>
+### SFTime [in, out] **release** 0.25 <small>[0,∞)</small>
 
-### SFFloat [in, out] **threshold** <small></small>
+*release* field represents amount of time (in seconds) to increase gain by 10dB.
 
-### SFTime [in, out] **tailTime** <small></small>
+### SFFloat [in, out] **threshold** -24 <small>[0,∞)</small>
+
+*threshold* field represents decibel value above which compression starts taking effect.
+
+### SFTime [in, out] **tailTime** 0 <small>[0,∞)</small>
+
+*tailTime* is duration of time that a node continues to provide output signal after the input signal becomes silent.
 
 ### SFInt32 [out] **channelCount**
 
-### SFString [in, out] **channelCountMode** <small></small>
+*channelCount* reports number of channels provided by input nodes.
+
+#### Hint
+
+- [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dom-audionode-channelcount){:target="_blank"}
+
+### SFString [in, out] **channelCountMode** "MAX" <small>["MAX", "CLAMPED-MAX", "EXPLICIT"]</small>
+
+*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){:target="_blank"}
+
+### SFString [in, out] **channelInterpretation** "SPEAKERS" <small>["SPEAKERS", "DISCRETE"]</small>
+
+*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){:target="_blank"}
+
+### SFTime [in, out] **startTime** 0 <small>(-∞,∞)</small>
+
+Absolute time: number of seconds since January 1, 1970, 00:00:00 GMT.
 
-### SFString [in, out] **channelInterpretation** <small></small>
+#### Hint
 
-### SFTime [in, out] **startTime** <small>(-∞,∞)</small>
+- ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
 
-### SFTime [in, out] **resumeTime** <small>(-∞,∞)</small>
+### SFTime [in, out] **resumeTime** 0 <small>(-∞,∞)</small>
 
-### SFTime [in, out] **pauseTime** <small>(-∞,∞)</small>
+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.
 
-### SFTime [in, out] **stopTime** <small>(-∞,∞)</small>
+#### Hint
+
+- ROUTE a time value matching system clock to this field, such as output event from TouchSensor touchTime or TimeTrigger triggerTime.
+
+### SFTime [in, out] **pauseTime** 0 <small>(-∞,∞)</small>
+
+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.
+
+### SFTime [in, out] **stopTime** 0 <small>(-∞,∞)</small>
+
+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.
+
+#### Warnings
+
+- An active TimeSensor node ignores set_cycleInterval and set_startTime events.
+- An active TimeSensor node ignores set_stopTime event values less than or equal to startTime.
 
 ### SFBool [out] **isPaused**
 
+*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.
+
 ### SFBool [out] **isActive**
 
+*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.
+
 ### SFTime [out] **elapsedTime**
 
-### MFNode [in, out] **children** <small></small>
+Current elapsed time since AudioClip activated/running, cumulative in seconds, and not counting any paused time.
+
+#### Hint
+
+- *elapsedTime* is a nonnegative SFTime duration interval, not an absolute clock 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.
+
+### MFNode [in, out] **children** [ ] <small>[X3DSoundChannelNode,X3DSoundProcessingNode,X3DSoundSourceNode]</small>
+
+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.
+
+#### Hint
+
+- Can be original (DEF) or referenced (USE) nodes.
+
+#### Warning
+
+- Contained AudioClip or MovieTexture nodes must have `containerField='children'` to override otherwise-incorrect defaults.
+
+## Advisories
+
+### Hint
+
+- W3C Web Audio API w3.org/TR/webaudio/#dynamicscompressornode
 
-## External Links
+## See Also
 
-- [X3D Specification of DynamicsCompressor](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#DynamicsCompressor){:target="_blank"}
+- [X3D Specification of DynamicsCompressor node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#DynamicsCompressor){:target="_blank"}