libvlc_structures.h 7.08 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
/*****************************************************************************
 * libvlc.h:  libvlc_* new external API structures
 *****************************************************************************
 * Copyright (C) 1998-2007 the VideoLAN team
 * $Id $
 *
 * Authors: Filippo Carone <littlejohn@videolan.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

#ifndef _LIBVLC_STRUCTURES_H
#define _LIBVLC_STRUCTURES_H 1

# ifdef __cplusplus
extern "C" {
# endif

/** This structure is opaque. It represents a libvlc instance */
typedef struct libvlc_instance_t libvlc_instance_t;
33 34 35 36 37

/*****************************************************************************
 * Exceptions
 *****************************************************************************/

38
/** \defgroup libvlc_exception libvlc_exception
39 40 41 42 43
 * \ingroup libvlc
 * LibVLC Exceptions handling
 * @{
 */

44
typedef struct libvlc_exception_t
45 46 47 48 49 50 51 52
{
    int b_raised;
    int i_code;
    char *psz_message;
} libvlc_exception_t;

/**@} */

53 54 55
/*****************************************************************************
 * Time
 *****************************************************************************/
56
/** \defgroup libvlc_time libvlc_time
57 58 59 60 61 62 63 64 65
 * \ingroup libvlc
 * LibVLC Time support in libvlc
 * @{
 */

typedef vlc_int64_t libvlc_time_t;

/**@} */

66 67 68
/*****************************************************************************
 * Media Descriptor
 *****************************************************************************/
69
/** \defgroup libvlc_media libvlc_media
70 71 72 73 74 75
 * \ingroup libvlc
 * LibVLC Media Descriptor handling
 * @{
 */

/* Meta Handling */
76
/** defgroup libvlc_meta libvlc_meta
77
 * \ingroup libvlc_media
78 79 80 81
 * LibVLC Media Meta
 * @{
 */

82
typedef enum libvlc_meta_t {
83
    libvlc_meta_Title,
84 85 86 87 88 89 90 91
    libvlc_meta_Artist,
    libvlc_meta_Genre,
    libvlc_meta_Copyright,
    libvlc_meta_Album,
    libvlc_meta_TrackNumber,
    libvlc_meta_Description,
    libvlc_meta_Rating,
    libvlc_meta_Date,
92
    libvlc_meta_Setting,
93 94 95 96 97 98 99
    libvlc_meta_URL,
    libvlc_meta_Language,
    libvlc_meta_NowPlaying,
    libvlc_meta_Publisher,
    libvlc_meta_EncodedBy,
    libvlc_meta_ArtworkURL,
    libvlc_meta_TrackID
100 101 102 103
} libvlc_meta_t;

/**@} */

104
typedef struct libvlc_media_t libvlc_media_t;
105 106 107

/**@} */

108

109 110 111
/*****************************************************************************
 * Media Instance
 *****************************************************************************/
112
/** \defgroup libvlc_media_player libvlc_media_player
113 114 115 116 117
 * \ingroup libvlc
 * LibVLC Media Instance handling
 * @{
 */

118
typedef struct libvlc_media_player_t libvlc_media_player_t;
119

120 121
typedef enum libvlc_state_t
{
122
    libvlc_NothingSpecial,
123 124 125 126 127 128 129 130 131
    libvlc_Stopped,
    libvlc_Opening,
    libvlc_Buffering,
    libvlc_Ended,
    libvlc_Error,
    libvlc_Playing,
    libvlc_Paused
} libvlc_state_t;

132 133
/**@} */

134 135 136
/*****************************************************************************
 * Media List
 *****************************************************************************/
137
/** \defgroup libvlc_media_list libvlc_media_list
138 139 140 141 142 143
 * \ingroup libvlc
 * LibVLC Media List handling
 * @{
 */

typedef struct libvlc_media_list_t libvlc_media_list_t;
144
typedef struct libvlc_media_list_view_t libvlc_media_list_view_t;
145 146 147 148 149


/*****************************************************************************
 * Media List Player
 *****************************************************************************/
150 151
/** \defgroup libvlc_media_list_player libvlc_media_list_player
 * \ingroup libvlc_media_list
152 153 154 155 156 157
 * LibVLC Media List Player handling
 * @{
 */

typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;

158 159 160
/**@} libvlc_media_list_player */

/**@} libvlc_media_list */
161

162 163 164
/*****************************************************************************
 * Media Library
 *****************************************************************************/
165
/** \defgroup libvlc_media_library libvlc_media_library
166 167 168 169 170 171 172 173 174
 * \ingroup libvlc
 * LibVLC Media Library
 * @{
 */

typedef struct libvlc_media_library_t libvlc_media_library_t;

/**@} */

175 176 177
/*****************************************************************************
 * Playlist
 *****************************************************************************/
178
/** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
179
 * \ingroup libvlc
180 181
 * LibVLC Playlist handling (Deprecated)
 * @deprecated Use media_list
182 183 184
 * @{
 */

185 186
typedef struct libvlc_playlist_item_t
{
187 188 189 190 191 192 193 194 195 196 197 198
    int i_id;
    char * psz_uri;
    char * psz_name;

} libvlc_playlist_item_t;

/**@} */


/*****************************************************************************
 * Video
 *****************************************************************************/
199
/** \defgroup libvlc_video libvlc_video
200
 * \ingroup libvlc_media_player
201 202 203
 * LibVLC Video handling
 * @{
 */
204
 
205 206 207 208 209 210 211 212 213 214 215
/**
* Downcast to this general type as placeholder for a platform specific one, such as:
*  Drawable on X11,
*  CGrafPort on MacOSX,
*  HWND on win32
*/
typedef int libvlc_drawable_t;

/**
* Rectangle type for video geometry
*/
216
typedef struct libvlc_rectangle_t
217 218 219 220 221 222 223 224 225
{
    int top, left;
    int bottom, right;
}
libvlc_rectangle_t;

/**@} */


226 227 228
/*****************************************************************************
 * Services/Media Discovery
 *****************************************************************************/
229
/** \defgroup libvlc_media_discoverer libvlc_media_discoverer
230 231 232 233 234 235 236 237 238
 * \ingroup libvlc
 * LibVLC Media Discoverer
 * @{
 */

typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t;

/**@} */

239 240 241 242
/*****************************************************************************
 * Message log handling
 *****************************************************************************/

243
/** \defgroup libvlc_log libvlc_log
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
 * \ingroup libvlc
 * LibVLC Message Logging
 * @{
 */

/** This structure is opaque. It represents a libvlc log instance */
typedef struct libvlc_log_t libvlc_log_t;

/** This structure is opaque. It represents a libvlc log iterator */
typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;

typedef struct libvlc_log_message_t
{
    unsigned    sizeof_msg;   /* sizeof() of message structure, must be filled in by user */
    int         i_severity;   /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
    const char *psz_type;     /* module type */
    const char *psz_name;     /* module name */
    const char *psz_header;   /* optional header */
    const char *psz_message;  /* message */
} libvlc_log_message_t;

/**@} */

# ifdef __cplusplus
}
# endif

#endif