Skip to content

Commit c276c9d

Browse files
authored
Merge pull request #444 from software-mansion/docs/stereo-panner-node
docs: stereo panner node
2 parents 93d6edd + 045c73f commit c276c9d

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ The above method lets you create `PeriodicWave`.
122122

123123
The above method lets you create `StereoPannerNode`.
124124

125-
#### Returns `StereoPannerNode`.
125+
#### Returns [`StereoPannerNode`](/effects/stereo-panner-node).
126126

127127
### `decodeAudioData`
128128

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
import AudioNodePropsTable from "@site/src/components/AudioNodePropsTable"
6+
import { ReadOnly } from '@site/src/components/Badges';
7+
8+
# StereoPannerNode
9+
10+
The `StereoPannerNode` interface represents the change in ratio between two outputing channels (f. e. left and right speaker).
11+
12+
#### [`AudioNode`](/core/audio-node#read-only-properties) properties
13+
14+
<AudioNodePropsTable numberOfInputs={1} numberOfOutputs={1} channelCount={2} channelCountMode={"explicit"} channelInterpretation={"speakers"} />
15+
16+
## Constructor
17+
18+
[`BaseAudioContext.createStereoPanner()`](/core/base-audio-context#createstereopanner)
19+
20+
## Properties
21+
22+
| Name | Type | Default value | Description |
23+
| :----: | :----: | :-------- | :------ |
24+
| `pan` | [`AudioParam`](/core/audio-param) <ReadOnly /> | 0 | [`a-rate`](/core/audio-param#a-rate-vs-k-rate) `AudioParam` representing value of pan to apply. |
25+
26+
## Remarks
27+
28+
#### `pan`
29+
- Nominal range is -1 (only left channel) to 1 (only right channel).

0 commit comments

Comments
 (0)