Replace libvlc_exception_get_message with libvlc_errmsg
[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 } libvlc_exception_t;
55
56 /**@} */
57
58 /*****************************************************************************
59  * Time
60  *****************************************************************************/
61 /** \defgroup libvlc_time libvlc_time
62  * \ingroup libvlc_core
63  * LibVLC Time support in libvlc
64  * @{
65  */
66
67 typedef int64_t libvlc_time_t;
68
69 /**@} */
70
71 /*****************************************************************************
72  * Media Descriptor
73  *****************************************************************************/
74 /** \defgroup libvlc_media libvlc_media
75  * \ingroup libvlc
76  * LibVLC Media Descriptor handling
77  * @{
78  */
79
80
81 /**@} */
82
83
84 /*****************************************************************************
85  * Playlist
86  *****************************************************************************/
87 /** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
88  * \ingroup libvlc
89  * LibVLC Playlist handling (Deprecated)
90  * @deprecated Use media_list
91  * @{
92  */
93
94 typedef struct libvlc_playlist_item_t
95 {
96     int i_id;
97     char * psz_uri;
98     char * psz_name;
99
100 } libvlc_playlist_item_t;
101
102 /**@} */
103
104
105 /*****************************************************************************
106  * Message log handling
107  *****************************************************************************/
108
109 /** \defgroup libvlc_log libvlc_log
110  * \ingroup libvlc_core
111  * LibVLC Message Logging
112  * @{
113  */
114
115 /** This structure is opaque. It represents a libvlc log instance */
116 typedef struct libvlc_log_t libvlc_log_t;
117
118 /** This structure is opaque. It represents a libvlc log iterator */
119 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
120
121 typedef struct libvlc_log_message_t
122 {
123     unsigned    sizeof_msg;   /* sizeof() of message structure, must be filled in by user */
124     int         i_severity;   /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
125     const char *psz_type;     /* module type */
126     const char *psz_name;     /* module name */
127     const char *psz_header;   /* optional header */
128     const char *psz_message;  /* message */
129 } libvlc_log_message_t;
130
131 /**@} */
132
133 # ifdef __cplusplus
134 }
135 # endif
136
137 #endif