Skip to content

Commit

Permalink
add clarification edits
Browse files Browse the repository at this point in the history
  • Loading branch information
ganicke committed Jul 24, 2023
1 parent 260840f commit 970a47f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions libs/audio-recording/docs/reference/record/audio-status.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# audio Status

Check to see if an audio buffer status is true or not.
Check to see if a certain audio status is true or not.

```sig
record.audioStatus(record.AudioStatus.Playing)
```

The audio buffer has several status conditions that you can check. It will return `true` or `false` to tell you if the audio is playing, recording, stopped or the buffer has nothing in it.
The audio status is related to what operation is happening to the audio [buffer](/types/buffer) at the current moment. The audio buffer has several status conditions that you can check. It will return `true` or `false` to tell you if the audio is playing, recording, stopped, or the buffer has nothing in it.

## Parameters

Expand Down
8 changes: 4 additions & 4 deletions libs/audio-recording/docs/reference/record/set-sample-rate.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ When playing back, the sample rate sets the speed at which the sound is taken fr

## Parameters

* **hz**: the [number](/types/number) of samples per second to record or play back.
* **hz**: the [number](/types/number) of samples per second for record or playback.
* **scope**: an optional operation scope for the sample rate.
>* `everything`: (default) both recording and playback are at the same rate.
>* `playback`: audio playback is at this sample rate.
> * `recording`: audio recording is at this sample rate.
>* `everything`: (default) set the same sample rate for both recording and playback.
>* `playback`: set the sample rate only for audio playback.
> * `recording`: set the sample rate only for audio recording.
## Example

Expand Down

0 comments on commit 970a47f

Please sign in to comment.