Skip to content

Commit

Permalink
Deploying to doxygen from @ f9c58e9 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
pschatzmann committed Jun 22, 2024
1 parent fd8be51 commit a64e167
Show file tree
Hide file tree
Showing 24 changed files with 585 additions and 482 deletions.
467 changes: 243 additions & 224 deletions _analog_audio_arduino_8h_source.html

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion _analog_driver_arduino_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="classaudio__tools_1_1_analog_driver_arduino.html">AnalogDriverArduino</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">bool</span> begin(<a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32.html">AnalogConfig</a> cfg) { <span class="keywordflow">return</span> drv.begin(cfg); }</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">bool</span> begin(<a class="code" href="classaudio__tools_1_1_analog_config_e_s_p32.html">AnalogConfig</a> cfg) { <span class="keywordflow">return</span> drv.<a class="code" href="classaudio__tools_1_1_analog_audio_arduino.html#acba365cc28eb702040c382646cfb0a7a">begin</a>(cfg); }</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordtype">void</span> end()<span class="keyword"> override </span>{ drv.end(); }</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
Expand All @@ -112,6 +112,7 @@
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;} <span class="comment">// namespace audio_tools</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_audio_arduino_html_acba365cc28eb702040c382646cfb0a7a"><div class="ttname"><a href="classaudio__tools_1_1_analog_audio_arduino.html#acba365cc28eb702040c382646cfb0a7a">audio_tools::AnalogAudioArduino::begin</a></div><div class="ttdeci">bool begin() override</div><div class="ttdoc">Reopen with last config.</div><div class="ttdef"><b>Definition:</b> AnalogAudioArduino.h:46</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_config_e_s_p32_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_config_e_s_p32.html">audio_tools::AnalogConfigESP32</a></div><div class="ttdoc">ESP32 specific configuration for i2s input via adc. The default input pin is GPIO34....</div><div class="ttdef"><b>Definition:</b> AnalogConfigESP32.h:21</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_driver_arduino_html"><div class="ttname"><a href="classaudio__tools_1_1_analog_driver_arduino.html">audio_tools::AnalogDriverArduino</a></div><div class="ttdoc">Please use the AnalogAudioStream: Reading Analog Data using a timer and the Arduino analogRead() meth...</div><div class="ttdef"><b>Definition:</b> AnalogDriverArduino.h:23</div></div>
<div class="ttc" id="aclassaudio__tools_1_1_analog_driver_arduino_html_a4c5c6275ddee80eb02839356b6185c0b"><div class="ttname"><a href="classaudio__tools_1_1_analog_driver_arduino.html#a4c5c6275ddee80eb02839356b6185c0b">audio_tools::AnalogDriverArduino::readBytes</a></div><div class="ttdeci">size_t readBytes(uint8_t *data, size_t len) override</div><div class="ttdoc">Provides the sampled audio data.</div><div class="ttdef"><b>Definition:</b> AnalogDriverArduino.h:34</div></div>
Expand Down
77 changes: 48 additions & 29 deletions classaudio__tools_1_1_analog_audio_arduino-members.html

Large diffs are not rendered by default.

77 changes: 68 additions & 9 deletions classaudio__tools_1_1_analog_audio_arduino.html

Large diffs are not rendered by default.

