add more missing documentation
[paraslash.git] / vss.h
1 /*
2 * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
17 */
18
19 /** \file vss.h exported functions from vss.c (para_server) */
20 void vss_init(void);
21 void vss_send_chunk(void);
22 struct timeval *vss_preselect(void);
23 const char *audio_format_name(int);
24 unsigned int vss_playing(void);
25 unsigned int vss_next(void);
26 unsigned int vss_repos(void);
27 unsigned int vss_paused(void);
28 char *vss_get_header(int *header_len);
29 struct timeval *vss_chunk_time(void);
30 int guess_audio_format(const char *name);
31 const char *supported_audio_formats(void);
32
33 /** stop playing after current audio file */
34 #define VSS_NOMORE 1
35 /** skip remaining part of current audio file */
36 #define VSS_NEXT 2
37 /** a reposition request was sent by a client */
38 #define VSS_REPOS 4
39 /** currently playing */
40 #define VSS_PLAYING 8
41 /** a client requested to change the audio file selector */
42 #define VSS_CHANGE 16