From 4613115becdf99846c0a2367ee7ae76e6ee91d8b Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Tue, 26 Aug 2008 08:27:17 +0200 Subject: document the PLAYER_QUEUE_ constants --- src/player.h | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'src') diff --git a/src/player.h b/src/player.h index 09c77e59e..b3cf207ec 100644 --- a/src/player.h +++ b/src/player.h @@ -53,11 +53,26 @@ enum player_command { * ->4->0 don't play queued song */ enum player_queue_state { + /** there is no queued song */ PLAYER_QUEUE_BLANK = 0, + + /** there is a queued song */ PLAYER_QUEUE_FULL = 1, + + /** the player thread has forwarded the queued song to the + decoder; it waits for PLAY or STOP */ PLAYER_QUEUE_DECODE = 2, + + /** tells the player thread to start playing the queued song; + this is a response to DECODE */ PLAYER_QUEUE_PLAY = 3, + + /** tells the player thread to stop before playing the queued + song; this is a response to DECODE */ PLAYER_QUEUE_STOP = 4, + + /** the player thread has begun playing the queued song, and + thus its queue is empty */ PLAYER_QUEUE_EMPTY = 5 }; -- cgit v1.2.3