Binary file modified classaudio__tools_1_1_analog_audio_arduino.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 30 additions & 29 deletions classaudio__tools_1_1_audio_info_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -143,35 +143,36 @@
<area href="classaudio__tools_1_1_a2_d_p_stream.html" title="Stream support for A2DP using https://github.com/pschatzmann/ESP32-A2DP: begin(TX_MODE) opens a a2dp_..." alt="A2DPStream" shape="rect" coords="1115,168,1328,192"/>
<area href="classaudio__tools_1_1_abstract_u_r_l_stream.html" title="Abstract Base class for all URLStream implementations." alt="AbstractURLStream" shape="rect" coords="1115,224,1328,248"/>
<area href="classaudio__tools_1_1_adapter_audio_output_to_audio_stream.html" title="Wrapper which converts a AudioStream to a AudioOutput." alt="AdapterAudioOutputToAudioStream" shape="rect" coords="1115,280,1328,304"/>
<area href="classaudio__tools_1_1_analog_audio_stream.html" title="ESP32: A very fast ADC and DAC using the ESP32 I2S interface. For all other architectures we support ..." alt="AnalogAudioStream" shape="rect" coords="1115,336,1328,360"/>
<area href="classaudio__tools_1_1_analog_driver_e_s_p32_v1_1_1_i_o16_bit.html" title="conversion between int16_t and other formats" alt="AnalogDriverESP32V1::IO16Bit" shape="rect" coords="1115,392,1328,416"/>
<area href="classaudio__tools_1_1_audio_kit_stream.html" title="AudioKit Stream which uses the https://github.com/pschatzmann/arduino-audiokit library." alt="AudioKitStream" shape="rect" coords="1115,448,1328,472"/>
<area href="classaudio__tools_1_1_audio_m_p34_d_t05.html" title="MP34DT05 Microphone of Nano BLE Sense. We provide a proper Stream implementation. See https://github...." alt="AudioMP34DT05" shape="rect" coords="1115,504,1328,528"/>
<area href="classaudio__tools_1_1_audio_stream_wrapper.html" title="To be used to support implementations where the readBytes is not virtual." alt="AudioStreamWrapper" shape="rect" coords="1115,560,1328,584"/>
<area href="classaudio__tools_1_1_audio_sync_reader.html" title="Receving Audio Data over the wire and requesting for more data when done to synchronize the processin..." alt="AudioSyncReader" shape="rect" coords="1115,616,1328,640"/>
<area href="classaudio__tools_1_1_buffered_task_stream.html" title="A FreeRTOS task is filling the buffer from the indicated stream. Only to be used on the ESP32." alt="BufferedTaskStream" shape="rect" coords="1115,672,1328,696"/>
<area href="classaudio__tools_1_1_e_s_p3288_audio_output.html" title="Stream Adapter for ESP8288-Audio AudioOutput." alt="ESP3288AudioOutput" shape="rect" coords="1115,728,1328,752"/>
<area href="classaudio__tools_1_1_faust_stream.html" title="Integration into Faust DSP see https://faust.grame.fr/ To generate code from faust,..." alt="FaustStream&lt; DSP &gt;" shape="rect" coords="1115,784,1328,808"/>
<area href="classaudio__tools_1_1_generated_sound_stream.html" title="Source for reading generated tones. Please note." alt="GeneratedSoundStream&lt; T &gt;" shape="rect" coords="1115,840,1328,864"/>
<area href="classaudio__tools_1_1_h_l_s_stream.html" title="HTTP Live Streaming using HLS: The result is a MPEG-TS data stream that must be decoded e...." alt="HLSStream" shape="rect" coords="1115,896,1328,920"/>
<area href="classaudio__tools_1_1_i2_s_codec_stream.html" title="I2S Stream which also sets up a codec chip and i2s." alt="I2SCodecStream" shape="rect" coords="1115,952,1328,976"/>
<area href="classaudio__tools_1_1_i2_s_stream.html" title="We support the Stream interface for the I2S access. In addition we allow a separate mute pin which mi..." alt="I2SStream" shape="rect" coords="1115,1008,1328,1032"/>
<area href="classaudio__tools_1_1_input_merge.html" title="Merges multiple input channels. The input must be mono! So if you provide 2 mono channels you get a s..." alt="InputMerge&lt; T &gt;" shape="rect" coords="1115,1064,1328,1088"/>
<area href="classaudio__tools_1_1_input_mixer.html" title="MixerStream is mixing the input from Multiple Input Streams. All streams must have the same audo form..." alt="InputMixer&lt; T &gt;" shape="rect" coords="1115,1120,1328,1144"/>
<area href="classaudio__tools_1_1_jupyter_audio_t.html" title="Output to Jupyter. We write the data just to a file from where we can load the data again for differe..." alt="JupyterAudioT&lt; T &gt;" shape="rect" coords="1115,1176,1328,1200"/>
<area href="classaudio__tools_1_1_memory_stream.html" title="A simple Stream implementation which is backed by allocated memory." alt="MemoryStream" shape="rect" coords="1115,1232,1328,1256"/>
<area href="classaudio__tools_1_1_mini_audio_stream.html" title="MiniAudio: https://miniaud.io/." alt="MiniAudioStream" shape="rect" coords="1115,1288,1328,1312"/>
<area href="classaudio__tools_1_1_modifying_stream.html" title="Abstract class: Objects can be put into a pipleline." alt="ModifyingStream" shape="rect" coords="1115,1344,1328,1368"/>
<area href="classaudio__tools_1_1_mozzi_stream.html" title="Stream that provides audio information that was generated using the Mozzi API using the updateControl..." alt="MozziStream" shape="rect" coords="1115,1400,1328,1424"/>
<area href="classaudio__tools_1_1_pipeline.html" title="We can build a input or an output chain: an input chain starts with setInput(); followed by add() an ..." alt="Pipeline" shape="rect" coords="1115,1456,1328,1480"/>
<area href="classaudio__tools_1_1_port_audio_stream.html" title="Arduino Audio Stream using PortAudio." alt="PortAudioStream" shape="rect" coords="1115,1512,1328,1536"/>
<area href="classaudio__tools_1_1_pure_data_stream.html" title="Input and output of Pure Data PD using code generated by the hvcc compiler. The audio format is defin..." alt="PureDataStream" shape="rect" coords="1115,1568,1328,1592"/>
<area href="classaudio__tools_1_1_ring_buffer_stream.html" title="An AudioStream backed by a Ringbuffer. We can write to the end and read from the beginning of the str..." alt="RingBufferStream" shape="rect" coords="1115,1624,1328,1648"/>
<area href="classaudio__tools_1_1_s_p_d_i_f_output.html" title="Output as 16 bit stereo SPDIF on the I2S data output pin." alt="SPDIFOutput" shape="rect" coords="1115,1680,1328,1704"/>
<area href="classaudio__tools_1_1_tf_lite_audio_stream_base.html" title="Astract TfLiteAudioStream to provide access to TfLiteAudioStream for Reader and Writers." alt="TfLiteAudioStreamBase" shape="rect" coords="1115,1736,1328,1760"/>
<area href="classaudio__tools_1_1_v_b_a_n_stream.html" title="VBAN Audio Source and Sink for the ESP32. For further details please see https://vb-audio...." alt="VBANStream" shape="rect" coords="1115,1792,1328,1816"/>
<area href="classaudio__tools_1_1_v_s1053_stream.html" title="VS1053 Output Interface which processes PCM data by default. If you want to write encoded data set is..." alt="VS1053Stream" shape="rect" coords="1115,1848,1328,1872"/>
<area href="classaudio__tools_1_1_w_m8960_stream.html" title="Stream for reading and writing audio data using the WM8960 Codec Chip You need to install https://git..." alt="WM8960Stream" shape="rect" coords="1115,1904,1328,1928"/>
<area href="classaudio__tools_1_1_analog_audio_arduino.html" title="Analog Data IO using a timer and the Arduino analogRead() method and writing using analogWrite();." alt="AnalogAudioArduino" shape="rect" coords="1115,336,1328,360"/>
<area href="classaudio__tools_1_1_analog_audio_stream.html" title="ESP32: A very fast ADC and DAC using the ESP32 I2S interface. For all other architectures we support ..." alt="AnalogAudioStream" shape="rect" coords="1115,392,1328,416"/>
<area href="classaudio__tools_1_1_analog_driver_e_s_p32_v1_1_1_i_o16_bit.html" title="conversion between int16_t and other formats" alt="AnalogDriverESP32V1::IO16Bit" shape="rect" coords="1115,448,1328,472"/>
<area href="classaudio__tools_1_1_audio_kit_stream.html" title="AudioKit Stream which uses the https://github.com/pschatzmann/arduino-audiokit library." alt="AudioKitStream" shape="rect" coords="1115,504,1328,528"/>
<area href="classaudio__tools_1_1_audio_m_p34_d_t05.html" title="MP34DT05 Microphone of Nano BLE Sense. We provide a proper Stream implementation. See https://github...." alt="AudioMP34DT05" shape="rect" coords="1115,560,1328,584"/>
<area href="classaudio__tools_1_1_audio_stream_wrapper.html" title="To be used to support implementations where the readBytes is not virtual." alt="AudioStreamWrapper" shape="rect" coords="1115,616,1328,640"/>
<area href="classaudio__tools_1_1_audio_sync_reader.html" title="Receving Audio Data over the wire and requesting for more data when done to synchronize the processin..." alt="AudioSyncReader" shape="rect" coords="1115,672,1328,696"/>
<area href="classaudio__tools_1_1_buffered_task_stream.html" title="A FreeRTOS task is filling the buffer from the indicated stream. Only to be used on the ESP32." alt="BufferedTaskStream" shape="rect" coords="1115,728,1328,752"/>
<area href="classaudio__tools_1_1_e_s_p3288_audio_output.html" title="Stream Adapter for ESP8288-Audio AudioOutput." alt="ESP3288AudioOutput" shape="rect" coords="1115,784,1328,808"/>
<area href="classaudio__tools_1_1_faust_stream.html" title="Integration into Faust DSP see https://faust.grame.fr/ To generate code from faust,..." alt="FaustStream&lt; DSP &gt;" shape="rect" coords="1115,840,1328,864"/>
<area href="classaudio__tools_1_1_generated_sound_stream.html" title="Source for reading generated tones. Please note." alt="GeneratedSoundStream&lt; T &gt;" shape="rect" coords="1115,896,1328,920"/>
<area href="classaudio__tools_1_1_h_l_s_stream.html" title="HTTP Live Streaming using HLS: The result is a MPEG-TS data stream that must be decoded e...." alt="HLSStream" shape="rect" coords="1115,952,1328,976"/>
<area href="classaudio__tools_1_1_i2_s_codec_stream.html" title="I2S Stream which also sets up a codec chip and i2s." alt="I2SCodecStream" shape="rect" coords="1115,1008,1328,1032"/>
<area href="classaudio__tools_1_1_i2_s_stream.html" title="We support the Stream interface for the I2S access. In addition we allow a separate mute pin which mi..." alt="I2SStream" shape="rect" coords="1115,1064,1328,1088"/>
<area href="classaudio__tools_1_1_input_merge.html" title="Merges multiple input channels. The input must be mono! So if you provide 2 mono channels you get a s..." alt="InputMerge&lt; T &gt;" shape="rect" coords="1115,1120,1328,1144"/>
<area href="classaudio__tools_1_1_input_mixer.html" title="MixerStream is mixing the input from Multiple Input Streams. All streams must have the same audo form..." alt="InputMixer&lt; T &gt;" shape="rect" coords="1115,1176,1328,1200"/>
<area href="classaudio__tools_1_1_jupyter_audio_t.html" title="Output to Jupyter. We write the data just to a file from where we can load the data again for differe..." alt="JupyterAudioT&lt; T &gt;" shape="rect" coords="1115,1232,1328,1256"/>
<area href="classaudio__tools_1_1_memory_stream.html" title="A simple Stream implementation which is backed by allocated memory." alt="MemoryStream" shape="rect" coords="1115,1288,1328,1312"/>
<area href="classaudio__tools_1_1_mini_audio_stream.html" title="MiniAudio: https://miniaud.io/." alt="MiniAudioStream" shape="rect" coords="1115,1344,1328,1368"/>
<area href="classaudio__tools_1_1_modifying_stream.html" title="Abstract class: Objects can be put into a pipleline." alt="ModifyingStream" shape="rect" coords="1115,1400,1328,1424"/>
<area href="classaudio__tools_1_1_mozzi_stream.html" title="Stream that provides audio information that was generated using the Mozzi API using the updateControl..." alt="MozziStream" shape="rect" coords="1115,1456,1328,1480"/>
<area href="classaudio__tools_1_1_pipeline.html" title="We can build a input or an output chain: an input chain starts with setInput(); followed by add() an ..." alt="Pipeline" shape="rect" coords="1115,1512,1328,1536"/>
<area href="classaudio__tools_1_1_port_audio_stream.html" title="Arduino Audio Stream using PortAudio." alt="PortAudioStream" shape="rect" coords="1115,1568,1328,1592"/>
<area href="classaudio__tools_1_1_pure_data_stream.html" title="Input and output of Pure Data PD using code generated by the hvcc compiler. The audio format is defin..." alt="PureDataStream" shape="rect" coords="1115,1624,1328,1648"/>
<area href="classaudio__tools_1_1_ring_buffer_stream.html" title="An AudioStream backed by a Ringbuffer. We can write to the end and read from the beginning of the str..." alt="RingBufferStream" shape="rect" coords="1115,1680,1328,1704"/>
<area href="classaudio__tools_1_1_s_p_d_i_f_output.html" title="Output as 16 bit stereo SPDIF on the I2S data output pin." alt="SPDIFOutput" shape="rect" coords="1115,1736,1328,1760"/>
<area href="classaudio__tools_1_1_tf_lite_audio_stream_base.html" title="Astract TfLiteAudioStream to provide access to TfLiteAudioStream for Reader and Writers." alt="TfLiteAudioStreamBase" shape="rect" coords="1115,1792,1328,1816"/>
<area href="classaudio__tools_1_1_v_b_a_n_stream.html" title="VBAN Audio Source and Sink for the ESP32. For further details please see https://vb-audio...." alt="VBANStream" shape="rect" coords="1115,1848,1328,1872"/>
<area href="classaudio__tools_1_1_v_s1053_stream.html" title="VS1053 Output Interface which processes PCM data by default. If you want to write encoded data set is..." alt="VS1053Stream" shape="rect" coords="1115,1904,1328,1928"/>
<area href="classaudio__tools_1_1_w_m8960_stream.html" title="Stream for reading and writing audio data using the WM8960 Codec Chip You need to install https://git..." alt="WM8960Stream" shape="rect" coords="1115,1960,1328,1984"/>
<area href="classaudio__tools_1_1_f_l_a_c_decoder.html" title="Decoder for FLAC. Depends on https://github.com/pschatzmann/arduino-libflac. We support an efficient ..." alt="FLACDecoder" shape="rect" coords="1561,112,1774,136"/>
<area href="classaudio__tools_1_1_streaming_decoder_adapter.html" title="Converts any AudioDecoder to a StreamingDecoder." alt="StreamingDecoderAdapter" shape="rect" coords="1561,168,1774,192"/>
<area href="classaudio__tools_1_1_vorbis_decoder.html" title="Vorbis Streaming Decoder using https://github.com/pschatzmann/arduino-libvorbis-tremor." alt="VorbisDecoder" shape="rect" coords="1561,224,1774,248"/>
Expand Down
Binary file modified classaudio__tools_1_1_audio_info_source.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit a64e167

Please sign in to comment.