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