]> git.sesse.net Git - vlc/blobdiff - include/vlc/libvlc.h
Replace libvlc_exception_get_message with libvlc_errmsg
[vlc] / include / vlc / libvlc.h
index 017c9ec13d8bec31410b46d2554324c5f0153b21..1171dc8aaa014fa140db5ca4787b706b3e49a150 100644 (file)
@@ -1,10 +1,12 @@
 /*****************************************************************************
- * libvlc.h:  libvlc_* new external API
+ * libvlc.h:  libvlc external API
  *****************************************************************************
- * Copyright (C) 1998-2005 the VideoLAN team
- * $Id: vlc.h 13701 2005-12-12 17:58:56Z zorglub $
+ * Copyright (C) 1998-2009 the VideoLAN team
+ * $Id$
  *
  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
+ *          Jean-Paul Saman <jpsaman@videolan.org>
+ *          Pierre d'Herbemont <pdherbemont@videolan.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  *****************************************************************************/
 
 /**
- * \defgroup libvlc Libvlc
+ * \file
+ * This file defines libvlc external API
+ */
+
+/**
+ * \defgroup libvlc libvlc
  * This is libvlc, the base library of the VLC program.
  *
  * @{
  */
 
+#ifndef VLC_LIBVLC_H
+#define VLC_LIBVLC_H 1
 
-#ifndef _LIBVLC_H
-#define _LIBVLC_H 1
+#if defined (WIN32) && defined (DLL_EXPORT)
+# define VLC_PUBLIC_API __declspec(dllexport)
+#else
+# define VLC_PUBLIC_API
+#endif
 
