Skip to content

Commit 28d882e

Browse files
authored
docs: sort base audio context methods alphabetically (#815)
1 parent 0a987bc commit 28d882e

File tree

5 files changed

+80
-81
lines changed

5 files changed

+80
-81
lines changed

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

Lines changed: 76 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -52,66 +52,11 @@ Creates [`AnalyserNode`](/docs/analysis/analyser-node).
5252

5353
#### Returns `AnalyserNode`.
5454

55-
### `createRecorderAdapter`
56-
57-
Creates [`RecorderAdapterNode`](/docs/sources/recorder-adapter-node).
58-
59-
#### Returns `RecorderAdapterNode`
60-
61-
### `createWorkletNode` <MobileOnly />
62-
63-
Creates [`WorkletNode`](/docs/worklets/worklet-node).
64-
65-
| Parameter | Type | Description |
66-
| :---: | :---: | :---- |
67-
| `worklet` | `(Array<Float32Array>, number) => void` | The worklet to be executed. |
68-
| `bufferLength` | `number` | The size of the buffer that will be passed to the worklet on each call. |
69-
| `inputChannelCount` | `number` | The number of channels that the node expects as input (it will get min(expected, provided)). |
70-
| `workletRuntime` | `AudioWorkletRuntime` | The kind of runtime to use for the worklet. See [worklet runtimes](/docs/worklets/worklets-introduction#what-kind-of-worklets-are-used-in-react-native-audio-api) for details. |
71-
72-
#### Errors
73-
74-
| Error type | Description |
75-
| :---: | :---- |
76-
| `Error` | `react-native-worklet` is not found as dependency. |
77-
| `NotSupportedError` | `bufferLength` < 1. |
78-
| `NotSupportedError` | `inputChannelCount` is not in range [1, 32]. |
79-
80-
#### Returns `WorkletNode`.
81-
82-
### `createWorkletSourceNode` <MobileOnly />
83-
84-
Creates [`WorkletSourceNode`](/docs/worklets/worklet-source-node).
85-
86-
| Parameter | Type | Description |
87-
| :---: | :---: | :---- |
88-
| `worklet` | `(Array<Float32Array>, number, number, number) => void` | The worklet to be executed. |
89-
| `workletRuntime` | `AudioWorkletRuntime` | The kind of runtime to use for the worklet. See [worklet runtimes](/docs/worklets/worklets-introduction#what-kind-of-worklets-are-used-in-react-native-audio-api) for details. |
90-
91-
#### Errors
92-
93-
| Error type | Description |
94-
| :---: | :---- |
95-
| `Error` | `react-native-worklet` is not found as dependency. |
96-
97-
#### Returns `WorkletSourceNode`.
98-
99-
### `createWorkletProcessingNode` <MobileOnly />
100-
101-
Creates [`WorkletProcessingNode`](/docs/worklets/worklet-processing-node).
102-
103-
| Parameter | Type | Description |
104-
| :---: | :---: | :---- |
105-
| `worklet` | `(Array<Float32Array>, Array<Float32Array>, number, number) => void` | The worklet to be executed. |
106-
| `workletRuntime` | `AudioWorkletRuntime` | The kind of runtime to use for the worklet. See [worklet runtimes](/docs/worklets/worklets-introduction#what-kind-of-worklets-are-used-in-react-native-audio-api) for details. |
107-
108-
#### Errors
55+
### `createBiquadFilter`
10956

110-
| Error type | Description |
111-
| :---: | :---- |
112-
| `Error` | `react-native-worklet` is not found as dependency. |
57+
Creates [`BiquadFilterNode`](/docs/effects/biquad-filter-node).
11358

114-
#### Returns `WorkletProcessingNode`.
59+
#### Returns `BiquadFilterNode`.
11560

11661
### `createBuffer`
11762

@@ -153,12 +98,11 @@ Creates [`AudioBufferQueueSourceNode`](/docs/sources/audio-buffer-queue-source-n
15398

15499
#### Returns `AudioBufferQueueSourceNode`.
155100

156-
### `createGain`
157-
158-
Creates [`GainNode`](/docs/effects/gain-node).
101+
### `createConstantSource`
159102

160-
#### Returns `GainNode`.
103+
Creates [`ConstantSourceNode`](/docs/sources/constant-source-node).
161104

105+
#### Returns `ConstantSourceNode`.
162106

163107
### `createConvolver`
164108

@@ -176,23 +120,17 @@ Creates [`ConvolverNode`](/docs/effects/convolver-node).
176120

177121
#### Returns `ConvolverNode`.
178122

179-
### `createOscillator`
180-
181-
Creates [`OscillatorNode`](/docs/sources/oscillator-node).
182-
183-
#### Returns `OscillatorNode`.
184-
185-
### `createStreamer` <MobileOnly />
123+
### `createGain`
186124

187-
Creates [`StreamerNode`](/docs/sources/streamer-node).
125+
Creates [`GainNode`](/docs/effects/gain-node).
188126

189-
#### Returns `StreamerNode`.
127+
#### Returns `GainNode`.
190128

191-
### `createConstantSource`
129+
### `createOscillator`
192130

193-
Creates [`ConstantSourceNode`](/docs/sources/constant-source-node).
131+
Creates [`OscillatorNode`](/docs/sources/oscillator-node).
194132

195-
#### Returns `ConstantSourceNode`.
133+
#### Returns `OscillatorNode`.
196134

197135
### `createPeriodicWave`
198136

@@ -212,17 +150,78 @@ Creates [`PeriodicWave`](/docs/effects/periodic-wave). This waveform specifies a
212150

213151
#### Returns `PeriodicWave`.
214152

153+
### `createRecorderAdapter`
154+
155+
Creates [`RecorderAdapterNode`](/docs/sources/recorder-adapter-node).
156+
157+
#### Returns `RecorderAdapterNode`
158+
215159
### `createStereoPanner`
216160

217161
Creates [`StereoPannerNode`](/docs/effects/stereo-panner-node).
218162

219163
#### Returns `StereoPannerNode`.
220164

221-
### `createBiquadFilter`
165+
### `createStreamer` <MobileOnly />
222166

223-
Creates [`BiquadFilterNode`](/docs/effects/biquad-filter-node).
167+
Creates [`StreamerNode`](/docs/sources/streamer-node).
224168

225-
#### Returns `BiquadFilterNode`.
169+
#### Returns `StreamerNode`.
170+
171+
### `createWorkletNode` <MobileOnly />
172+
173+
Creates [`WorkletNode`](/docs/worklets/worklet-node).
174+
175+
| Parameter | Type | Description |
176+
| :---: | :---: | :---- |
177+
| `worklet` | `(Array<Float32Array>, number) => void` | The worklet to be executed. |
178+
| `bufferLength` | `number` | The size of the buffer that will be passed to the worklet on each call. |
179+
| `inputChannelCount` | `number` | The number of channels that the node expects as input (it will get min(expected, provided)). |
180+
| `workletRuntime` | `AudioWorkletRuntime` | The kind of runtime to use for the worklet. See [worklet runtimes](/docs/worklets/worklets-introduction#what-kind-of-worklets-are-used-in-react-native-audio-api) for details. |
181+
182+
#### Errors
183+
184+
| Error type | Description |
185+
| :---: | :---- |
186+
| `Error` | `react-native-worklet` is not found as dependency. |
187+
| `NotSupportedError` | `bufferLength` < 1. |
188+
| `NotSupportedError` | `inputChannelCount` is not in range [1, 32]. |
189+
190+
#### Returns `WorkletNode`.
191+
192+
### `createWorkletSourceNode` <MobileOnly />
193+
194+
Creates [`WorkletSourceNode`](/docs/worklets/worklet-source-node).
195+
196+
| Parameter | Type | Description |
197+
| :---: | :---: | :---- |
198+
| `worklet` | `(Array<Float32Array>, number, number, number) => void` | The worklet to be executed. |
199+
| `workletRuntime` | `AudioWorkletRuntime` | The kind of runtime to use for the worklet. See [worklet runtimes](/docs/worklets/worklets-introduction#what-kind-of-worklets-are-used-in-react-native-audio-api) for details. |
200+
201+
#### Errors
202+
203+
| Error type | Description |
204+
| :---: | :---- |
205+
| `Error` | `react-native-worklet` is not found as dependency. |
206+
207+
#### Returns `WorkletSourceNode`.
208+
209+
### `createWorkletProcessingNode` <MobileOnly />
210+
211+
Creates [`WorkletProcessingNode`](/docs/worklets/worklet-processing-node).
212+
213+
| Parameter | Type | Description |
214+
| :---: | :---: | :---- |
215+
| `worklet` | `(Array<Float32Array>, Array<Float32Array>, number, number) => void` | The worklet to be executed. |
216+
| `workletRuntime` | `AudioWorkletRuntime` | The kind of runtime to use for the worklet. See [worklet runtimes](/docs/worklets/worklets-introduction#what-kind-of-worklets-are-used-in-react-native-audio-api) for details. |
217+
218+
#### Errors
219+
220+
| Error type | Description |
221+
| :---: | :---- |
222+
| `Error` | `react-native-worklet` is not found as dependency. |
223+
224+
#### Returns `WorkletProcessingNode`.
226225

227226
:::caution
228227
Supported file formats:

packages/audiodocs/docs/effects/convolver-node.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 5
2+
sidebar_position: 2
33
---
44

55
import AudioNodePropsTable from "@site/src/components/AudioNodePropsTable"

packages/audiodocs/docs/effects/gain-node.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 3
33
---
44

55
import AudioNodePropsTable from "@site/src/components/AudioNodePropsTable"

packages/audiodocs/docs/effects/periodic-wave.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 3
2+
sidebar_position: 4
33
---
44

55
# PeriodicWave

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 4
2+
sidebar_position: 5
33
---
44

55
import AudioNodePropsTable from "@site/src/components/AudioNodePropsTable"

0 commit comments

Comments
 (0)