Huberts design doc

Author: michalsek

README.md

@@ -1,6 +1,10 @@
 # react-native-audio-context
 
-D
+The main goal of the project is to reproduce the Web Audio API as accurate as possible in the React Native environment.
+
+## Internal Documentation
+
+- [Basic interfaces description](./internal-docs/basic-interfaces.md)
 
 ## Installation
 

internal-docs/basic-interfaces.md

@@ -0,0 +1,99 @@
+# React Native Audio Context
+
+## Project goal
+
+The main goal of the project is to reproduce the Web Audio API as accurate as possible in the React Native environment.
+
+## Interfaces
+
+The document introduces the basic interfaces that we want to recreate.
+
+1. [AudioContext](#audiocontext)
+2. [AudioNode](#audionode)
+3. [AudioParam](#audioparam)
+4. [OscillatorNode](#oscillatornode)
+5. [GainNode](#gainnode)
+6. [StereoPannerNode](#stereopannernode)
+
+### AudioContext
+
+The `AudioContext` interface is the underlying audio context that manages the state of the entire audio application.
+
+#### Attributes
+
+- **`destination`**: Output node that is typically connected to speakers.
+- **`sampleRate`**: Audio sampling rate in hertz.
+
+#### Methods
+
+- **`createBuffer()`**: Creates the audio buffer.
+- **`createGain()`**: Creates a gain node.
+- **`createOscillator()`**: Creates an oscillator node.
+- **`createStereoPanner()`**: Creates a stereo panning node.
+
+### AudioNode
+
+The `AudioNode` interface is the base interface for all audio nodes in the audio processing graph.
+
+#### Methods
+
+- **`connect(destination, output, input)`**: Connects the current audio node to another audio node or parameter.
+- **`disconnect(destination, output, input)`**: Disconnects the current audio node from another audio node or parameter.
+- **`process()`**: process node base on setup attributes.
+
+### AudioParam
+
+The `AudioParam` interface represents audio parameters that can be time-modulated.
+
+#### Attributes
+
+- **`value`**: The current value of the parameter.
+
+#### Methods
+
+- **`setValueAtTime(value, startTime)`**: Sets the parameter value at the specified time.
+- **`linearRampToValueAtTime(value, endTime)`**: Linearly ramps the value of a parameter to a specified value in a specified time.
+- **`exponentialRampToValueAtTime(value, endTime)`**: Exponentially changes the value of a parameter to the specified value over the specified time.
+
+### OscillatorNode
+
+The `OscillatorNode` interface represents an oscillator node that generates sounds at a specific frequency and waveform.
+
+#### Attributes
+
+- **`frequency`**: `AudioParam` - frequency parameter.
+- **`detune`**: `AudioParam` - detune parameter.
+- **`type`**: wave type (`sine`, `square`, `sawtooth`, `triangle`).
+
+### GainNode
+
+The `GainNode` interface represents a gain node that allows you to control the volume of the audio signal.
+
+#### Attributes
+
+- **`gain`**: `AudioParam` - gain parameter.
+
+### StereoPannerNode
+
+The `StereoPannerNode` interface represents a stereo panning node that allows you to control the position of sound in stereo space.
+
+#### Attributes
+
+- **`pan`**: `AudioParam` - panning parameter.
+
+## Processing Graph
+
+Processing graph - a graph, or more precisely, a chain of interconnected nodes through which the audio signal flows. Each node can be independently configured and connected to other nodes.
+
+### Example processing graph
+
+```mermaid
+	graph TD
+    A[Oscillator] --> B[GainNode]
+		B --> C[PannerNode]
+		C --> D[Destination]
+		E[Oscillator] --> F[GainNode]
+		F --> D
+```
+
+The example graph consists of two oscillators. The first of them is equipped with GainNode and PannerNode, which allows you to control the volume and panning of the sound. Only the GainNode is connected to the second oscillator, which allows you to change its volume. Both oscillators are connected to destination, which means they will be heard at the same time

package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-audio-context",
   "version": "0.1.0",
-  "description": "D",
+  "description": "The main goal of the project is to reproduce the Web Audio API as accurate as possible in the React Native environment",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
   "types": "lib/typescript/src/index.d.ts",