1 /*****************************************************************************
2 * vlc.h: global header for vlc
3 *****************************************************************************
4 * Copyright (C) 1998, 1999, 2000 VideoLAN
5 * $Id: vlc.h,v 1.20 2002/12/14 19:34:07 gbazin 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;
33 typedef struct vlc_list_t vlc_list_t;
34 typedef struct vlc_object_t vlc_object_t;
43 vlc_object_t * p_object;
46 /* Make sure the structure is at least 64bits */
47 struct { char a, b, c, d, e, f, g, h; } padding;
54 vlc_value_t * p_values;
58 /*****************************************************************************
60 *****************************************************************************/
61 #define VLC_SUCCESS -0 /* No error */
62 #define VLC_ENOMEM -1 /* Not enough memory */
63 #define VLC_ETHREAD -2 /* Thread error */
64 #define VLC_ETIMEOUT -3 /* Timeout */
66 #define VLC_ENOMOD -10 /* Module not found */
68 #define VLC_ENOOBJ -20 /* Object not found */
69 #define VLC_EBADOBJ -21 /* Bad object type */
71 #define VLC_ENOVAR -30 /* Variable not found */
72 #define VLC_EBADVAR -31 /* Bad variable value */
74 #define VLC_EEXIT -255 /* Program exited */
75 #define VLC_EGENERIC -666 /* Generic error */
77 /*****************************************************************************
79 *****************************************************************************/
83 /*****************************************************************************
85 *****************************************************************************/
87 /* Used by playlist_Add */
88 #define PLAYLIST_INSERT 0x0001
89 #define PLAYLIST_REPLACE 0x0002
90 #define PLAYLIST_APPEND 0x0004
91 #define PLAYLIST_GO 0x0008
92 #define PLAYLIST_CHECK_INSERT 0x0010
94 #define PLAYLIST_END -666
96 /* Playlist parsing mode */
97 #define PLAYLIST_REPEAT_CURRENT 0 /* Keep playing current item */
98 #define PLAYLIST_FORWARD 1 /* Parse playlist until end */
99 #define PLAYLIST_BACKWARD -1 /* Parse backwards */
100 #define PLAYLIST_FORWARD_LOOP 2 /* Parse playlist and loop */
101 #define PLAYLIST_BACKWARD_LOOP -2 /* Parse backwards and loop */
102 #define PLAYLIST_RANDOM 3 /* Shuffle play */
103 #define PLAYLIST_REVERSE_RANDOM -3 /* Reverse shuffle play */
105 /* Playlist commands */
106 #define PLAYLIST_PLAY 1 /* Starts playing. No arg. */
107 #define PLAYLIST_PAUSE 2 /* Toggles playlist pause. No arg. */
108 #define PLAYLIST_STOP 3 /* Stops playing. No arg. */
109 #define PLAYLIST_SKIP 4 /* Skip X items and play. */
110 #define PLAYLIST_GOTO 5 /* Goto Xth item. */
111 #define PLAYLIST_MODE 6 /* Set playlist mode. ??? */
113 /*****************************************************************************
114 * Required internal headers
115 *****************************************************************************/
116 #if defined( __VLC__ )
117 # include "vlc_common.h"
120 /*****************************************************************************
121 * Exported libvlc API
122 *****************************************************************************/
123 char const * VLC_Version ( void );
124 char const * VLC_Error ( int );
126 int VLC_Create ( void );
127 int VLC_Init ( int, int, char *[] );
129 int VLC_Destroy ( int );
131 int VLC_Set ( int, char const *, vlc_value_t );
132 int VLC_Get ( int, char const *, vlc_value_t * );
133 int VLC_AddIntf ( int, char const *, vlc_bool_t );
134 int VLC_AddTarget ( int, char const *, int, int );
136 int VLC_Play ( int );
137 int VLC_Pause ( int );
138 int VLC_Stop ( int );
139 int VLC_FullScreen ( int );
145 #endif /* <vlc/vlc.h> */