*****************************************************************************/
/**
- * \defgroup libvlc Libvlc
+ * \defgroup libvlc libvlc
* This is libvlc, the base library of the VLC program.
*
* @{
/*****************************************************************************
* Exception handling
*****************************************************************************/
-/** \defgroup libvlc_exception Exceptions
+/** \defgroup libvlc_exception libvlc_exception
* \ingroup libvlc
* LibVLC Exceptions handling
* @{
* Core handling
*****************************************************************************/
-/** \defgroup libvlc_core Core
+/** \defgroup libvlc_core libvlc_core
* \ingroup libvlc
* LibVLC Core
* @{
/*****************************************************************************
* Media descriptor
*****************************************************************************/
-/** \defgroup libvlc_media_descriptor Media Descriptor
+/** \defgroup libvlc_media_descriptor libvlc_media_descriptor
* \ingroup libvlc
* LibVLC Media Descriptor
* @{
/*****************************************************************************
* Media Instance
*****************************************************************************/
-/** \defgroup libvlc_media_instance Media Instance
+/** \defgroup libvlc_media_instance libvlc_media_instance
* \ingroup libvlc
* LibVLC Media Instance, object that let you play a media descriptor
* in a libvlc_drawable_t
*/
VLC_PUBLIC_API int libvlc_media_instance_can_pause( libvlc_media_instance_t *p_mi, libvlc_exception_t *p_e );
-/** \defgroup libvlc_video Video
+/** \defgroup libvlc_video libvlc_video
* \ingroup libvlc_media_instance
* LibVLC Video handling
* @{
/** @} video */
-/** \defgroup libvlc_audio Audio
+/** \defgroup libvlc_audio libvlc_audio
* \ingroup libvlc_media_instance
* LibVLC Audio handling
* @{
* Event handling
*****************************************************************************/
-/** \defgroup libvlc_callbacks Callbacks
+/** \defgroup libvlc_event libvlc_event
* \ingroup libvlc
* LibVLC Events
* @{
/** @} */
-/*****************************************************************************
- * Media List
- *****************************************************************************/
-/** \defgroup libvlc_media_list MediaList
- * \ingroup libvlc
- * LibVLC Media List, a media list holds multiple media descriptors
- * @{
- */
-
-/**
- * Create an empty media list.
- *
- * \param p_libvlc the event manager
- * \param i_event_type the desired event to which we want to unregister
- * \param f_callback the function to call when i_event_type occurs
- * \param p_e an initialized exception pointer
- */
-
-VLC_PUBLIC_API libvlc_media_list_t *
- libvlc_media_list_new( libvlc_instance_t *, libvlc_exception_t * );
-
-VLC_PUBLIC_API void
- libvlc_media_list_release( libvlc_media_list_t * );
-
-VLC_PUBLIC_API void
- libvlc_media_list_retain( libvlc_media_list_t * );
-
-VLC_DEPRECATED_API void
- libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
- const char * psz_uri,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API void
- libvlc_media_list_set_media_descriptor( libvlc_media_list_t *,
- libvlc_media_descriptor_t *,
- libvlc_exception_t *);
-
-VLC_PUBLIC_API libvlc_media_descriptor_t *
- libvlc_media_list_media_descriptor( libvlc_media_list_t *,
- libvlc_exception_t *);
-
-VLC_PUBLIC_API void
- libvlc_media_list_add_media_descriptor( libvlc_media_list_t *,
- libvlc_media_descriptor_t *,
- libvlc_exception_t * );
-VLC_PUBLIC_API void
- libvlc_media_list_insert_media_descriptor( libvlc_media_list_t *,
- libvlc_media_descriptor_t *,
- int,
- libvlc_exception_t * );
-VLC_PUBLIC_API void
- libvlc_media_list_remove_index( libvlc_media_list_t *, int,
- libvlc_exception_t * );
-
-VLC_PUBLIC_API int
- libvlc_media_list_count( libvlc_media_list_t * p_mlist,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API libvlc_media_descriptor_t *
- libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
- libvlc_exception_t * );
-VLC_PUBLIC_API int
- libvlc_media_list_index_of_item( libvlc_media_list_t *,
- libvlc_media_descriptor_t *,
- libvlc_exception_t * );
-
-/* This indicates if this media list is read-only from a user point of view */
-VLC_PUBLIC_API int
- libvlc_media_list_is_readonly( libvlc_media_list_t * p_mlist );
-
-VLC_PUBLIC_API void
- libvlc_media_list_lock( libvlc_media_list_t * );
-VLC_PUBLIC_API void
- libvlc_media_list_unlock( libvlc_media_list_t * );
-
-VLC_PUBLIC_API libvlc_media_list_view_t *
- libvlc_media_list_flat_view( libvlc_media_list_t *,
- libvlc_exception_t * );
-
-VLC_PUBLIC_API libvlc_media_list_view_t *
- libvlc_media_list_hierarchical_view( libvlc_media_list_t *,
- libvlc_exception_t * );
-
-VLC_PUBLIC_API libvlc_media_list_view_t *
- libvlc_media_list_hierarchical_node_view( libvlc_media_list_t *,
- libvlc_exception_t * );
-
-VLC_PUBLIC_API libvlc_event_manager_t *
- libvlc_media_list_event_manager( libvlc_media_list_t *,
- libvlc_exception_t * );
-
-/*****************************************************************************
- * Media List View
- *****************************************************************************/
-/** \defgroup libvlc_media_list_view MediaListView
- * \ingroup libvlc_media_list
- * LibVLC Media List View, represent a media_list using a different layout
- * @{ */
-
-VLC_PUBLIC_API void
- libvlc_media_list_view_retain( libvlc_media_list_view_t * p_mlv );
-
-VLC_PUBLIC_API void
- libvlc_media_list_view_release( libvlc_media_list_view_t * p_mlv );
-
-VLC_PUBLIC_API libvlc_event_manager_t *
- libvlc_media_list_view_event_manager( libvlc_media_list_view_t * p_mlv );
-
-VLC_PUBLIC_API int
- libvlc_media_list_view_count( libvlc_media_list_view_t * p_mlv,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API libvlc_media_descriptor_t *
- libvlc_media_list_view_item_at_index( libvlc_media_list_view_t * p_mlv,
- int index,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API libvlc_media_list_view_t *
- libvlc_media_list_view_children_at_index( libvlc_media_list_view_t * p_mlv,
- int index,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API libvlc_media_list_view_t *
- libvlc_media_list_view_children_for_item( libvlc_media_list_view_t * p_mlv,
- libvlc_media_descriptor_t * p_md,
- libvlc_exception_t * p_e );
-
-
-VLC_PUBLIC_API int
- libvlc_media_list_view_index_of_item( libvlc_media_list_view_t * p_mlv,
- libvlc_media_descriptor_t * p_md,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API void
- libvlc_media_list_view_insert_at_index( libvlc_media_list_view_t * p_mlv,
- libvlc_media_descriptor_t * p_md,
- int index,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API void
- libvlc_media_list_view_remove_at_index( libvlc_media_list_view_t * p_mlv,
- int index,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API void
- libvlc_media_list_view_add_item( libvlc_media_list_view_t * p_mlv,
- libvlc_media_descriptor_t * p_md,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API libvlc_media_list_t *
- libvlc_media_list_view_parent_media_list( libvlc_media_list_view_t * p_mlv,
- libvlc_exception_t * p_e );
-
-/** @} media_list_view */
-
-/*****************************************************************************
- * Media List Player
- *****************************************************************************/
-/** \defgroup libvlc_media_list_player MediaListPlayer
- * \ingroup libvlc
- * LibVLC Media List Player, play a media_list. You can see that as a media
- * instance subclass
- * @{
- */
-VLC_PUBLIC_API libvlc_media_list_player_t *
- libvlc_media_list_player_new( libvlc_instance_t * p_instance,
- libvlc_exception_t * p_e );
-VLC_PUBLIC_API void
- libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
-
-VLC_PUBLIC_API void
- libvlc_media_list_player_set_media_instance(
- libvlc_media_list_player_t * p_mlp,
- libvlc_media_instance_t * p_mi,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API void
- libvlc_media_list_player_set_media_list(
- libvlc_media_list_player_t * p_mlp,
- libvlc_media_list_t * p_mlist,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API void
- libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API void
- libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API int
- libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API libvlc_state_t
- libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API void
- libvlc_media_list_player_play_item_at_index(
- libvlc_media_list_player_t * p_mlp,
- int i_index,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API void
- libvlc_media_list_player_play_item(
- libvlc_media_list_player_t * p_mlp,
- libvlc_media_descriptor_t * p_md,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API void
- libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
- libvlc_exception_t * p_e );
-
-VLC_PUBLIC_API void
- libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
- libvlc_exception_t * p_e );
-
-/** @} media_list_player */
-
-/** @} media_list */
-
/*****************************************************************************
* Media Library
*****************************************************************************/
-/** \defgroup libvlc_media_library Media Library
+/** \defgroup libvlc_media_library libvlc_media_library
* \ingroup libvlc
* LibVLC Media Library
* @{
/*****************************************************************************
* Services/Media Discovery
*****************************************************************************/
-/** \defgroup libvlc_media_discoverer Media Discoverer
+/** \defgroup libvlc_media_discoverer libvlc_media_discoverer
* \ingroup libvlc
* LibVLC Media Discoverer
* @{
* Message log handling
*****************************************************************************/
-/** \defgroup libvlc_log Log
+/** \defgroup libvlc_log libvlc_log
* \ingroup libvlc
* LibVLC Message Logging
* @{
* Exceptions
*****************************************************************************/
-/** defgroup libvlc_exception Exceptions
+/** \defgroup libvlc_exception libvlc_exception
* \ingroup libvlc
* LibVLC Exceptions handling
* @{
/*****************************************************************************
* Time
*****************************************************************************/
-/** defgroup libvlc_time Time
+/** \defgroup libvlc_time libvlc_time
* \ingroup libvlc
* LibVLC Time support in libvlc
* @{
/*****************************************************************************
* Media Descriptor
*****************************************************************************/
-/** defgroup libvlc_media_descriptor MediaDescriptor
+/** \defgroup libvlc_media_descriptor libvlc_media_descriptor
* \ingroup libvlc
* LibVLC Media Descriptor handling
* @{
*/
/* Meta Handling */
-/** defgroup libvlc_meta Meta
+/** defgroup libvlc_meta libvlc_meta
* \ingroup libvlc_media_descriptor
* LibVLC Media Meta
* @{
/*****************************************************************************
* Media Instance
*****************************************************************************/
-/** defgroup libvlc_media_instance MediaInstance
+/** \defgroup libvlc_media_instance libvlc_media_instance
* \ingroup libvlc
* LibVLC Media Instance handling
* @{
/*****************************************************************************
* Media List
*****************************************************************************/
-/** defgroup libvlc_media_list MediaList
+/** \defgroup libvlc_media_list libvlc_media_list
* \ingroup libvlc
* LibVLC Media List handling
* @{
typedef struct libvlc_media_list_t libvlc_media_list_t;
typedef struct libvlc_media_list_view_t libvlc_media_list_view_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
* @{
/*****************************************************************************
* Playlist
*****************************************************************************/
-/** defgroup libvlc_playlist Playlist
+/** \defgroup libvlc_playlist libvlc_playlist (Deprecated)
* \ingroup libvlc
- * LibVLC Playlist handling
+ * LibVLC Playlist handling (Deprecated)
+ * @deprecated Use media_list
* @{
*/
/*****************************************************************************
* Video
*****************************************************************************/
-/** defgroup libvlc_video Video
- * \ingroup libvlc
+/** \defgroup libvlc_video libvlc_video
+ * \ingroup libvlc_media_instance
* LibVLC Video handling
* @{
*/
/*****************************************************************************
* Services/Media Discovery
*****************************************************************************/
-/** defgroup libvlc_media_discoverer Media Discoverer
+/** \defgroup libvlc_media_discoverer libvlc_media_discoverer
* \ingroup libvlc
* LibVLC Media Discoverer
* @{
* Message log handling
*****************************************************************************/
-/** defgroup libvlc_log Log
+/** \defgroup libvlc_log libvlc_log
* \ingroup libvlc
* LibVLC Message Logging
* @{