-#include <vlc/vlc.h>
+#ifdef __LIBVLC__
+/* Avoid unuseful warnings from libvlc with our deprecated APIs */
+#   define VLC_DEPRECATED_API VLC_PUBLIC_API
+#elif defined(__GNUC__) && \
+      (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
+# define VLC_DEPRECATED_API VLC_PUBLIC_API __attribute__((deprecated))
+#else
+# define VLC_DEPRECATED_API VLC_PUBLIC_API
+#endif
 
 # ifdef __cplusplus
 extern "C" {
 # endif
 
+#include <stdarg.h>
+#include <vlc/libvlc_structures.h>
+
 /*****************************************************************************
  * Exception handling
  *****************************************************************************/
-/** defgroup libvlc_exception Exceptions
- * \ingroup libvlc
+/** \defgroup libvlc_exception libvlc_exception
+ * \ingroup libvlc_core
  * LibVLC Exceptions handling
  * @{
  */
 
-struct libvlc_exception_t
-{
-    int b_raised;
-    char *psz_message;
-};
-typedef struct libvlc_exception_t libvlc_exception_t;
-
 /**
- * Initialize an exception structure. This can be called several times to reuse
- * an exception structure.
+ * Initialize an exception structure. This can be called several times to
+ * reuse an exception structure.
+ *
  * \param p_exception the exception to initialize
  */
-void libvlc_exception_init( libvlc_exception_t *p_exception );
+VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
 
 /**
- * Has an exception been raised ?
+ * Has an exception been raised?
+ *
  * \param p_exception the exception to query
- * \return 0 if no exception raised, 1 else
+ * \return 0 if the exception was raised, 1 otherwise
  */
-int libvlc_exception_raised( libvlc_exception_t *p_exception );
+VLC_PUBLIC_API int
+libvlc_exception_raised( const libvlc_exception_t *p_exception );
 
 /**
- * Raise an exception
+ * Raise an exception using a user-provided message.
+ *
  * \param p_exception the exception to raise
- * \param psz_message the exception message
+ * \param psz_format the exception message format string
+ * \param ... the format string arguments
  */
-void libvlc_exception_raise( libvlc_exception_t *p_exception, char *psz_format, ... );
+VLC_PUBLIC_API void
+libvlc_exception_raise( libvlc_exception_t *p_exception,
+                        const char *psz_format, ... );
 
 /**
  * Clear an exception object so it can be reused.
- * The exception object must be initialized
+ * The exception object must have be initialized.
+ *
  * \param p_exception the exception to clear
  */
-void libvlc_exception_clear( libvlc_exception_t * );
-
-/**
- * Get exception message
- * \param p_exception the exception to query
- * \return the exception message or NULL if not applicable (exception not raised
- * for example)
- */
-char* libvlc_exception_get_message( libvlc_exception_t *p_exception );
+VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
 
 /**@} */
 
 /*****************************************************************************
- * Core handling
+ * Error handling
  *****************************************************************************/
-
-/** defgroup libvlc_core Core
- * \ingroup libvlc
- * LibVLC Core
+/** \defgroup libvlc_error libvlc_error
+ * \ingroup libvlc_core
+ * LibVLC error handling
  * @{
  */
 
-/** This structure is opaque. It represents a libvlc instance */
-typedef struct libvlc_instance_t libvlc_instance_t;
+/**
+ * A human-readable error message for the last LibVLC error in the calling
+ * thread. The resulting string is valid until another error occurs (at least
+ * until the next LibVLC call).
+ *
+ * @warning
+ * This will be NULL if there was no error.
+ */
+const char *libvlc_errmsg (void);
 
 /**
- * Create an initialized libvlc instance
- * \param argc the number of arguments
- * \param argv command-line-type arguments
- * \param exception an initialized exception pointer
+ * Clears the LibVLC error status for the current thread. This is optional.
+ * By default, the error status is automatically overriden when a new error
+ * occurs, and destroyed when the thread exits.
  */
-libvlc_instance_t * libvlc_new( int , char **, libvlc_exception_t *);
+void libvlc_clearerr (void);
 
 /**
- * returns a libvlc instance identifier for legacy APIs
- * \param p_instance the instance to destroy
+ * Sets the LibVLC error status and message for the current thread.
+ * Any previous error is overriden.
+ * @return a nul terminated string in any case
  */
-int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
+const char *libvlc_vprinterr (const char *fmt, va_list ap);
 
 /**
- * Destroy a libvlc instance
- * \param p_instance the instance to destroy
+ * Sets the LibVLC error status and message for the current thread.
+ * Any previous error is overriden.
+ * @return a nul terminated string in any case
  */
-void libvlc_destroy( libvlc_instance_t *);
+const char *libvlc_printerr (const char *fmt, ...);
+
+/**@} */
 
-/** @}*/
 
 /*****************************************************************************
- * Playlist
+ * Core handling
  *****************************************************************************/
-/** defgroup libvlc_playlist Playlist
+
+/** \defgroup libvlc_core libvlc_core
  * \ingroup libvlc
- * LibVLC Playlist handling
+ * LibVLC Core
  * @{
  */
 
 /**
- * Start playing. You can give some additionnal playlist item options
- * that will be added to the item before playing it.
- * \param p_instance the instance
- * \param i_id the item to play. If this is a negative number, the next
- * item will be selected. Else, the item with the given ID will be played
- * \param i_options the number of options to add to the item
- * \param ppsz_options the options to add to the item
- * \param p_exception an initialized exception
+ * Create and initialize a libvlc instance.
+ *
+ * \param argc the number of arguments
+ * \param argv command-line-type arguments. argv[0] must be the path of the
+ *        calling program.
+ * \param p_e an initialized exception pointer
+ * \return the libvlc instance
  */
-void libvlc_playlist_play( libvlc_instance_t*, int, int, char **,
-                           libvlc_exception_t * );
+VLC_PUBLIC_API libvlc_instance_t *
+libvlc_new( int , const char *const *, libvlc_exception_t *);
 
 /**
- * Pause a running playlist, resume if it was stopped
- * \param p_instance the instance to pause
- * \param p_exception an initialized exception
+ * Decrement the reference count of a libvlc instance, and destroy it
+ * if it reaches zero.
+ *
+ * \param p_instance the instance to destroy
  */
-void libvlc_playlist_pause( libvlc_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
 
 /**
- * Checks if the playlist is running
- * \param p_instance the instance
- * \param p_exception an initialized exception
- * \return 0 if the playlist is stopped or paused, 1 if it is running
+ * Increments the reference count of a libvlc instance.
+ * The initial reference count is 1 after libvlc_new() returns.
+ *
+ * \param p_instance the instance to reference
  */
-int libvlc_playlist_isplaying( libvlc_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
 
 /**
- * Get the number of items in the playlist
+ * Try to start a user interface for the libvlc instance.
+ *
  * \param p_instance the instance
- * \param p_exception an initialized exception
- * \return the number of items
+ * \param name interface name, or NULL for default
+ * \param p_exception an initialized exception pointer
+ * \return 0 on success, -1 on error.
  */
-int libvlc_playlist_items_count( libvlc_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API
+int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name,
+                     libvlc_exception_t *p_exception );
 
 /**
- * Stop playing
- * \param p_instance the instance to stop
- * \param p_exception an initialized exception
- */
-void libvlc_playlist_stop( libvlc_instance_t *, libvlc_exception_t * );
-
-/**
- * Go to next playlist item (starts playback if it was stopped)
- * \param p_instance the instance to use
- * \param p_exception an initialized exception
+ * Waits until an interface causes the instance to exit.
+ * You should start at least one interface first, using libvlc_add_intf().
+ *
+ * \param p_instance the instance
  */
-void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API
+void libvlc_wait( libvlc_instance_t *p_instance );
 
 /**
- * Go to previous playlist item (starts playback if it was stopped)
- * \param p_instance the instance to use
- * \param p_exception an initialized exception
+ * Retrieve libvlc version.
+ *
+ * Example: "0.9.0-git Grishenko"
+ *
+ * \return a string containing the libvlc version
  */
-void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API const char * libvlc_get_version(void);
 
 /**
- * Remove all playlist items
- * \param p_instance the instance
- * \param p_exception an initialized exception
+ * Retrieve libvlc compiler version.
+ *
+ * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
+ *
+ * \return a string containing the libvlc compiler version
  */
-void libvlc_playlist_clear( libvlc_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API const char * libvlc_get_compiler(void);
 
 /**
- * Go to next playlist item
- * \param p_instance the instance
- * \param p_exception an initialized exception
+ * Retrieve libvlc changeset.
+ *
+ * Example: "aa9bce0bc4"
+ *
+ * \return a string containing the libvlc changeset
  */
-void libvlc_playlist_next( libvlc_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API const char * libvlc_get_changeset(void);
 
-/**
- * Go to Previous playlist item
- * \param p_instance the instance
- * \param p_exception an initialized exception
- */
-void libvlc_playlist_prev( libvlc_instance_t *, libvlc_exception_t * );
+struct vlc_object_t;
 
 /**
- * Add an item at the end of the playlist
- * If you need more advanced options, \see libvlc_playlist_add_extended
- * \param p_instance the instance
- * \param psz_uri the URI to open, using VLC format
- * \param psz_name a name that you might want to give or NULL
- * \return the identifier of the new item
+ * Get the internal main VLC object.
+ * Use of this function is usually a hack and should be avoided.
+ * @note
+ * You will need to link with libvlccore to make any use of the underlying VLC
+ * object. The libvlccore programming and binary interfaces are not stable.
+ * @warning
+ * Remember to release the object with vlc_object_release().
+ *
+ * \param p_instance the libvlc instance
+ * @return a VLC object of type "libvlc"
  */
-int libvlc_playlist_add( libvlc_instance_t *, const char *, const char *,
-                         libvlc_exception_t * );
+VLC_PUBLIC_API struct vlc_object_t *libvlc_get_vlc_instance(libvlc_instance_t *p_instance);
 
 /**
- * Add an item at the end of the playlist, with additional input options
- * \param p_instance the instance
- * \param psz_uri the URI to open, using VLC format
- * \param psz_name a name that you might want to give or NULL
- * \param i_options the number of options to add
- * \param ppsz_options strings representing the options to add
- * \return the identifier of the new item
+ * Frees an heap allocation (char *) returned by a LibVLC API.
+ * If you know you're using the same underlying C run-time as the LibVLC
+ * implementation, then you can call ANSI C free() directly instead.
  */
-int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
-                                  const char *, int, const char **,
-                                  libvlc_exception_t * );
-
-
-int libvlc_playlist_delete_item( libvlc_instance_t *, int,
-                                 libvlc_exception_t * );
-    
-typedef struct libvlc_input_t libvlc_input_t;
-
-/* Get the input that is currently being played by the playlist
- * \param p_instance the instance to use
- * \param p_exception an initialized excecption
- * \return an input object
- */
-libvlc_input_t *libvlc_playlist_get_input( libvlc_instance_t *,
-                                           libvlc_exception_t * );
-
-
+VLC_PUBLIC_API void libvlc_free( void *ptr );
 
 /** @}*/
 
 /*****************************************************************************
- * Input
+ * Event handling
  *****************************************************************************/
-/** defgroup libvlc_input Input
- * \ingroup libvlc
- * LibVLC Input handling
- * @{
- */
-
-/** Free an input object
- * \param p_input the input to free
- */
-void libvlc_input_free( libvlc_input_t * );
 
-/// \bug This might go away ... to be replaced by a broader system
-vlc_int64_t libvlc_input_get_length     ( libvlc_input_t *, libvlc_exception_t *);
-vlc_int64_t libvlc_input_get_time       ( libvlc_input_t *, libvlc_exception_t *);
-float       libvlc_input_get_position   ( libvlc_input_t *, libvlc_exception_t *);
-vlc_bool_t  libvlc_input_will_play      ( libvlc_input_t *, libvlc_exception_t *);
-vlc_bool_t  libvlc_input_has_vout       ( libvlc_input_t *, libvlc_exception_t *);
-float       libvlc_input_get_fps        ( libvlc_input_t *, libvlc_exception_t *);
-        
-/** @} */
-
-/** defgroup libvlc_video Video
- * \ingroup libvlc
- * LibVLC Video handling
+/** \defgroup libvlc_event libvlc_event
+ * \ingroup libvlc_core
+ * LibVLC Events
  * @{
  */
 
 /**
- * Toggle fullscreen status on video output
- * \param p_input the input
- * \param p_exception an initialized exception
- */
-void libvlc_toggle_fullscreen( libvlc_input_t *, libvlc_exception_t * );
-
-/**
- * Enable or disable fullscreen on a video output
- * \param p_input the input
- * \param b_fullscreen boolean for fullscreen status
- * \param p_exception an initialized exception
+ * Event manager that belongs to a libvlc object, and from whom events can
+ * be received.
  */
-void libvlc_set_fullscreen( libvlc_input_t *, int, libvlc_exception_t * );
 
-/**
- * Get current fullscreen status
- * \param p_input the input
- * \param p_exception an initialized exception
- * \return the fullscreen status (boolean)
- */
-int libvlc_get_fullscreen( libvlc_input_t *, libvlc_exception_t * );
+typedef struct libvlc_event_manager_t libvlc_event_manager_t;
+typedef struct libvlc_event_t libvlc_event_t;
+typedef uint32_t libvlc_event_type_t;
     
 /**
- * Get current video height
- * \param p_input the input
- * \param p_exception an initialized exception
- * \return the video height
- */
-int libvlc_video_get_height( libvlc_input_t *, libvlc_exception_t * );
-
-/**
- * Get current video width
- * \param p_input the input
- * \param p_exception an initialized exception
- * \return the video width
+ * Callback function notification
+ * \param p_event the event triggering the callback
  */
-int libvlc_video_get_width( libvlc_input_t *, libvlc_exception_t * );
-
-/**
- * Take a snapshot of the current video window
- * \param p_input the input
- * \param psz_filepath the path where to save the screenshot to
- * \param p_exception an initialized exception
- */
-void libvlc_video_take_snapshot( libvlc_input_t *, char *, libvlc_exception_t * );
-    
-int libvlc_video_destroy( libvlc_input_t *, libvlc_exception_t *);
 
+typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * );
     
 /**
- * Resize the video output window
- * \param p_instance libvlc instance
- * \param width new width for video output window
- * \param height new height for video output window
- * \param p_exception an initialized exception
- * \return the mute status (boolean)
+ * Register for an event notification.
+ *
+ * \param p_event_manager the event manager to which you want to attach to.
+ *        Generally it is obtained by vlc_my_object_event_manager() where
+ *        my_object is the object you want to listen to.
+ * \param i_event_type the desired event to which we want to listen
+ * \param f_callback the function to call when i_event_type occurs
+ * \param user_data user provided data to carry with the event
+ * \param p_e an initialized exception pointer
+ */
+VLC_PUBLIC_API void libvlc_event_attach( libvlc_event_manager_t *p_event_manager,
+                                         libvlc_event_type_t i_event_type,
+                                         libvlc_callback_t f_callback,
+                                         void *user_data,
+                                         libvlc_exception_t *p_e );
+
+/**
+ * Unregister an event notification.
+ *
+ * \param p_event_manager 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_user_data user provided data to carry with the event
+ * \param p_e an initialized exception pointer
  */
-void libvlc_video_resize( libvlc_input_t *, int, int, libvlc_exception_t *);
-    
-/**
-* Downcast to this general type as placeholder for a platform specific one, such as:
-*  Drawable on X11,
-*  CGrafPort on MacOSX,
-*  HWND on win32
-*/
-typedef int libvlc_drawable_t;
+VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
+                                         libvlc_event_type_t i_event_type,
+                                         libvlc_callback_t f_callback,
+                                         void *p_user_data,
+                                         libvlc_exception_t *p_e );
 
 /**
- * Get current mute status
- * \param p_instance libvlc instance
- * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
- * \param p_exception an initialized exception
- * \return the mute status (boolean)
+ * Get an event's type name.
+ *
+ * \param i_event_type the desired event
  */
-int libvlc_video_reparent( libvlc_input_t *, libvlc_drawable_t, libvlc_exception_t * );
-
+VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
 
 /** @} */
 
-/**
- * defgroup libvlc_vlm VLM
- * \ingroup libvlc
- * LibVLC VLM handling
- * @{
- */
+/*****************************************************************************
+ * Message log handling
+ *****************************************************************************/
 
-/** defgroup libvlc_audio Audio
- * \ingroup libvlc
- * LibVLC Audio handling
+/** \defgroup libvlc_log libvlc_log
+ * \ingroup libvlc_core
+ * LibVLC Message Logging
  * @{
  */
 
 /**
- * Get current mute status
+ * Return the VLC messaging verbosity level.
+ *
  * \param p_instance libvlc instance
- * \param p_exception an initialized exception
- * \return the mute status (boolean)
+ * \return verbosity level for messages
  */
-vlc_bool_t libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance );
 
 /**
- * Set mute status
- * \param p_instance libvlc instance
- * \param status If status is VLC_TRUE then mute, otherwise unmute
- * \param p_exception an initialized exception
- * \return void
+ * Set the VLC messaging verbosity level.
+ *
+ * \param p_instance libvlc log instance
+ * \param level log level
  */
-void libvlc_audio_set_mute( libvlc_instance_t *, vlc_bool_t , libvlc_exception_t * );
-
+VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level );
 
 /**
- * Get current audio level
+ * Open a VLC message log instance.
+ *
  * \param p_instance libvlc instance
- * \param p_exception an initialized exception
- * \return the audio level (int)
+ * \param p_e an initialized exception pointer
+ * \return log message instance
  */
-int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
-
+VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
 
 /**
- * Set current audio level
- * \param p_instance libvlc instance
- * \param i_volume the volume (int)
- * \param p_exception an initialized exception
- * \return void
- */
-void libvlc_audio_set_volume( libvlc_instance_t *, int , libvlc_exception_t *);
-
-/** @} */
-
-
-/**
- * Add a broadcast, with one input
- * \param p_instance the instance
- * \param psz_name the name of the new broadcast
- * \param psz_input the input MRL
- * \param psz_output the output MRL (the parameter to the "sout" variable)
- * \param i_options number of additional options
- * \param ppsz_options additional options
- * \param b_enabled boolean for enabling the new broadcast
- * \param b_loop Should this broadcast be played in loop ?
- * \param p_exception an initialized exception
+ * Close a VLC message log instance.
+ *
+ * \param p_log libvlc log instance or NULL
  */
-void libvlc_vlm_add_broadcast( libvlc_instance_t *, char *, char *, char* ,
-                               int, char **, int, int, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log );
 
 /**
- * Delete a media (vod or broadcast)
- * \param p_instance the instance
- * \param psz_name the media to delete
- * \param p_exception an initialized exception
+ * Returns the number of messages in a log instance.
+ *
+ * \param p_log libvlc log instance or NULL
+ * \param p_e an initialized exception pointer
+ * \return number of log messages, 0 if p_log is NULL
  */
-void libvlc_vlm_del_media( libvlc_instance_t *, char *, libvlc_exception_t * );
+VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log );
 
 /**
- * Enable or disable a media (vod or broadcast)
- * \param p_instance the instance
- * \param psz_name the media to work on
- * \param b_enabled the new status
- * \param p_exception an initialized exception
+ * Clear a log instance.
+ *
+ * All messages in the log are removed. The log should be cleared on a
+ * regular basis to avoid clogging.
+ *
+ * \param p_log libvlc log instance or NULL
  */
