]> git.sesse.net Git - vlc/blobdiff - include/vlc/libvlc_media_list.h
libvlc: Split public headers by object and layers.
[vlc] / include / vlc / libvlc_media_list.h
index 94a4f7b956eb36ac805d6e2ec5b511dd98acbc93..102a23dd0c951914eb0a272903f759a1955475f7 100644 (file)
@@ -42,6 +42,9 @@ extern "C" {
  * @{
  */
 
+typedef struct libvlc_media_list_t libvlc_media_list_t;
+typedef struct libvlc_media_list_view_t libvlc_media_list_view_t;
+
 /**
  * Create an empty media list.
  *
@@ -242,259 +245,6 @@ 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 libvlc_media_list_view
- * \ingroup libvlc_media_list
- * LibVLC Media List View, represent a media_list using a different layout
- * @{ */
-
-/**
- * Retain reference to a media list view
- *
- * \param p_mlv a media list view created with libvlc_media_list_view_new()
- */
-VLC_PUBLIC_API void
-    libvlc_media_list_view_retain( libvlc_media_list_view_t * p_mlv );
-
-/**
- * Release reference to a media list view. If the refcount reaches 0, then
- * the object will be released.
- *
- * \param p_mlv a media list view created with libvlc_media_list_view_new()
- */
-VLC_PUBLIC_API void
-    libvlc_media_list_view_release( libvlc_media_list_view_t * p_mlv );
-
-/**
- * Get libvlc_event_manager from this media list view instance.
- * The p_event_manager is immutable, so you don't have to hold the lock
- *
- * \param p_mlv a media list view instance
- * \return libvlc_event_manager
- */
-VLC_PUBLIC_API libvlc_event_manager_t *
-    libvlc_media_list_view_event_manager( libvlc_media_list_view_t * p_mlv );
-
-/**
- * Get count on media list view items
- *
- * \param p_mlv a media list view instance
- * \param p_e initialized exception object
- * \return number of items in media list view
- */
-VLC_PUBLIC_API int
-    libvlc_media_list_view_count(  libvlc_media_list_view_t * p_mlv,
-                                   libvlc_exception_t * p_e );
-
-/**
- * List media instance in media list view at an index position
- *
- * \param p_mlv a media list view instance
- * \param i_index index position in array where to insert
- * \param p_e initialized exception object
- * \return media instance at position i_pos and libvlc_media_retain() has been called to increase the refcount on this object.
- */
-VLC_PUBLIC_API libvlc_media_t *
-    libvlc_media_list_view_item_at_index(  libvlc_media_list_view_t * p_mlv,
-                                           int i_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_t * p_md,
-                                           libvlc_exception_t * p_e );
-
-/**
- * Get index position of media instance in media list view.
- * The function will return the first occurence.
- *
- * \param p_mlv a media list view instance
- * \param p_md media instance
- * \param p_e initialized exception object
- * \return index position in array of p_md
- */
-VLC_PUBLIC_API int
-    libvlc_media_list_view_index_of_item(  libvlc_media_list_view_t * p_mlv,
-                                           libvlc_media_t * p_md,
-                                           libvlc_exception_t * p_e );
-
-/**
- * Insert media instance in media list view at index position
- *
- * \param p_mlv a media list view instance
- * \param p_md media instance
- * \param index position in array where to insert
- * \param p_e initialized exception object
- */
-VLC_PUBLIC_API void
-    libvlc_media_list_view_insert_at_index(  libvlc_media_list_view_t * p_mlv,
-                                             libvlc_media_t * p_md,
-                                             int index,
-                                             libvlc_exception_t * p_e );
-
-/**
- * Remove media instance in media list view from index position
- *
- * \param p_mlv a media list view instance
- * \param index position in array of media instance to remove
- * \param p_e initialized exception object
- */
-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_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 libvlc_media_list_player
- * \ingroup libvlc_media_list_player
- * LibVLC Media List Player, play a media_list. You can see that as a media
- * instance subclass
- * @{
- */
-
-/**
- * Create new media_list_player.
- *
- * \param p_instance libvlc instance
- * \param p_e initialized exception instance
- * \return media list player instance
- */
-VLC_PUBLIC_API libvlc_media_list_player_t *
-    libvlc_media_list_player_new( libvlc_instance_t * p_instance,
-                                  libvlc_exception_t * p_e );
-
-/**
- * Release media_list_player.
- *
- * \param p_mlp media list player instance
- */
-VLC_PUBLIC_API void
-    libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
-
-/**
- * Replace media player in media_list_player with this instance.
- *
- * \param p_mlp media list player instance
- * \param p_mi media player instance
- * \param p_e initialized exception instance
- */
-VLC_PUBLIC_API void
-    libvlc_media_list_player_set_media_player(
-                                     libvlc_media_list_player_t * p_mlp,
-                                     libvlc_media_player_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 );
-
-/**
- * Play media list
- *
- * \param p_mlp media list player instance
- * \param p_e initialized exception instance
- */
-VLC_PUBLIC_API void
-    libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
-                                   libvlc_exception_t * p_e );
-
-/**
- * Pause media list
- *
- * \param p_mlp media list player instance
- * \param p_e initialized exception instance
- */
-VLC_PUBLIC_API void
-    libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
-                                   libvlc_exception_t * p_e );
-
-/**
- * Is media list playing?
- *
- * \param p_mlp media list player instance
- * \param p_e initialized exception instance
- * \return true for playing and false for not playing
- */
-VLC_PUBLIC_API int
-    libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
-                                         libvlc_exception_t * p_e );
-
-/**
- * Get current libvlc_state of media list player
- *
- * \param p_mlp media list player instance
- * \param p_e initialized exception instance
- * \return libvlc_state_t for media list player
- */
-VLC_PUBLIC_API libvlc_state_t
-    libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
-                                        libvlc_exception_t * p_e );
-
-/**
- * Play media list item at position index
- *
- * \param p_mlp media list player instance
- * \param i_index index in media list to play
- * \param p_e initialized exception instance
- */
-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_t * p_md,
-                                   libvlc_exception_t * p_e );
-
-/**
- * Stop playing media list
- *
- * \param p_mlp media list player instance
- * \param p_e initialized exception instance
- */
-VLC_PUBLIC_API void
-    libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
-                                   libvlc_exception_t * p_e );
-
-/**
- * Play next item from media list
- *
- * \param p_mlp media list player instance
- * \param p_e initialized exception instance
- */
-VLC_PUBLIC_API void
-    libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
-                                   libvlc_exception_t * p_e );
-
-/* NOTE: shouldn't there also be a libvlc_media_list_player_prev() */
-
-/** @} media_list_player */
-
 /** @} media_list */
 
 # ifdef __cplusplus