Merge pull request #442 from software-mansion/docs/oscillator-node

docs: add docs for oscillator node

Author: mdydek

packages/audiodocs/docs/core/base-audio-context.mdx

@@ -96,7 +96,7 @@ The above method lets you create [`GainNode`](/effects/gain-node).
 
 ### `createOscillator`
 
-The above method lets you create `OscillatorNode`.
+The above method lets you create [`OscillatorNode`](/sources/oscillator-node).
 
 #### Returns `OscillatorNode`.
 

packages/audiodocs/docs/sources/audio-buffer-source-node.mdx

@@ -10,8 +10,8 @@ import { Optional, Overridden } from '@site/src/components/Badges';
 The `AudioBufferSourceNode` is an [`AudioScheduledSourceNode`](/sources/audio-scheduled-source-node) which represents audio source with in-memory audio data, stored in `AudioBuffer`.
 You can use it for audio playback, including standard pause and resume functionalities.
 
-An `AudioBufferSourceNode` can be started only once, so if you want to play the same sound again you have to created new one.
-However this node is very inexpensive to create, and what is crucial you can reuse same [`AudioBuffer`](/sources/audio-buffer).
+An `AudioBufferSourceNode` can be started only once, so if you want to play the same sound again you have to create a new one.
+However, this node is very inexpensive to create, and what is crucial you can reuse same [`AudioBuffer`](/sources/audio-buffer).
 
 #### [`AudioNode`](/core/audio-node#read-only-properties) properties
 

packages/audiodocs/docs/sources/oscillator-node.mdx

@@ -0,0 +1,73 @@
+---
+sidebar_position: 4
+---
+
+import AudioNodePropsTable from "@site/src/components/AudioNodePropsTable"
+import { Optional, ReadOnly } from '@site/src/components/Badges';
+
+# OscillatorNode
+
+The `OscillatorNode` is an [`AudioScheduledSourceNode`](/sources/audio-scheduled-source-node) which represents a simple periodic wave signal.
+Similar to all of `AudioScheduledSourceNodes`, it can be started only once. If you want to play the same sound again you have to create a new one.
+
+#### [`AudioNode`](/core/audio-node#read-only-properties) properties
+
+<AudioNodePropsTable numberOfInputs={0} numberOfOutputs={1} channelCount={"defined by associated buffer"} channelCountMode={"max"} channelInterpretation={"speakers"} />
+
+## Constructor
+
+[`BaseAudioContext.createOscillator(options)`](/core/base-audio-context#createoscillator)
+
+## Example
+
+```tsx
+import React, { useEffect, useRef, FC } from 'react';
+import {
+  AudioContext,
+  OscillatorNode,
+} from 'react-native-audio-api';
+
+export default MyComponent: FC = () => {
+  const audioContextRef = useRef<AudioContext | null>(null);
+
+  useEffect(() => {
+      if (!audioContextRef.current) {
+        audioContextRef.current = new AudioContext();
+      }
+      const oscillator = audioContextRef.current.createOscillator();
+      oscillator.connect(audioContextRef.current.destination);
+      oscillator.start(audioContextRef.current.currentTime);
+    }
+  )
+}
+```
+
+## Properties
+
+| Name | Type | Default value | Description |
+| :----: | :----: | :-------- | :------- |
+| `detune` <ReadOnly /> | [`AudioParam`](/core/audio-param) | 0 |[`a-rate`](/core/audio-param#a-rate-vs-k-rate) `AudioParam` representing detuning of oscillation in cents. |
+| `frequency` <ReadOnly /> | [`AudioParam`](/core/audio-param) | 440 | [`a-rate`](/core/audio-param#a-rate-vs-k-rate) `AudioParam` representing frequency of wave in herzs. |
+| `type` | [`OscillatorType`](/types/oscillator-type)| `sine` | String value represening type of wave. |
+
+## Methods
+
+### `setPeriodicWave`
+
+The above allows user to set any periodic wave.
+
+| Parameters | Type | Description |
+| :---: | :---: | :---- |
+| `wave` | `PeriodicWave` | Data representing custom wave. [`See for reference`](/core/base-audio-context#createperiodicwave) |
+
+#### Returns `undefined`.
+
+## Remarks
+
+#### `detune`
+- Nominal range is: -∞ to ∞.
+- For example value of 100 detune the source up by one semitone, whereas -1200 down by one octave.
+
+#### `frequency`
+- 440 Hz is equivalent to piano note A4.
+- Nominal range is: -sampleRate/2 to sampleRate/2 (`sampleRate` value is taken from [`AudioContext`](/core/base-audio-context#properties))

packages/audiodocs/docs/types/oscillator-type.mdx

@@ -0,0 +1,24 @@
+---
+sidebar_position: 6
+---
+
+# OscillatorType
+
+`OscillatorType` is a string that specifies shape of an oscillator wave
+
+```jsx
+type OscillatorType =
+  | 'sine'
+  | 'square'
+  | 'sawtooth'
+  | 'triangle'
+  | 'custom';
+```
+
+Below you can see possible names with shapes corresponding to them.
+![](/img/oscillator-waves.png)
+
+## `custom`
+
+This value can't be set explicitly, but it allows user to set any shape. See [`setPeriodicWave`](/sources/oscillator-node#setperiodicwave) for reference.
+

packages/audiodocs/docs/types/periodic-wave-constraints.mdx

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 6
+sidebar_position: 7
 ---
 
 # PeriodicWaveConstraints

packages/audiodocs/docs/types/window-type.mdx

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 7
+sidebar_position: 8
 ---
 
 # WindowType