x_ite 8.11.6 → 8.11.8

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

@@ -1,205 +0,0 @@
----
-title: Analyser
-date: 2023-01-31
-nav: components-Sound
-categories: [components, Sound]
-tags: [Analyser, Sound]
----
-<style>
-.post h3 {
-   word-spacing: 0.2em;
-}
-</style>
-
-## Overview
-
-Analyser provides real-time frequency and time-domain analysis information, without any change to the input.
-
-The Analyser 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
-       + Analyser
-```
-
-## 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 [in, out] **fftSize** 2048 <small>[0,∞)</small>
-
-*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){:target="_blank"}
-
-### SFInt32 [in, out] **frequencyBinCount** 1024 <small>[0,∞)</small>
-
-*frequencyBinCount* is half of fftSize and generally equates to number of data values available for the visualization.
-
-### SFFloat [in, out] **minDecibels** -100 <small>(-∞,∞)</small>
-
-*minDecibels* represents minimum power value in scaling range for FFT analysis data.
-
-### SFFloat [in, out] **maxDecibels** -30 <small>(-∞,∞)</small>
-
-*maxDecibels* represents maximum power value in scaling range for FFT analysis data.
-
-### SFFloat [in, out] **smoothingTimeConstant** 0.8<small>[0,∞)</small>
-
-*smoothingTimeConstant* represents averaging constant during last analysis frame.
-
-### 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.
-
-#### Hint
-
-- *tailTime* always has a value of zero for Analyser.
-
-### 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/#analysernode){:target="_blank"}
-
-## See Also
-
-- [X3D Specification of Analyser node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#Analyser){:target="_blank"}

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

@@ -1,223 +0,0 @@
----
-title: AudioClip
-date: 2023-01-07
-nav: components-Sound
-categories: [components, Sound]
-tags: [AudioClip, Sound]
----
-<style>
-.post h3 {
-  word-spacing: 0.2em;
-}
-</style>
-
-## Overview
-
-AudioClip provides audio data used by parent Sound nodes.
-
-The AudioClip node belongs to the **Sound** component and its default container field is *source.* It is available from X3D version 2.0 or higher.
-
-## Hierarchy
-
-```
-+ X3DNode
-  + X3DChildNode
-    + X3DTimeDependentNode
-      + X3DSoundSourceNode
-        + AudioClip (X3DUrlObject)*
-```
-
-<small>\* Derived from multiple interfaces.</small>
-
-## 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 or stream. 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.
-
-### SFFloat [in, out] **pitch** 1 <small>(0,∞)</small>
-
-Multiplier for the rate at which sampled sound is played. Changing *pitch* also changes playback speed.
-
-#### Hint
-
-- Changing the *pitch* field does not trigger a duration_changed event. Playback interval may vary but duration of the original media data remains unmodified.
-
-### 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.
-
-### SFTime [out] **duration_changed**
-
-*duration_changed* is length of time in seconds for one cycle of media stream.
-
-#### Hints
-
-- *duration_changed* is an SFTime duration interval, normally nonnegative, and not an absolute clock time.
-- Changing the pitch field does not trigger a *duration_changed* event. Playback interval may vary but duration of the original media data remains unmodified.
-
-#### Warnings
-
-- Duration value of -1 implies that media data has not yet loaded or is unavailable for some reason.
-- It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
-
-## Advisories
-
-### Hints
-
-- Add a parent Sound node first.
-- Utilize DEF/USE references for multiple copies of a single AudioClip sound file in order to avoid multiple-download delays, reduce memory requirements, and maintain synchronization.
-- Authors can provide multiple audio formats for the same audio track, with each source address listed separately in the url field.
-- Player support for .wav format is required, .midi format is recommended, other formats are optional.
-- [X3D Scene Authoring Hints:Audio](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Audio){:target="_blank"}
-- [When parent node is LoadSensor, apply `containerField='children'` (X3Dv4) or `containerField='watchList'` (X3Dv3).](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#fieldNameChanges){:target="_blank"}
-
-## Example
-
-<x3d-canvas src="https://create3000.github.io/media/examples/Sound/AudioClip/AudioClip.x3d" update="auto"></x3d-canvas>
-
-## See Also
-
-- [X3D Specification of AudioClip node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#AudioClip){:target="_blank"}

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

@@ -1,128 +0,0 @@
----
-title: AudioDestination
-date: 2023-01-31
-nav: components-Sound
-categories: [components, Sound]
-tags: [AudioDestination, Sound]
----
-<style>
-.post h3 {
-   word-spacing: 0.2em;
-}
-</style>
-
-## Overview
-
-AudioDestination node represents the final audio destination and is what user ultimately hears, typically from the speakers of user device. An AudioDestinationNode representing the audio hardware end-point (the normal case) can potentially output more than 2 channels of audio if the audio hardware is multi-channel.
-
-The AudioDestination 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
-      + X3DSoundDestinationNode
-        + AudioDestination
-```
-
-## 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 [in, out] **maxChannelCount** 2 <small>[0,∞)</small>
-
-[*maxChannelCount*.
-
-#### Hint
-
-- [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dom-audionode-channelcount){: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"}
-
-### SFString [out] **mediaDeviceID**
-
-*mediaDeviceID* field provides ID parameter functionality. (TODO experimental)
-
-### 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.
-
-### 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/#AudioDestinationNode){:target="_blank"}
-
-## See Also
-
-- [X3D Specification of AudioDestination node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#AudioDestination){:target="_blank"}