x_ite 8.8.6 → 8.9.0

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

@@ -13,30 +13,71 @@ tags: [PeriodicWave, Sound]
 
 ## Overview
 
-PeriodicWave ...
+PeriodicWave defines a periodic waveform that can be used to shape the output of an Oscillator.#10;
 
-The PeriodicWave node belongs to the **Sound** component and its default container field is *periodicWave.* It is available since X3D version 4.0 or later.
+The PeriodicWave node belongs to the **Sound** component and its default container field is *periodicWave.* It is available from X3D version 4.0 or higher.
 
 ## Hierarchy
 
 ```
 + X3DNode
+  + X3DChildNode
+    + X3DSoundNode
+      + PeriodicWave
 ```
 
 ## 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
 
-### MFFloat [in, out] **optionsReal** <small></small>
+Enables/disables node operation.
+
+### SFString [in, out] **type** "SQUARE" <small>["SINE", "SQUARE", "SAWTOOTH", "TRIANGLE", "CUSTOM"]</small>
+
+The *type* field specifies shape of waveform to play, which can be one of several provided values or else 'custom' to indicate that real and imaginary coefficient arrays define a custom waveform.
+
+#### Hint
+
+- [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dictdef-periodicwaveoptions){:target="_blank"}
+
+### MFFloat [in, out] **optionsReal** [ ] <small>(-∞,∞)</small>
+
+Real coefficients for defining a waveform.
+
+#### Warning
+
+- Array lengths for *optionsReal* and optionsImag must match.
+
+### MFFloat [in, out] **optionsImag** [ ] <small>(-∞,∞)</small>
+
+Imaginary coefficients for defining a waveform.
+
+#### Warning
+
+- Array lengths for optionsReal and *optionsImag* must match.
+
+## Advisories
 
-### MFFloat [in, out] **optionsImag** <small></small>
+### Hint
 
