Skip to content

Commit 5e685a9

Browse files
committed
docs/library/machine.I2S: Clarify what rate refers to.
Signed-off-by: Damien George <[email protected]>
1 parent 7266285 commit 5e685a9

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/library/machine.I2S.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,8 @@ Constructor
9595
- ``mode`` specifies receive or transmit
9696
- ``bits`` specifies sample size (bits), 16 or 32
9797
- ``format`` specifies channel format, STEREO or MONO
98-
- ``rate`` specifies audio sampling rate (samples/s)
98+
- ``rate`` specifies audio sampling rate (Hz);
99+
this is the frequency of the ``ws`` signal
99100
- ``ibuf`` specifies internal buffer length (bytes)
100101

101102
For all ports, DMA runs continuously in the background and allows user applications to perform other operations while

0 commit comments

Comments
 (0)