-void libvlc_vlm_set_enabled( libvlc_instance_t *, char *, int,
-                             libvlc_exception_t *);
+VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
 
 /**
- * Set the output for a media
- * \param p_instance the instance
- * \param psz_name the media to work on
- * \param psz_output the output MRL (the parameter to the "sout" variable)
- * \param p_exception an initialized exception
+ * Allocate and returns a new iterator to messages in log.
+ *
+ * \param p_log libvlc log instance
+ * \param p_e an initialized exception pointer
+ * \return log iterator object
  */
-void libvlc_vlm_set_output( libvlc_instance_t *, char *, char*,
-                            libvlc_exception_t *);
+VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
 
 /**
- * Set a media's input MRL. This will delete all existing inputs and
- * add the specified one.
- * \param p_instance the instance
- * \param psz_name the media to work on
- * \param psz_input the input MRL
- * \param p_exception an initialized exception
+ * Release a previoulsy allocated iterator.
+ *
+ * \param p_iter libvlc log iterator or NULL
  */
-void libvlc_vlm_set_input( libvlc_instance_t *, char *, char*,
-                           libvlc_exception_t *);
-
-
+VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
 
 /**
- * Set output for a media
- * \param p_instance the instance
- * \param psz_name the media to work on
- * \param b_loop the new status
- * \param p_exception an initialized exception
+ * Return whether log iterator has more messages.
+ *
+ * \param p_iter libvlc log iterator or NULL
+ * \return true if iterator has more message objects, else false
  */
