x_ite 8.11.6 → 8.11.8

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

@@ -1,213 +0,0 @@
----
-title: BiquadFilter
-date: 2023-01-31
-nav: components-Sound
-categories: [components, Sound]
-tags: [BiquadFilter, Sound]
----
-<style>
-.post h3 {
-   word-spacing: 0.2em;
-}
-</style>
-
-## Overview
-
-BiquadFilter node is an AudioNode processor implementing common low-order filters. Low-order filters are the building blocks of basic tone controls (bass, mid, treble), graphic equalizers, and more advanced filters. Multiple BiquadFilter node filters can be combined to form more complex filters. The filter parameters such as frequency can be changed over time for filter sweeps, etc.
-
-The BiquadFilter 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
-       + BiquadFilter
-```
-
-## 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
-
-Enables/disables node operation.
-
-### SFFloat [in, out] **detune** 0 <small>[0,∞)</small>
-
-The *detune* field forms a compound field together with playbackRate that together determine a computedPlaybackRate value.
-
-#### Hint
-
-- ComputedPlaybackRate(t) = playbackRate(t) * pow(2, *detune*(t) / 1200)
-
-### SFFloat [in, out] **frequency** 350 <small>[0,∞)</small>
-
-*frequency* at which the BiquadFilterNode operates, in Hz.
-
-#### Hint
-
-- [Wikipedia Hertz](https://en.wikipedia.org/wiki/Hertz){:target="_blank"}
-
-### 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] **qualityFactor** 1 <small>[0,∞)</small>
-
-*qualityFactor* is Quality Factor (Q) of the respective filter algorithm.
-
-#### Hint
-
-- [Wikipedia Q factor](https://en.wikipedia.org/wiki/Q_factor){:target="_blank"}
-
-### 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.
-
-### SFString [in, out] **type** "LOWPASS" <small>["LOWPASS", "HIGHPASS", "BANDPASS", "LOWSHELF", "HIGHSHELF", "PEAKING", "NOTCH", "ALLPASS"]</small>
-
-*type* selects which BiquadFilter algorithm is used.
-
-#### Hint
-
-- [W3C Web Audio API](https://www.w3.org/TR/webaudio/#enumdef-biquadfiltertype){:target="_blank"}
-
-### SFInt32 [out] **channelCount**
-
-*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.
-
-### SFTime [in, out] **resumeTime** 0 <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.
-
-#### 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**
-
-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/#biquadfilternode){:target="_blank"}
-
-### Warning
-
-- Contained AudioClip or MovieTexture nodes must have `containerField='children'` to override otherwise-incorrect defaults.
-
-## See Also
-
-- [X3D Specification of BiquadFilter node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#BiquadFilter){:target="_blank"}

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

@@ -1,284 +0,0 @@
----
-title: BufferAudioSource
-date: 2023-01-31
-nav: components-Sound
-categories: [components, Sound]
-tags: [BufferAudioSource, Sound]
----
-<style>
-.post h3 {
-   word-spacing: 0.2em;
-}
-</style>
-
-## Overview
-
-BufferAudioSource node represents a memory-resident audio asset that can contain one or more channels. Typically the length of the Pulse Coded Modulation (PCM) data is expected to be fairly short (usually somewhat less than a minute).
-
-The BufferAudioSource 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
-      + X3DSoundSourceNode
-        + BufferAudioSource (X3DUrlObject)*
-```
-
-## 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
-
-Enables/disables node operation.
-
-### SFBool [in, out] **load** TRUE
-
-*load*=true means *load* immediately, *load*=false means defer loading or else unload a previously loaded scene.
-
-#### Hints
-
-- Allows author to design when Inline loading occurs via user interaction, event chains or scripting.
-- Use a separate LoadSensor node to detect when loading is complete.
-
-### MFString [in, out] **url** [ ] <small>[URI]</small>
-
-Location and filename of sound file. Support for .wav format is required, .midi format is recommended, other formats are optional.
-
-#### Hints
-
-- MFString arrays can have multiple values, so separate each individual string by quote marks. "https://www.web3d.org" "https://www.web3d.org/about" "etc."
-- Alternative XML encoding for quotation mark " is &amp;quot; (which is an example of a character entity).
-- Can replace embedded blank(s) in *url* queries with %20 for each blank character.
-- [X3D Scene Authoring Hints, urls](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#urls){:target="_blank"}
-
-#### Warning
-
-- Strictly match directory and filename capitalization for http links! This is important for portability. Some operating systems are forgiving of capitalization mismatches, but http/https *url* addresses and paths in Unix-based operating systems are all case sensitive and intolerant of uppercase/lowercase mismatches.
-
-### SFTime [in, out] **autoRefresh** 0 <small>[0,∞)</small>
-
-*autoRefresh* defines interval in seconds before automatic reload of current url asset is performed.
-
-#### Hints
-
-- If preceding file loading fails or load field is false, no refresh is performed.
-- Repeated refresh attempts to reload currently loaded entry of url list. If that fails, the browser retries other entries in the url list.
-
-#### Warning
-
-- Automatically reloading content has security considerations and needs to be considered carefully.
-
-### SFTime [in, out] **autoRefreshTimeLimit** 3600 <small>[0,∞)</small>
-
-*autoRefreshTimeLimit* defines maximum duration that automatic refresh activity can occur.
-
-#### Hint
-
-- Automatic refresh is different than query and response timeouts performed by a networking library while sequentially attempting to retrieve addressed content from a url list.
-
-#### Warning
-
-- Automatically reloading content has security considerations and needs to be considered carefully.
-
-### 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
-
-- [Wikipedia Pulse-Code Modulation (PCM)](https://en.wikipedia.org/wiki/Pulse-code_modulation){:target="_blank"}
-
-### SFFloat [in, out] **detune** 0 <small>[0,∞)</small>
-
-The *detune* field forms a compound field together with playbackRate that together determine a computedPlaybackRate value.
-
-#### Hint
-
-- ComputedPlaybackRate(t) = playbackRate(t) * pow(2, *detune*(t) / 1200)
-
-### SFTime [in, out] **bufferDuration** 0 <small>[0,∞)</small>
-
-*bufferDuration* is duration in seconds to use from buffer field.
-
-#### Hint
-
-- Duration is a nonnegative SFTime duration interval, not an absolute clock time.
-
-### SFTime [in, out] **loopStart** 0 <small>[0,∞)</small>
-
-*loopStart* field is optional playhead position where looping begins if loop=true. If *loopStart* is greater than duration of buffer, looping starts at buffer end.
-
-#### Hint
-
-- *loopStart* represents a nonnegative SFTime duration interval, not an absolute clock time.
-
-### SFTime [in, out] **loopEnd** 0 <small>[0,∞)</small>
-
-*loopEnd* field is optional playhead position where looping ends if loop=true. If *loopEnd* value is zero, or if *loopEnd* is greater than duration of buffer, looping ends at buffer end.
-
-#### Hint
-
-- *loopEnd* represents a nonnegative SFTime duration interval, not an absolute clock time.
-
-### SFInt32 [in, out] **numberOfChannels** 0 <small>[0,∞)</small>
-
-*numberOfChannels* is number of audio channels found in this buffer source.
-
-### SFFloat [in, out] **playbackRate** 1 <small>(-∞,∞)</small>
-
-*playbackRate* field is speed at which to render the audio stream, and forms a compound field together with detune field
-
-#### Hint
-
-- Negative values play in reverse.
-
-### SFFloat [in, out] **sampleRate** 0 <small>[0,∞)</small>
-
-*sampleRate* field is sample-frames per second.
-
-#### Hints
-
-- Sample-rate converters (variable speed processors) are not supported in real-time processing.
-- Nyquist frequency is half this *sampleRate* value.
-- [Wikipedia Nyquist frequency](https://en.wikipedia.org/wiki/Nyquist_frequency){:target="_blank"}
-
-### SFInt32 [out] **bufferLength**
-
-*bufferLength* is length of buffer field in sample-frames.
-
-### SFInt32 [out] **channelCount**
-
-*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"}
-
-### SFBool [in, out] **loop** FALSE
-
-Repeat indefinitely when *loop*=true, repeat only once when *loop*=false.
-
-### 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.
-
-### SFTime [in, out] **resumeTime** 0 <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.
-
-#### 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**
-
-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.
-
-## Advisories
-
-### Hint
-
-- [W3C Web Audio API](https://www.w3.org/TR/webaudio/#AudioBufferSourceNode){:target="_blank"}
-
-### Warning
-
-- For longer sounds, such as music soundtracks, streaming such as StreamAudioSource should be used.
-
-## See Also
-
-- [X3D Specification of BufferAudioSource node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#BufferAudioSource){:target="_blank"}

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

@@ -1,108 +0,0 @@
----
-title: ChannelMerger
-date: 2023-01-31
-nav: components-Sound
-categories: [components, Sound]
-tags: [ChannelMerger, Sound]
----
-<style>
-.post h3 {
-   word-spacing: 0.2em;
-}
-</style>
-
-## Overview
-
-ChannelMerger unites different input channels into a single output channel.
-
-The ChannelMerger 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
-    + X3DSoundNode
-      + X3DSoundChannelNode
-        + ChannelMerger
-```
-
-## 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
-
-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.
-
-### SFInt32 [out] **channelCount**
-
-*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"}
-
-### 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/#channelmergernode){:target="_blank"}
-
-## See Also
-
-- [X3D Specification of ChannelMerger node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#ChannelMerger){:target="_blank"}