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