-void libvlc_vlm_set_loop( libvlc_instance_t *, char *, int,
-                          libvlc_exception_t *);
-
-
-
+VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
 
 /**
- * Edit the parameters of a media. This will delete all existing inputs and
- * add the specified one.
- * \param p_instance the instance
- * \param psz_name the name of the new broadcast
- * \param psz_input the input MRL
- * \param psz_output the output MRL (the parameter to the "sout" variable)
- * \param i_options number of additional options
- * \param ppsz_options additional options
- * \param b_enabled boolean for enabling the new broadcast
- * \param b_loop Should this broadcast be played in loop ?
- * \param p_exception an initialized exception
+ * Return the next log message.
+ *
+ * The message contents must not be freed
+ *
+ * \param p_iter libvlc log iterator or NULL
+ * \param p_buffer log buffer
+ * \param p_e an initialized exception pointer
+ * \return log message object
  */
-void libvlc_vlm_change_media( libvlc_instance_t *, char *, char *, char* ,
-                              int, char **, int, int, libvlc_exception_t * );
-
-/**
- * Plays the named broadcast.
- * \param p_instance the instance
- * \param psz_name the name of the broadcast
- * \param p_exception an initialized exception
- */ 
-void libvlc_vlm_play_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
-
-/**
- * Stops the named broadcast.
- * \param p_instance the instance
- * \param psz_name the name of the broadcast
- * \param p_exception an initialized exception
- */ 
-void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
+VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
+                                                               libvlc_log_message_t *p_buffer,
+                                                               libvlc_exception_t *p_e );
 
-    
-/**
- * Pauses the named broadcast.
- * \param p_instance the instance
- * \param psz_name the name of the broadcast
- * \param p_exception an initialized exception
- */ 
-void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
-    
-    
-
-/** @} */
 /** @} */
 
 # ifdef __cplusplus