/*****************************************************************************
* libvlc.h: libvlc external API
*****************************************************************************
- * Copyright (C) 1998-2005 the VideoLAN team
+ * Copyright (C) 1998-2009 the VideoLAN team
* $Id$
*
* Authors: Clément Stenac <zorglub@videolan.org>
*/
/**
- * \defgroup libvlc libvlc
- * This is libvlc, the base library of the VLC program.
- *
+ * \defgroup libvlc LibVLC
+ * LibVLC is the external programming interface of the VLC media player.
+ * It is used to embed VLC into other applications or frameworks.
* @{
*/
extern "C" {
# endif
-/*****************************************************************************
- * Exception handling
- *****************************************************************************/
-/** \defgroup libvlc_exception libvlc_exception
- * \ingroup libvlc_core
- * LibVLC Exceptions handling
+#include <stdarg.h>
+#include <vlc/libvlc_structures.h>
+
+/** \defgroup libvlc_core LibVLC core
+ * \ingroup libvlc
+ * Before it can do anything useful, LibVLC must be initialized.
+ * You can create one (or more) instance(s) of LibVLC in a given process,
+ * with libvlc_new() and destroy them with libvlc_release().
+ *
+ * \version Unless otherwise stated, these functions are available
+ * from LibVLC versions numbered 1.1.0 or more.
+ * Earlier versions (0.9.x and 1.0.x) are <b>not</b> compatible.
* @{
*/
-/**
- * Initialize an exception structure. This can be called several times to
- * reuse an exception structure.
- *
- * \param p_exception the exception to initialize
+/** \defgroup libvlc_error LibVLC error handling
+ * @{
*/
-VLC_PUBLIC_API void libvlc_exception_init( libvlc_exception_t *p_exception );
/**
- * Has an exception been raised?
+ * 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).
*
- * \param p_exception the exception to query
- * \return 0 if the exception was raised, 1 otherwise
+ * @warning
+ * This will be NULL if there was no error.
*/
-VLC_PUBLIC_API int
-libvlc_exception_raised( const libvlc_exception_t *p_exception );
+VLC_PUBLIC_API const char *libvlc_errmsg (void);
/**
- * Raise an exception using a user-provided message.
- *
- * \param p_exception the exception to raise
- * \param psz_format the exception message format string
- * \param ... the format string arguments
+ * Clears the LibVLC error status for the current thread. This is optional.
+ * By default, the error status is automatically overridden when a new error
+ * occurs, and destroyed when the thread exits.
*/
-VLC_PUBLIC_API void
-libvlc_exception_raise( libvlc_exception_t *p_exception,
- const char *psz_format, ... );
+VLC_PUBLIC_API void libvlc_clearerr (void);
/**
- * Clear an exception object so it can be reused.
- * The exception object must have be initialized.
- *
- * \param p_exception the exception to clear
+ * Sets the LibVLC error status and message for the current thread.
+ * Any previous error is overridden.
+ * \return a nul terminated string in any case
*/
-VLC_PUBLIC_API void libvlc_exception_clear( libvlc_exception_t * );
+const char *libvlc_vprinterr (const char *fmt, va_list ap);
/**
- * Get an exception's message.
- *
- * \param p_exception the exception to query
- * \return the exception message or NULL if not applicable (exception not
- * raised, for example)
+ * Sets the LibVLC error status and message for the current thread.
+ * Any previous error is overridden.
+ * \return a nul terminated string in any case
*/
-VLC_PUBLIC_API const char *
-libvlc_exception_get_message( const libvlc_exception_t *p_exception );
+const char *libvlc_printerr (const char *fmt, ...);
/**@} */
-/*****************************************************************************
- * Core handling
- *****************************************************************************/
-
-/** \defgroup libvlc_core libvlc_core
- * \ingroup libvlc
- * LibVLC Core
- * @{
- */
-
/**
* 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
+ * This functions accept a list of "command line" arguments similar to the
+ * main(). These arguments affect the LibVLC instance default configuration.
+ *
+ * \version
+ * Arguments are meant to be passed from the command line to LibVLC, just like
+ * VLC media player does. The list of valid arguments depends on the LibVLC
+ * version, the operating system and platform, and set of available LibVLC
+ * plugins. Invalid or unsupported arguments will cause the function to fail
+ * (i.e. return NULL). Also, some arguments may alter the behaviour or
+ * otherwise interfere with other LibVLC functions.
+ *
+ * \warning
+ * There is absolutely no warranty or promise of forward, backward and
+ * cross-platform compatibility with regards to libvlc_new() arguments.
+ * We recommend that you do not use them, other than when debugging.
+ *
+ * \param argc the number of arguments (should be 0)
+ * \param argv list of arguments (should be NULL)
+ * \return the libvlc instance or NULL in case of error
*/
VLC_PUBLIC_API libvlc_instance_t *
-libvlc_new( int , const char *const *, libvlc_exception_t *);
-
-/**
- * Return a libvlc instance identifier for legacy APIs. Use of this
- * function is discouraged, you should convert your program to use the
- * new API.
- *
- * \param p_instance the instance
- * \return the instance identifier
- */
-VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
+libvlc_new( int argc , const char *const *argv );
/**
* Decrement the reference count of a libvlc instance, and destroy it
*
* \param p_instance the instance to destroy
*/
-VLC_PUBLIC_API void libvlc_release( libvlc_instance_t * );
+VLC_PUBLIC_API void libvlc_release( libvlc_instance_t *p_instance );
/**
* Increments the reference count of a libvlc instance.
*
* \param p_instance the instance to reference
*/
-VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
+VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t *p_instance );
/**
- * Try to start a user interface for the libvlc instance, and wait until the
- * user exits.
+ * Try to start a user interface for the libvlc instance.
*
* \param p_instance the instance
* \param name interface name, or NULL for default
- * \param p_exception an initialized exception pointer
+ * \return 0 on success, -1 on error.
+ */
+VLC_PUBLIC_API
+int libvlc_add_intf( libvlc_instance_t *p_instance, const char *name );
+
+/**
+ * Registers a callback for the LibVLC exit event. This is mostly useful if
+ * you have started at least one interface with libvlc_add_intf().
+ * Typically, this function will wake up your application main loop (from
+ * another thread).
+ *
+ * \param p_instance LibVLC instance
+ * \param cb callback to invoke when LibVLC wants to exit
+ * \param opaque data pointer for the callback
+ * \warning This function and libvlc_wait() cannot be used at the same time.
+ * Use either or none of them but not both.
*/
VLC_PUBLIC_API
-void libvlc_add_intf( libvlc_instance_t *p_instance, const char *name,
- libvlc_exception_t *p_exception );
+void libvlc_set_exit_handler( libvlc_instance_t *p_instance,
+ void (*cb) (void *), void *opaque );
/**
* Waits until an interface causes the instance to exit.
VLC_PUBLIC_API
void libvlc_wait( libvlc_instance_t *p_instance );
+/**
+ * Sets the application name. LibVLC passes this as the user agent string
+ * when a protocol requires it.
+ *
+ * \param p_instance LibVLC instance
+ * \param name human-readable application name, e.g. "FooBar player 1.2.3"
+ * \param http HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0"
+ * \version LibVLC 1.1.1 or later
+ */
+VLC_PUBLIC_API
+void libvlc_set_user_agent( libvlc_instance_t *p_instance,
+ const char *name, const char *http );
+
/**
* Retrieve libvlc version.
*
- * Example: "0.9.0-git Grishenko"
+ * Example: "1.1.0-git The Luggage"
*
* \return a string containing the libvlc version
*/
*/
VLC_PUBLIC_API const char * libvlc_get_changeset(void);
-/** @}*/
-
-/*****************************************************************************
- * media
- *****************************************************************************/
-/** \defgroup libvlc_media libvlc_media
- * \ingroup libvlc
- * LibVLC Media
- * @{
- */
-
-/**
- * Create a media with the given MRL.
- *
- * \param p_instance the instance
- * \param psz_mrl the MRL to read
- * \param p_e an initialized exception pointer
- * \return the newly created media
- */
-VLC_PUBLIC_API libvlc_media_t * libvlc_media_new(
- libvlc_instance_t *p_instance,
- const char * psz_mrl,
- libvlc_exception_t *p_e );
-
-/**
- * Create a media as an empty node with the passed name.
- *
- * \param p_instance the instance
- * \param psz_name the name of the node
- * \param p_e an initialized exception pointer
- * \return the new empty media
- */
-VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node(
- libvlc_instance_t *p_instance,
- const char * psz_name,
- libvlc_exception_t *p_e );
-
-/**
- * Add an option to the media.
- *
- * This option will be used to determine how the media_player will
- * read the media. This allows to use VLC's advanced
- * reading/streaming options on a per-media basis.
- *
- * The options are detailed in vlc --long-help, for instance "--sout-all"
- *
- * \param p_instance the instance
- * \param ppsz_options the options (as a string)
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_media_add_option(
- libvlc_media_t * p_md,
- const char * ppsz_options,
- libvlc_exception_t * p_e );
-
-/**
- * Retain a reference to a media descriptor object (libvlc_media_t). Use
- * libvlc_media_release() to decrement the reference count of a
- * media descriptor object.
- *
- * \param p_meta_desc a media descriptor object.
- */
-VLC_PUBLIC_API void libvlc_media_retain(
- libvlc_media_t *p_meta_desc );
-
-/**
- * Decrement the reference count of a media descriptor object. If the
- * reference count is 0, then libvlc_media_release() will release the
- * media descriptor object. It will send out an libvlc_MediaFreed event
- * to all listeners. If the media descriptor object has been released it
- * should not be used again.
- *
- * \param p_meta_desc a media descriptor object.
- */
-VLC_PUBLIC_API void libvlc_media_release(
- libvlc_media_t *p_meta_desc );
-
-
-/**
- * Get the media resource locator (mrl) from a media descriptor object
- *
- * \param p_md a media descriptor object
- * \param p_e an initialized exception object
- * \return string with mrl of media descriptor object
- */
-VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md,
- libvlc_exception_t * p_e );
-
-/**
- * Duplicate a media descriptor object.
- *
- * \param p_meta_desc a media descriptor object.
- */
-VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t * );
-
-/**
- * Read the meta of the media.
- *
- * \param p_meta_desc the media to read
- * \param e_meta_desc the meta to read
- * \param p_e an initialized exception pointer
- * \return the media's meta
- */
-VLC_PUBLIC_API char * libvlc_media_get_meta(
- libvlc_media_t *p_meta_desc,
- libvlc_meta_t e_meta,
- libvlc_exception_t *p_e );
-/**
- * Get current state of media descriptor object. Possible media states
- * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
- * libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
- * libvlc_Stopped, libvlc_Forward, libvlc_Backward, libvlc_Ended,
- * libvlc_Error).
- *
- * @see libvlc_state_t
- * \param p_meta_desc a media descriptor object
- * \param p_e an initialized exception object
- * \return state of media descriptor object
- */
-VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
- libvlc_media_t *p_meta_desc,
- libvlc_exception_t *p_e );
-
-/**
- * Get subitems of media descriptor object. This will increment
- * the reference count of supplied media descriptor object. Use
- * libvlc_media_list_release() to decrement the reference counting.
- *
- * \param p_md media descriptor object
- * \param p_e initalized exception object
- * \return list of media descriptor subitems or NULL
- */
-VLC_PUBLIC_API libvlc_media_list_t *
- libvlc_media_subitems( libvlc_media_t *p_md,
- libvlc_exception_t *p_e );
-/**
- * Get event manager from media descriptor object.
- * NOTE: this function doesn't increment reference counting.
- *
- * \param p_md a media descriptor object
- * \param p_e an initialized exception object
- * \return event manager object
- */
-VLC_PUBLIC_API libvlc_event_manager_t *
- libvlc_media_event_manager( libvlc_media_t * p_md,
- libvlc_exception_t * p_e );
-
-/**
- * Get duration of media descriptor object item.
- *
- * \param p_md media descriptor object
- * \param p_e an initialized exception object
- * \return duration of media item
- */
-VLC_PUBLIC_API libvlc_time_t
- libvlc_media_get_duration( libvlc_media_t * p_md,
- libvlc_exception_t * p_e );
-/**
- * Get preparsed status for media descriptor object.
+/** \defgroup libvlc_event LibVLC asynchronous events
+ * LibVLC emits asynchronous events.
*
- * \param p_md media descriptor object
- * \param p_e an initialized exception object
- * \return true if media object has been preparsed otherwise it returns false
- */
-VLC_PUBLIC_API int
- libvlc_media_is_preparsed( libvlc_media_t * p_md,
- libvlc_exception_t * p_e );
-
-/**
- * Sets media descriptor's user_data. user_data is specialized data
- * accessed by the host application, VLC.framework uses it as a pointer to
- * an native object that references a libvlc_media_t pointer
- *
- * \param p_md media descriptor object
- * \param p_new_user_data pointer to user data
- * \param p_e an initialized exception object
- */
-VLC_PUBLIC_API void
- libvlc_media_set_user_data( libvlc_media_t * p_md,
- void * p_new_user_data,
- libvlc_exception_t * p_e);
-
-/**
- * Get media descriptor's user_data. user_data is specialized data
- * accessed by the host application, VLC.framework uses it as a pointer to
- * an native object that references a libvlc_media_t pointer
- *
- * \param p_md media descriptor object
- * \param p_e an initialized exception object
- */
-VLC_PUBLIC_API void *
- libvlc_media_get_user_data( libvlc_media_t * p_md,
- libvlc_exception_t * p_e);
-
-/** @}*/
-
-/*****************************************************************************
- * Media Player
- *****************************************************************************/
-/** \defgroup libvlc_media_player libvlc_media_player
- * \ingroup libvlc
- * LibVLC Media Player, object that let you play a media
- * in a libvlc_drawable_t
+ * Several LibVLC objects (such @ref libvlc_instance_t as
+ * @ref libvlc_media_player_t) generate events asynchronously. Each of them
+ * provides @ref libvlc_event_manager_t event manager. You can subscribe to
+ * events with libvlc_event_attach() and unsubscribe with
+ * libvlc_event_detach().
* @{
*/
/**
- * Create an empty Media Player object
- *
- * \param p_libvlc_instance the libvlc instance in which the Media Player
- * should be created.
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *, libvlc_exception_t * );
-
-/**
- * Create a Media Player object from a Media
- *
- * \param p_md the media. Afterwards the p_md can be safely
- * destroyed.
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new_from_media( libvlc_media_t *, libvlc_exception_t * );
-
-/**
- * Release a media_player after use
- * Decrement the reference count of a media player object. If the
- * reference count is 0, then libvlc_media_player_release() will
- * release the media player object. If the media player object
- * has been released, then it should not be used again.
- *
- * \param p_mi the Media Player to free
- */
-VLC_PUBLIC_API void libvlc_media_player_release( libvlc_media_player_t * );
-
-/**
- * Retain a reference to a media player object. Use
- * libvlc_media_player_release() to decrement reference count.
- *
- * \param p_mi media player object
- */
-VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * );
-
-/**
- * Set the media that will be used by the media_player. If any,
- * previous md will be released.
- *
- * \param p_mi the Media Player
- * \param p_md the Media. Afterwards the p_md can be safely
- * destroyed.
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t * );
-
-/**
- * Get the media used by the media_player.
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- * \return the media associated with p_mi, or NULL if no
- * media is associated
- */
-VLC_PUBLIC_API libvlc_media_t * libvlc_media_player_get_media( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Get the Event Manager from which the media player send event.
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- * \return the event manager associated with p_mi
- */
-VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Play
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_media_player_play ( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Pause
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Stop
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Set the drawable where the media player should render its video output
- *
- * \param p_mi the Media Player
- * \param drawable the libvlc_drawable_t where the media player
- * should render its video
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_media_player_set_drawable ( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
-
-/**
- * Get the drawable where the media player should render its video output
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- * \return the libvlc_drawable_t where the media player
- * should render its video
- */
-VLC_PUBLIC_API libvlc_drawable_t
- libvlc_media_player_get_drawable ( libvlc_media_player_t *, libvlc_exception_t * );
-
-/** \bug This might go away ... to be replaced by a broader system */
-
-/**
- * Get the current movie length (in ms).
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- * \return the movie length (in ms).
- */
-VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_length( libvlc_media_player_t *, libvlc_exception_t *);
-
-/**
- * Get the current movie time (in ms).
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- * \return the movie time (in ms).
- */
-VLC_PUBLIC_API libvlc_time_t libvlc_media_player_get_time( libvlc_media_player_t *, libvlc_exception_t *);
-
-/**
- * Set the movie time (in ms).
- *
- * \param p_mi the Media Player
- * \param the movie time (in ms).
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_media_player_set_time( libvlc_media_player_t *, libvlc_time_t, libvlc_exception_t *);
-
-/**
- * Get movie position.
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- * \return movie position
- */
-VLC_PUBLIC_API float libvlc_media_player_get_position( libvlc_media_player_t *, libvlc_exception_t *);
-
-/**
- * Set movie position.
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- * \return movie position
- */
-VLC_PUBLIC_API void libvlc_media_player_set_position( libvlc_media_player_t *, float, libvlc_exception_t *);
-
-/**
- * Set movie chapter
- *
- * \param p_mi the Media Player
- * \param i_chapter chapter number to play
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_media_player_set_chapter( libvlc_media_player_t *, int, libvlc_exception_t *);
-
-/**
- * Get movie chapter
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- * \return chapter number currently playing
- */
-VLC_PUBLIC_API int libvlc_media_player_get_chapter( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Get movie chapter count
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- * \return number of chapters in movie
- */
-VLC_PUBLIC_API int libvlc_media_player_get_chapter_count( libvlc_media_player_t *, libvlc_exception_t *);
-VLC_PUBLIC_API int libvlc_media_player_will_play ( libvlc_media_player_t *, libvlc_exception_t *);
-
-/**
- * Get movie play rate
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- * \return movie play rate
+ * Event manager that belongs to a libvlc object, and from whom events can
+ * be received.
*/
-VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *);
+typedef struct libvlc_event_manager_t libvlc_event_manager_t;
-/**
- * Set movie play rate
- *
- * \param p_mi the Media Player
- * \param movie play rate to set
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *);
-
-/**
- * Get current movie state
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- * \return current movie state as libvlc_state_t
- */
-VLC_PUBLIC_API libvlc_state_t libvlc_media_player_get_state( libvlc_media_player_t *, libvlc_exception_t *);
+struct libvlc_event_t;
/**
- * Get movie fps rate
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- * \return frames per second (fps) for this playing movie
+ * Type of a LibVLC event.
*/
-VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
-
-/** end bug */
+typedef int libvlc_event_type_t;
/**
- * Does this media player have a video output?
- *
- * \param p_md the media player
- * \param p_e an initialized exception pointer
+ * Callback function notification
+ * \param p_event the event triggering the callback
*/
-VLC_PUBLIC_API int libvlc_media_player_has_vout( libvlc_media_player_t *, libvlc_exception_t *);
-
-/**
- * Is this media player seekable?
- *
- * \param p_input the input
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
-
-/**
- * Can this media player be paused?
- *
- * \param p_input the input
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API int libvlc_media_player_can_pause( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
-
-/** \defgroup libvlc_video libvlc_video
- * \ingroup libvlc_media_player
- * LibVLC Video handling
- * @{
- */
-
-/**
- * Toggle fullscreen status on video output.
- *
- * \param p_mediaplayer the media player
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Enable or disable fullscreen on a video output.
- *
- * \param p_mediaplayer the media player
- * \param b_fullscreen boolean for fullscreen status
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_exception_t * );
-
-/**
- * Get current fullscreen status.
- *
- * \param p_mediaplayer the media player
- * \param p_e an initialized exception pointer
- * \return the fullscreen status (boolean)
- */
-VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Get current video height.
- *
- * \param p_mediaplayer the media player
- * \param p_e an initialized exception pointer
- * \return the video height
- */
-VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Get current video width.
- *
- * \param p_mediaplayer the media player
- * \param p_e an initialized exception pointer
- * \return the video width
- */
-VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Get current video aspect ratio.
- *
- * \param p_mediaplayer the media player
- * \param p_e an initialized exception pointer
- * \return the video aspect ratio
- */
-VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Set new video aspect ratio.
- *
- * \param p_mediaplayer the media player
- * \param psz_aspect new video aspect-ratio
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, char *, libvlc_exception_t * );
-
-/**
- * Get current video subtitle.
- *
- * \param p_mediaplayer the media player
- * \param p_e an initialized exception pointer
- * \return the video subtitle selected
- */
-VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Set new video subtitle.
- *
- * \param p_mediaplayer the media player
- * \param i_spu new video subtitle to select
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_player_t *, int , libvlc_exception_t * );
-
-/**
- * Set new video subtitle file.
- *
- * \param p_mediaplayer the media player
- * \param psz_subtitle new video subtitle file
- * \param p_e an initialized exception pointer
- * \return the success status (boolean)
- */
-VLC_PUBLIC_API int libvlc_video_set_subtitle_file( libvlc_media_player_t *, char *, libvlc_exception_t * );
-
-/**
- * Get current crop filter geometry.
- *
- * \param p_mediaplayer the media player
- * \param p_e an initialized exception pointer
- * \return the crop filter geometry
- */
-VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Set new crop filter geometry.
- *
- * \param p_mediaplayer the media player
- * \param psz_geometry new crop filter geometry
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_player_t *, char *, libvlc_exception_t * );
-
-/**
- * Toggle teletext transparent status on video output.
- *
- * \param p_mediaplayer the media player
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Get current teletext page requested.
- *
- * \param p_mediaplayer the media player
- * \param p_e an initialized exception pointer
- * \return the current teletext page requested.
- */
-VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Set new teletext page to retrieve.
- *
- * \param p_mediaplayer the media player
- * \param i_page teletex page number requested
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_player_t *, int, libvlc_exception_t * );
-
-/**
- * Take a snapshot of the current video window.
- *
- * If i_width AND i_height is 0, original size is used.
- * If i_width XOR i_height is 0, original aspect-ratio is preserved.
- *
- * \param p_mediaplayer the media player
- * \param psz_filepath the path where to save the screenshot to
- * \param i_width the snapshot's width
- * \param i_height the snapshot's height
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_media_player_t *, char *,unsigned int, unsigned int, libvlc_exception_t * );
-
-/**
- * Resize the current 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_e an initialized exception pointer
- * \return the success status (boolean)
- */
-VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_player_t *, int, int, libvlc_exception_t *);
-
-/**
- * Change the parent for the current the video output.
- *
- * \param p_instance libvlc instance
- * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
- * \param p_e an initialized exception pointer
- * \return the success status (boolean)
- */
-VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
-
-/**
- * Tell windowless video output to redraw rectangular area (MacOS X only).
- *
- * \param p_instance libvlc instance
- * \param area coordinates within video drawable
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_player_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
-
-/**
- * Set the default video output size.
- *
- * This setting will be used as default for all video outputs.
- *
- * \param p_instance libvlc instance
- * \param width new width for video drawable
- * \param height new height for video drawable
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
-
-/**
- * Set the default video output viewport for a windowless video output
- * (MacOS X only).
- *
- * This setting will be used as default for all video outputs.
- *
- * \param p_instance libvlc instance
- * \param view coordinates within video drawable
- * \param clip coordinates within video drawable
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
-
-/** @} video */
-
-/** \defgroup libvlc_audio libvlc_audio
- * \ingroup libvlc_media_player
- * LibVLC Audio handling
- * @{
- */
-
-/**
- * Toggle mute status.
- *
- * \param p_instance libvlc instance
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_audio_toggle_mute( libvlc_instance_t *, libvlc_exception_t * );
-
-/**
- * Get current mute status.
- *
- * \param p_instance libvlc instance
- * \param p_e an initialized exception pointer
- * \return the mute status (boolean)
- */
-VLC_PUBLIC_API int libvlc_audio_get_mute( libvlc_instance_t *, libvlc_exception_t * );
-
-/**
- * Set mute status.
- *
- * \param p_instance libvlc instance
- * \param status If status is true then mute, otherwise unmute
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_audio_set_mute( libvlc_instance_t *, int , libvlc_exception_t * );
-
-/**
- * Get current audio level.
- *
- * \param p_instance libvlc instance
- * \param p_e an initialized exception pointer
- * \return the audio level (int)
- */
-VLC_PUBLIC_API int libvlc_audio_get_volume( libvlc_instance_t *, libvlc_exception_t * );
-
-/**
- * Set current audio level.
- *
- * \param p_instance libvlc instance
- * \param i_volume the volume (int)
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_audio_set_volume( libvlc_instance_t *, int, libvlc_exception_t *);
-
-/**
- * Get number of available audio tracks.
- *
- * \param p_mi media player
- * \param p_e an initialized exception
- * \return the number of available audio tracks (int)
- */
-VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Get current audio track.
- *
- * \param p_mi media player
- * \param p_e an initialized exception pointer
- * \return the audio track (int)
- */
-VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * );
-
-/**
- * Set current audio track.
- *
- * \param p_mi media player
- * \param i_track the track (int)
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
-
-/**
- * Get current audio channel.
- *
- * \param p_instance vlc instance
- * \param p_e an initialized exception pointer
- * \return the audio channel (int)
- */
-VLC_PUBLIC_API int libvlc_audio_get_channel( libvlc_instance_t *, libvlc_exception_t * );
-
-/**
- * Set current audio channel.
- *
- * \param p_instance vlc instance
- * \param i_channel the audio channel (int)
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_audio_set_channel( libvlc_instance_t *, int, libvlc_exception_t * );
-
-/** @} audio */
-
-/** @} media_player */
-
-/*****************************************************************************
- * Event handling
- *****************************************************************************/
-
-/** \defgroup libvlc_event libvlc_event
- * \ingroup libvlc_core
- * LibVLC Events
- * @{
- */
-
+typedef void ( *libvlc_callback_t )( const struct libvlc_event_t *, void * );
+
/**
* Register for an event notification.
*
* \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
+ * \return 0 on success, ENOMEM on error
*/
-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 );
+VLC_PUBLIC_API int 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 );
/**
* Unregister an event notification.
* \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
*/
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 );
+ void *p_user_data );
/**
* Get an event's type name.
*
- * \param i_event_type the desired event
+ * \param event_type the desired event
*/
VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
/** @} */
-/*****************************************************************************
- * Media Library
- *****************************************************************************/
-/** \defgroup libvlc_media_library libvlc_media_library
- * \ingroup libvlc
- * LibVLC Media Library
- * @{
- */
-VLC_PUBLIC_API libvlc_media_library_t *
- libvlc_media_library_new( libvlc_instance_t * p_inst,
- libvlc_exception_t * p_e );
-
-/**
- * Release media library object. This functions decrements the
- * reference count of the media library object. If it reaches 0,
- * then the object will be released.
- *
- * \param p_mlib media library object
- */
-VLC_PUBLIC_API void
- libvlc_media_library_release( libvlc_media_library_t * p_mlib );
-
-/**
- * Retain a reference to a media library object. This function will
- * increment the reference counting for this object. Use
- * libvlc_media_library_release() to decrement the reference count.
- *
- * \param p_mlib media library object
- */
-VLC_PUBLIC_API void
- libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
-
-/**
- * Load media library.
- *
- * \param p_mlib media library object
- * \param p_e an initialized exception object.
- */
-VLC_PUBLIC_API void
- libvlc_media_library_load( libvlc_media_library_t * p_mlib,
- libvlc_exception_t * p_e );
-
-/**
- * Save media library.
- *
- * \param p_mlib media library object
- * \param p_e an initialized exception object.
- */
-VLC_PUBLIC_API void
- libvlc_media_library_save( libvlc_media_library_t * p_mlib,
- libvlc_exception_t * p_e );
-
-/**
- * Get media library subitems.
- *
- * \param p_mlib media library object
- * \param p_e an initialized exception object.
- * \return media list subitems
- */
-VLC_PUBLIC_API libvlc_media_list_t *
- libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
- libvlc_exception_t * p_e );
-
-
-/** @} */
-
-
-/*****************************************************************************
- * Services/Media Discovery
- *****************************************************************************/
-/** \defgroup libvlc_media_discoverer libvlc_media_discoverer
- * \ingroup libvlc
- * LibVLC Media Discoverer
- * @{
- */
-
-/**
- * Discover media service by name.
- *
- * \param p_inst libvlc instance
- * \param psz_name service name
- * \param p_e an initialized exception object
- * \return media discover object
- */
-VLC_PUBLIC_API libvlc_media_discoverer_t *
-libvlc_media_discoverer_new_from_name( libvlc_instance_t * p_inst,
- const char * psz_name,
- libvlc_exception_t * p_e );
-
-/**
- * Release media discover object. If the reference count reaches 0, then
- * the object will be released.
- *
- * \param p_mdis media service discover object
- */
-VLC_PUBLIC_API void libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
-
-/**
- * Get media service discover object its localized name.
- *
- * \param media discover object
- * \return localized name
- */
-VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
-
-/**
- * Get media service discover media list.
- *
- * \param p_mdis media service discover object
- * \return list of media items
- */
-VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
-
-/**
- * Get event manager from media service discover object.
- *
- * \param p_mdis media service discover object
- * \return event manager object.
- */
-VLC_PUBLIC_API libvlc_event_manager_t *
- libvlc_media_discoverer_event_manager( libvlc_media_discoverer_t * p_mdis );
-
-/**
- * Query if media service discover object is running.
- *
- * \param p_mdis media service discover object
- * \return true if running, false if not
- */
-VLC_PUBLIC_API int
- libvlc_media_discoverer_is_running( libvlc_media_discoverer_t * p_mdis );
-
-/**@} */
-
-
-/*****************************************************************************
- * Message log handling
- *****************************************************************************/
-
-/** \defgroup libvlc_log libvlc_log
- * \ingroup libvlc_core
- * LibVLC Message Logging
+/** \defgroup libvlc_log LibVLC logging
+ * libvlc_log_* functions provide access to the LibVLC messages log.
+ * This is used for debugging or by advanced users.
* @{
*/
* Return the VLC messaging verbosity level.
*
* \param p_instance libvlc instance
- * \param p_e an initialized exception pointer
* \return verbosity level for messages
*/
-VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance,
- libvlc_exception_t *p_e );
+VLC_PUBLIC_API unsigned libvlc_get_log_verbosity( const libvlc_instance_t *p_instance );
/**
* Set the VLC messaging verbosity level.
*
* \param p_instance libvlc log instance
* \param level log level
- * \param p_e an initialized exception pointer
*/
-VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level,
- libvlc_exception_t *p_e );
+VLC_PUBLIC_API void libvlc_set_log_verbosity( libvlc_instance_t *p_instance, unsigned level );
/**
* Open a VLC message log instance.
*
* \param p_instance libvlc instance
- * \param p_e an initialized exception pointer
- * \return log message instance
+ * \return log message instance or NULL on error
*/
-VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
+VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *p_instance );
/**
* Close a VLC message log instance.
*
- * \param p_log libvlc log instance
- * \param p_e an initialized exception pointer
+ * \param p_log libvlc log instance or NULL
*/
-VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
+VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *p_log );
/**
* Returns the number of messages in a log instance.
*
- * \param p_log libvlc log instance
- * \param p_e an initialized exception pointer
- * \return number of log messages
+ * \param p_log libvlc log instance or NULL
+ * \return number of log messages, 0 if p_log is NULL
*/
-VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
+VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *p_log );
/**
* 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
- * \param p_e an initialized exception pointer
+ * \param p_log libvlc log instance or NULL
*/
-VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
+VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *p_log );
/**
* 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
+ * \return log iterator object or NULL on error
*/
-VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
+VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *p_log );
/**
* Release a previoulsy allocated iterator.
*
- * \param p_iter libvlc log iterator
- * \param p_e an initialized exception pointer
+ * \param p_iter libvlc log iterator or NULL
*/
-VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
+VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter );
/**
* Return whether log iterator has more messages.
*
- * \param p_iter libvlc log iterator
- * \param p_e an initialized exception pointer
+ * \param p_iter libvlc log iterator or NULL
* \return true if iterator has more message objects, else false
*/
-VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
+VLC_PUBLIC_API int libvlc_log_iterator_has_next( const libvlc_log_iterator_t *p_iter );
/**
* Return the next log message.
*
* The message contents must not be freed
*
- * \param p_iter libvlc log iterator
+ * \param p_iter libvlc log iterator or NULL
* \param p_buffer log buffer
- * \param p_e an initialized exception pointer
- * \return log message object
+ * \return log message object or NULL if none left
*/
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 );
+ libvlc_log_message_t *p_buffer );
/** @} */
+/** @} */
+/** @} */
# ifdef __cplusplus
}
projects / vlc / blobdiff