1 /*****************************************************************************
2 * libvlc.h: libvlc_* new external API structures
3 *****************************************************************************
4 * Copyright (C) 1998-2007 the VideoLAN team
7 * Authors: Filippo Carone <littlejohn@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
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 General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 #ifndef _LIBVLC_STRUCTURES_H
25 #define _LIBVLC_STRUCTURES_H 1
33 /** This structure is opaque. It represents a libvlc instance */
34 typedef struct libvlc_instance_t libvlc_instance_t;
36 /*****************************************************************************
38 *****************************************************************************/
40 /** \defgroup libvlc_exception libvlc_exception
41 * \ingroup libvlc_core
42 * LibVLC Exceptions handling
46 typedef struct libvlc_exception_t
55 /*****************************************************************************
57 *****************************************************************************/
58 /** \defgroup libvlc_time libvlc_time
59 * \ingroup libvlc_core
60 * LibVLC Time support in libvlc
64 typedef int64_t libvlc_time_t;
68 /*****************************************************************************
70 *****************************************************************************/
71 /** \defgroup libvlc_media libvlc_media
73 * LibVLC Media Descriptor handling
78 /** defgroup libvlc_meta libvlc_meta
79 * \ingroup libvlc_media
84 typedef enum libvlc_meta_t {
88 libvlc_meta_Copyright,
90 libvlc_meta_TrackNumber,
91 libvlc_meta_Description,
97 libvlc_meta_NowPlaying,
98 libvlc_meta_Publisher,
99 libvlc_meta_EncodedBy,
100 libvlc_meta_ArtworkURL,
106 typedef struct libvlc_media_t libvlc_media_t;
111 /*****************************************************************************
113 *****************************************************************************/
114 /** \defgroup libvlc_media_player libvlc_media_player
116 * LibVLC Media Instance handling
120 typedef struct libvlc_media_player_t libvlc_media_player_t;
122 typedef enum libvlc_state_t
124 libvlc_NothingSpecial,
136 /*****************************************************************************
138 *****************************************************************************/
139 /** \defgroup libvlc_media_list libvlc_media_list
141 * LibVLC Media List handling
145 typedef struct libvlc_media_list_t libvlc_media_list_t;
146 typedef struct libvlc_media_list_view_t libvlc_media_list_view_t;
149 /*****************************************************************************
151 *****************************************************************************/
152 /** \defgroup libvlc_media_list_player libvlc_media_list_player
153 * \ingroup libvlc_media_list
154 * LibVLC Media List Player handling
158 typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;
160 /**@} libvlc_media_list_player */
162 /**@} libvlc_media_list */
164 /*****************************************************************************
166 *****************************************************************************/
167 /** \defgroup libvlc_media_library libvlc_media_library
169 * LibVLC Media Library
173 typedef struct libvlc_media_library_t libvlc_media_library_t;
177 /*****************************************************************************
179 *****************************************************************************/
180 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
182 * LibVLC Playlist handling (Deprecated)
183 * @deprecated Use media_list
187 typedef struct libvlc_playlist_item_t
193 } libvlc_playlist_item_t;
198 /*****************************************************************************
200 *****************************************************************************/
201 /** \defgroup libvlc_video libvlc_video
202 * \ingroup libvlc_media_player
203 * LibVLC Video handling
208 * Downcast to this general type as placeholder for a platform specific one, such as:
210 * CGrafPort on MacOSX,
213 typedef int libvlc_drawable_t;
216 * Rectangle type for video geometry
218 typedef struct libvlc_rectangle_t
228 /*****************************************************************************
229 * Services/Media Discovery
230 *****************************************************************************/
231 /** \defgroup libvlc_media_discoverer libvlc_media_discoverer
233 * LibVLC Media Discoverer
237 typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
241 /*****************************************************************************
242 * Message log handling
243 *****************************************************************************/
245 /** \defgroup libvlc_log libvlc_log
246 * \ingroup libvlc_core
247 * LibVLC Message Logging
251 /** This structure is opaque. It represents a libvlc log instance */
252 typedef struct libvlc_log_t libvlc_log_t;
254 /** This structure is opaque. It represents a libvlc log iterator */
255 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
257 typedef struct libvlc_log_message_t
259 unsigned sizeof_msg; /* sizeof() of message structure, must be filled in by user */
260 int i_severity; /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
261 const char *psz_type; /* module type */
262 const char *psz_name; /* module name */
263 const char *psz_header; /* optional header */
264 const char *psz_message; /* message */
265 } libvlc_log_message_t;