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

   1 /*****************************************************************************
   2  * deprecated.h:  libvlc deprecated API
   3  *****************************************************************************
   4  * Copyright (C) 1998-2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef _LIBVLC_DEPRECATED_H
  26 #define _LIBVLC_DEPRECATED_H 1
  27
  28 # ifdef __cplusplus
  29 extern "C" {
  30 # endif
  31
  32 VLC_DEPRECATED_API int libvlc_video_destroy( libvlc_media_player_t *, libvlc_exception_t *);
  33
  34 /*****************************************************************************
  35  * Playlist (Deprecated)
  36  *****************************************************************************/
  37 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
  38  * \ingroup libvlc
  39  * LibVLC Playlist handling (Deprecated)
  40  * @deprecated Use media_list
  41  * @{
  42  */
  43
  44 /**
  45  * Set the playlist's loop attribute. If set, the playlist runs continuously
  46  * and wraps around when it reaches the end.
  47  *
  48  * \param p_instance the playlist instance
  49  * \param loop the loop attribute. 1 sets looping, 0 disables it
  50  * \param p_e an initialized exception pointer
  51  */
  52 VLC_DEPRECATED_API void libvlc_playlist_loop( libvlc_instance_t* , int,
  53                                           libvlc_exception_t * );
  54
  55 /**
  56  * Start playing.
  57  *
  58  * Additionnal playlist item options can be specified for addition to the
  59  * item before it is played.
  60  *
  61  * \param p_instance the playlist instance
  62  * \param i_id the item to play. If this is a negative number, the next
  63  *        item will be selected. Otherwise, the item with the given ID will be
  64  *        played
  65  * \param i_options the number of options to add to the item
  66  * \param ppsz_options the options to add to the item
  67  * \param p_e an initialized exception pointer
  68  */
  69 VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
  70                                           char **, libvlc_exception_t * );
  71
  72 /**
  73  * Toggle the playlist's pause status.
  74  *
  75  * If the playlist was running, it is paused. If it was paused, it is resumed.
  76  *
  77  * \param p_instance the playlist instance to pause
  78  * \param p_e an initialized exception pointer
  79  */
  80 VLC_DEPRECATED_API void libvlc_playlist_pause( libvlc_instance_t *,
  81                                            libvlc_exception_t * );
  82
  83 /**
  84  * Checks whether the playlist is running
  85  *
  86  * \param p_instance the playlist instance
  87  * \param p_e an initialized exception pointer
  88  * \return 0 if the playlist is stopped or paused, 1 if it is running
  89  */
  90 VLC_DEPRECATED_API int libvlc_playlist_isplaying( libvlc_instance_t *,
  91                                               libvlc_exception_t * );
  92
  93 /**
  94  * Get the number of items in the playlist
  95  *
  96  * \param p_instance the playlist instance
  97  * \param p_e an initialized exception pointer
  98  * \return the number of items
  99  */
 100 VLC_DEPRECATED_API int libvlc_playlist_items_count( libvlc_instance_t *,
 101                                                 libvlc_exception_t * );
 102
 103 /**
 104  * Lock the playlist.
 105  *
 106  * \param p_instance the playlist instance
 107  */
 108 VLC_DEPRECATED_API void libvlc_playlist_lock( libvlc_instance_t * );
 109
 110 /**
 111  * Unlock the playlist.
 112  *
 113  * \param p_instance the playlist instance
 114  */
 115 VLC_DEPRECATED_API void libvlc_playlist_unlock( libvlc_instance_t * );
 116
 117 /**
 118  * Stop playing.
 119  *
 120  * \param p_instance the playlist instance to stop
 121  * \param p_e an initialized exception pointer
 122  */
 123 VLC_DEPRECATED_API void libvlc_playlist_stop( libvlc_instance_t *,
 124                                           libvlc_exception_t * );
 125
 126 /**
 127  * Go to the next playlist item. If the playlist was stopped, playback
 128  * is started.
 129  *
 130  * \param p_instance the playlist instance
 131  * \param p_e an initialized exception pointer
 132  */
 133 VLC_DEPRECATED_API void libvlc_playlist_next( libvlc_instance_t *,
 134                                           libvlc_exception_t * );
 135
 136 /**
 137  * Go to the previous playlist item. If the playlist was stopped, playback
 138  * is started.
 139  *
 140  * \param p_instance the playlist instance
 141  * \param p_e an initialized exception pointer
 142  */
 143 VLC_DEPRECATED_API void libvlc_playlist_prev( libvlc_instance_t *,
 144                                           libvlc_exception_t * );
 145
 146 /**
 147  * Empty a playlist. All items in the playlist are removed.
 148  *
 149  * \param p_instance the playlist instance
 150  * \param p_e an initialized exception pointer
 151  */
 152 VLC_DEPRECATED_API void libvlc_playlist_clear( libvlc_instance_t *,
 153                                            libvlc_exception_t * );
 154
 155 /**
 156  * Append an item to the playlist. The item is added at the end. If more
 157  * advanced options are required, \see libvlc_playlist_add_extended instead.
 158  *
 159  * \param p_instance the playlist instance
 160  * \param psz_uri the URI to open, using VLC format
 161  * \param psz_name a name that you might want to give or NULL
 162  * \param p_e an initialized exception pointer
 163  * \return the identifier of the new item
 164  */
 165 VLC_DEPRECATED_API int libvlc_playlist_add( libvlc_instance_t *, const char *,
 166                                         const char *, libvlc_exception_t * );
 167
 168 /**
 169  * Append an item to the playlist. The item is added at the end, with
 170  * additional input options.
 171  *
 172  * \param p_instance the playlist instance
 173  * \param psz_uri the URI to open, using VLC format
 174  * \param psz_name a name that you might want to give or NULL
 175  * \param i_options the number of options to add
 176  * \param ppsz_options strings representing the options to add
 177  * \param p_e an initialized exception pointer
 178  * \return the identifier of the new item
 179  */
 180 VLC_DEPRECATED_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
 181                                                  const char *, int, const char **,
 182                                                  libvlc_exception_t * );
 183
 184 /**
 185  * Delete the playlist item with the given ID.
 186  *
 187  * \param p_instance the playlist instance
 188  * \param i_id the id to remove
 189  * \param p_e an initialized exception pointer
 190  * \return 0 in case of success, a non-zero value otherwise
 191  */
 192 VLC_DEPRECATED_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
 193                                                 libvlc_exception_t * );
 194
 195 /** Get the input that is currently being played by the playlist.
 196  *
 197  * \param p_instance the playlist instance to use
 198  * \param p_e an initialized exception pointern
 199  * \return a media instance object
 200  */
 201 VLC_DEPRECATED_API libvlc_media_player_t * libvlc_playlist_get_media_player(
 202                                 libvlc_instance_t *, libvlc_exception_t * );
 203
 204 /** @}*/
 205
 206 # ifdef __cplusplus
 207 }
 208 # endif
 209
 210 #endif /* _LIBVLC_DEPRECATED_H */