1 /*****************************************************************************
2 * vlc.h: global header for vlc
3 *****************************************************************************
4 * Copyright (C) 1998, 1999, 2000 VideoLAN
5 * $Id: vlc.h,v 1.16 2002/10/14 16:46:55 sam Exp $
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
20 *****************************************************************************/
29 /*****************************************************************************
31 *****************************************************************************/
32 typedef int vlc_bool_t;
42 /* Make sure the structure is at least 64bits */
43 struct { char a, b, c, d, e, f, g, h; } padding;
47 /*****************************************************************************
49 *****************************************************************************/
50 #define VLC_SUCCESS -0 /* No error */
51 #define VLC_ENOMEM -1 /* Not enough memory */
52 #define VLC_ETHREAD -2 /* Thread error */
54 #define VLC_ENOMOD -10 /* Module not found */
56 #define VLC_ENOOBJ -20 /* Object not found */
57 #define VLC_EBADOBJ -21 /* Bad object type */
59 #define VLC_ENOVAR -30 /* Variable not found */
60 #define VLC_EBADVAR -31 /* Bad variable value */
62 #define VLC_EEXIT -255 /* Program exited */
63 #define VLC_EGENERIC -666 /* Generic error */
65 /*****************************************************************************
67 *****************************************************************************/
71 /*****************************************************************************
73 *****************************************************************************/
75 /* Used by playlist_Add */
76 #define PLAYLIST_INSERT 0x0001
77 #define PLAYLIST_REPLACE 0x0002
78 #define PLAYLIST_APPEND 0x0004
79 #define PLAYLIST_GO 0x0008
81 #define PLAYLIST_END -666
83 /* Playlist parsing mode */
84 #define PLAYLIST_REPEAT_CURRENT 0 /* Keep playing current item */
85 #define PLAYLIST_FORWARD 1 /* Parse playlist until end */
86 #define PLAYLIST_BACKWARD -1 /* Parse backwards */
87 #define PLAYLIST_FORWARD_LOOP 2 /* Parse playlist and loop */
88 #define PLAYLIST_BACKWARD_LOOP -2 /* Parse backwards and loop */
89 #define PLAYLIST_RANDOM 3 /* Shuffle play */
90 #define PLAYLIST_REVERSE_RANDOM -3 /* Reverse shuffle play */
92 /* Playlist commands */
93 #define PLAYLIST_PLAY 1 /* Starts playing. No arg. */
94 #define PLAYLIST_PAUSE 2 /* Toggles playlist pause. No arg. */
95 #define PLAYLIST_STOP 3 /* Stops playing. No arg. */
96 #define PLAYLIST_SKIP 4 /* Skip X items and play. */
97 #define PLAYLIST_GOTO 5 /* Goto Xth item. */
98 #define PLAYLIST_MODE 6 /* Set playlist mode. ??? */
100 /*****************************************************************************
101 * Required internal headers
102 *****************************************************************************/
103 #if defined( __VLC__ )
104 # include "vlc_common.h"
107 /*****************************************************************************
108 * Exported libvlc API
109 *****************************************************************************/
110 char const * VLC_Version ( void );
111 char const * VLC_Error ( int );
113 int VLC_Create ( void );
114 int VLC_Init ( int, int, char *[] );
116 int VLC_Destroy ( int );
118 int VLC_Set ( int, char const *, vlc_value_t );
119 int VLC_Get ( int, char const *, vlc_value_t * );
120 int VLC_AddIntf ( int, char const *, vlc_bool_t );
121 int VLC_AddTarget ( int, char const *, int, int );
123 int VLC_Play ( int );
124 int VLC_Pause ( int );
125 int VLC_Stop ( int );
126 int VLC_FullScreen ( int );
132 #endif /* <vlc/vlc.h> */