1 /*****************************************************************************
2 * libvlc_events.h: libvlc_events external API structure
3 *****************************************************************************
4 * Copyright (C) 1998-2008 the VideoLAN team
7 * Authors: Filippo Carone <littlejohn@videolan.org>
8 * Pierre d'Herbemont <pdherbemont@videolan.org>
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.
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.
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 *****************************************************************************/
25 #ifndef LIBVLC_EVENTS_H
26 #define LIBVLC_EVENTS_H 1
30 * This file defines libvlc_event external API
37 /*****************************************************************************
39 *****************************************************************************/
41 /** \defgroup libvlc_event libvlc_event
42 * \ingroup libvlc_core
43 * LibVLC Available Events
48 enum libvlc_event_type_e {
50 enum libvlc_event_type_t {
52 /* Append new event types at the end.
53 * Do not remove, insert or re-order any entry. */
54 libvlc_MediaMetaChanged,
55 libvlc_MediaSubItemAdded,
56 libvlc_MediaDurationChanged,
57 libvlc_MediaPreparsedChanged,
59 libvlc_MediaStateChanged,
61 libvlc_MediaPlayerNothingSpecial,
62 libvlc_MediaPlayerOpening,
63 libvlc_MediaPlayerBuffering,
64 libvlc_MediaPlayerPlaying,
65 libvlc_MediaPlayerPaused,
66 libvlc_MediaPlayerStopped,
67 libvlc_MediaPlayerForward,
68 libvlc_MediaPlayerBackward,
69 libvlc_MediaPlayerEndReached,
70 libvlc_MediaPlayerEncounteredError,
71 libvlc_MediaPlayerTimeChanged,
72 libvlc_MediaPlayerPositionChanged,
73 libvlc_MediaPlayerSeekableChanged,
74 libvlc_MediaPlayerPausableChanged,
76 libvlc_MediaListItemAdded,
77 libvlc_MediaListWillAddItem,
78 libvlc_MediaListItemDeleted,
79 libvlc_MediaListWillDeleteItem,
81 libvlc_MediaListViewItemAdded,
82 libvlc_MediaListViewWillAddItem,
83 libvlc_MediaListViewItemDeleted,
84 libvlc_MediaListViewWillDeleteItem,
86 libvlc_MediaListPlayerPlayed,
87 libvlc_MediaListPlayerNextItemSet,
88 libvlc_MediaListPlayerStopped,
90 libvlc_MediaDiscovererStarted,
91 libvlc_MediaDiscovererEnded,
93 libvlc_MediaPlayerTitleChanged,
94 libvlc_MediaPlayerSnapshotTaken,
95 libvlc_MediaPlayerLengthChanged,
98 libvlc_VlmMediaRemoved,
99 libvlc_VlmMediaChanged,
100 libvlc_VlmMediaInstanceStarted,
101 libvlc_VlmMediaInstanceStopped,
102 /* New event types HERE */
107 * \param type the even type
108 * \param p_obj the sender object
109 * \param u Event dependent content
112 struct libvlc_event_t
114 libvlc_event_type_t type;
116 union event_type_specific
118 /* media descriptor */
121 libvlc_meta_t meta_type;
122 } media_meta_changed;
125 libvlc_media_t * new_child;
126 } media_subitem_added;
129 int64_t new_duration;
130 } media_duration_changed;
134 } media_preparsed_changed;
141 libvlc_state_t new_state;
142 } media_state_changed;
148 } media_player_position_changed;
151 libvlc_time_t new_time;
152 } media_player_time_changed;
156 } media_player_title_changed;
159 uint64_t new_seekable; /* FIXME: that's a boolean! */
160 } media_player_seekable_changed;
163 uint64_t new_pausable; /* FIXME: that's a BOOL!!! */
164 } media_player_pausable_changed;
169 libvlc_media_t * item;
171 } media_list_item_added;
174 libvlc_media_t * item;
176 } media_list_will_add_item;
179 libvlc_media_t * item;
181 } media_list_item_deleted;
184 libvlc_media_t * item;
186 } media_list_will_delete_item;
188 /* media list view */
191 libvlc_media_t * item;
193 } media_list_view_item_added;
196 libvlc_media_t * item;
198 } media_list_view_will_add_item;
201 libvlc_media_t * item;
203 } media_list_view_item_deleted;
206 libvlc_media_t * item;
208 } media_list_view_will_delete_item;
214 } media_player_snapshot_taken ;
219 libvlc_time_t new_length;
220 } media_player_length_changed;
225 const char * psz_media_name;
238 #endif /* _LIBVLC_EVENTS_H */