git.sesse.net Git - vlc/blob - include/vlc/libvlc_events.h

   1 /*****************************************************************************
   2  * libvlc_events.h:  libvlc_events external API structure
   3  *****************************************************************************
   4  * Copyright (C) 1998-2008 the VideoLAN team
   5  * $Id $
   6  *
   7  * Authors: Filippo Carone <littlejohn@videolan.org>
   8  *          Pierre d'Herbemont <pdherbemont@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef LIBVLC_EVENTS_H
  26 #define LIBVLC_EVENTS_H 1
  27
  28 /**
  29  * \file
  30  * This file defines libvlc_event external API
  31  */
  32
  33 # ifdef __cplusplus
  34 extern "C" {
  35 # endif
  36
  37 /*****************************************************************************
  38  * Events handling
  39  *****************************************************************************/
  40
  41 /** \defgroup libvlc_event libvlc_event
  42  * \ingroup libvlc_core
  43  * LibVLC Available Events
  44  * @{
  45  */
  46
  47 typedef enum libvlc_event_type_t {
  48     /* Append new event types at the end.
  49      * Do not remove, insert or re-order any entry. */
  50     libvlc_MediaMetaChanged,
  51     libvlc_MediaSubItemAdded,
  52     libvlc_MediaDurationChanged,
  53     libvlc_MediaPreparsedChanged,
  54     libvlc_MediaFreed,
  55     libvlc_MediaStateChanged,
  56
  57     libvlc_MediaPlayerNothingSpecial,
  58     libvlc_MediaPlayerOpening,
  59     libvlc_MediaPlayerBuffering,
  60     libvlc_MediaPlayerPlaying,
  61     libvlc_MediaPlayerPaused,
  62     libvlc_MediaPlayerStopped,
  63     libvlc_MediaPlayerForward,
  64     libvlc_MediaPlayerBackward,
  65     libvlc_MediaPlayerEndReached,
  66     libvlc_MediaPlayerEncounteredError,
  67     libvlc_MediaPlayerTimeChanged,
  68     libvlc_MediaPlayerPositionChanged,
  69     libvlc_MediaPlayerSeekableChanged,
  70     libvlc_MediaPlayerPausableChanged,
  71
  72     libvlc_MediaListItemAdded,
  73     libvlc_MediaListWillAddItem,
  74     libvlc_MediaListItemDeleted,
  75     libvlc_MediaListWillDeleteItem,
  76
  77     libvlc_MediaListViewItemAdded,
  78     libvlc_MediaListViewWillAddItem,
  79     libvlc_MediaListViewItemDeleted,
  80     libvlc_MediaListViewWillDeleteItem,
  81
  82     libvlc_MediaListPlayerPlayed,
  83     libvlc_MediaListPlayerNextItemSet,
  84     libvlc_MediaListPlayerStopped,
  85
  86     libvlc_MediaDiscovererStarted,
  87     libvlc_MediaDiscovererEnded,
  88
  89     libvlc_MediaPlayerTitleChanged,
  90     libvlc_MediaPlayerSnapshotTaken,
  91     /* New event types HERE */
  92 } libvlc_event_type_t;
  93
  94 /**
  95  * An Event
  96  * \param type the even type
  97  * \param p_obj the sender object
  98  * \param u Event dependent content
  99  */
 100
 101 typedef struct libvlc_event_t
 102 {
 103     libvlc_event_type_t type;
 104     void * p_obj;
 105     union event_type_specific
 106     {
 107         /* media descriptor */
 108         struct
 109         {
 110             libvlc_meta_t meta_type;
 111         } media_meta_changed;
 112         struct
 113         {
 114             libvlc_media_t * new_child;
 115         } media_subitem_added;
 116         struct
 117         {
 118             int64_t new_duration;
 119         } media_duration_changed;
 120         struct
 121         {
 122             int new_status;
 123         } media_preparsed_changed;
 124         struct
 125         {
 126             libvlc_media_t * md;
 127         } media_freed;
 128         struct
 129         {
 130             libvlc_state_t new_state;
 131         } media_state_changed;
 132
 133         /* media instance */
 134         struct
 135         {
 136             float new_position;
 137         } media_player_position_changed;
 138         struct
 139         {
 140             libvlc_time_t new_time;
 141         } media_player_time_changed;
 142         struct
 143         {
 144             int new_title;
 145         } media_player_title_changed;
 146         struct
 147         {
 148             uint64_t new_seekable; /* FIXME: that's a boolean! */
 149         } media_player_seekable_changed;
 150         struct
 151         {
 152             uint64_t new_pausable; /* FIXME: that's a BOOL!!! */
 153         } media_player_pausable_changed;
 154
 155         /* media list */
 156         struct
 157         {
 158             libvlc_media_t * item;
 159             int index;
 160         } media_list_item_added;
 161         struct
 162         {
 163             libvlc_media_t * item;
 164             int index;
 165         } media_list_will_add_item;
 166         struct
 167         {
 168             libvlc_media_t * item;
 169             int index;
 170         } media_list_item_deleted;
 171         struct
 172         {
 173             libvlc_media_t * item;
 174             int index;
 175         } media_list_will_delete_item;
 176
 177         /* media list view */
 178         struct
 179         {
 180             libvlc_media_t * item;
 181             int index;
 182         } media_list_view_item_added;
 183         struct
 184         {
 185             libvlc_media_t * item;
 186             int index;
 187         } media_list_view_will_add_item;
 188         struct
 189         {
 190             libvlc_media_t * item;
 191             int index;
 192         } media_list_view_item_deleted;
 193         struct
 194         {
 195             libvlc_media_t * item;
 196             int index;
 197         } media_list_view_will_delete_item;
 198
 199         /* snapshot taken */
 200         struct
 201         {
 202              char* psz_filename ;
 203         } media_player_snapshot_taken ;
 204
 205     } u;
 206 } libvlc_event_t;
 207
 208 /**
 209  * Event manager that belongs to a libvlc object, and from whom events can
 210  * be received.
 211  */
 212
 213 typedef struct libvlc_event_manager_t libvlc_event_manager_t;
 214
 215 /**
 216  * Callback function notification
 217  * \param p_event the event triggering the callback
 218  */
 219
 220 typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );
 221
 222 /**@} */
 223
 224 # ifdef __cplusplus
 225 }
 226 # endif
 227
 228 #endif /* _LIBVLC_EVENTS_H */