Skip to content

Commit 49aeb20

Browse files
[Docs] Language improvements (#259)
* fix: language in getting started and make some noise * fix: language in docs Co-authored-by: Katarzyna Smoleń <katarzyna.smolen@swmansion.com> --------- Co-authored-by: Katarzyna Smoleń <katarzyna.smolen@swmansion.com>
1 parent 4e01c3e commit 49aeb20

File tree

7 files changed

+76
-70
lines changed

7 files changed

+76
-70
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ import TabItem from '@theme/TabItem';
88

99
# Getting started
1010

11-
The goal of _Fundamentals_ is to guide You through setup proces of Audio API as well as show base concepts standing behind audio programming using web audio framework to give you the confidence to explore more advanced use cases on your own. This section is packed with interactive examples, code snippets and explanations. Are you ready? Let's make some noise!
11+
The goal of _Fundamentals_ is to guide you through the setup process of the Audio API, as well as to show the basic concepts behind audio programming using a web audio framework, giving you the confidence to explore more advanced use cases on your own. This section is packed with interactive examples, code snippets, and explanations. Are you ready? Let's make some noise!
1212

1313
## What is React Native Audio API?
1414

15-
React Native Audio API is a powerful high-performant and low-level audio library built by [Software Mansion](https://swmansion.com/).
15+
React Native Audio API is a powerful, high-performant and low-level audio library built by [Software Mansion](https://swmansion.com/).
1616
RN Audio API is fully compatible\* with [Web Audio specification](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API), making it easy to write audio-intensive applications for iOS, Android and Web with just one codebase.
1717

1818
## Installation
1919

20-
It takes only a few steps to add audio api to Your project:
20+
It takes only a few steps to add Audio API to your project:
2121

2222
### Install the package
2323

24-
Install `react-native-audio-api` package from npm:
24+
Install the `react-native-audio-api` package from npm:
2525

2626
<Tabs groupId="package-managers">
2727
<TabItem value="expo" label="EXPO" default>
@@ -62,7 +62,7 @@ To learn more about expo development builds, please check out [Development Build
6262

6363
#### Android
6464

65-
No additional steps are necessary.
65+
No further steps are necessary.
6666

6767
#### iOS
6868

@@ -74,11 +74,11 @@ cd ios && pod install && cd ..
7474

7575
#### Web
7676

77-
No additional steps are necessary.
77+
No further steps are necessary.
7878

7979
:::caution
8080

81-
`react-native-audio-api` on web, exposes browser built-in Web Audio API, but for compatibility between platforms, its limits available interfaces to APIs that are implemented on iOS and Android.
81+
`react-native-audio-api` on the web exposes the browser's built-in Web Audio API, but for compatibility between platforms, it limits the available interfaces to APIs that are implemented on iOS and Android.
8282

8383
:::
8484

@@ -104,4 +104,4 @@ No additional steps are necessary.
104104

105105
## What's next?
106106

107-
In [the next section](/fundamentals/lets-make-some-noise), we will learn how to prepare audio api and how to play some sound!.
107+
In [the next section](/guides/lets-make-some-noise), we will learn how to prepare Audio API and to play some sound!.

packages/audiodocs/docs/fundamentals/lets-make-some-noise.mdx renamed to packages/audiodocs/docs/guides/lets-make-some-noise.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 2
44

55
# Let's make some noise!
66

7-
In this section, we will guide you through the basic concepts of Audio API. We're going to use core audio components such as `AudioContext` and `AudioBufferSourceNode` to simply play sound from a file, which will help you develop a basic understanding of the library.
7+
In this section, we will guide you through the basic concepts of Audio API. We are going to use core audio components such as `AudioContext` and `AudioBufferSourceNode` to simply play sound from a file, which will help you develop a basic understanding of the library.
88

99
## Using audio context
1010

@@ -28,11 +28,11 @@ export default function App() {
2828
}
2929
```
3030

31-
`AudioContext` is object that controls both the creation of the nodes, as well as execution of the audio processing, or decoding.
31+
`AudioContext` is an object that controls both the creation of the nodes and the execution of the audio processing or decoding.
3232

33-
## Loading audio file
33+
## Loading an audio file
3434

35-
Before we will be able to play anything, we need to gain access to some audio data. For the purpose of this guide, we will first download it from remote source using expo [FileSystem](https://docs.expo.dev/versions/latest/sdk/filesystem/) `downloadAsync` API.
35+
Before we can play anything, we need to gain access to some audio data. For the purpose of this guide, we will first download it from a remote source using [Expo FileSystem](https://docs.expo.dev/versions/latest/sdk/filesystem/) `downloadAsync` API.
3636

3737
```jsx {2,10-13}
3838
import React from 'react';
@@ -58,11 +58,11 @@ export default function App() {
5858
}
5959
```
6060

61-
We have used `decodeAudioDataSource` method of the `AudioContext`, which takes url to local file or bundled audio asset and decodes it to raw audio data, that can be used within our system.
61+
We have used the `decodeAudioDataSource` method of the `AudioContext`, which takes a URL to a local file or bundled audio asset and decodes it into raw audio data that can be used within our system.
6262

6363
## Play the audio
6464

65-
Last and final step is to create `AudioBufferSourceNode`, connect it to the `AudioContext` destination and start playing the sound. For the purpose of this guide, we will play the sound for only 10 seconds.
65+
The last and final step is to create an `AudioBufferSourceNode`, connect it to the `AudioContext` destination, and start playing the sound. For the purpose of this guide, we will play the sound for just 10 seconds.
6666

6767
```jsx {15-16,18-20}
6868
import React from 'react';
@@ -95,7 +95,7 @@ export default function App() {
9595
}
9696
```
9797

98-
And that's it! You have just played Your first sound using react-native-audio-api. You can hear how it works in the live example below:
98+
And that's it! you have just played your first sound using react-native-audio-api. you can hear how it works in the live example below:
9999

100100
import InteractiveExample from '@site/src/components/InteractiveExample';
101101
import LetsMakeSomeNoise from '@site/src/examples/LetsMakeSomeNoise/Component';
@@ -105,7 +105,7 @@ import LetsMakeSomeNoiseSrc from '!!raw-loader!@site/src/examples/LetsMakeSomeNo
105105

106106
:::info
107107

108-
In web environment you can use `decodeAudioDataSource` directly on the asset url, without the need to download it first.
108+
In the web environment, you can use `decodeAudioDataSource` directly on the asset URL, without the need to download it first.
109109

110110
:::
111111

@@ -114,11 +114,11 @@ In web environment you can use `decodeAudioDataSource` directly on the asset url
114114
In this guide, we have learned how to create a simple audio player using `AudioContext` and `AudioBufferSourceNode` as well as how we can load audio data from a remote source. To sum up:
115115

116116
- `AudioContext` is the main object that controls the audio graph.
117-
- `decodeAudioDataSource` method can be used to load audio data from a local audio source in form of `AudioBuffer`.
118-
- `AudioBufferSourceNode` can be used to any `AudioBuffer`.
117+
- the `decodeAudioDataSource` method can be used to load audio data from a local audio source in the form of an `AudioBuffer`.
118+
- `AudioBufferSourceNode` can be used with any `AudioBuffer`.
119119
- In order to hear the sounds, we need to connect the source node to the destination node exposed by `AudioContext`.
120-
- We can control the playback of the sound using `start` and `stop` methods of the `AudioBufferSourceNode` (And other source nodes which we show later).
120+
- We can control the playback of the sound using `start` and `stop` methods of the `AudioBufferSourceNode` (and other source nodes, which we will show later).
121121

122122
## What's next?
123123

124-
In [the next section](/fundamentals/making-a-piano-keyboard) we will learn more about how the audio graph works, what are audio params and how we can use them to create a simple piano keyboard.
124+
In [the next section](/fundamentals/making-a-piano-keyboard), we will learn more about how the audio graph works, what audio parameters are, and how we can use them to create a simple piano keyboard.

0 commit comments

Comments
 (0)