Commit 85b6ff7b authored by Max Kellermann's avatar Max Kellermann

music_pipe: document struct music_chunk

Add doxygen compatible comments.
parent b42dad9b
...@@ -28,10 +28,21 @@ ...@@ -28,10 +28,21 @@
struct audio_format; struct audio_format;
/**
* A chunk of music data. Its format is defined by the
* music_pipe_append() caller.
*/
struct music_chunk { struct music_chunk {
/** number of bytes stored in this chunk */
uint16_t length; uint16_t length;
/** current bit rate of the source file */
uint16_t bit_rate; uint16_t bit_rate;
/** the time stamp within the song */
float times; float times;
/** the data (probably PCM) */
char data[CHUNK_SIZE]; char data[CHUNK_SIZE];
}; };
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment