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
  33 /*****************************************************************************
  34  * Playlist (Deprecated)
  35  *****************************************************************************/
  36 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
  37  * \ingroup libvlc
  38  * LibVLC Playlist handling (Deprecated)
  39  * @deprecated Use media_list
  40  * @{
  41  */
  42
  43 /**
  44  * Set the playlist's loop attribute. If set, the playlist runs continuously
  45  * and wraps around when it reaches the end.
  46  *
  47  * \param p_instance the playlist instance
  48  * \param loop the loop attribute. 1 sets looping, 0 disables it
  49  * \param p_e an initialized exception pointer
  50  */
  51 VLC_DEPRECATED_API void libvlc_playlist_loop( libvlc_instance_t* , int,
  52                                           libvlc_exception_t * );
  53
  54 /**
  55  * Start playing.
  56  *
  57  * Additionnal playlist item options can be specified for addition to the
  58  * item before it is played.
  59  *
  60  * \param p_instance the playlist instance
  61  * \param i_id the item to play. If this is a negative number, the next
  62  *        item will be selected. Otherwise, the item with the given ID will be
  63  *        played
  64  * \param i_options the number of options to add to the item
  65  * \param ppsz_options the options to add to the item
  66  * \param p_e an initialized exception pointer
  67  */
  68 VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
  69                                           char **, libvlc_exception_t * );
  70
  71 /**
  72  * Toggle the playlist's pause status.
  73  *
  74  * If the playlist was running, it is paused. If it was paused, it is resumed.
  75  *
  76  * \param p_instance the playlist instance to pause
  77  * \param p_e an initialized exception pointer
  78  */
  79 VLC_DEPRECATED_API void libvlc_playlist_pause( libvlc_instance_t *,
  80                                            libvlc_exception_t * );
  81
  82 /**
  83  * Checks whether the playlist is running
  84  *
  85  * \param p_instance the playlist instance
  86  * \param p_e an initialized exception pointer
  87  * \return 0 if the playlist is stopped or paused, 1 if it is running
  88  */
  89 VLC_DEPRECATED_API int libvlc_playlist_isplaying( libvlc_instance_t *,
  90                                               libvlc_exception_t * );
  91
  92 /**
  93  * Get the number of items in the playlist
  94  *
  95  * \param p_instance the playlist instance
  96  * \param p_e an initialized exception pointer
  97  * \return the number of items
  98  */
  99 VLC_DEPRECATED_API int libvlc_playlist_items_count( libvlc_instance_t *,
 100                                                 libvlc_exception_t * );
 101
 102 /**
 103  * Lock the playlist.
 104  *
 105  * \param p_instance the playlist instance
 106  */
 107 VLC_DEPRECATED_API void libvlc_playlist_lock( libvlc_instance_t * );
 108
 109 /**
 110  * Unlock the playlist.
 111  *
 112  * \param p_instance the playlist instance
 113  */
 114 VLC_DEPRECATED_API void libvlc_playlist_unlock( libvlc_instance_t * );
 115
 116 /**
 117  * Stop playing.
 118  *
 119  * \param p_instance the playlist instance to stop
 120  * \param p_e an initialized exception pointer
 121  */
 122 VLC_DEPRECATED_API void libvlc_playlist_stop( libvlc_instance_t *,
 123                                           libvlc_exception_t * );
 124
 125 /**
 126  * Go to the next playlist item. If the playlist was stopped, playback
 127  * is started.
 128  *
 129  * \param p_instance the playlist instance
 130  * \param p_e an initialized exception pointer
 131  */
 132 VLC_DEPRECATED_API void libvlc_playlist_next( libvlc_instance_t *,
 133                                           libvlc_exception_t * );
 134
 135 /**
 136  * Go to the previous playlist item. If the playlist was stopped, playback
 137  * is started.
 138  *
 139  * \param p_instance the playlist instance
 140  * \param p_e an initialized exception pointer
 141  */
 142 VLC_DEPRECATED_API void libvlc_playlist_prev( libvlc_instance_t *,
 143                                           libvlc_exception_t * );
 144
 145 /**
 146  * Empty a playlist. All items in the playlist are removed.
 147  *
 148  * \param p_instance the playlist instance
 149  * \param p_e an initialized exception pointer
 150  */
 151 VLC_DEPRECATED_API void libvlc_playlist_clear( libvlc_instance_t *,
 152                                            libvlc_exception_t * );
 153
 154 /**
 155  * Append an item to the playlist. The item is added at the end. If more
 156  * advanced options are required, \see libvlc_playlist_add_extended instead.
 157  *
 158  * \param p_instance the playlist instance
 159  * \param psz_uri the URI to open, using VLC format
 160  * \param psz_name a name that you might want to give or NULL
 161  * \param p_e an initialized exception pointer
 162  * \return the identifier of the new item
 163  */
 164 VLC_DEPRECATED_API int libvlc_playlist_add( libvlc_instance_t *, const char *,
 165                                         const char *, libvlc_exception_t * );
 166
 167 /**
 168  * Append an item to the playlist. The item is added at the end, with
 169  * additional input options.
 170  *
 171  * \param p_instance the playlist instance
 172  * \param psz_uri the URI to open, using VLC format
 173  * \param psz_name a name that you might want to give or NULL
 174  * \param i_options the number of options to add
 175  * \param ppsz_options strings representing the options to add
 176  * \param p_e an initialized exception pointer
 177  * \return the identifier of the new item
 178  */
 179 VLC_DEPRECATED_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
 180                                                  const char *, int, const char **,
 181                                                  libvlc_exception_t * );
 182
 183 /**
 184  * Delete the playlist item with the given ID.
 185  *
 186  * \param p_instance the playlist instance
 187  * \param i_id the id to remove
 188  * \param p_e an initialized exception pointer
 189  * \return 0 in case of success, a non-zero value otherwise
 190  */
 191 VLC_DEPRECATED_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
 192                                                 libvlc_exception_t * );
 193
 194 /** Get the input that is currently being played by the playlist.
 195  *
 196  * \param p_instance the playlist instance to use
 197  * \param p_e an initialized exception pointern
 198  * \return a media instance object
 199  */
 200 VLC_DEPRECATED_API libvlc_media_player_t * libvlc_playlist_get_media_player(
 201                                 libvlc_instance_t *, libvlc_exception_t * );
 202
 203 /** @}*/
 204
 205 # ifdef __cplusplus
 206 }
 207 # endif
 208
 209 #endif /* _LIBVLC_DEPRECATED_H */