1 /*****************************************************************************
2 * libvlc.h: libvlc_* new external API
3 *****************************************************************************
4 * Copyright (C) 1998-2005 the VideoLAN team
5 * $Id: vlc.h 13701 2005-12-12 17:58:56Z zorglub $
7 * Authors: Cl�ent Stenac <zorglub@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
25 * \defgroup libvlc Libvlc
26 * This is libvlc, the base library of the VLC program.
41 /*****************************************************************************
43 *****************************************************************************/
44 /** defgroup libvlc_exception Exceptions
46 * LibVLC Exceptions handling
50 struct libvlc_exception_t
55 typedef struct libvlc_exception_t libvlc_exception_t;
58 * Initialize an exception structure. This can be called several times to reuse
59 * an exception structure.
60 * \param p_exception the exception to initialize
62 void libvlc_exception_init( libvlc_exception_t *p_exception );
65 * Has an exception been raised ?
66 * \param p_exception the exception to query
67 * \return 0 if no exception raised, 1 else
69 int libvlc_exception_raised( libvlc_exception_t *p_exception );
70 void libvlc_exception_raise( libvlc_exception_t *p_exception, char *psz_message );
73 * Get exception message
74 * \param p_exception the exception to query
75 * \return the exception message or NULL if not applicable (exception not raised
78 char* libvlc_exception_get_message( libvlc_exception_t *p_exception );
84 /*****************************************************************************
86 *****************************************************************************/
88 /** defgroup libvlc_core Core
94 /** This structure is opaque. It represents a libvlc instance */
95 typedef struct libvlc_instance_t libvlc_instance_t;
98 * Create an initialized libvlc instance
99 * \param argc the number of arguments
100 * \param argv command-line-type arguments
101 * \param exception an initialized exception pointer
103 libvlc_instance_t * libvlc_new( int , char **, libvlc_exception_t *);
106 * Destroy a libvlc instance
107 * \param p_instance the instance to destroy
109 void libvlc_destroy( libvlc_instance_t *);
113 /*****************************************************************************
115 *****************************************************************************/
116 /** defgroup libvlc_playlist Playlist
118 * LibVLC Playlist handling
123 * Start playing. You can give some additionnal playlist item options
124 * that will be added to the item before playing it.
125 * \param p_instance the instance
126 * \param i_options the number of options to add to the item
127 * \param ppsz_options the options to add to the item
128 * \param p_exception an initialized exception
130 void libvlc_playlist_play( libvlc_instance_t*, int, char **,
131 libvlc_exception_t * );
133 typedef struct libvlc_input_t libvlc_input_t;
136 libvlc_input_t *libvlc_playlist_get_input( libvlc_instance_t *,
137 libvlc_exception_t * );
143 /*****************************************************************************
145 *****************************************************************************/
146 /** defgroup libvlc_input Input
148 * LibVLC Input handling
152 /** Free an input object
153 * \param p_input the input to free
155 void libvlc_input_free( libvlc_input_t * );
157 /// \bug This might go away ... to be replaced by a broader system
158 vlc_int64_t libvlc_input_get_length( libvlc_input_t *, libvlc_exception_t *);
159 vlc_int64_t libvlc_input_get_time( libvlc_input_t *, libvlc_exception_t *);
160 float libvlc_input_get_position( libvlc_input_t *, libvlc_exception_t *);
170 #endif /* <vlc/vlc_control.h> */