Skip to content

docs: Add missing read() method documentation to I2S library #2730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add missing read() method documentation to I2S library #2730

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions content/learn/07.built-in-libraries/02.i2s/i2s.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,36 @@ None
#### Returns
The next sample of incoming I2S data available (or 0 if no data is available)


### `read()`

#### Description

Reads incoming I2S data from the I2S interface. This method reads and removes the next sample of incoming I2S data available from the internal I2S buffer. read() inherits from the Stream utility class.

#### Syntax

```
I2S.read()
```

```
I2S.read(buffer, length)
```

#### Parameters

None (for single sample read)

buffer: an array to read data into

length: the number of samples to read

#### Returns

The first sample of incoming I2S data available (or -1 if no data is available) - int

For buffer read: the number of samples read into the buffer
### `write()`

#### Description
Expand Down