music_pipe: document struct music_chunk
Add doxygen compatible comments.
This commit is contained in:
parent
b42dad9b05
commit
85b6ff7b59
11
src/pipe.h
11
src/pipe.h
@ -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];
|
||||||
};
|
};
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user