extern "C" {
# endif
-/*****************************************************************************
- * media
- *****************************************************************************/
-/** \defgroup libvlc_media libvlc_media
+/** \defgroup libvlc_media LibVLC media
* \ingroup libvlc
- * LibVLC Media
+ * @ref libvlc_media_t is an abstract representation of a playable media.
+ * It consists of a media location and various optional meta data.
* @{
*/
typedef struct libvlc_media_t libvlc_media_t;
-/* Meta Handling */
-/** defgroup libvlc_meta libvlc_meta
+/** defgroup libvlc_meta LibVLC meta data
* \ingroup libvlc_media
- * LibVLC Media Meta
* @{
*/
+/** Meta data types */
typedef enum libvlc_meta_t {
libvlc_meta_Title,
libvlc_meta_Artist,
libvlc_Error
} libvlc_state_t;
-typedef enum libvlc_media_option_t
+enum
{
libvlc_media_option_trusted = 0x2,
libvlc_media_option_unique = 0x100
-} libvlc_media_option_t;
+};
typedef enum libvlc_es_type_t
{
libvlc_es_text = 2,
} libvlc_es_type_t;
-/** defgroup libvlc_media_stats_t libvlc_media_stats_t
+/** defgroup libvlc_media_stats_t LibVLC media statistics
* \ingroup libvlc_media
- * LibVLC Media statistics
* @{
*/
typedef struct libvlc_media_stats_t
/**
- * Create a media with the given MRL.
+ * Create a media with a certain given media resource location.
*
* \param p_instance the instance
* \param psz_mrl the MRL to read
* \return the newly created media or NULL on error
*/
-VLC_PUBLIC_API libvlc_media_t * libvlc_media_new(
+VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_location(
libvlc_instance_t *p_instance,
const char * psz_mrl );
+/**
+ * Create a media with a certain file path.
+ *
+ * \param p_instance the instance
+ * \param path local filesystem path
+ * \return the newly created media or NULL on error
+ */
+VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_path(
+ libvlc_instance_t *p_instance,
+ const char *path );
+
/**
* Create a media as an empty node with a given name.
*
VLC_PUBLIC_API void libvlc_media_add_option_flag(
libvlc_media_t * p_md,
const char * ppsz_options,
- libvlc_media_option_t i_flags );
+ unsigned i_flags );
/**
/**
* Duplicate a media descriptor object.
*
- * \param p_meta_desc a media descriptor object.
+ * \param p_md a media descriptor object.
*/
VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t *p_md );
*
* \param p_md the media descriptor
* \param e_meta the meta to write
- * \param the media's meta
+ * \param psz_value the media's meta
*/
VLC_PUBLIC_API void libvlc_media_set_meta( libvlc_media_t *p_md,
libvlc_meta_t e_meta,
* will duplicate the entries in the array each time.
*
* \param p_md media descriptor object
- * \param pp_es adress to store an allocated array of Elementary Streams descriptions (must be freed by the caller)
+ * \param pp_es address to store an allocated array of Elementary Streams descriptions (must be freed by the caller)
*
* return the number of Elementary Streams
*/