diff --git a/packages/audiodocs/docs/types/channel-interpretation.mdx b/packages/audiodocs/docs/types/channel-interpretation.mdx index 56ac9bca..05274b48 100644 --- a/packages/audiodocs/docs/types/channel-interpretation.mdx +++ b/packages/audiodocs/docs/types/channel-interpretation.mdx @@ -41,5 +41,3 @@ sidebar_position: 2 | :------------------------: | :------------------------- | :------------ | | x | y where y > x | Fill each output channel with its counterpart(channel with same number), rest of output channels are silent channels | | x | y where y < x | Fill each output channel with its counterpart(channel with same number), rest of input channels are skipped | - - diff --git a/packages/audiodocs/docs/types/window-type.mdx b/packages/audiodocs/docs/types/window-type.mdx new file mode 100644 index 00000000..64ec2a86 --- /dev/null +++ b/packages/audiodocs/docs/types/window-type.mdx @@ -0,0 +1,16 @@ +--- +sidebar_position: 3 +--- + +# WindowType + +`WindowType` type specifies which [window function](https://en.wikipedia.org/wiki/Window_function) is applied when extracting frequency data. + +**Acceptable values:** + - `blackman` + + Set [Blackman window](https://www.sciencedirect.com/topics/engineering/blackman-window) as window function. + + - 'hann` + + Set [Hanning window](https://www.sciencedirect.com/topics/engineering/hanning-window) as window function. diff --git a/packages/audiodocs/docs/visualization/analyser-node.mdx b/packages/audiodocs/docs/visualization/analyser-node.mdx index 68d7308c..eab93b5f 100644 --- a/packages/audiodocs/docs/visualization/analyser-node.mdx +++ b/packages/audiodocs/docs/visualization/analyser-node.mdx @@ -28,6 +28,13 @@ In contrast, a frequency-domain graph reveals how the signal's energy or power i | `minDecibels` | `number` | Returns float value representing the minimum value for the range of results from [`getByteFrequencyData()`](/visualization/analyser-node#getbytefrequencydata). | | `maxDecibels` | `number` | Returns float value representing the maximum value for the range of results from [`getByteFrequencyData()`](/visualization/analyser-node#getbytefrequencydata). | | `smoothingTimeConstant` | `number` | Returns float value representing averaging constant with the last analysis frame. In general the higher value the smoother is the transition between values over time. | +| `window` | [`WindowType`](/types/window-type) | Returns an enumerated value that specifies the type of window function applied when extracting frequency data. | + +:::caution + +On `Web`, the value of`window` is permanently `'blackman'`, and it cannot be set like in the `Android` or `iOS`. + +::: ## Read-only properties @@ -101,3 +108,6 @@ Each value in the array is within the range 0 to 255, where value of 127 indicat - Default value is 0.8. - From range 0 to 1. - 0 means no averaging, 1 means "overlap the previous and current buffer quite a lot while computing the value". + +#### `window` +- Default value is `'blackman'`