summaryrefslogtreecommitdiff
path: root/docs/library/machine.I2S.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/machine.I2S.rst')
-rw-r--r--docs/library/machine.I2S.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/library/machine.I2S.rst b/docs/library/machine.I2S.rst
index abfbb0878..d4e5ac943 100644
--- a/docs/library/machine.I2S.rst
+++ b/docs/library/machine.I2S.rst
@@ -95,7 +95,8 @@ Constructor
- ``mode`` specifies receive or transmit
- ``bits`` specifies sample size (bits), 16 or 32
- ``format`` specifies channel format, STEREO or MONO
- - ``rate`` specifies audio sampling rate (samples/s)
+ - ``rate`` specifies audio sampling rate (Hz);
+ this is the frequency of the ``ws`` signal
- ``ibuf`` specifies internal buffer length (bytes)
For all ports, DMA runs continuously in the background and allows user applications to perform other operations while