input: Disable logs & interactions for thumbnailing
[vlc.git] / include / vlc / deprecated.h
1 /*****************************************************************************
2  * deprecated.h:  libvlc deprecated API
3  *****************************************************************************
4  * Copyright (C) 1998-2008 VLC authors and VideoLAN
5  *
6  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
7  *          Jean-Paul Saman <jpsaman@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifndef LIBVLC_DEPRECATED_H
25 #define LIBVLC_DEPRECATED_H 1
26
27 # ifdef __cplusplus
28 extern "C" {
29 # endif
30
31 /**
32  * \ingroup libvlc libvlc_media
33  * @{
34  */
35
36 /**
37  * Parse a media.
38  *
39  * This fetches (local) art, meta data and tracks information.
40  * The method is synchronous.
41  *
42  * \deprecated This function could block indefinitely.
43  *             Use libvlc_media_parse_with_options() instead
44  *
45  * \see libvlc_media_parse_with_options
46  * \see libvlc_media_get_meta
47  *
48  * \param p_md media descriptor object
49  */
50 LIBVLC_DEPRECATED LIBVLC_API void
51 libvlc_media_parse( libvlc_media_t *p_md );
52
53 /**
54  * Parse a media.
55  *
56  * This fetches (local) art, meta data and tracks information.
57  * The method is the asynchronous of libvlc_media_parse().
58  *
59  * To track when this is over you can listen to libvlc_MediaParsedChanged
60  * event. However if the media was already parsed you will not receive this
61  * event.
62  *
63  * \deprecated You can't be sure to receive the libvlc_MediaParsedChanged
64  *             event (you can wait indefinitely for this event).
65  *             Use libvlc_media_parse_with_options() instead
66  *
67  * \see libvlc_media_parse
68  * \see libvlc_MediaParsedChanged
69  * \see libvlc_media_get_meta
70  *
71  * \param p_md media descriptor object
72  */
73 LIBVLC_DEPRECATED LIBVLC_API void
74 libvlc_media_parse_async( libvlc_media_t *p_md );
75
76 /**
77  * Return true is the media descriptor object is parsed
78  *
79  * \deprecated This can return true in case of failure.
80  *             Use libvlc_media_get_parsed_status() instead
81  *
82  * \see libvlc_MediaParsedChanged
83  *
84  * \param p_md media descriptor object
85  * \retval true media object has been parsed
86  * \retval false otherwise
87  */
88 LIBVLC_DEPRECATED LIBVLC_API bool
89    libvlc_media_is_parsed( libvlc_media_t *p_md );
90
91 /** @}*/
92
93 /**
94  * \ingroup libvlc
95  * \defgroup libvlc_playlist LibVLC playlist (legacy)
96  * @deprecated Use @ref libvlc_media_list instead.
97  * @{
98  * \file
99  * LibVLC deprecated playlist API
100  */
101
102 /**
103  * Start playing (if there is any item in the playlist).
104  *
105  * Additionnal playlist item options can be specified for addition to the
106  * item before it is played.
107  *
108  * \param p_instance the playlist instance
109  */
110 LIBVLC_DEPRECATED LIBVLC_API
111 void libvlc_playlist_play( libvlc_instance_t *p_instance );
112
113 /** @}*/
114
115 # ifdef __cplusplus
116 }
117 # endif
118
119 #endif /* _LIBVLC_DEPRECATED_H */