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
31 /** This structure is opaque. It represents a libvlc instance */
32 typedef struct libvlc_instance_t libvlc_instance_t;
34 /*****************************************************************************
36 *****************************************************************************/
38 /** \defgroup libvlc_exception libvlc_exception
39 * \ingroup libvlc_core
40 * LibVLC Exceptions handling
44 typedef struct libvlc_exception_t
53 /*****************************************************************************
55 *****************************************************************************/
56 /** \defgroup libvlc_time libvlc_time
57 * \ingroup libvlc_core
58 * LibVLC Time support in libvlc
62 typedef vlc_int64_t libvlc_time_t;
66 /*****************************************************************************
68 *****************************************************************************/
69 /** \defgroup libvlc_media libvlc_media
71 * LibVLC Media Descriptor handling
76 /** defgroup libvlc_meta libvlc_meta
77 * \ingroup libvlc_media
82 typedef enum libvlc_meta_t {
86 libvlc_meta_Copyright,
88 libvlc_meta_TrackNumber,
89 libvlc_meta_Description,
95 libvlc_meta_NowPlaying,
96 libvlc_meta_Publisher,
97 libvlc_meta_EncodedBy,
98 libvlc_meta_ArtworkURL,
104 typedef struct libvlc_media_t libvlc_media_t;
109 /*****************************************************************************
111 *****************************************************************************/
112 /** \defgroup libvlc_media_player libvlc_media_player
114 * LibVLC Media Instance handling
118 typedef struct libvlc_media_player_t libvlc_media_player_t;
120 typedef enum libvlc_state_t
122 libvlc_NothingSpecial,
134 /*****************************************************************************
136 *****************************************************************************/
137 /** \defgroup libvlc_media_list libvlc_media_list
139 * LibVLC Media List handling
143 typedef struct libvlc_media_list_t libvlc_media_list_t;
144 typedef struct libvlc_media_list_view_t libvlc_media_list_view_t;
147 /*****************************************************************************
149 *****************************************************************************/
150 /** \defgroup libvlc_media_list_player libvlc_media_list_player
151 * \ingroup libvlc_media_list
152 * LibVLC Media List Player handling
156 typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;
158 /**@} libvlc_media_list_player */
160 /**@} libvlc_media_list */
162 /*****************************************************************************
164 *****************************************************************************/
165 /** \defgroup libvlc_media_library libvlc_media_library
167 * LibVLC Media Library
171 typedef struct libvlc_media_library_t libvlc_media_library_t;
175 /*****************************************************************************
177 *****************************************************************************/
178 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
180 * LibVLC Playlist handling (Deprecated)
181 * @deprecated Use media_list
185 typedef struct libvlc_playlist_item_t
191 } libvlc_playlist_item_t;
196 /*****************************************************************************
198 *****************************************************************************/
199 /** \defgroup libvlc_video libvlc_video
200 * \ingroup libvlc_media_player
201 * LibVLC Video handling
206 * Downcast to this general type as placeholder for a platform specific one, such as:
208 * CGrafPort on MacOSX,
211 typedef int libvlc_drawable_t;
214 * Rectangle type for video geometry
216 typedef struct libvlc_rectangle_t
226 /*****************************************************************************
227 * Services/Media Discovery
228 *****************************************************************************/
229 /** \defgroup libvlc_media_discoverer libvlc_media_discoverer
231 * LibVLC Media Discoverer
235 typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;
239 /*****************************************************************************
240 * Message log handling
241 *****************************************************************************/
243 /** \defgroup libvlc_log libvlc_log
244 * \ingroup libvlc_core
245 * LibVLC Message Logging
249 /** This structure is opaque. It represents a libvlc log instance */
250 typedef struct libvlc_log_t libvlc_log_t;
252 /** This structure is opaque. It represents a libvlc log iterator */
253 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
255 typedef struct libvlc_log_message_t
257 unsigned sizeof_msg; /* sizeof() of message structure, must be filled in by user */
258 int i_severity; /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
259 const char *psz_type; /* module type */
260 const char *psz_name; /* module name */
261 const char *psz_header; /* optional header */
262 const char *psz_message; /* message */
263 } libvlc_log_message_t;