X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc%2Flibvlc_structures.h;h=125501e4c28bed2b6f8319aa585eb8b64e26f828;hb=c0f4bfc5d85c96cf29f4bd05fa5fa42eb344d1dc;hp=7ee11ec60e265cf86bf7b929502923149f49341d;hpb=7b32ae177048eb0bc36b6f7610b9e8a1fb22fead;p=vlc diff --git a/include/vlc/libvlc_structures.h b/include/vlc/libvlc_structures.h index 7ee11ec60e..125501e4c2 100644 --- a/include/vlc/libvlc_structures.h +++ b/include/vlc/libvlc_structures.h @@ -21,10 +21,10 @@ * 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 +#include # ifdef __cplusplus extern "C" { @@ -37,8 +37,8 @@ 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 * @{ */ @@ -53,31 +53,30 @@ typedef struct libvlc_exception_t /**@} */ /***************************************************************************** - * Tag + * Time *****************************************************************************/ -/** defgroup libvlc_tag Tag - * \ingroup libvlc - * LibVLC Tag support in media descriptor +/** \defgroup libvlc_time libvlc_time + * \ingroup libvlc_core + * LibVLC Time support in libvlc * @{ */ -typedef struct libvlc_tag_query_t libvlc_tag_query_t; -typedef char * libvlc_tag_t; +typedef int64_t libvlc_time_t; /**@} */ /***************************************************************************** * Media Descriptor *****************************************************************************/ -/** defgroup libvlc_media_descriptor MediaDescriptor +/** \defgroup libvlc_media libvlc_media * \ingroup libvlc * LibVLC Media Descriptor handling * @{ */ /* Meta Handling */ -/** defgroup libvlc_meta Meta - * \ingroup libvlc_media_descriptor +/** defgroup libvlc_meta libvlc_meta + * \ingroup libvlc_media * LibVLC Media Meta * @{ */ @@ -104,7 +103,7 @@ typedef enum libvlc_meta_t { /**@} */ -typedef struct libvlc_media_descriptor_t libvlc_media_descriptor_t; +typedef struct libvlc_media_t libvlc_media_t; /**@} */ @@ -112,23 +111,34 @@ typedef struct libvlc_media_descriptor_t libvlc_media_descriptor_t; /***************************************************************************** * Media Instance *****************************************************************************/ -/** defgroup libvlc_media_instance MediaInstance +/** \defgroup libvlc_media_player libvlc_media_player * \ingroup libvlc * LibVLC Media Instance handling * @{ */ -typedef struct libvlc_media_instance_t libvlc_media_instance_t; +typedef struct libvlc_media_player_t libvlc_media_player_t; +/** + * Note the order of libvlc_state_t enum must match exactly the order of + * @see mediacontrol_PlayerStatus and @see input_state_e enums. + * + * Expected states by web plugins are: + * IDLE/CLOSE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, + * STOPPING=5, FORWARD=6, BACKWARD=7, ENDED=8, ERROR=9 + */ typedef enum libvlc_state_t { - libvlc_Stopped, + libvlc_NothingSpecial=0, libvlc_Opening, libvlc_Buffering, - libvlc_Ended, - libvlc_Error, libvlc_Playing, - libvlc_Paused + libvlc_Paused, + libvlc_Stopped, + libvlc_Forward, + libvlc_Backward, + libvlc_Ended, + libvlc_Error } libvlc_state_t; /**@} */ @@ -136,7 +146,7 @@ typedef enum libvlc_state_t /***************************************************************************** * Media List *****************************************************************************/ -/** defgroup libvlc_media_list MediaList +/** \defgroup libvlc_media_list libvlc_media_list * \ingroup libvlc * LibVLC Media List handling * @{ @@ -145,39 +155,26 @@ typedef enum libvlc_state_t typedef struct libvlc_media_list_t libvlc_media_list_t; typedef struct libvlc_media_list_view_t libvlc_media_list_view_t; -/**@} */ - -/***************************************************************************** - * Dynamic Media List - *****************************************************************************/ -/** defgroup libvlc_media_list MediaList - * \ingroup libvlc - * LibVLC Dynamic Media list: Media list with content synchronized with - * an other playlist - * @{ - */ - -typedef struct libvlc_dynamic_media_list_t libvlc_dynamic_media_list_t; - -/**@} */ /***************************************************************************** * Media List Player *****************************************************************************/ -/** defgroup libvlc_media_list_player MediaListPlayer - * \ingroup libvlc +/** \defgroup libvlc_media_list_player libvlc_media_list_player + * \ingroup libvlc_media_list * LibVLC Media List Player handling * @{ */ typedef struct libvlc_media_list_player_t libvlc_media_list_player_t; -/**@} */ +/**@} libvlc_media_list_player */ + +/**@} libvlc_media_list */ /***************************************************************************** * Media Library *****************************************************************************/ -/** defgroup libvlc_media_library Media Library +/** \defgroup libvlc_media_library libvlc_media_library * \ingroup libvlc * LibVLC Media Library * @{ @@ -190,9 +187,10 @@ typedef struct libvlc_media_library_t libvlc_media_library_t; /***************************************************************************** * Playlist *****************************************************************************/ -/** defgroup libvlc_playlist Playlist +/** \defgroup libvlc_playlist libvlc_playlist (Deprecated) * \ingroup libvlc - * LibVLC Playlist handling + * LibVLC Playlist handling (Deprecated) + * @deprecated Use media_list * @{ */ @@ -210,8 +208,8 @@ typedef struct libvlc_playlist_item_t /***************************************************************************** * Video *****************************************************************************/ -/** defgroup libvlc_video Video - * \ingroup libvlc +/** \defgroup libvlc_video libvlc_video + * \ingroup libvlc_media_player * LibVLC Video handling * @{ */ @@ -240,7 +238,7 @@ libvlc_rectangle_t; /***************************************************************************** * Services/Media Discovery *****************************************************************************/ -/** defgroup libvlc_media_discoverer Media Discoverer +/** \defgroup libvlc_media_discoverer libvlc_media_discoverer * \ingroup libvlc * LibVLC Media Discoverer * @{ @@ -254,8 +252,8 @@ typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t; * Message log handling *****************************************************************************/ -/** defgroup libvlc_log Log - * \ingroup libvlc +/** \defgroup libvlc_log libvlc_log + * \ingroup libvlc_core * LibVLC Message Logging * @{ */ @@ -278,108 +276,6 @@ typedef struct libvlc_log_message_t /**@} */ -/***************************************************************************** - * Callbacks handling - *****************************************************************************/ - -/** defgroup libvlc_callbacks Callbacks - * \ingroup libvlc - * LibVLC Event Callbacks - * @{ - */ - -/** - * Available events: (XXX: being reworked) - * - libvlc_MediaInstanceReachedEnd - */ - -typedef enum libvlc_event_type_t { - libvlc_MediaDescriptorMetaChanged, - libvlc_MediaDescriptorSubItemAdded, - libvlc_MediaDescriptorDurationChanged, - libvlc_MediaDescriptorPreparsedChanged, - - libvlc_MediaInstancePlayed, - libvlc_MediaInstancePaused, - libvlc_MediaInstanceReachedEnd, - libvlc_MediaInstancePositionChanged, - - libvlc_MediaListItemAdded, - libvlc_MediaListItemDeleted, - - libvlc_MediaListPlayerPlayed, - libvlc_MediaListPlayerNextItemSet, - libvlc_MediaListPlayerStopped, - -} libvlc_event_type_t; - -/** - * An Event - * \param type the even type - * \param p_obj the sender object - * \param u Event dependent content - */ - -typedef struct libvlc_event_t -{ - libvlc_event_type_t type; - void * p_obj; - union event_type_specific - { - /* media descriptor */ - struct - { - libvlc_meta_t meta_type; - } media_descriptor_meta_changed; - struct - { - libvlc_media_descriptor_t * new_child; - } media_descriptor_subitem_added; - struct - { - vlc_int64_t new_duration; - } media_descriptor_duration_changed; - struct - { - int new_status; - } media_descriptor_preparsed_changed; - - /* media instance */ - struct - { - long int new_position; - } media_instance_position_changed; - - /* media list */ - struct - { - libvlc_media_descriptor_t * item; - int index; - } media_list_item_added; - struct - { - libvlc_media_descriptor_t * item; - int index; - } media_list_item_deleted; - } u; -} libvlc_event_t; - -/** - * Event manager that belongs to a libvlc object, and from whom events can - * be received. - */ - -typedef struct libvlc_event_manager_t libvlc_event_manager_t; - -/** - * Callback function notification - * \param p_event the event triggering the callback - */ - -typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * ); - -/**@} */ - # ifdef __cplusplus } # endif