The Arduino Reference text is licensed under a Creative Commons Attribution-Share Alike 3.0 License.

Find anything that can be improved? Suggest corrections and new documentation via GitHub.

Doubts on how to use Github? Learn everything you need to know in this tutorial.

Reference > Libraries > Arduino advancedanalog > Advancedi2s.begin

Arduino_AdvancedAnalog - AdvancedI2S.begin()

Initializes and starts the I2S device.

Syntax

i2s.begin(mode, resolution, frequency, n_samples, n_buffers)

Parameters

  • enum - mode - The I2S mode.
    • AN_I2S_MODE_IN
    • AN_I2S_MODE_OUT
    • AN_I2S_MODE_INOUT
  • int - sample_rate - The sample rate / frequency in Hertz, e.g. 16000.
  • int - n_samples - the number of samples per sample buffer. See SampleBuffer for more details.
  • int - n_buffers - the number of sample buffers in the queue. See SampleBuffer for more details.

Returns

1 on success, 0 on failure.