* $Id$
*
* Authors: Clément Stenac <zorglub@videolan.org>
- * Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
+ * Jean-Paul Saman <jpsaman@videolan.org>
* Pierre d'Herbemont <pdherbemont@videolan.org>
*
* This program is free software; you can redistribute it and/or modify
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
+/**
+ * \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" {
* Exception handling
*****************************************************************************/
/** \defgroup libvlc_exception libvlc_exception
- * \ingroup libvlc
+ * \ingroup libvlc_core
* LibVLC Exceptions handling
* @{
*/
* Raise an exception using a user-provided message.
*
* \param p_exception the exception to raise
- * \param psz_message the exception message format string
+ * \param psz_format the exception message format string
* \param ... the format string arguments
*/
VLC_PUBLIC_API void
*/
VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
+/**
+ * Try to start a user interface for the libvlc instance, and wait until the
+ * user exits.
+ *
+ * \param p_instance the instance
+ * \param name interface name, or NULL for default
+ * \param p_exception an initialized exception pointer
+ */
+VLC_PUBLIC_API
+void libvlc_add_intf( libvlc_instance_t *p_instance, const char *name,
+ libvlc_exception_t *p_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
+ */
+VLC_PUBLIC_API
+void libvlc_wait( libvlc_instance_t *p_instance );
+
+/**
+ * Retrieve libvlc version.
+ *
+ * Example: "0.9.0-git Grishenko"
+ *
+ * \return a string containing the libvlc version
+ */
+VLC_PUBLIC_API const char * libvlc_get_version(void);
+
+/**
+ * Retrieve libvlc compiler version.
+ *
+ * Example: "gcc version 4.2.3 (Ubuntu 4.2.3-2ubuntu6)"
+ *
+ * \return a string containing the libvlc compiler version
+ */
+VLC_PUBLIC_API const char * libvlc_get_compiler(void);
+
+/**
+ * Retrieve libvlc changeset.
+ *
+ * Example: "aa9bce0bc4"
+ *
+ * \return a string containing the libvlc changeset
+ */
+VLC_PUBLIC_API const char * libvlc_get_changeset(void);
+
/** @}*/
/*****************************************************************************
- * Media descriptor
+ * media
*****************************************************************************/
-/** \defgroup libvlc_media_descriptor libvlc_media_descriptor
+/** \defgroup libvlc_media libvlc_media
* \ingroup libvlc
- * LibVLC Media Descriptor
+ * LibVLC Media
* @{
*/
/**
- * Create a media descriptor with the given MRL.
+ * 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 descriptor
+ * \return the newly created media
*/
-VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new(
+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 descriptor as an empty node with the passed name.
+ * 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 descriptor
+ * \return the new empty media
*/
-VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new_as_node(
+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 descriptor.
+ * Add an option to the media.
*
- * This option will be used to determine how the media_instance will
- * read the media_descriptor. This allows to use VLC's advanced
+ * 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 psz_mrl the MRL to read
+ * \param ppsz_options the options (as a string)
* \param p_e an initialized exception pointer
*/
-VLC_PUBLIC_API void libvlc_media_descriptor_add_option(
- libvlc_media_descriptor_t * p_md,
+VLC_PUBLIC_API void libvlc_media_add_option(
+ libvlc_media_t * p_md,
const char * ppsz_options,
libvlc_exception_t * p_e );
-VLC_PUBLIC_API void libvlc_media_descriptor_retain(
- libvlc_media_descriptor_t *p_meta_desc );
+/**
+ * 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 );
-VLC_PUBLIC_API void libvlc_media_descriptor_release(
- libvlc_media_descriptor_t *p_meta_desc );
-VLC_PUBLIC_API char * libvlc_media_descriptor_get_mrl( libvlc_media_descriptor_t * p_md,
+/**
+ * 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 );
-VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_duplicate( libvlc_media_descriptor_t * );
+/**
+ * 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 descriptor.
+ * Read the meta of the media.
*
- * \param p_meta_desc the media descriptor to read
- * \param p_meta_desc the meta to read
+ * \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 descriptor's meta
+ * \return the media's meta
*/
-VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
- libvlc_media_descriptor_t *p_meta_desc,
+VLC_PUBLIC_API char * libvlc_media_get_meta(
+ libvlc_media_t *p_meta_desc,
libvlc_meta_t e_meta,
libvlc_exception_t *p_e );
-
-VLC_PUBLIC_API libvlc_state_t libvlc_media_descriptor_get_state(
- libvlc_media_descriptor_t *p_meta_desc,
+/**
+ * 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_descriptor_subitems( libvlc_media_descriptor_t *p_md,
+ 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_descriptor_event_manager( libvlc_media_descriptor_t * p_md,
+ 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_descriptor_get_duration( libvlc_media_descriptor_t * p_md,
+ libvlc_media_get_duration( libvlc_media_t * p_md,
libvlc_exception_t * p_e );
+/**
+ * Get preparsed status for media descriptor object.
+ *
+ * \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_descriptor_is_preparsed( libvlc_media_descriptor_t * p_md,
+ 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_descriptor_set_user_data( libvlc_media_descriptor_t * p_md,
+ 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_descriptor_get_user_data( libvlc_media_descriptor_t * p_md,
+ libvlc_media_get_user_data( libvlc_media_t * p_md,
libvlc_exception_t * p_e);
/** @}*/
/*****************************************************************************
- * Media Instance
+ * Media Player
*****************************************************************************/
-/** \defgroup libvlc_media_instance libvlc_media_instance
+/** \defgroup libvlc_media_player libvlc_media_player
* \ingroup libvlc
- * LibVLC Media Instance, object that let you play a media descriptor
+ * LibVLC Media Player, object that let you play a media
* in a libvlc_drawable_t
* @{
*/
-/**
- * Create an empty Media Instance object
+/**
+ * Create an empty Media Player object
*
- * \param p_libvlc_instance the libvlc instance in which the Media Instance
+ * \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_instance_t * libvlc_media_instance_new( libvlc_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API libvlc_media_player_t * libvlc_media_player_new( libvlc_instance_t *, libvlc_exception_t * );
/**
- * Create a Media Instance object from a Media Descriptor
+ * Create a Media Player object from a Media
*
- * \param p_md the media descriptor. Afterwards the p_md can be safely
+ * \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_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * );
+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 * );
/**
- * Release a media_instance after use
+ * Retain a reference to a media player object. Use
+ * libvlc_media_player_release() to decrement reference count.
*
- * \param p_mi the Media Instance to free
+ * \param p_mi media player object
*/
-VLC_PUBLIC_API void libvlc_media_instance_release( libvlc_media_instance_t * );
-VLC_PUBLIC_API void libvlc_media_instance_retain( libvlc_media_instance_t * );
+VLC_PUBLIC_API void libvlc_media_player_retain( libvlc_media_player_t * );
-/** Set the media descriptor that will be used by the media_instance. If any,
+/**
+ * Set the media that will be used by the media_player. If any,
* previous md will be released.
*
- * \param p_mi the Media Instance
- * \param p_md the Media Descriptor. Afterwards the p_md can be safely
+ * \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_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_media_player_set_media( libvlc_media_player_t *, libvlc_media_t *, libvlc_exception_t * );
/**
- * Get the media descriptor used by the media_instance.
+ * Get the media used by the media_player.
*
- * \param p_mi the Media Instance
+ * \param p_mi the Media Player
* \param p_e an initialized exception pointer
- * \return the media descriptor associated with p_mi, or NULL if no
- * media descriptor is associated
+ * \return the media associated with p_mi, or NULL if no
+ * media is associated
*/
-VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
+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 instance send event.
+ * Get the Event Manager from which the media player send event.
*
- * \param p_mi the Media Instance
+ * \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_instance_event_manager ( libvlc_media_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_player_event_manager ( libvlc_media_player_t *, libvlc_exception_t * );
/**
- * Play
+ * Play
*
- * \param p_mi the Media Instance
+ * \param p_mi the Media Player
* \param p_e an initialized exception pointer
*/
-VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_media_player_play ( libvlc_media_player_t *, libvlc_exception_t * );
/**
- * Pause
+ * Pause
*
- * \param p_mi the Media Instance
+ * \param p_mi the Media Player
* \param p_e an initialized exception pointer
*/
-VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *, libvlc_exception_t * );
/**
- * Stop
+ * Stop
*
- * \param p_mi the Media Instance
+ * \param p_mi the Media Player
* \param p_e an initialized exception pointer
*/
-VLC_PUBLIC_API void libvlc_media_instance_stop ( libvlc_media_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *, libvlc_exception_t * );
/**
- * Set the drawable where the media instance should render its video output
+ * Set the drawable where the media player should render its video output
*
- * \param p_mi the Media Instance
- * \param drawable the libvlc_drawable_t where the media instance
+ * \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_instance_set_drawable ( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
+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 instance should render its video output
+ * Get the drawable where the media player should render its video output
*
- * \param p_mi the Media Instance
+ * \param p_mi the Media Player
* \param p_e an initialized exception pointer
- * \return the libvlc_drawable_t where the media instance
+ * \return the libvlc_drawable_t where the media player
* should render its video
*/
VLC_PUBLIC_API libvlc_drawable_t
- libvlc_media_instance_get_drawable ( libvlc_media_instance_t *, libvlc_exception_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 */
-VLC_PUBLIC_API libvlc_time_t libvlc_media_instance_get_length ( libvlc_media_instance_t *, libvlc_exception_t *);
-VLC_PUBLIC_API libvlc_time_t libvlc_media_instance_get_time ( libvlc_media_instance_t *, libvlc_exception_t *);
-VLC_PUBLIC_API void libvlc_media_instance_set_time ( libvlc_media_instance_t *, libvlc_time_t, libvlc_exception_t *);
-VLC_PUBLIC_API float libvlc_media_instance_get_position ( libvlc_media_instance_t *, libvlc_exception_t *);
-VLC_PUBLIC_API void libvlc_media_instance_set_position ( libvlc_media_instance_t *, float, libvlc_exception_t *);
-VLC_PUBLIC_API void libvlc_media_instance_set_chapter ( libvlc_media_instance_t *, int, libvlc_exception_t *);
-VLC_PUBLIC_API int libvlc_media_instance_get_chapter (libvlc_media_instance_t *, libvlc_exception_t *);
-VLC_PUBLIC_API int libvlc_media_instance_get_chapter_count( libvlc_media_instance_t *, libvlc_exception_t *);
-VLC_PUBLIC_API int libvlc_media_instance_will_play ( libvlc_media_instance_t *, libvlc_exception_t *);
-VLC_PUBLIC_API float libvlc_media_instance_get_rate ( libvlc_media_instance_t *, libvlc_exception_t *);
-VLC_PUBLIC_API void libvlc_media_instance_set_rate ( libvlc_media_instance_t *, float, libvlc_exception_t *);
-VLC_PUBLIC_API libvlc_state_t libvlc_media_instance_get_state ( libvlc_media_instance_t *, libvlc_exception_t *);
-VLC_PUBLIC_API float libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
/**
- * Does this media instance have a video output?
+ * 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
+ */
+VLC_PUBLIC_API float libvlc_media_player_get_rate( libvlc_media_player_t *, libvlc_exception_t *);
+
+/**
+ * Set movie play rate
*
- * \param p_md the media instance
+ * \param p_mi the Media Player
+ * \param movie play rate to set
* \param p_e an initialized exception pointer
*/
-VLC_PUBLIC_API int libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
+VLC_PUBLIC_API void libvlc_media_player_set_rate( libvlc_media_player_t *, float, libvlc_exception_t *);
/**
- * Is this media instance seekable?
+ * 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 *);
+
+/**
+ * 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
+ */
+VLC_PUBLIC_API float libvlc_media_player_get_fps( libvlc_media_player_t *, libvlc_exception_t *);
+
+/** end bug */
+
+/**
+ * Does this media player have a video output?
+ *
+ * \param p_md the media player
+ * \param p_e an initialized exception pointer
+ */
+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_instance_is_seekable( libvlc_media_instance_t *p_mi, libvlc_exception_t *p_e );
+VLC_PUBLIC_API int libvlc_media_player_is_seekable( libvlc_media_player_t *p_mi, libvlc_exception_t *p_e );
/**
- * Can this media instance be paused?
+ * Can this media player be paused?
*
* \param p_input the input
* \param p_e an initialized exception pointer
*/
-VLC_PUBLIC_API int libvlc_media_instance_can_pause( libvlc_media_instance_t *p_mi, libvlc_exception_t *p_e );
+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_instance
+ * \ingroup libvlc_media_player
* LibVLC Video handling
* @{
*/
/**
* Toggle fullscreen status on video output.
*
- * \param p_input the input
+ * \param p_mediaplayer the media player
* \param p_e an initialized exception pointer
*/
-VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
/**
* Enable or disable fullscreen on a video output.
*
- * \param p_input the input
+ * \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_instance_t *, int, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_player_t *, int, libvlc_exception_t * );
/**
* Get current fullscreen status.
*
- * \param p_input the input
+ * \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_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
/**
* Get current video height.
*
- * \param p_input the input
+ * \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_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_player_t *, libvlc_exception_t * );
/**
* Get current video width.
*
- * \param p_input the input
+ * \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_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_player_t *, libvlc_exception_t * );
/**
* Get current video aspect ratio.
*
- * \param p_input the input
+ * \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_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_player_t *, libvlc_exception_t * );
/**
* Set new video aspect ratio.
*
- * \param p_input the input
+ * \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_instance_t *, char *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_player_t *, char *, libvlc_exception_t * );
/**
* Get current video subtitle.
*
- * \param p_input the input
+ * \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_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_player_t *, libvlc_exception_t * );
/**
* Set new video subtitle.
*
- * \param p_input the input
+ * \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_instance_t *, int , libvlc_exception_t * );
+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_input the input
+ * \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_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_player_t *, libvlc_exception_t * );
/**
* Set new crop filter geometry.
*
- * \param p_input the input
+ * \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_instance_t *, char *, libvlc_exception_t * );
+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_input the input
+ * \param p_mediaplayer the media player
* \param p_e an initialized exception pointer
*/
-VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_player_t *, libvlc_exception_t * );
/**
* Get current teletext page requested.
*
- * \param p_input the input
+ * \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_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_player_t *, libvlc_exception_t * );
/**
* Set new teletext page to retrieve.
*
- * \param p_input the input
+ * \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_instance_t *, int, libvlc_exception_t * );
+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_input the input
+ * \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_instance_t *, char *,unsigned int, unsigned int, libvlc_exception_t * );
-
-VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
+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_e an initialized exception pointer
* \return the success status (boolean)
*/
-VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
+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_e an initialized exception pointer
* \return the success status (boolean)
*/
-VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
+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 area coordinates within video drawable
* \param p_e an initialized exception pointer
*/
-VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
-
-/**
- * Set the default video output's parent.
- *
- * This setting will be used as default for all video outputs.
- *
- * \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
- */
-VLC_PUBLIC_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
-
-/**
- * Set the default video output parent.
- *
- * This setting will be used as default for all video outputs.
- *
- * \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
- */
-VLC_PUBLIC_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
+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.
/** @} video */
/** \defgroup libvlc_audio libvlc_audio
- * \ingroup libvlc_media_instance
+ * \ingroup libvlc_media_player
* LibVLC Audio handling
* @{
*/
* Set mute status.
*
* \param p_instance libvlc instance
- * \param status If status is VLC_TRUE then mute, otherwise unmute
+ * \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 number of available audio tracks.
*
- * \param p_mi media instance
+ * \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_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API int libvlc_audio_get_track_count( libvlc_media_player_t *, libvlc_exception_t * );
/**
* Get current audio track.
*
- * \param p_input input instance
+ * \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_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_player_t *, libvlc_exception_t * );
/**
* Set current audio track.
*
- * \param p_input input instance
+ * \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_instance_t *, int, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_player_t *, int, libvlc_exception_t * );
/**
* Get current audio channel.
*
- * \param p_instance input instance
+ * \param p_instance vlc instance
* \param p_e an initialized exception pointer
* \return the audio channel (int)
*/
/**
* Set current audio channel.
*
- * \param p_instance input instance
+ * \param p_instance vlc instance
* \param i_channel the audio channel (int)
* \param p_e an initialized exception pointer
*/
/** @} audio */
-/** @} media_instance */
+/** @} media_player */
/*****************************************************************************
* Event handling
*****************************************************************************/
/** \defgroup libvlc_event libvlc_event
- * \ingroup libvlc
+ * \ingroup libvlc_core
* LibVLC Events
* @{
*/
* \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
*/
VLC_PUBLIC_API void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
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 );
* @{
*/
+/**
+ * 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 );
*****************************************************************************/
/** \defgroup libvlc_log libvlc_log
- * \ingroup libvlc
+ * \ingroup libvlc_core
* LibVLC Message Logging
* @{
*/
* Return the VLC messaging verbosity level.
*
* \param p_instance libvlc instance
- * \param exception an initialized exception pointer
+ * \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 );
/**
* Set the VLC messaging verbosity level.
*
- * \param p_log libvlc log instance
- * \param exception an initialized exception pointer
+ * \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 );
* Open a VLC message log instance.
*
* \param p_instance libvlc instance
- * \param exception an initialized exception pointer
+ * \param p_e an initialized exception pointer
+ * \return log message instance
*/
VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
* Close a VLC message log instance.
*
* \param p_log libvlc log instance
- * \param exception an initialized exception pointer
+ * \param p_e an initialized exception pointer
*/
VLC_PUBLIC_API void libvlc_log_close( libvlc_log_t *, libvlc_exception_t *);
* Returns the number of messages in a log instance.
*
* \param p_log libvlc log instance
- * \param exception an initialized exception pointer
+ * \param p_e an initialized exception pointer
+ * \return number of log messages
*/
VLC_PUBLIC_API unsigned libvlc_log_count( const libvlc_log_t *, libvlc_exception_t *);
* regular basis to avoid clogging.
*
* \param p_log libvlc log instance
- * \param exception an initialized exception pointer
+ * \param p_e an initialized exception pointer
*/
VLC_PUBLIC_API void libvlc_log_clear( libvlc_log_t *, libvlc_exception_t *);
* Allocate and returns a new iterator to messages in log.
*
* \param p_log libvlc log instance
- * \param exception an initialized exception pointer
+ * \param p_e an initialized exception pointer
+ * \return log iterator object
*/
VLC_PUBLIC_API libvlc_log_iterator_t *libvlc_log_get_iterator( const libvlc_log_t *, libvlc_exception_t *);
/**
* Release a previoulsy allocated iterator.
*
- * \param p_log libvlc log iterator
- * \param exception an initialized exception pointer
+ * \param p_iter libvlc log iterator
+ * \param p_e an initialized exception pointer
*/
VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
/**
* Return whether log iterator has more messages.
*
- * \param p_log libvlc log iterator
- * \param exception an initialized exception pointer
+ * \param p_iter libvlc log iterator
+ * \param p_e an initialized exception pointer
+ * \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 );
*
* The message contents must not be freed
*
- * \param p_log libvlc log iterator
- * \param exception an initialized exception pointer
+ * \param p_iter libvlc log iterator
+ * \param p_buffer log buffer
+ * \param p_e an initialized exception pointer
+ * \return log message object
*/
VLC_PUBLIC_API libvlc_log_message_t *libvlc_log_iterator_next( libvlc_log_iterator_t *p_iter,
- struct libvlc_log_message_t *buffer,
+ libvlc_log_message_t *p_buffer,
libvlc_exception_t *p_e );
/** @} */
projects / vlc / blobdiff