#define _LIBVLC_H 1
#include <vlc/vlc.h>
+#include <vlc/libvlc_structures.h>
# ifdef __cplusplus
extern "C" {
* @{
*/
-typedef struct
-{
- int b_raised;
- int i_code;
- char *psz_message;
-} libvlc_exception_t;
-
/**
* Initialize an exception structure. This can be called several times to reuse
* an exception structure.
* \param p_exception the exception to query
* \return 0 if no exception raised, 1 else
*/
-VLC_PUBLIC_API 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
* \param p_exception the exception to raise
* \param psz_message the exception message
*/
-VLC_PUBLIC_API void libvlc_exception_raise( libvlc_exception_t *p_exception, const 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.
* \return the exception message or NULL if not applicable (exception not raised
* for example)
*/
-VLC_PUBLIC_API char* libvlc_exception_get_message( libvlc_exception_t *p_exception );
+VLC_PUBLIC_API const char *
+libvlc_exception_get_message( const libvlc_exception_t *p_exception );
/**@} */
* @{
*/
-/** This structure is opaque. It represents a libvlc instance */
-typedef struct libvlc_instance_t libvlc_instance_t;
-
/**
- * Create an initialized libvlc instance
+ * Create an initialized libvlc instance.
* \param argc the number of arguments
* \param argv command-line-type arguments
* \param exception an initialized exception pointer
*/
-VLC_PUBLIC_API libvlc_instance_t * libvlc_new( int , char **, libvlc_exception_t *);
+VLC_PUBLIC_API libvlc_instance_t *
+libvlc_new( int , const char *const *, libvlc_exception_t *);
/**
* Returns a libvlc instance identifier for legacy APIs. Use of this
VLC_PUBLIC_API int libvlc_get_vlc_id( libvlc_instance_t *p_instance );
/**
- * Destroy a libvlc instance.
+ * Decrements the reference count of a libvlc instance, and destroys it
+ * if it reaches zero.
* \param p_instance the instance to destroy
*/
-VLC_PUBLIC_API void libvlc_destroy( libvlc_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_release( libvlc_instance_t *, libvlc_exception_t * );
+
+/**
+ * Increments the reference count of a libvlc instance.
+ * The reference count is initially one when libvlc_new() returns.
+ */
+VLC_PUBLIC_API void libvlc_retain( libvlc_instance_t * );
+
+/** @}*/
+
+/*****************************************************************************
+ * Media descriptor
+ *****************************************************************************/
+/** defgroup libvlc_media_descriptor Media Descriptor
+ * \ingroup libvlc
+ * LibVLC Media Descriptor
+ * @{
+ */
+
+/**
+ * Create a media descriptor with the given mrl.
+ * \param p_instance the instance
+ * \param psz_mrl the mrl to read
+ */
+VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_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.
+ * \param p_instance the instance
+ * \param psz_name the name of the node
+ */
+VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_descriptor_new_as_node(
+ libvlc_instance_t *p_instance,
+ const char * psz_name,
+ libvlc_exception_t *p_e );
+
+/**
+ * Add an option to the media descriptor,
+ * This option will be used to determine how the media_instance will
+ * read the media_descriptor. This allow to use VLC advanced
+ * reading/streaming options in a per-media basis.
+ *
+ * The options are detailled in vlc --long-help, for instance "--sout-all"
+ * \param p_instance the instance
+ * \param psz_mrl the mrl to read
+ */
+VLC_PUBLIC_API void libvlc_media_descriptor_add_option(
+ libvlc_media_descriptor_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 );
+
+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,
+ libvlc_exception_t * p_e );
+
+/**
+ * Read the meta of the media descriptor.
+ * \param p_meta_desc the media descriptor to read
+ * \param p_meta_desc the meta to read
+ */
+VLC_PUBLIC_API char * libvlc_media_descriptor_get_meta(
+ libvlc_media_descriptor_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,
+ libvlc_exception_t *p_e );
+
+/* Tags */
+VLC_PUBLIC_API void libvlc_media_descriptor_add_tag( libvlc_media_descriptor_t *p_md,
+ const char * key,
+ const libvlc_tag_t tag,
+ libvlc_exception_t *p_e );
+
+VLC_PUBLIC_API void libvlc_media_descriptor_remove_tag( libvlc_media_descriptor_t *p_md,
+ const char * key,
+ const libvlc_tag_t tag,
+ libvlc_exception_t *p_e );
+
+VLC_PUBLIC_API int
+ libvlc_media_descriptor_tags_count_for_key( libvlc_media_descriptor_t *p_md,
+ const char * key,
+ libvlc_exception_t *p_e );
+
+VLC_PUBLIC_API libvlc_tag_t
+ libvlc_media_descriptor_tag_at_index_for_key( libvlc_media_descriptor_t *p_md,
+ int i,
+ const char * key,
+ libvlc_exception_t *p_e );
+
+VLC_PUBLIC_API libvlc_media_list_t *
+ libvlc_media_descriptor_subitems( libvlc_media_descriptor_t *p_md,
+ libvlc_exception_t *p_e );
+
+VLC_PUBLIC_API libvlc_event_manager_t *
+ libvlc_media_descriptor_event_manager( libvlc_media_descriptor_t * p_md,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API vlc_int64_t
+ libvlc_media_descriptor_get_duration( libvlc_media_descriptor_t * p_md,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API vlc_bool_t
+ libvlc_media_descriptor_is_preparsed( libvlc_media_descriptor_t * p_md,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+ libvlc_media_descriptor_set_user_data( libvlc_media_descriptor_t * p_md,
+ void * p_new_user_data,
+ libvlc_exception_t * p_e);
+VLC_PUBLIC_API void *
+ libvlc_media_descriptor_get_user_data( libvlc_media_descriptor_t * p_md,
+ libvlc_exception_t * p_e);
/** @}*/
* @{
*/
-typedef struct {
- int i_id;
- char * psz_uri;
- char * psz_name;
-
-} libvlc_playlist_item_t;
-
/**
* Set loop variable
*/
VLC_PUBLIC_API 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
+/** 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
*/
-VLC_PUBLIC_API libvlc_input_t *libvlc_playlist_get_input( libvlc_instance_t *,
- libvlc_exception_t * );
+VLC_PUBLIC_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
+ libvlc_instance_t *, libvlc_exception_t * );
/** @}*/
/*****************************************************************************
- * Input
+ * Media Instance
*****************************************************************************/
-/** defgroup libvlc_input Input
+/** defgroup libvlc_media_instance Media Instance
* \ingroup libvlc
- * LibVLC Input handling
+ * LibVLC Media Instance
* @{
*/
-/** Free an input object
- * \param p_input the input to free
+/** Create an empty Media Instance object
+ * \param p_libvlc_instance the libvlc instance in which the Media Instance
+ * should be (not used for now).
*/
-VLC_PUBLIC_API void libvlc_input_free( libvlc_input_t * );
+VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new( libvlc_instance_t *, libvlc_exception_t * );
-/// \bug This might go away ... to be replaced by a broader system
-VLC_PUBLIC_API vlc_int64_t libvlc_input_get_length ( libvlc_input_t *, libvlc_exception_t *);
-VLC_PUBLIC_API vlc_int64_t libvlc_input_get_time ( libvlc_input_t *, libvlc_exception_t *);
-VLC_PUBLIC_API void libvlc_input_set_time ( libvlc_input_t *, vlc_int64_t, libvlc_exception_t *);
-VLC_PUBLIC_API float libvlc_input_get_position ( libvlc_input_t *, libvlc_exception_t *);
-VLC_PUBLIC_API void libvlc_input_set_position ( libvlc_input_t *, float, libvlc_exception_t *);
-VLC_PUBLIC_API vlc_bool_t libvlc_input_will_play ( libvlc_input_t *, libvlc_exception_t *);
-VLC_PUBLIC_API float libvlc_input_get_rate ( libvlc_input_t *, libvlc_exception_t *);
-VLC_PUBLIC_API void libvlc_input_set_rate ( libvlc_input_t *, float, libvlc_exception_t *);
-VLC_PUBLIC_API int libvlc_input_get_state ( libvlc_input_t *, libvlc_exception_t *);
+/** Create a Media Instance object from a Media Descriptor
+ * \param p_md the media descriptor. Afterwards the p_md can safely be
+ * destroyed.
+ */
+VLC_PUBLIC_API libvlc_media_instance_t * libvlc_media_instance_new_from_media_descriptor( libvlc_media_descriptor_t *, libvlc_exception_t * );
-/** @} */
+/** Release a media_instance after use
+ * \param p_mi the Media Instance to free
+ */
+VLC_PUBLIC_API void libvlc_media_instance_release( libvlc_media_instance_t * );
+VLC_PUBLIC_API void libvlc_media_instance_retain( libvlc_media_instance_t * );
-/** defgroup libvlc_video Video
- * \ingroup libvlc
- * LibVLC Video handling
- * @{
+/** Set the media descriptor that will be used by the media_instance. If any,
+ * previous md will be released.
+ * \param p_mi the Media Instance
+ * \param p_md the Media Descriptor. Afterwards the p_md can safely be
+ * destroyed.
*/
+VLC_PUBLIC_API void libvlc_media_instance_set_media_descriptor( libvlc_media_instance_t *, libvlc_media_descriptor_t *, 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;
+/** Get the media descriptor used by the media_instance (if any). A copy of
+ * the md is returned. NULL is returned if no media instance is associated.
+ * \param p_mi the Media Instance
+ */
+VLC_PUBLIC_API libvlc_media_descriptor_t * libvlc_media_instance_get_media_descriptor( libvlc_media_instance_t *, libvlc_exception_t * );
-/**
-* Rectangle type for video geometry
-*/
-typedef struct
-{
- int top, left;
- int bottom, right;
-}
-libvlc_rectangle_t;
+/** Get the Event Manager from which the media instance send event.
+ * \param p_mi the Media Instance
+ */
+VLC_PUBLIC_API libvlc_event_manager_t * libvlc_media_instance_event_manager ( libvlc_media_instance_t *, libvlc_exception_t * );
+
+VLC_PUBLIC_API void libvlc_media_instance_play ( libvlc_media_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_media_instance_pause ( libvlc_media_instance_t *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_media_instance_stop ( libvlc_media_instance_t *, libvlc_exception_t * );
+
+VLC_PUBLIC_API void libvlc_media_instance_set_drawable ( libvlc_media_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
+
+/** \bug This might go away ... to be replaced by a broader system */
+VLC_PUBLIC_API vlc_int64_t libvlc_media_instance_get_length ( libvlc_media_instance_t *, libvlc_exception_t *);
+VLC_PUBLIC_API vlc_int64_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 *, vlc_int64_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 vlc_bool_t 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 *);
/**
* Does this input have a video output ?
* \param p_input the input
* \param p_exception an initialized exception
*/
-VLC_PUBLIC_API vlc_bool_t libvlc_input_has_vout( libvlc_input_t *, libvlc_exception_t *);
-VLC_PUBLIC_API float libvlc_input_get_fps( libvlc_input_t *, libvlc_exception_t *);
+VLC_PUBLIC_API vlc_bool_t libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
+VLC_PUBLIC_API float libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
+
+
+/** @} */
+
+/*****************************************************************************
+ * Tag Query
+ *****************************************************************************/
+/** defgroup libvlc_tag_query Tag Query
+ * \ingroup libvlc
+ * LibVLC Tag query
+ * @{
+ */
+VLC_PUBLIC_API libvlc_tag_query_t *
+ libvlc_tag_query_new( libvlc_instance_t *, libvlc_exception_t * );
+
+VLC_PUBLIC_API void
+ libvlc_tag_query_release( libvlc_tag_query_t * );
+
+VLC_PUBLIC_API void
+ libvlc_tag_query_retain( libvlc_tag_query_t * );
+
+VLC_PUBLIC_API void
+ libvlc_tag_query_set_match_tag_and_key( libvlc_tag_query_t * p_q,
+ libvlc_tag_t tag,
+ char * psz_tag_key,
+ libvlc_exception_t * );
+
+VLC_PUBLIC_API vlc_bool_t
+ libvlc_tag_query_match( libvlc_tag_query_t *, libvlc_media_descriptor_t *,
+ libvlc_exception_t * );
+
+/** @} */
+
+/*****************************************************************************
+ * Media List
+ *****************************************************************************/
+/** defgroup libvlc_media_list MediaList
+ * \ingroup libvlc
+ * LibVLC Media List
+ * @{
+ */
+VLC_PUBLIC_API libvlc_media_list_t *
+ libvlc_media_list_new( libvlc_instance_t *, libvlc_exception_t * );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_release( libvlc_media_list_t * );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_retain( libvlc_media_list_t * );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_add_file_content( libvlc_media_list_t * p_mlist,
+ const char * psz_uri,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_set_media_descriptor( libvlc_media_list_t *,
+ libvlc_media_descriptor_t *,
+ libvlc_exception_t *);
+
+VLC_PUBLIC_API libvlc_media_descriptor_t *
+ libvlc_media_list_media_descriptor( libvlc_media_list_t *,
+ libvlc_exception_t *);
+
+VLC_PUBLIC_API void
+ libvlc_media_list_add_media_descriptor( libvlc_media_list_t *,
+ libvlc_media_descriptor_t *,
+ libvlc_exception_t * );
+VLC_PUBLIC_API void
+ libvlc_media_list_insert_media_descriptor( libvlc_media_list_t *,
+ libvlc_media_descriptor_t *,
+ int,
+ libvlc_exception_t * );
+VLC_PUBLIC_API void
+ libvlc_media_list_remove_index( libvlc_media_list_t *, int,
+ libvlc_exception_t * );
+
+VLC_PUBLIC_API int
+ libvlc_media_list_count( libvlc_media_list_t * p_mlist,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API libvlc_media_descriptor_t *
+ libvlc_media_list_item_at_index( libvlc_media_list_t *, int,
+ libvlc_exception_t * );
+VLC_PUBLIC_API int
+ libvlc_media_list_index_of_item( libvlc_media_list_t *,
+ libvlc_media_descriptor_t *,
+ libvlc_exception_t * );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_lock( libvlc_media_list_t * );
+VLC_PUBLIC_API void
+ libvlc_media_list_unlock( libvlc_media_list_t * );
+
+VLC_PUBLIC_API libvlc_media_list_view_t *
+ libvlc_media_list_flat_view( libvlc_media_list_t *,
+ libvlc_exception_t * );
+
+VLC_PUBLIC_API libvlc_media_list_view_t *
+ libvlc_media_list_hierarchical_view( libvlc_media_list_t *,
+ libvlc_exception_t * );
+
+VLC_PUBLIC_API libvlc_event_manager_t *
+ libvlc_media_list_event_manager( libvlc_media_list_t *,
+ libvlc_exception_t * );
+/** @} */
+
+
+/*****************************************************************************
+ * Media List View
+ *****************************************************************************/
+/** defgroup libvlc_media_list_view MediaListView
+ * \ingroup libvlc
+ * LibVLC Media List View
+ * @{ */
+
+VLC_PUBLIC_API void
+ libvlc_media_list_view_retain( libvlc_media_list_view_t * p_mlv );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_view_release( libvlc_media_list_view_t * p_mlv );
+
+VLC_PUBLIC_API libvlc_event_manager_t *
+ libvlc_media_list_view_event_manager( libvlc_media_list_view_t * p_mlv );
+
+VLC_PUBLIC_API int
+ libvlc_media_list_view_count( libvlc_media_list_view_t * p_mlv,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API libvlc_media_descriptor_t *
+ libvlc_media_list_view_item_at_index( libvlc_media_list_view_t * p_mlv,
+ int index,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API libvlc_media_list_view_t *
+ libvlc_media_list_view_children_at_index( libvlc_media_list_view_t * p_mlv,
+ int index,
+ libvlc_exception_t * p_e );
+
+
+VLC_PUBLIC_API int
+ libvlc_media_list_view_index_of_item( libvlc_media_list_view_t * p_mlv,
+ libvlc_media_descriptor_t * p_md,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_view_insert_at_index( libvlc_media_list_view_t * p_mlv,
+ libvlc_media_descriptor_t * p_md,
+ int index,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_view_remove_at_index( libvlc_media_list_view_t * p_mlv,
+ int index,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_view_add_item( libvlc_media_list_view_t * p_mlv,
+ libvlc_media_descriptor_t * p_md,
+ libvlc_exception_t * p_e );
+
+/** @} */
+
+/*****************************************************************************
+ * Dynamic Media List (Deprecated)
+ *****************************************************************************/
+/** defgroup libvlc_media_list MediaList
+ * \ingroup libvlc
+ * LibVLC Media List
+ * @{ */
+
+VLC_PUBLIC_API libvlc_dynamic_media_list_t *
+ libvlc_dynamic_media_list_new( libvlc_media_list_t * p_mlist,
+ libvlc_tag_query_t * p_query,
+ libvlc_tag_t tag,
+ libvlc_exception_t * p_e );
+VLC_PUBLIC_API void
+ libvlc_dynamic_media_list_release( libvlc_dynamic_media_list_t * p_dmlist );
+
+VLC_PUBLIC_API void
+ libvlc_dynamic_media_list_retain( libvlc_dynamic_media_list_t * p_dmlist );
+
+libvlc_media_list_t *
+ libvlc_dynamic_media_list_media_list( libvlc_dynamic_media_list_t * p_dmlist,
+ libvlc_exception_t * p_e );
+
+/** @} */
+
+/*****************************************************************************
+ * Media Library
+ *****************************************************************************/
+/** defgroup libvlc_media_library 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 );
+VLC_PUBLIC_API void
+ libvlc_media_library_release( libvlc_media_library_t * p_mlib );
+VLC_PUBLIC_API void
+ libvlc_media_library_retain( libvlc_media_library_t * p_mlib );
+
+
+VLC_PUBLIC_API void
+ libvlc_media_library_load( libvlc_media_library_t * p_mlib,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+ libvlc_media_library_save( libvlc_media_library_t * p_mlib,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API libvlc_media_list_t *
+ libvlc_media_library_media_list( libvlc_media_library_t * p_mlib,
+ libvlc_exception_t * p_e );
+
+
+/** @} */
+
+/*****************************************************************************
+ * Media List Player
+ *****************************************************************************/
+/** defgroup libvlc_media_list_player MediaListPlayer
+ * \ingroup libvlc
+ * LibVLC Media List Player
+ * @{
+ */
+VLC_PUBLIC_API libvlc_media_list_player_t *
+ libvlc_media_list_player_new( libvlc_instance_t * p_instance,
+ libvlc_exception_t * p_e );
+VLC_PUBLIC_API void
+ libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_player_set_media_instance(
+ libvlc_media_list_player_t * p_mlp,
+ libvlc_media_instance_t * p_mi,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_player_set_media_list(
+ libvlc_media_list_player_t * p_mlp,
+ libvlc_media_list_t * p_mlist,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API int
+ libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API libvlc_state_t
+ libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_player_play_item_at_index(
+ libvlc_media_list_player_t * p_mlp,
+ int i_index,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_player_play_item(
+ libvlc_media_list_player_t * p_mlp,
+ libvlc_media_descriptor_t * p_md,
+ libvlc_exception_t * p_e );
+
+VLC_PUBLIC_API void
+ libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
+ libvlc_exception_t * p_e );
+VLC_PUBLIC_API void
+ libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
+ libvlc_exception_t * p_e );
+
+/** @} */
+
+/** defgroup libvlc_video Video
+ * \ingroup libvlc
+ * LibVLC Video handling
+ * @{
+ */
/**
* Toggle fullscreen status on video output
* \param p_input the input
* \param p_exception an initialized exception
*/
-VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_input_t *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
/**
* Enable or disable fullscreen on a video output
* \param b_fullscreen boolean for fullscreen status
* \param p_exception an initialized exception
*/
-VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_input_t *, int, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_set_fullscreen( libvlc_media_instance_t *, int, libvlc_exception_t * );
/**
* Get current fullscreen status
* \param p_exception an initialized exception
* \return the fullscreen status (boolean)
*/
-VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_input_t *, libvlc_exception_t * );
+VLC_PUBLIC_API int libvlc_get_fullscreen( libvlc_media_instance_t *, libvlc_exception_t * );
/**
* Get current video height
* \param p_exception an initialized exception
* \return the video height
*/
-VLC_PUBLIC_API int libvlc_video_get_height( libvlc_input_t *, libvlc_exception_t * );
+VLC_PUBLIC_API int libvlc_video_get_height( libvlc_media_instance_t *, libvlc_exception_t * );
/**
* Get current video width
* \param p_exception an initialized exception
* \return the video width
*/
-VLC_PUBLIC_API int libvlc_video_get_width( libvlc_input_t *, libvlc_exception_t * );
+VLC_PUBLIC_API int libvlc_video_get_width( libvlc_media_instance_t *, libvlc_exception_t * );
/**
* Get current video aspect ratio
* \param p_exception an initialized exception
* \return the video aspect ratio
*/
-VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_input_t *, libvlc_exception_t * );
+VLC_PUBLIC_API char *libvlc_video_get_aspect_ratio( libvlc_media_instance_t *, libvlc_exception_t * );
/**
* Set new video aspect ratio
* \param psz_aspect new video aspect-ratio
* \param p_exception an initialized exception
*/
-VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_input_t *, char *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_video_set_aspect_ratio( libvlc_media_instance_t *, char *, libvlc_exception_t * );
/**
* Get current video subtitle
* \param p_exception an initialized exception
* \return the video subtitle selected
*/
-VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_input_t *, libvlc_exception_t * );
+VLC_PUBLIC_API int libvlc_video_get_spu( libvlc_media_instance_t *, libvlc_exception_t * );
/**
* Set new video subtitle
* \param i_spu new video subtitle to select
* \param p_exception an initialized exception
*/
-VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_input_t *, int , libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_video_set_spu( libvlc_media_instance_t *, int , libvlc_exception_t * );
/**
* Get current crop filter geometry
* \param p_exception an initialized exception
* \return the crop filter geometry
*/
-VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_input_t *, libvlc_exception_t * );
+VLC_PUBLIC_API char *libvlc_video_get_crop_geometry( libvlc_media_instance_t *, libvlc_exception_t * );
/**
* Set new crop filter geometry
* \param psz_geometry new crop filter geometry
* \param p_exception an initialized exception
*/
-VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_input_t *, char *, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_video_set_crop_geometry( libvlc_media_instance_t *, char *, libvlc_exception_t * );
+
+/**
+ * Toggle teletext transparent status on video output
+ * \param p_input the input
+ * \param p_exception an initialized exception
+ */
+VLC_PUBLIC_API void libvlc_toggle_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
+
+/**
+ * Get current teletext page requested.
+ * \param p_input the input
+ * \param p_exception an initialized exception
+ * \return the current teletext page requested.
+ */
+VLC_PUBLIC_API int libvlc_video_get_teletext( libvlc_media_instance_t *, libvlc_exception_t * );
+
+/**
+ * Set new teletext page to retrieve
+ * \param p_input the input
+ * \param i_page teletex page number requested
+ * \param p_exception an initialized exception
+ */
+VLC_PUBLIC_API void libvlc_video_set_teletext( libvlc_media_instance_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 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_exception an initialized exception
*/
-VLC_PUBLIC_API void libvlc_video_take_snapshot( libvlc_input_t *, char *, libvlc_exception_t * );
+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_input_t *, libvlc_exception_t *);
+VLC_PUBLIC_API int libvlc_video_destroy( libvlc_media_instance_t *, libvlc_exception_t *);
/**
* Resize the current video output window
* \param p_exception an initialized exception
* \return the success status (boolean)
*/
-VLC_PUBLIC_API void libvlc_video_resize( libvlc_input_t *, int, int, libvlc_exception_t *);
+VLC_PUBLIC_API void libvlc_video_resize( libvlc_media_instance_t *, int, int, libvlc_exception_t *);
/**
* change the parent for the current the video output
* \param p_exception an initialized exception
* \return the success status (boolean)
*/
-VLC_PUBLIC_API int libvlc_video_reparent( libvlc_input_t *, libvlc_drawable_t, libvlc_exception_t * );
+VLC_PUBLIC_API int libvlc_video_reparent( libvlc_media_instance_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_exception an initialized exception
+ */
+VLC_PUBLIC_API void libvlc_video_redraw_rectangle( libvlc_media_instance_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
/**
* Set the default video output parent
*/
VLC_PUBLIC_API void libvlc_video_set_viewport( libvlc_instance_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
-
/** @} */
-/**
- * defgroup libvlc_vlm VLM
- * \ingroup libvlc
- * LibVLC VLM handling
- * @{
- */
-
/** defgroup libvlc_audio Audio
* \ingroup libvlc
* LibVLC Audio handling
*/
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 instance
+ * \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 * );
+
/**
+ * Get current audio track
+ * \param p_input input instance
+ * \param p_exception an initialized exception
+ * \return the audio track (int)
+ */
-VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_input_t *, libvlc_exception_t * );
+VLC_PUBLIC_API int libvlc_audio_get_track( libvlc_media_instance_t *, libvlc_exception_t * );
/**
* Set current audio track
* \param i_track the track (int)
* \param p_exception an initialized exception
*/
-VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_input_t *, int, libvlc_exception_t * );
+VLC_PUBLIC_API void libvlc_audio_set_track( libvlc_media_instance_t *, int, libvlc_exception_t * );
/**
* Get current audio channel
/** @} */
+/*****************************************************************************
+ * Services/Media Discovery
+ *****************************************************************************/
+/** defgroup libvlc_media_discoverer Media Discoverer
+ * \ingroup libvlc
+ * LibVLC Media Discoverer
+ * @{
+ */
+
+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 );
+VLC_PUBLIC_API void libvlc_media_discoverer_release( libvlc_media_discoverer_t * p_mdis );
+VLC_PUBLIC_API char * libvlc_media_discoverer_localized_name( libvlc_media_discoverer_t * p_mdis );
+
+VLC_PUBLIC_API libvlc_media_list_t * libvlc_media_discoverer_media_list( libvlc_media_discoverer_t * p_mdis );
+
+/**@} */
+
+/*****************************************************************************
+ * VLM
+ *****************************************************************************/
+/** defgroup libvlc_vlm VLM
+ * \ingroup libvlc
+ * LibVLC VLM
+ * @{
+ */
/**
* Add a broadcast, with one input
* \param p_instance the instance
* \param psz_name the name of the broadcast
* \param p_exception an initialized exception
- */
+ */
VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, char *, libvlc_exception_t * );
/**
* \param p_instance the instance
* \param psz_name the name of the broadcast
* \param p_exception an initialized exception
- */
+ */
VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, char *, libvlc_exception_t * );
-
+
/**
* Seeks in the named broadcast.
* \param p_instance the instance
* \param psz_name the name of the broadcast
* \param f_percentage the percentage to seek to
* \param p_exception an initialized exception
- */
+ */
VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, char *,
float, libvlc_exception_t * );
-
+
/**
* Return information of the named broadcast.
* \param p_instance the instance
* \param psz_name the name of the broadcast
* \param p_exception an initialized exception
- */
+ */
VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, char *, libvlc_exception_t * );
#define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE( attr, returnType, getType, default)\
#undef LIBVLC_VLM_GET_MEDIA_ATTRIBUTE
-/** @} */
/** @} */
/*****************************************************************************
* @{
*/
-/** This structure is opaque. It represents a libvlc log instance */
-typedef struct libvlc_log_t libvlc_log_t;
-
-/** This structure is opaque. It represents a libvlc log iterator */
-typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
-
-typedef struct libvlc_log_message_t
-{
- unsigned sizeof_msg; /* sizeof() of message structure, must be filled in by user */
- int i_severity; /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
- const char *psz_type; /* module type */
- const char *psz_name; /* module name */
- const char *psz_header; /* optional header */
- const char *psz_message; /* message */
-} libvlc_log_message_t;
-
/**
* Returns the VLC messaging verbosity level
* \param p_instance libvlc instance
libvlc_exception_t *p_e );
/**
- * Open an instance to VLC message log
+ * Open an instance to VLC message log
* \param p_instance libvlc instance
* \param exception an initialized exception pointer
*/
-VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( const libvlc_instance_t *, libvlc_exception_t *);
+VLC_PUBLIC_API libvlc_log_t *libvlc_log_open( libvlc_instance_t *, libvlc_exception_t *);
/**
- * Close an instance of VLC message log
+ * Close an instance of VLC message log
* \param p_log libvlc log instance
* \param exception an initialized exception pointer
*/
/**
* Releases a previoulsy allocated iterator
- * \param p_log libvlc log iterator
+ * \param p_log libvlc log iterator
* \param exception an initialized exception pointer
*/
VLC_PUBLIC_API void libvlc_log_iterator_free( libvlc_log_iterator_t *p_iter, libvlc_exception_t *p_e );
/**
- * Returns whether log iterator has more messages
+ * Returns whether log iterator has more messages
* \param p_log libvlc log iterator
* \param exception an initialized exception pointer
*/
/** @} */
+/*****************************************************************************
+ * Event handling
+ *****************************************************************************/
+
+/** defgroup libvlc_callbacks Callbacks
+ * \ingroup libvlc
+ * LibVLC Events
+ * @{
+ */
+
+/**
+ * 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_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 );
+
+/**
+ * Get an event type name
+ * \param i_event_type the desired event
+ */
+VLC_PUBLIC_API const char * libvlc_event_type_name( libvlc_event_type_t event_type );
+
+/** @} */
+
+
# ifdef __cplusplus
}
# endif
projects / vlc / blobdiff