-### SFString [in, out] **type** <small></small>
+- [W3C Web Audio API](https://www.w3.org/TR/webaudio/#periodicwave){:target="_blank"}
 
-## External Links
+## See Also
 
-- [X3D Specification of PeriodicWave](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#PeriodicWave){:target="_blank"}
+- [X3D Specification of PeriodicWave node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#PeriodicWave){:target="_blank"}

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

@@ -1,6 +1,6 @@
 ---
 title: Sound
-date: 2022-01-07
+date: 2023-01-07
 nav: components-Sound
 categories: [components, Sound]
 tags: [Sound, Sound]
@@ -15,7 +15,7 @@ tags: [Sound, Sound]
 
 The Sound node controls the 3D spatialization of sound playback by a child AudioClip or MovieTexture node. Sound intensity includes stereo support, varying according to user location and view direction in the scene.
 
-The Sound node belongs to the **Sound** component and its default container field is *children.* It is available since X3D version 2.0 or later.
+The Sound node belongs to the **Sound** component and its default container field is *children.* It is available from X3D version 2.0 or higher.
 
 ## Hierarchy
 
@@ -30,31 +30,44 @@ The Sound node belongs to the **Sound** component and its default container fiel
 
 ### SFNode [in, out] **metadata** NULL <small>[X3DMetadataObject]</small>
 
-Metadata are not part of the X3D world and not interpreted by the X3D browser, but they can be accessed via the ECMAScript interface.
+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.
+Author-provided prose that describes intended purpose of this node.
 
-#### Hint
+#### Hints
 
-- Many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as &amp;#38; for & ampersand character, or &amp;#34; for " quotation-mark character).
+- Include space characters since a *description* is not a DEF identifier. Write short phrases that make descriptions clear and readable.
+- 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).
 
-### SFFloat [in, out] **intensity** 1 <small>[0,1]</small>
+### SFBool [in, out] **enabled** TRUE
 
-Factor [0,1] adjusting loudness (decibels) of emitted sound.
+Enables/disables node operation.
 
 ### SFBool [ ] **spatialize** TRUE
 
-Whether to spatialize sound playback relative to viewer.
+Whether to *spatialize* sound playback relative to viewer.
 
 #### Hint
 
-- Only effective between minimum and maximum ellipsoids.
+- Only effective within the auralization volume.
+
+### SFFloat [in, out] **intensity** 1 <small>[0,1]</small>
+
+Factor [0,1] adjusting loudness (decibels) of emitted sound.
 
 ### SFVec3f [in, out] **location** 0 0 0 <small>(-∞,∞)</small>
 
-Position of sound center, relative to local coordinate system.
+Position of sound ellipsoid center, relative to local coordinate system.
+
+#### Hint
+
+- Improve audibility by setting *location*='0 1.6 0' so that center height of sound ellipsoid matches typical NavigationInfo avatarSize height.
 
 ### SFVec3f [in, out] **direction** 0 0 1 <small>(-∞,∞)</small>
 
@@ -62,19 +75,35 @@ Position of sound center, relative to local coordinate system.
 
 ### SFFloat [in, out] **minBack** 1 <small>[0,∞)</small>
 
-Inner (full volume) ellipsoid distance along back direction. Ensure minBack \<= maxBack.
+Inner (full loudness) ellipsoid distance along back direction.
+
+#### Warning
+
+- Ensure *minBack* \<= maxBack.
 
 ### SFFloat [in, out] **minFront** 1 <small>[0,∞)</small>
 
-Inner (full volume) ellipsoid distance along front direction. Ensure minFront \<= maxFront.
+Inner (full loudness) ellipsoid distance along front direction.
+
+#### Warning
+
+- Ensure *minFront* \<= maxFront.
 
 ### SFFloat [in, out] **maxBack** 10 <small>[0,∞)</small>
 
-Outer (zero volume) ellipsoid distance along back direction. Ensure minBack \<= maxBack.
+Outer (zero loudness)ellipsoid distance along back direction.
+
+#### Warning
+
+- Ensure minBack \<= *maxBack*.
 
 ### SFFloat [in, out] **maxFront** 10 <small>[0,∞)</small>
 
-Outer (zero volume) ellipsoid distance along front direction. Ensure minFront \<= maxFront.
+Outer (zero loudness)ellipsoid distance along front direction.
+
+#### Warning
+
+- Ensure minFront \<= *maxFront*.
 
 ### SFFloat [in, out] **priority** 0 <small>[0,1]</small>
 
@@ -82,19 +111,29 @@ Player hint [0,1] if needed to choose which sounds to play.
 
 ### SFNode [in, out] **source** NULL <small>[X3DSoundSourceNode]</small>
 
-Input/Output field source.
+Sound *source* for the Sound node, either an AudioClip node or a MovieTexture node.
 
-## Description
+#### Warning
 
-### Hint
+- If *source* field is not specified, the Sound node does not emit audio.
+
+### MFNode [in, out] **children** [ ] <small>[X3DSoundChannelNode,X3DSoundProcessingNode,X3DSoundSourceNode]</small>
+
+Input/Output field *children*.
+
+## Advisories
+
+### Hints
 
 - If the audio source is stereo or multi-channel, channel separation is retained during playback.
+- [X3D Sound component Figure 16.2 Sound Node Geometry](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/sound.html#f-Soundnodegeometry){:target="_blank"}
+- [X3D Scene Authoring Hints:Audio](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Audio){:target="_blank"}
+- [Wikipedia 3D sound localization](https://en.wikipedia.org/wiki/3D_sound_localization){:target="_blank"}
 
 ### Warning
 
-- While providing sounds on the ground plane, ensure that the audible auralization ellipse is sufficiently elevated to match avatar height.
+- While providing sounds on the ground plane, ensure that the audible auralization volume is sufficiently elevated to match avatar height.
 
-## External Links
+## See Also
 
-- [X3D Specification of Sound](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#Sound){:target="_blank"}
-- [X3D Scene Authoring Hints:Audio](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Audio){:target="_blank"}
+- [X3D Specification of Sound node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#Sound){:target="_blank"}

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

@@ -13,56 +13,175 @@ tags: [SpatialSound, Sound]
 
 ## Overview
 
-SpatialSound ...
+The SpatialSound node controls the 3D spatialization of sound playback by a child AudioClip or MovieTexture node. Sound intensity includes stereo support, varying according to user location and view direction in the scene.
 
-The SpatialSound node belongs to the **Sound** component and its default container field is *children.* It is available since X3D version 4.0 or later.
+The SpatialSound 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
+      + SpatialSound
 ```
 
 ## 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 [ ] **spatialize** TRUE
 
-### SFFloat [in, out] **coneInnerAngle** <small></small>
+Whether to *spatialize* sound playback relative to viewer.
+
+#### Hint
+
+- Only effective within the auralization volume.
+
+### SFFloat [in, out] **coneInnerAngle** 6.2832 <small>[0,2π]</small>
+
+*coneInnerAngle* is centered along direction and defines the inner conical volume, inside of which no source gain reduction occurs.
+
+#### Hints
+
+- ConeOuterAngle value is greater than or equal to *coneInnerAngle*.
+- [X3D4 Architecture Figure 16.3, SpatialSound Panning Gain Relationships](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/sound.html#f-AudioPannerListenerRelationships){:target="_blank"}
+
+### SFFloat [in, out] **coneOuterAngle** 6.2832 <small>[0,2π]</small>
 
-### SFFloat [in, out] **coneOuterAngle** <small></small>
+*coneOuterAngle* is centered along direction and defines an outer conical volume, within which the sound gain decreases linearly from full gain to coneOuterGain. Outside of *coneOuterAngle*, gain equals coneOuterGain.
 
-### SFFloat [in, out] **coneOuterGain** <small></small>
+#### Hints
 
-### SFVec3f [in, out] **direction** <small></small>
+- *coneOuterAngle* value is greater than or equal to coneInnerAngle.
+- [X3D4 Architecture Figure 16.3, SpatialSound Panning Gain Relationships](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/sound.html#f-AudioPannerListenerRelationships){:target="_blank"}
 
-### SFString [in, out] **distanceModel** <small></small>
+### SFFloat [in, out] **coneOuterGain** 0 <small>(-∞,∞)</small>
+
+*coneOuterGain* is minimum gain value found outside coneOuterAngle.
+
+### SFVec3f [in, out] **direction** 0 0 1 <small>(-∞,∞)</small>
+
+*direction* of sound axis, relative to local coordinate system.
+
+### SFString [in, out] **distanceModel** "INVERSE" <small>["LINEAR" "INVERSE" "EXPONENTIAL"]</small>
+
+*distanceModel* determines how field specifies which algorithm to use for sound attenuation, corresponding to distance between an audio source and a listener, as it moves away from the listener.
+
+#### Hint
+
+- [W3C Web Audio API](https://www.w3.org/TR/webaudio/#enumdef-distancemodeltype){:target="_blank"}
 
 ### SFBool [in, out] **dopplerEnabled** FALSE
 
+*dopplerEnabled* enables/disables whether real-time Doppler effects (due to relation motion between sources and listeners) are computed by browser between virtual sound sources and active listening locations, then applied to received frequency at active listening locations.
+
+#### Hints
+
+- Functional support requires player support for Sound component level 3.
+- [Wikipedia Doppler effect](https://en.wikipedia.org/wiki/Doppler_effect){:target="_blank"}
+
 ### SFBool [in, out] **enableHRTF** FALSE
 
-### SFFloat [in, out] **gain** <small></small>
+*enableHRTF* enables/disables Head Related Transfer Function (HRTF) auralization, if available. SpatialSound enabledHRTF=true corresponds to panningModelType HRTF, enabledHRTF=false corresponds to panningModelType equalpower.
+
+#### Hints
+
+- [W3C Audio API](https://www.w3.org/TR/webaudio/#enumdef-panningmodeltype){:target="_blank"}
+- [Wikipedia HRTF](https://en.wikipedia.org/wiki/3D_sound_localization#Head-related_Transfer_Function_(HRTF)){: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] **intensity** 1 <small>[0,1]</small>
+
+Factor [0,1] adjusting loudness (decibels) of emitted sound.
+
+### SFVec3f [in, out] **location** 0 0 0 <small>(-∞,∞)</small>
+
+Position of sound ellipsoid center, relative to local coordinate system.
+
+#### Hint
+
+- Improve audibility by setting *location*='0 1.6 0' so that center height of sound ellipsoid matches typical NavigationInfo avatarSize height.
+
+### SFFloat [in, out] **maxDistance** 10000 <small>[0,∞)</small>
+
+*maxDistance* is the maximum distance where sound is renderable between source and listener, after which no reduction in sound volume occurs.
+
+### SFFloat [in, out] **priority** 0 <small>[0,1]</small>
+
+Player hint [0,1] if needed to choose which sounds to play.
+
+### SFFloat [in, out] **referenceDistance** 1 <small>[0,∞)</small>
+
+*referenceDistance* for reducing volume as source moves further from the listener. For distances less than this value, volume is not reduced.
+
+#### Hint
+
+- [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dom-pannernode-refdistance){:target="_blank"}
+
+### SFFloat [in, out] **rolloffFactor** 1 <small>[0,∞)</small>
+
+*rolloffFactor* indicates how quickly volume is reduced as source moves further from listener.
+
+#### Hint
+
+- [W3C Web Audio API](https://www.w3.org/TR/webaudio/#dom-pannernode-rollofffactor){: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.
 
-### SFFloat [in, out] **intensity** <small></small>
+#### Warning
 
-### SFVec3f [in, out] **location** <small></small>
+- Contained AudioClip or MovieTexture nodes must have `containerField='children'` to override otherwise-incorrect defaults.
 
-### SFFloat [in, out] **maxDistance** <small></small>
+## Advisories
 
-### SFFloat [in, out] **priority** <small></small>
+### Hints
 
-### SFFloat [in, out] **referenceDistance** <small></small>
+- If the audio source is stereo or multi-channel, channel separation is retained during playback.
+- [X3D Sound component Figure 16.2 Sound Node Geometry](https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/sound.html#f-Soundnodegeometry){:target="_blank"}
+- [W3C Web Audio API, PannerNode Interface](https://www.w3.org/TR/webaudio/#pannernode){:target="_blank"}
+- [X3D Scene Authoring Hints:Audio](https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Audio){:target="_blank"}
+- [Wikipedia 3D sound localization](https://en.wikipedia.org/wiki/3D_sound_localization){:target="_blank"}
 
-### SFFloat [in, out] **rolloffFactor** <small></small>
+### Warning
 
-### MFNode [in, out] **children** <small></small>
+- While providing sounds on the ground plane, ensure that the audible auralization volume is sufficiently elevated to match avatar height.
 
-## External Links
+## See Also
 
-- [X3D Specification of SpatialSound](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#SpatialSound){:target="_blank"}
+- [X3D Specification of SpatialSound node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#SpatialSound){:target="_blank"}

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

@@ -13,40 +13,120 @@ tags: [StreamAudioDestination, Sound]
 
 ## Overview
 
-StreamAudioDestination ...
+StreamAudioDestination node represents the final audio destination via a media stream.
 
-The StreamAudioDestination node belongs to the **Sound** component and its default container field is *children.* It is available since X3D version 4.0 or later.
+The StreamAudioDestination 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
+        + StreamAudioDestination
 ```
 
 ## 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.
 
-### MFString [in, out] **streamIdentifier** <small></small>
+#### Warning
+
+- Decibel values shall not be used.
+
+### MFString [in, out] **streamIdentifier** [ ]
+
+Stream identification TBD
+
+#### Hint
+
+- [W3C Media Capture and Streams](https://www.w3.org/TR/mediacapture-streams){:target="_blank"}
 
 ### 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.
 
-### SFString [in, out] **channelInterpretation** <small></small>
+#### 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**
 
-### MFNode [in, out] **children** <small></small>
+*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/#mediastreamaudiodestinationnode){:target="_blank"}
+
+### Warning
+
+- Stream-identification parameters are not fully defined and subject to change.
 
-## External Links
+## See Also
 
-- [X3D Specification of StreamAudioDestination](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#StreamAudioDestination){:target="_blank"}
+- [X3D Specification of StreamAudioDestination node](https://www.web3d.org/documents/specifications/19775-1/V4.0/Part01/components/sound.html#StreamAudioDestination){:target="_blank"}