1f830d7e23c94115d5eb50842a2afb7d4f67e3ee
[vlc.git] / include / vlc / libvlc_structures.h
1 /*****************************************************************************
2  * libvlc.h:  libvlc_* new external API structures
3  *****************************************************************************
4  * Copyright (C) 1998-2008 the VideoLAN team
5  * $Id $
6  *
7  * Authors: Filippo Carone <littlejohn@videolan.org>
8  *
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.
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 General Public License for more details.
18  *
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  *****************************************************************************/
23
24 #ifndef LIBVLC_STRUCTURES_H
25 #define LIBVLC_STRUCTURES_H 1
26
27 /**
28  * \file
29  * This file defines libvlc_* new external API structures
30  */
31
32 #include <stdint.h>
33
34 # ifdef __cplusplus
35 extern "C" {
36 # endif
37
38 /** This structure is opaque. It represents a libvlc instance */
39 typedef struct libvlc_instance_t libvlc_instance_t;
40
41 /*****************************************************************************
42  * Exceptions
43  *****************************************************************************/
44
45 /** \defgroup libvlc_exception libvlc_exception
46  * \ingroup libvlc_core
47  * LibVLC Exceptions handling
48  * @{
49  */
50
51 typedef struct libvlc_exception_t
52 {
53     int b_raised;
54     int i_code;
55     char *psz_message;
56 } libvlc_exception_t;
57
58 /**@} */
59
60 /*****************************************************************************
61  * Time
62  *****************************************************************************/
63 /** \defgroup libvlc_time libvlc_time
64  * \ingroup libvlc_core
65  * LibVLC Time support in libvlc
66  * @{
67  */
68
69 typedef int64_t libvlc_time_t;
70
71 /**@} */
72
73 /*****************************************************************************
74  * Media Descriptor
75  *****************************************************************************/
76 /** \defgroup libvlc_media libvlc_media
77  * \ingroup libvlc
78  * LibVLC Media Descriptor handling
79  * @{
80  */
81
82
83 /**@} */
84
85
86 /*****************************************************************************
87  * Playlist
88  *****************************************************************************/
89 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
90  * \ingroup libvlc
91  * LibVLC Playlist handling (Deprecated)
92  * @deprecated Use media_list
93  * @{
94  */
95
96 typedef struct libvlc_playlist_item_t
97 {
98     int i_id;
99     char * psz_uri;
100     char * psz_name;
101
102 } libvlc_playlist_item_t;
103
104 /**@} */
105
106
107 /*****************************************************************************
108  * Message log handling
109  *****************************************************************************/
110
111 /** \defgroup libvlc_log libvlc_log
112  * \ingroup libvlc_core
113  * LibVLC Message Logging
114  * @{
115  */
116
117 /** This structure is opaque. It represents a libvlc log instance */
118 typedef struct libvlc_log_t libvlc_log_t;
119
120 /** This structure is opaque. It represents a libvlc log iterator */
121 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
122
123 typedef struct libvlc_log_message_t
124 {
125     unsigned    sizeof_msg;   /* sizeof() of message structure, must be filled in by user */
126     int         i_severity;   /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
127     const char *psz_type;     /* module type */
128     const char *psz_name;     /* module name */
129     const char *psz_header;   /* optional header */
130     const char *psz_message;  /* message */
131 } libvlc_log_message_t;
132
133 /**@} */
134
135 # ifdef __cplusplus
136 }
137 # endif
138
139 #endif