git.sesse.net Git - vlc/blob - include/vlc/libvlc.h

   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 $
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 /**
  25  * \defgroup libvlc Libvlc
  26  * This is libvlc, the base library of the VLC program.
  27  *
  28  * @{
  29  */
  30
  31
  32 #ifndef _LIBVLC_H
  33 #define _LIBVLC_H 1
  34
  35 #include <vlc/vlc.h>
  36
  37 # ifdef __cplusplus
  38 extern "C" {
  39 # endif
  40
  41 /*****************************************************************************
  42  * Exception handling
  43  *****************************************************************************/
  44 /** defgroup libvlc_exception Exceptions
  45  * \ingroup libvlc
  46  * LibVLC Exceptions handling
  47  * @{
  48  */
  49
  50 struct libvlc_exception_t
  51 {
  52     int b_raised;
  53     char *psz_message;
  54 };
  55 typedef struct libvlc_exception_t libvlc_exception_t;
  56
  57 /**
  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
  61  */
  62 void libvlc_exception_init( libvlc_exception_t *p_exception );
  63
  64 /**
  65  * Has an exception been raised ?
  66  * \param p_exception the exception to query
  67  * \return 0 if no exception raised, 1 else
  68  */
  69 int libvlc_exception_raised( libvlc_exception_t *p_exception );
  70
  71 /**
  72  * Get exception message
  73  * \param p_exception the exception to query
  74  * \return the exception message or NULL if not applicable (exception not raised
  75  * for example)
  76  */
  77 char* libvlc_exception_get_message( libvlc_exception_t *p_exception );
  78
  79
  80
  81 /** @} */
  82
  83 /*****************************************************************************
  84  * Core handling
  85  *****************************************************************************/
  86
  87 /** defgroup libvlc_core Core
  88  * \ingroup libvlc
  89  * LibVLC Core
  90  * @{
  91  */
  92
  93 /** This structure is opaque. It represents a libvlc instance */
  94 typedef struct libvlc_instance_t libvlc_instance_t;
  95
  96 /**
  97  * Create an initialized libvlc instance
  98  * \param argc the number of arguments
  99  * \param argv command-line-type arguments
 100  * \param exception an initialized exception pointer
 101  */
 102 libvlc_instance_t * libvlc_new( int , char **, libvlc_exception_t *);
 103
 104 /**
 105  * Destroy a libvlc instance
 106  * \param p_instance the instance to destroy
 107  */
 108 void libvlc_destroy( libvlc_instance_t *);
 109
 110 /** @}*/
 111
 112 /*****************************************************************************
 113  * Playlist
 114  *****************************************************************************/
 115 /** defgroup libvlc_playlist Playlist
 116  * \ingroup libvlc
 117  * LibVLC Playlist handling
 118  * @{
 119  */
 120
 121 /**
 122  * Start playing. You can give some additionnal playlist item options
 123  * that will be added to the item before playing it.
 124  * \param p_instance the instance
 125  * \param i_options the number of options to add to the item
 126  * \param ppsz_options the options to add to the item
 127  * \param p_exception an initialized exception
 128  */
 129 void libvlc_playlist_play( libvlc_instance_t*, int, char **,
 130                            libvlc_exception_t * );
 131
 132 typedef struct libvlc_input_t libvlc_input_t;
 133
 134 ///\todo document me
 135 libvlc_input_t *libvlc_playlist_get_input( libvlc_instance_t *,
 136                                            libvlc_exception_t * );
 137
 138
 139
 140 /** @}*/
 141
 142 /*****************************************************************************
 143  * Input
 144  *****************************************************************************/
 145 /** defgroup libvlc_input Input
 146  * \ingroup libvlc
 147  * LibVLC Input handling
 148  * @{
 149  */
 150
 151 /** Free an input object
 152  * \param p_input the input to free
 153  */
 154 void libvlc_input_free( libvlc_input_t * );
 155
 156 /// \bug This might go away ... to be replaced by a broader system
 157 vlc_int64_t libvlc_input_get_length( libvlc_input_t *, libvlc_exception_t *);
 158 vlc_int64_t libvlc_input_get_time( libvlc_input_t *, libvlc_exception_t *);
 159 float libvlc_input_get_position( libvlc_input_t *, libvlc_exception_t *);
 160
 161 /** @} */
 162
 163
 164
 165 # ifdef __cplusplus
 166 }
 167 # endif
 168
 169 #endif /* <vlc/vlc_control.h> */