diff --git a/README.md b/README.md index 0b9a3d4d..7b676de0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -React Native Audio API +React Native Audio API ### ⚠️ Pre-Alpha @@ -31,7 +31,7 @@ allowing developers to generate and modify audio in exact same way it is possibl ## Coverage -Our current coverage of Web Audio API specification can be found here: [Web Audio API coverage](./internal-docs/web-audio-coverage.md). +Our current coverage of Web Audio API specification can be found here: [Web Audio API coverage](./docs/web-audio-coverage.md). ## Examples diff --git a/docs/assets/react-native-audio-api-gh-cover.png b/docs/assets/react-native-audio-api-gh-cover.png new file mode 100644 index 00000000..7573535b Binary files /dev/null and b/docs/assets/react-native-audio-api-gh-cover.png differ diff --git a/internal-docs/web-audio-coverage.md b/docs/web-audio-coverage.md similarity index 53% rename from internal-docs/web-audio-coverage.md rename to docs/web-audio-coverage.md index f6fa67bf..f3108cf3 100644 --- a/internal-docs/web-audio-coverage.md +++ b/docs/web-audio-coverage.md @@ -7,28 +7,28 @@ Some of the noticeable implementation details that are still in progress or not - Support of different number of channels (current approach in most of the audio-graph nodes assumes working with two channel audio) - Multi-input for each node and input mixing (Although specification suggests that most of the nodes can cave only one input or output, common use-cases proves otherwise). Only node that mixes multiple inputs is `DestinationNode`. -## Completed (**5** out of 33) +## ✅ Completed (**5** out of 33)
- ✅ AudioScheduledSourceNode + AudioScheduledSourceNode
- ✅ AudioDestinationNode + AudioDestinationNode
- ✅ GainNode + GainNode
- ✅ StereoPannerNode + StereoPannerNode
- ✅ AudioNode + AudioNode
-## In Progress (**7** out of 33) +## 🚧 In Progress (**7** out of 33)
- 🚧 AudioContext + AudioContext
@@ -50,69 +50,69 @@ Some of the noticeable implementation details that are still in progress or not
- 🚧 AudioBuffer + AudioBuffer
| Property 🔹/ Method 🔘 | state | | ---------------------- | ----- | -| 🔹sampleRate | ✅ | -| 🔹length | ✅ | -| 🔹duration | ✅ | -| 🔹numberOfChannels | ✅ | -| 🔘getChannelData | ✅ | -| 🔘getChannelData | ✅ | -| 🔘setChannelData | ✅ | -| 🔘copyFromChannel | ❌ | -| 🔘copyToChannel | ❌ | +| 🔹 sampleRate | ✅ | +| 🔹 length | ✅ | +| 🔹 duration | ✅ | +| 🔹 numberOfChannels | ✅ | +| 🔘 getChannelData | ✅ | +| 🔘 getChannelData | ✅ | +| 🔘 setChannelData | ✅ | +| 🔘 copyFromChannel | ❌ | +| 🔘 copyToChannel | ❌ |
- 🚧 AudioBufferSourceNode + AudioBufferSourceNode
| Property 🔹/ Method 🔘 | state | | ---------------------- | ----- | -| 🔹buffer | ✅ | -| 🔹detune | ❌ | -| 🔹loop | ✅ | -| 🔹loopStart | ❌ | -| 🔹loopEnd | ❌ | -| 🔹playBackRate | ❌ | -| 🔘start(overridden) | ❌ | +| 🔹 buffer | ✅ | +| 🔹 detune | ❌ | +| 🔹 loop | ✅ | +| 🔹 loopStart | ❌ | +| 🔹 loopEnd | ❌ | +| 🔹 playBackRate | ❌ | +| 🔘 start(overridden) | ❌ |
- 🚧 AudioParam + AudioParam
-| Property 🔹/ Method 🔘 | state | -| ------------------------- | ----- | -| 🔹value | ✅ | -| 🔹defaultValue | ✅ | -| 🔹minValue | ✅ | -| 🔹maxValue | ✅ | -| 🔘setValueAtTime | ✅ | -| 🔘linearRampToValueAtTime | ✅ | -| 🔘setTargetAtTime | ❌ | -| 🔘setValueCurveAtTime | ❌ | -| 🔘cancelScheduledValues | ❌ | -| 🔘cancelAndHoldAtTime | ❌ | +| Property 🔹/ Method 🔘 | state | +| -------------------------- | ----- | +| 🔹 value | ✅ | +| 🔹 defaultValue | ✅ | +| 🔹 minValue | ✅ | +| 🔹 maxValue | ✅ | +| 🔘 setValueAtTime | ✅ | +| 🔘 linearRampToValueAtTime | ✅ | +| 🔘 setTargetAtTime | ❌ | +| 🔘 setValueCurveAtTime | ❌ | +| 🔘 cancelScheduledValues | ❌ | +| 🔘 cancelAndHoldAtTime | ❌ |
- 🚧 BaseAudioContext + BaseAudioContext
@@ -148,101 +148,101 @@ Some of the noticeable implementation details that are still in progress or not
- 🚧 OscillatorNode + OscillatorNode
| Property 🔹/ Method 🔘 | state | | ---------------------- | ----- | -| 🔹frequency | ✅ | -| 🔹detune | ✅ | -| 🔹type | ✅ | -| 🔘setPeriodicWave | ❌ | +| 🔹 frequency | ✅ | +| 🔹 detune | ✅ | +| 🔹 type | ✅ | +| 🔘 setPeriodicWave | ❌ |
- 🚧 BiquadFilterNode + BiquadFilterNode
-| Property 🔹/ Method 🔘 | state | -| ---------------------- | ----- | -| 🔹frequency | ✅ | -| 🔹detune | ✅ | -| 🔹Q | ✅ | -| 🔹gain | ✅ | -| 🔹type | ✅ | -| 🔘getFrequencyResponse | ❌ | +| Property 🔹/ Method 🔘 | state | +| ----------------------- | ----- | +| 🔹 frequency | ✅ | +| 🔹 detune | ✅ | +| 🔹 Q | ✅ | +| 🔹 gain | ✅ | +| 🔹 type | ✅ | +| 🔘 getFrequencyResponse | ❌ |
-## Not yet available (**21** out of 33) +## ❌ Not yet available (**21** out of 33)
- ❌ AudioParamMap + AudioParamMap
- ❌ MediaElementAudioSourceNode + MediaElementAudioSourceNode
- ❌ MediaStreamAudioSourceNode + MediaStreamAudioSourceNode
- ❌ MediaStreamTrackAudioSourceNode + MediaStreamTrackAudioSourceNode
- ❌ ConvolverNode + ConvolverNode
- ❌ DelayNode + DelayNode
- ❌ DynamicsCompressorNode + DynamicsCompressorNode
- ❌ WaveShaperNode + WaveShaperNode
- ❌ PeriodicWave + PeriodicWave
- ❌ IRRFilterNode + IRRFilterNode
- ❌ MediaStreamAudioDestinationNode + MediaStreamAudioDestinationNode
- ❌ AnalyserNode + AnalyserNode
- ❌ ChannelSplitterNode + ChannelSplitterNode
- ❌ MergerNode + MergerNode
- ❌ AudioListener + AudioListener
- ❌ PannerNode + PannerNode
- ❌ AudioWorkletNode + AudioWorkletNode
- ❌ AudioWorkletProcessor + AudioWorkletProcessor
- ❌ AudioWorkletGlobalScope + AudioWorkletGlobalScope
- ❌ OfflineAudioContext + OfflineAudioContext
- ❌ AudioParamMap + AudioParamMap
diff --git a/internal-docs/assets/react-native-audio-api-gh-cover.png b/internal-docs/assets/react-native-audio-api-gh-cover.png deleted file mode 100644 index 296123f5..00000000 Binary files a/internal-docs/assets/react-native-audio-api-gh-cover.png and /dev/null differ