c18567b89aaa434da151232b37fde00f423824ed
[vlc.git] / 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 deprecated API
31  */
32
33 # ifdef __cplusplus
34 extern "C" {
35 # endif
36
37 /*****************************************************************************
38  * Playlist (Deprecated)
39  *****************************************************************************/
40 /** \defgroup libvlc_playlist LibVLC playlist (legacy)
41  * \ingroup libvlc
42  * @deprecated Use @ref libvlc_media_list instead.
43  * @{
44  */
45
46 /**
47  * Start playing (if there is any item in the playlist).
48  *
49  * Additionnal playlist item options can be specified for addition to the
50  * item before it is played.
51  *
52  * \param p_instance the playlist instance
53  * \param i_id the item to play. If this is a negative number, the next
54  *        item will be selected. Otherwise, the item with the given ID will be
55  *        played
56  * \param i_options the number of options to add to the item
57  * \param ppsz_options the options to add to the item
58  */
59 LIBVLC_DEPRECATED void libvlc_playlist_play( libvlc_instance_t *p_instance,
60                                               int i_id, int i_options,
61                                               char **ppsz_options );
62
63 /** @}*/
64
65 # ifdef __cplusplus
66 }
67 # endif
68
69 #endif /* _LIBVLC_DEPRECATED_H */