merge main to docsprod (#483)

* docs: add docs for oscillator node

* docs: added wave shapes img

* docs: removed empty periodic wave screen

* docs: stereo panner node

* update installation docs to include metro config (#447)

* fix: linted file

* Feat/onended/added state to payload (#453)

* feat: added state to payload of onended event

* ci: yarn format

* fix: added appropriate type to arg of onended method

---------

Co-authored-by: Maciej Makowski <[email protected]>

* fix: number of channelCount

* fix: added possibility of disconnection between node and param in ts

* docs: add mention about connecting node to param

* feat: naive approach to streaming in beloved cpp (#461)

* feat: naive approach streaming in beloved cpp

* refactor: minor improvements

* fix: minor fix

* fix: bring back Audiofile example

* fix: renamed new node

* fix: revert project.pbxproj changes and formatting

---------

Co-authored-by: Maciej Makowski <[email protected]>

* docs: added search bar into the documentation

* Feat/streaming/additional features (#462)

* feat: added bufferId arg to enqueueBuffer and attached it to onended payload

* feat: added onPositionChanged event

* ci: yarn format

* fix: minor fix

---------

Co-authored-by: Maciej Makowski <[email protected]>

* Refactor/system settings and audio engine (#466)

* feat: added bufferId arg to enqueueBuffer and attached it to onended payload

* feat: added onPositionChanged event

* ci: yarn format

* fix: minor fix

* fix: fixed system settings

* fix: fixed engine connections

* feat: implemented setAudioSessionActivity

* ci: yarn format

* fix: small fix

---------

Co-authored-by: Maciej Makowski <[email protected]>

* fix: changed type of reason to string union

* fix: removed double unknown type

* fix: fixed NativeAudioAPIModuleSpec on oldArch (#470)

Co-authored-by: Maciej Makowski <[email protected]>

* fix: fixed building without withAudioAPI plugin (#471)

Co-authored-by: Maciej Makowski <[email protected]>

* Docs/audio manager (#458)

* docs: add audio manager documentation

* feat: rewrote types section

* docs: better info on returning types

* docs: added missing explanation and aligned with new impl

* fix: small typos

* fix: typos

* feat: extended examples

* fix: minor fixes (#474)

Co-authored-by: Maciej Makowski <[email protected]>

* fix: possibility of connecting node to param on web

* chore: readme update to 0.6.0

* chore: readme update to 0.6.0 v2

* chore: add 0.6.0 link

* fix: typo

* Revert "Chore/update readme 0.6.0"

* chore: small refactor in readme

* fix: config plugin defaults and types

* fix: config plugin defaults and types

* fix: cleanup types

* fix: fixed system playback speed (#479)

Co-authored-by: Maciej Makowski <[email protected]>

* Refactor/system audio settings and engines (#480)

* refactor: android system functions improvement

* ci: yarn format

* feat: added option to init audioContext suspended

* refactor: refactored audio player behaviors

* ci: yarn format

* refactor: small refactor of AudioContextOptions

* fix: small nitpick

* refactor: pausing engine only if all players are paused

* ci: yarn format

* fix: removed synchronized decorator from AudioAPIModule

---------

Co-authored-by: Maciej Makowski <[email protected]>

* fix returning status in requestRecordingPermissions (#473)

* fix: ios fix

* fix: android fix

* fix: 2nd iteration of andoroid implementation

* docs: added info note about  plugin (#472)

* docs: added info note plugin

* fix: naming

* docs: removed info about connecting to only node from web audio api coverage

* fix: small fix

---------

Co-authored-by: Maciej Makowski <[email protected]>
Co-authored-by: michal <[email protected]>

---------

Co-authored-by: michal <[email protected]>
Co-authored-by: gabimoncha <[email protected]>
Co-authored-by: Michał Dydek <[email protected]>
Co-authored-by: Maciej Makowski <[email protected]>
Co-authored-by: Michał Sęk <[email protected]>

Author: 5 people

.github/workflows/publish-docs.yml

@@ -45,5 +45,11 @@ jobs:
       - name: Setup Pages
         uses: actions/configure-pages@v5
 
+      - name: Recrawl search index
+        run: | 
+          curl -X POST https://crawler.algolia.com/api/1/crawlers/${{ secrets.CRAWLER_ID }}/reindex \
+          -H "Content-Type: application/json" \
+          -u ${{ secrets.CRAWLER_USER_ID }}:${{ secrets.CRAWLER_API_KEY }}
+
       - name: Deploy to Github Pages
         uses: actions/deploy-pages@v4

README.md

@@ -34,17 +34,12 @@ check out the [Getting Started](https://docs.swmansion.com/react-native-audio-ap
   Ability to modify playback speed without affecting pitch of the sound
   <br />
 
-- <sub>![Coming in 0.6.0](https://img.shields.io/badge/Coming_in-0.6.0-blue)</sub> **System configuration** 🛠️ <br />
-  Full control of system audio settings, remote controls, lock screen integration and most importantly configurable background modes
-  <br />
-
-- **Microphone support** 🎙️ <br />
-  Grab audio data from device microphone or connected device, connect it to the audio graph or stream through the internet
-  <br />
-
-- **Connect audio param** 🤞 <br />
-  Ability to connect Audio nodes to audio params, which will allow for powerful and efficient modulation of audio parameters, creating effects like tremolo, vibrato or complex envelope followers.
-  <br />
+- <sub>[![Released in 0.6.0](https://img.shields.io/badge/Released_in-0.6.0-green)](https://github.com/software-mansion/react-native-audio-api/releases/tag/0.6.0)</sub> <br/> **System configuration** 🛠️ <br />
+  Full control of system audio settings, remote controls, lock screen integration and most importantly configurable background modes <br />
+  <br /> **Microphone support** 🎙️ <br />
+  Grab audio data from device microphone or connected device, connect it to the audio graph or stream through the internet <br />
+  <br /> **Connect audio param** 🤞 <br />
+  Ability to connect Audio nodes to audio params, which will allow for powerful and efficient modulation of audio parameters, creating effects like tremolo, vibrato or complex envelope followers. <br />
 
 - **JS Audio Worklets** 🐎 <br />
   Ability to run JS functions connected to the audio graph running on audio thread allowing for full customization of what happens to the audio signal.

apps/common-app/src/examples/AudioFile/AudioFile.tsx

@@ -12,9 +12,6 @@ import { Container, Button, Spacer, Slider } from '../../components';
 const URL =
   'https://software-mansion.github.io/react-native-audio-api/audio/voice/example-voice-01.mp3';
 
-const LOOP_START = 0;
-const LOOP_END = 10;
-
 const INITIAL_RATE = 1;
 const INITIAL_DETUNE = 0;
 
@@ -49,7 +46,7 @@ const AudioFile: FC = () => {
     }
   };
 
-  const handlePress = () => {
+  const handlePress = async () => {
     if (!audioContextRef.current) {
       return;
     }
@@ -59,11 +56,17 @@ const AudioFile: FC = () => {
       AudioManager.setLockScreenInfo({
         state: 'state_paused',
       });
+
+      setTimeout(async () => {
+        await audioContextRef.current?.suspend();
+      }, 5);
     } else {
       if (!audioBuffer) {
         fetchAudioBuffer();
       }
 
+      await audioContextRef.current.resume();
+
       AudioManager.setLockScreenInfo({
         state: 'state_playing',
       });
@@ -74,12 +77,9 @@ const AudioFile: FC = () => {
         pitchCorrection: true,
       });
       bufferSourceRef.current.buffer = audioBuffer;
-      bufferSourceRef.current.loop = true;
       bufferSourceRef.current.onended = (event) => {
         setOffset((_prev) => event.value || 0);
       };
-      bufferSourceRef.current.loopStart = LOOP_START;
-      bufferSourceRef.current.loopEnd = LOOP_END;
       bufferSourceRef.current.playbackRate.value = playbackRate;
       bufferSourceRef.current.detune.value = detune;
       bufferSourceRef.current.connect(audioContextRef.current.destination);
@@ -113,7 +113,7 @@ const AudioFile: FC = () => {
 
   useEffect(() => {
     if (!audioContextRef.current) {
-      audioContextRef.current = new AudioContext();
+      audioContextRef.current = new AudioContext({ initSuspended: true });
     }
 
     AudioManager.setLockScreenInfo({
@@ -123,37 +123,40 @@ const AudioFile: FC = () => {
       duration: 10,
     });
 
-    const remotePlaySubscription = AudioManager.enableSystemEvent(
+    AudioManager.enableRemoteCommand('remotePlay', true);
+    AudioManager.enableRemoteCommand('remotePause', true);
+    AudioManager.enableRemoteCommand('remoteChangePlaybackPosition', true);
+    AudioManager.observeAudioInterruptions(true);
+
+    const remotePlaySubscription = AudioManager.addSystemEventListener(
       'remotePlay',
       (event) => {
         console.log('remotePlay event:', event);
       }
     );
 
-    const remotePauseSubscription = AudioManager.enableSystemEvent(
+    const remotePauseSubscription = AudioManager.addSystemEventListener(
       'remotePause',
       (event) => {
         console.log('remotePause event:', event);
       }
     );
 
     const remoteChangePlaybackPositionSubscription =
-      AudioManager.enableSystemEvent(
+      AudioManager.addSystemEventListener(
         'remoteChangePlaybackPosition',
         (event) => {
           console.log('remoteChangePlaybackPosition event:', event);
         }
       );
 
-    const interruptionSubscription = AudioManager.enableSystemEvent(
+    const interruptionSubscription = AudioManager.addSystemEventListener(
       'interruption',
       (event) => {
         console.log('Interruption event:', event);
       }
     );
 
-    AudioManager.observeAudioInterruptions(true);
-
     fetchAudioBuffer();
 
     return () => {
@@ -162,6 +165,7 @@ const AudioFile: FC = () => {
       remoteChangePlaybackPositionSubscription?.remove();
       interruptionSubscription?.remove();
       audioContextRef.current?.close();
+      AudioManager.resetLockScreenInfo();
     };
   }, [fetchAudioBuffer]);
 

packages/audiodocs/docs/core/audio-node.mdx

@@ -35,6 +35,52 @@ Based on them we can obtain output's number of channels and mixing strategy.
 | `channelCountMode` | [`ChannelCountMode`](/types/channel-count-mode) | Enumerated value that specifies the method by which channels are mixed between the node's inputs and outputs. | <ReadOnly /> |
 | `channelInterpretation` | [`ChannelInterpretation`](/types/channel-interpretation) | Enumerated value that specifies how input channels are mapped to output channels when number of them is different. | <ReadOnly /> |
 
+## Examples
+
+### Connecting node to node
+
+```tsx
+import { OscillatorNode, GainNode, AudioContext } from 'react-native-audio-api';
+
+function App() {
+  const audioContext = new AudioContext();
+  const oscillatorNode = audioContext.createOscillator();
+  const gainNode = audioContext.createGain();
+
+  gainNode.gain.value = 0.5; //lower volume to 0.5
+  oscillatorNode.connect(gainNode);
+  gainNode.connect(audioContext.destination);
+  oscillatorNode.start(audioContext.currentTime);
+}
+```
+
+### Connecting node to audio param (LFO-controlled parameter)
+
+```tsx
+import { OscillatorNode, GainNode, AudioContext } from 'react-native-audio-api';
+
+function App() {
+  const audioContext = new AudioContext();
+  const oscillatorNode = audioContext.createOscillator();
+  const lfo = audioContext.createOscillator();
+  const gainNode = audioContext.createGain();
+
+  gainNode.gain.value = 0.5; //lower volume to 0.5
+  lfo.frequency.value = 2; //low frequency oscillator with 2Hz
+
+  // by default oscillator wave values ranges from -1 to 1
+  // connecting lfo to gain param will cause the gain param to oscillate at 2Hz and its value will range from 0.5 - 1 to 0.5 + 1
+  // you can modulate amplitude by connecting lfo to another gain that would be responsible for this value
+  lfo.connect(gainNode.gain)
+
+  oscillatorNode.connect(gainNode);
+  gainNode.connect(audioContext.destination);
+  oscillatorNode.start(audioContext.currentTime);
+  lfo.start(audioContext.currentTime);
+}
+```
+
+
 ## Methods
 
 ### `connect`
@@ -43,7 +89,7 @@ The above method lets you connect one of the node's outputs to a destination.
 
 | Parameters | Type | Description |
 | :---: | :---: | :---- |
-| `destination` | [`AudioNode`](/core/audio-node) | `AudioNode` to which to connect. |
+| `destination` | [`AudioNode`](/core/audio-node) or [`AudioParam`](/core/audio-param) | `AudioNode` or `AudioParam` to which to connect. |
 
 #### Errors:
 
@@ -59,7 +105,7 @@ The above method lets you disconnect one or more nodes from the node.
 
 | Parameters | Type | Description |
 | :---: | :---: | :---- |
-| `destination` <Optional /> | [`AudioNode`](/core/audio-node) | `AudioNode` to which to connect. |
+| `destination` <Optional /> | [`AudioNode`](/core/audio-node) or [`AudioParam`](/core/audio-param) | `AudioNode` or `AudioParam` from which to disconnect. |
 
 If no arguments provided node disconnects from all outgoing connections.
 

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`.
 
@@ -122,7 +122,7 @@ The above method lets you create `PeriodicWave`.
 
 The above method lets you create `StereoPannerNode`.
 
-#### Returns `StereoPannerNode`.
+#### Returns [`StereoPannerNode`](/effects/stereo-panner-node).
 
 ### `decodeAudioData`
 

packages/audiodocs/docs/effects/stereo-panner-node.mdx

@@ -0,0 +1,29 @@
+---
+sidebar_position: 2
+---
+
+import AudioNodePropsTable from "@site/src/components/AudioNodePropsTable"
+import { ReadOnly } from '@site/src/components/Badges';
+
+# StereoPannerNode
+
+The `StereoPannerNode` interface represents the change in ratio between two outputing channels (f. e. left and right speaker).
+
+#### [`AudioNode`](/core/audio-node#read-only-properties) properties
+
+<AudioNodePropsTable numberOfInputs={1} numberOfOutputs={1} channelCount={2} channelCountMode={"explicit"} channelInterpretation={"speakers"} />
+
+## Constructor
+
+[`BaseAudioContext.createStereoPanner()`](/core/base-audio-context#createstereopanner)
+
+## Properties
+
+| Name | Type | Default value | Description |
+| :----: | :----: | :-------- | :------ |
+| `pan` | [`AudioParam`](/core/audio-param) <ReadOnly /> | 0 | [`a-rate`](/core/audio-param#a-rate-vs-k-rate) `AudioParam` representing value of pan to apply. | 
+
+## Remarks
+
+#### `pan`
+- Nominal range is -1 (only left channel) to 1 (only right channel).

packages/audiodocs/docs/fundamentals/getting-started.mdx

@@ -13,7 +13,7 @@ The goal of _Fundamentals_ is to guide you through the setup process of the Audi
 
 It takes only a few steps to add Audio API to your project:
 
-### Install the package
+### Step 1: Install the package
 
 Install the `react-native-audio-api` package from npm:
 
@@ -35,6 +35,80 @@ Install the `react-native-audio-api` package from npm:
   </TabItem>
 </Tabs>
 
+### Step 2: Add Audio API expo plugin (optional)
+
+Add `react-native-audio-api` expo plugin to your `app.json` or `app.config.js`.
+
+<details>
+<summary>app.json</summary>
+```javascript
+{
+  "plugins": [
+    [
+      "react-native-audio-api",
+      {
+        "iosBackgroundMode": true,
+        "androidPermissions" : [
+          "android.permission.MODIFY_AUDIO_SETTINGS",
+          "android.permission.FOREGROUND_SERVICE",
+          "android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK"
+        ],
+        "androidForegroundService": true,
+        "androidFSTypes": [
+          "mediaPlayback"
+        ]
+      }
+    ]
+  ]
+}
+```
+</details>
+
+<details>
+<summary>app.config.js</summary>
+```javascript
+export default {
+  ...
+  "plugins": [
+    [
+      "react-native-audio-api",
+      {
+        "iosBackgroundMode": true,
+        "androidPermissions" : [
+          "android.permission.MODIFY_AUDIO_SETTINGS",
+          "android.permission.FOREGROUND_SERVICE",
+          "android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK"
+        ],
+        "androidForegroundService": true,
+        "androidFSTypes": [
+          "mediaPlayback"
+        ]
+      }
+    ]
+  ]
+};
+```
+</details>
+
+Read more about plugin [here](/other/audio-api-plugin)!
+
+### Step 3: Wrap metro config with Audio API wrapper (recommended)
+
+Wrap your existing Metro configuration in the `metro.config.js` file with the `wrapWithAudioAPIMetroConfig` function:
+
+```javascript
+// metro.config.js
+const {
+  wrapWithAudioAPIMetroConfig,
+} = require('react-native-audio-api/metro-config');
+
+const config = {
+  // Your existing Metro configuration options
+};
+
+module.exports = wrapWithAudioAPIMetroConfig(config);
+```
+
 ### Usage with expo
 
 `react-native-audio-api` contains native custom code and isn't part of the Expo Go application. In order to be available in expo managed builds, you have to use Expo development build. Simplest way on starting local expo dev builds, is to use:

packages/audiodocs/docs/other/audio-api-plugin.mdx

@@ -0,0 +1,7 @@
+---
+id: audio-api-plugin
+sidebar_label: Audio API Expo plugin
+sidebar_position: 3
+---
+
+# 🚧 Audio API Expo plugin 🚧

packages/audiodocs/docs/other/web-audio-api-coverage.mdx

@@ -14,7 +14,7 @@ sidebar_position: 2
 | AudioBuffer | ✅ |
 | AudioBufferSourceNode | ✅ |
 | AudioDestinationNode | ✅ |
-| AudioNode | ✅ | `connect` to `AudioNode` is only possible |
+| AudioNode | ✅ |
 | AudioParam | ✅ |
 | AudioScheduledSourceNode | ✅ |
 | BiquadFilterNode | ✅ |

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