music_pipe: document struct music_chunk

Add doxygen compatible comments.
This commit is contained in:
Max Kellermann 2008-11-02 16:58:45 +01:00
parent b42dad9b05
commit 85b6ff7b59

View File

@ -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];
};