Replace libvlc_exception_get_message with libvlc_errmsg

[vlc] / include / vlc / libvlc_structures.h

diff --git a/include/vlc/libvlc_structures.h b/include/vlc/libvlc_structures.h
index 7bc53a65f497e2228608e8e6d0a5abfd5653feb3..4e5e1c5d4d40f83e741a83b8bdb53382c85d34e0 100644 (file)
--- a/include/vlc/libvlc_structures.h
+++ b/include/vlc/libvlc_structures.h
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * libvlc.h:  libvlc_* new external API structures
  *****************************************************************************
- * Copyright (C) 1998-2007 the VideoLAN team
+ * Copyright (C) 1998-2008 the VideoLAN team
  * $Id $
  *
  * Authors: Filippo Carone <littlejohn@videolan.org>
@@ -21,10 +21,15 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#ifndef _LIBVLC_STRUCTURES_H
-#define _LIBVLC_STRUCTURES_H 1
+#ifndef LIBVLC_STRUCTURES_H
+#define LIBVLC_STRUCTURES_H 1
 
-#include <vlc/vlc.h>
+/**
+ * \file
+ * This file defines libvlc_* new external API structures
+ */
+
+#include <stdint.h>
 
 # ifdef __cplusplus
 extern "C" {
@@ -37,99 +42,62 @@ typedef struct libvlc_instance_t libvlc_instance_t;
  * Exceptions
  *****************************************************************************/
 
-/** defgroup libvlc_exception Exceptions
- * \ingroup libvlc
+/** \defgroup libvlc_exception libvlc_exception
+ * \ingroup libvlc_core
  * LibVLC Exceptions handling
  * @{
  */
 
-typedef struct
+typedef struct libvlc_exception_t
 {
     int b_raised;
-    int i_code;
-    char *psz_message;
 } libvlc_exception_t;
 
 /**@} */
 
 /*****************************************************************************
- * Media Descriptor
+ * Time
  *****************************************************************************/
-/** defgroup libvlc_media_descriptor MediaDescriptor
- * \ingroup libvlc
- * LibVLC Media Descriptor handling
+/** \defgroup libvlc_time libvlc_time
+ * \ingroup libvlc_core
+ * LibVLC Time support in libvlc
  * @{
  */
 
-/* Meta Handling */
-/** defgroup libvlc_meta Meta
- * \ingroup libvlc_media_descriptor
- * LibVLC Media Meta
- * @{
- */
-
-typedef enum {
-    libvlc_meta_Title,
-    libvlc_meta_Artist
-} libvlc_meta_t;
-
-/**@} */
-
-
-typedef struct {
-    bool                b_preparsed;
-    input_item_t      * p_input_item;
-    libvlc_instance_t * p_libvlc_instance;
-} libvlc_media_descriptor_t;
+typedef int64_t libvlc_time_t;
 
 /**@} */
 
-
 /*****************************************************************************
- * Playlist
+ * Media Descriptor
  *****************************************************************************/
-/** defgroup libvlc_playlist Playlist
+/** \defgroup libvlc_media libvlc_media
  * \ingroup libvlc
- * LibVLC Playlist handling
+ * LibVLC Media Descriptor handling
  * @{
  */
 
-typedef struct {
-    int i_id;
-    char * psz_uri;
-    char * psz_name;
-
-} libvlc_playlist_item_t;
 
 /**@} */
 
 
 /*****************************************************************************
- * Video
+ * Playlist
  *****************************************************************************/
-/** defgroup libvlc_video Video
+/** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
  * \ingroup libvlc
- * LibVLC Video handling
+ * LibVLC Playlist handling (Deprecated)
+ * @deprecated Use media_list
  * @{
  */
-    
-/**
-* 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
-*/
-typedef struct
+typedef struct libvlc_playlist_item_t
 {
-    int top, left;
-    int bottom, right;
-}
-libvlc_rectangle_t;
+    int i_id;
+    char * psz_uri;
+    char * psz_name;
+
+} libvlc_playlist_item_t;
 
 /**@} */
 
@@ -138,8 +106,8 @@ libvlc_rectangle_t;
  * Message log handling
  *****************************************************************************/
 
-/** defgroup libvlc_log Log
- * \ingroup libvlc
+/** \defgroup libvlc_log libvlc_log
+ * \ingroup libvlc_core
  * LibVLC Message Logging
  * @{
  */
@@ -162,54 +130,6 @@ typedef struct libvlc_log_message_t
 
 /**@} */
 
-/*****************************************************************************
- * Callbacks handling
- *****************************************************************************/
-
-/** defgroup libvlc_callbacks Callbacks
- * \ingroup libvlc
- * LibVLC Event Callbacks
- * @{
- */
-    
-/**
- * Available events:
- * - libvlc_VolumeChanged
- * - libvlc_InputPositionChanged
- */
-
-typedef enum {
-    libvlc_VolumeChanged,
-    libvlc_InputPositionChanged,
-} libvlc_event_type_t;
-
-typedef struct 
-{
-    libvlc_event_type_t type;
-    union
-    {
-        struct
-        {
-            int new_volume;
-        } volume_changed;
-        struct
-        {
-            vlc_int64_t new_position;
-        } input_position_changed;
-    } u;
-} libvlc_event_t;
-
-/**
- * Callback function notification
- * \param p_instance the libvlc instance
- * \param p_event the event triggering the callback
- * \param p_user_data user provided data
- */
-
-typedef void ( *libvlc_callback_t )( struct libvlc_instance_t *, libvlc_event_t *, void * );
-
-/**@} */
-
 # ifdef __cplusplus
 }
 # endif