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  * Set the drawable where the media player should render its video output.
  46  *
  47  * On Windows 32-bits, a window handle (HWND) is expected.
  48  * On Windows 64-bits, this function will always fail.
  49  *
  50  * On OSX 32-bits, a CGrafPort is expected.
  51  * On OSX 64-bits, this function will always fail.
  52  *
  53  * On other platforms, an existing X11 window ID is expected. See
  54  * libvlc_media_player_set_xid() for details.
  55  *
  56  * \param p_mi the Media Player
  57  * \param drawable the libvlc_drawable_t where the media player
  58  *        should render its video
  59  * \param p_e an initialized exception pointer
  60  */
  61 VLC_DEPRECATED_API void libvlc_media_player_set_drawable ( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
  62
  63 /**
  64  * Get the drawable where the media player should render its video output
  65  *
  66  * \param p_mi the Media Player
  67  * \param p_e an initialized exception pointer
  68  * \return the libvlc_drawable_t where the media player
  69  *         should render its video
  70  */
  71 VLC_DEPRECATED_API libvlc_drawable_t
  72                     libvlc_media_player_get_drawable ( libvlc_media_player_t *, libvlc_exception_t * );
  73
  74 /*****************************************************************************
  75  * Playlist (Deprecated)
  76  *****************************************************************************/
  77 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
  78  * \ingroup libvlc
  79  * LibVLC Playlist handling (Deprecated)
  80  * @deprecated Use media_list
  81  * @{
  82  */
  83
  84 /**
  85  * Start playing.
  86  *
  87  * Additionnal playlist item options can be specified for addition to the
  88  * item before it is played.
  89  *
  90  * \param p_instance the playlist instance
  91  * \param i_id the item to play. If this is a negative number, the next
  92  *        item will be selected. Otherwise, the item with the given ID will be
  93  *        played
  94  * \param i_options the number of options to add to the item
  95  * \param ppsz_options the options to add to the item
  96  * \param p_e an initialized exception pointer
  97  */
  98 VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
  99                                           char **, libvlc_exception_t * );
 100
 101 /** @}*/
 102
 103 # ifdef __cplusplus
 104 }
 105 # endif
 106
 107 #endif /* _LIBVLC_DEPRECATED_H */