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

   1 /*****************************************************************************
   2  * deprecated.h:  libvlc deprecated API
   3  *****************************************************************************
   4  * Copyright (C) 1998-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Clément Stenac <zorglub@videolan.org>
   8  *          Jean-Paul Saman <jpsaman@videolan.org>
   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 /**
  29  * \file
  30  * This file defines libvlc depreceated API
  31  */
  32
  33 /**
  34  * This is the legacy representation of a platform-specific drawable. Because
  35  * it cannot accomodate a pointer on most 64-bits platforms, it should not be
  36  * used anymore.
  37  */
  38 typedef int libvlc_drawable_t;
  39
  40 # ifdef __cplusplus
  41 extern "C" {
  42 # endif
  43
  44 /*****************************************************************************
  45  * Playlist (Deprecated)
  46  *****************************************************************************/
  47 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
  48  * \ingroup libvlc
  49  * LibVLC Playlist handling (Deprecated)
  50  * @deprecated Use media_list
  51  * @{
  52  */
  53
  54 /**
  55  * Start playing (if there is any item in the playlist).
  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  */
  67 VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
  68                                           char ** );
  69
  70 /** @}*/
  71
  72 # ifdef __cplusplus
  73 }
  74 # endif
  75
  76 #endif /* _LIBVLC_DEPRECATED_H */