Remove some exceptions in media_list

[vlc] / include / vlc / libvlc_media_list.h

diff --git a/include/vlc/libvlc_media_list.h b/include/vlc/libvlc_media_list.h
index 102a23dd0c951914eb0a272903f759a1955475f7..5e833720da593b053e6b0ef35df3e78c7eea012f 100644 (file)
--- a/include/vlc/libvlc_media_list.h
+++ b/include/vlc/libvlc_media_list.h
@@ -49,11 +49,10 @@ typedef struct libvlc_media_list_view_t libvlc_media_list_view_t;
  * Create an empty media list.
  *
  * \param p_libvlc libvlc instance
- * \param p_e an initialized exception pointer
- * \return empty media list
+ * \return empty media list, or NULL on error
  */
 VLC_PUBLIC_API libvlc_media_list_t *
-    libvlc_media_list_new( libvlc_instance_t *, libvlc_exception_t * );
+    libvlc_media_list_new( libvlc_instance_t * );
 
 /**
  * Release media list created with libvlc_media_list_new().
@@ -83,12 +82,9 @@ VLC_DEPRECATED_API void
  *
  * \param p_ml a media list instance
  * \param p_mi media instance to add
- * \param p_e initialized exception object
  */
 VLC_PUBLIC_API void
-    libvlc_media_list_set_media( libvlc_media_list_t *,
-                                            libvlc_media_t *,
-                                            libvlc_exception_t *);
+libvlc_media_list_set_media( libvlc_media_list_t *p_ml, libvlc_media_t *p_md );
 
 /**
  * Get media instance from this media list instance. This action will increase
@@ -96,12 +92,10 @@ VLC_PUBLIC_API void
  * The libvlc_media_list_lock should NOT be held upon entering this function.
  *
  * \param p_ml a media list instance
- * \param p_e initialized exception object
  * \return media instance
  */
 VLC_PUBLIC_API libvlc_media_t *
-    libvlc_media_list_media( libvlc_media_list_t *,
-                                        libvlc_exception_t *);
+    libvlc_media_list_media( libvlc_media_list_t *p_ml );
 
 /**
  * Add media instance to media list
@@ -109,12 +103,10 @@ VLC_PUBLIC_API libvlc_media_t *
  *
  * \param p_ml a media list instance
  * \param p_mi a media instance
- * \param p_e initialized exception object
+ * \return 0 on success, -1 if the media list is read-only
  */
-VLC_PUBLIC_API void
-    libvlc_media_list_add_media( libvlc_media_list_t *,
-                                            libvlc_media_t *,
-                                            libvlc_exception_t * );
+VLC_PUBLIC_API int
+libvlc_media_list_add_media( libvlc_media_list_t *, libvlc_media_t * );
 
 /**
  * Insert media instance in media list on a position
@@ -123,36 +115,32 @@ VLC_PUBLIC_API void
  * \param p_ml a media list instance
  * \param p_mi a media instance
  * \param i_pos position in array where to insert
- * \param p_e initialized exception object
+ * \return 0 on success, -1 if the media list si read-only
  */
-VLC_PUBLIC_API void
-    libvlc_media_list_insert_media( libvlc_media_list_t *,
-                                               libvlc_media_t *,
-                                               int,
-                                               libvlc_exception_t * );
+VLC_PUBLIC_API int
+libvlc_media_list_insert_media( libvlc_media_list_t *,
+                                libvlc_media_t *, int );
+
 /**
  * Remove media instance from media list on a position
  * The libvlc_media_list_lock should be held upon entering this function.
  *
  * \param p_ml a media list instance
  * \param i_pos position in array where to insert
- * \param p_e initialized exception object
+ * \return 0 on success, -1 if the list is read-only or the item was not found
  */
-VLC_PUBLIC_API void
-    libvlc_media_list_remove_index( libvlc_media_list_t *, int,
-                                    libvlc_exception_t * );
+VLC_PUBLIC_API int
+libvlc_media_list_remove_index( libvlc_media_list_t *, int );
 
 /**
  * Get count on media list items
  * The libvlc_media_list_lock should be held upon entering this function.
  *
  * \param p_ml a media list instance
- * \param p_e initialized exception object
  * \return number of items in media list
  */
 VLC_PUBLIC_API int
-    libvlc_media_list_count( libvlc_media_list_t * p_mlist,
-                             libvlc_exception_t * p_e );
+    libvlc_media_list_count( libvlc_media_list_t *p_ml );
 
 /**
  * List media instance in media list at a position
@@ -160,12 +148,12 @@ VLC_PUBLIC_API int
  *
  * \param p_ml a media list instance
  * \param i_pos 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.
+ * \return media instance at position i_pos, or NULL if not found.
+ * In case of success, libvlc_media_retain() is called to increase the refcount
+ * on the media.
  */
 VLC_PUBLIC_API libvlc_media_t *
-    libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
-                                     libvlc_exception_t * );
+    libvlc_media_list_item_at_index( libvlc_media_list_t *, int );
 /**
  * Find index position of List media instance in media list.
  * Warning: the function will return the first matched position.
@@ -173,13 +161,11 @@ VLC_PUBLIC_API libvlc_media_t *
  *
  * \param p_ml a media list instance
  * \param p_mi media list instance
- * \param p_e initialized exception object
  * \return position of media instance
  */
 VLC_PUBLIC_API int
-    libvlc_media_list_index_of_item( libvlc_media_list_t *,
-                                     libvlc_media_t *,
-                                     libvlc_exception_t * );
+    libvlc_media_list_index_of_item( libvlc_media_list_t *p_ml,
+                                     libvlc_media_t *p_mi );
 
 /**
  * This indicates if this media list is read-only from a user point of view
@@ -222,28 +208,23 @@ VLC_PUBLIC_API libvlc_media_list_view_t *
  * Get a hierarchical media list view of media list items
  *
  * \param p_ml a media list instance
- * \param p_ex an excpetion instance
  * \return hierarchical media list view instance
  */
 VLC_PUBLIC_API libvlc_media_list_view_t *
-    libvlc_media_list_hierarchical_view( libvlc_media_list_t *,
-                                         libvlc_exception_t * );
+    libvlc_media_list_hierarchical_view( libvlc_media_list_t * );
 
 VLC_PUBLIC_API libvlc_media_list_view_t *
-    libvlc_media_list_hierarchical_node_view( libvlc_media_list_t *,
-                                              libvlc_exception_t * );
+    libvlc_media_list_hierarchical_node_view( libvlc_media_list_t * p_ml );
 
 /**
  * Get libvlc_event_manager from this media list instance.
  * The p_event_manager is immutable, so you don't have to hold the lock
  *
  * \param p_ml a media list instance
- * \param p_ex an excpetion instance
  * \return libvlc_event_manager
  */
 VLC_PUBLIC_API libvlc_event_manager_t *
-    libvlc_media_list_event_manager( libvlc_media_list_t *,
-                                     libvlc_exception_t * );
+    libvlc_media_list_event_manager( libvlc_media_list_t *p_ml );
 
 /** @} media_list */