From 85b6ff7b594775276dcec85e8caf89d245476e47 Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Sun, 2 Nov 2008 16:58:45 +0100 Subject: music_pipe: document struct music_chunk Add doxygen compatible comments. --- src/pipe.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/pipe.h b/src/pipe.h index 4d57adc04..7d2912197 100644 --- a/src/pipe.h +++ b/src/pipe.h @@ -28,10 +28,21 @@ struct audio_format; +/** + * A chunk of music data. Its format is defined by the + * music_pipe_append() caller. + */ struct music_chunk { + /** number of bytes stored in this chunk */ uint16_t length; + + /** current bit rate of the source file */ uint16_t bit_rate; + + /** the time stamp within the song */ float times; + + /** the data (probably PCM) */ char data[CHUNK_SIZE]; }; -- cgit v1.2.3