Skip to content

Commit 090159e

Browse files
committed
doxygen
1 parent 10ec1b9 commit 090159e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+1943
-1145
lines changed

docs/html/_snap_client_8h_source.html

Lines changed: 195 additions & 183 deletions
Large diffs are not rendered by default.

docs/html/_snap_output_8h_source.html

Lines changed: 220 additions & 222 deletions
Large diffs are not rendered by default.

docs/html/_snap_processor_8h_source.html

Lines changed: 509 additions & 507 deletions
Large diffs are not rendered by default.

docs/html/_snap_processor_r_t_o_s_8h_source.html

Lines changed: 191 additions & 0 deletions
Large diffs are not rendered by default.

docs/html/annotated.html

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,15 +77,16 @@
7777
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_snap_message_wire_chunk.html" target="_self">SnapMessageWireChunk</a></td><td class="desc">Snapcast Wire Chunk Message </td></tr>
7878
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_snap_output.html" target="_self">SnapOutput</a></td><td class="desc">Simple Output Class which uses the AudioTools to build an output chain with volume control and a resampler </td></tr>
7979
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_snap_processor.html" target="_self">SnapProcessor</a></td><td class="desc">Snap Processor implementation which does not rely on FreeRTOS </td></tr>
80-
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_snap_read_buffer.html" target="_self">SnapReadBuffer</a></td><td class="desc">Buffer to read different data types </td></tr>
81-
<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_snap_time.html" target="_self">SnapTime</a></td><td class="desc">The the sys/time functions are used to represent the server time. The local time will be measured with the help of the Arduino millis() method. This class provides the basic functionality to translate between local and server time </td></tr>
82-
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_snap_time_points.html" target="_self">SnapTimePoints</a></td><td class="desc">Recording of local_ms and server_ms </td></tr>
83-
<tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_snap_time_sync.html" target="_self">SnapTimeSync</a></td><td class="desc">Abstract (Common) Time Synchronization Logic which consists of the startup synchronization and the local to server clock synchronization which adjusts the sampling rate </td></tr>
84-
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_snap_time_sync_dynamic.html" target="_self">SnapTimeSyncDynamic</a></td><td class="desc">Dynamically adjusts the effective playback sample rate based on the differences of the local and server clock between the different intervals </td></tr>
85-
<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_snap_time_sync_dynamic_since_start.html" target="_self">SnapTimeSyncDynamicSinceStart</a></td><td class="desc">Dynamically adjusts the effective playback sample rate based on the differences of the local and server clock since the start </td></tr>
86-
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_snap_time_sync_fixed.html" target="_self">SnapTimeSyncFixed</a></td><td class="desc">Uses predefined fixed factor </td></tr>
87-
<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_snap_write_buffer.html" target="_self">SnapWriteBuffer</a></td><td class="desc">Buffer to write different data types </td></tr>
88-
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structtv__t.html" target="_self">tv_t</a></td><td class="desc">Time as sec &amp; usec </td></tr>
80+
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_snap_processor_r_t_o_s.html" target="_self">SnapProcessorRTOS</a></td><td class="desc"></td></tr>
81+
<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_snap_read_buffer.html" target="_self">SnapReadBuffer</a></td><td class="desc">Buffer to read different data types </td></tr>
82+
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_snap_time.html" target="_self">SnapTime</a></td><td class="desc">The the sys/time functions are used to represent the server time. The local time will be measured with the help of the Arduino millis() method. This class provides the basic functionality to translate between local and server time </td></tr>
83+
<tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_snap_time_points.html" target="_self">SnapTimePoints</a></td><td class="desc">Recording of local_ms and server_ms </td></tr>
84+
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_snap_time_sync.html" target="_self">SnapTimeSync</a></td><td class="desc">Abstract (Common) Time Synchronization Logic which consists of the startup synchronization and the local to server clock synchronization which adjusts the sampling rate </td></tr>
85+
<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_snap_time_sync_dynamic.html" target="_self">SnapTimeSyncDynamic</a></td><td class="desc">Dynamically adjusts the effective playback sample rate based on the differences of the local and server clock between the different intervals </td></tr>
86+
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_snap_time_sync_dynamic_since_start.html" target="_self">SnapTimeSyncDynamicSinceStart</a></td><td class="desc">Dynamically adjusts the effective playback sample rate based on the differences of the local and server clock since the start </td></tr>
87+
<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_snap_time_sync_fixed.html" target="_self">SnapTimeSyncFixed</a></td><td class="desc">Uses predefined fixed factor </td></tr>
88+
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_snap_write_buffer.html" target="_self">SnapWriteBuffer</a></td><td class="desc">Buffer to write different data types </td></tr>
89+
<tr id="row_19_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structtv__t.html" target="_self">tv_t</a></td><td class="desc">Time as sec &amp; usec </td></tr>
8990
</table>
9091
</div><!-- directory -->
9192
</div><!-- contents -->

0 commit comments

Comments
 (0)