libvlc_media
[libvlc]

Collaboration diagram for libvlc_media:

LibVLC Media. More...

enum	libvlc_meta_t {   libvlc_meta_Title, libvlc_meta_Artist, libvlc_meta_Genre, libvlc_meta_Copyright,   libvlc_meta_Album, libvlc_meta_TrackNumber, libvlc_meta_Description, libvlc_meta_Rating,   libvlc_meta_Date, libvlc_meta_Setting, libvlc_meta_URL, libvlc_meta_Language,   libvlc_meta_NowPlaying, libvlc_meta_Publisher, libvlc_meta_EncodedBy, libvlc_meta_ArtworkURL,   libvlc_meta_TrackID }
	defgroup libvlc_meta libvlc_meta More...
Typedefs
typedef libvlc_media_t	libvlc_media_t
Functions
libvlc_media_t *	libvlc_media_new (libvlc_instance_t *p_instance, const char *psz_mrl, libvlc_exception_t *p_e)
	Create a media with the given MRL.
libvlc_media_t *	libvlc_media_new_as_node (libvlc_instance_t *p_instance, const char *psz_name, libvlc_exception_t *p_e)
	Create a media as an empty node with the passed name.
void	libvlc_media_add_option (libvlc_media_t *p_md, const char *ppsz_options, libvlc_exception_t *p_e)
	Add an option to the media.
void	libvlc_media_retain (libvlc_media_t *p_meta_desc)
	Retain a reference to a media descriptor object (libvlc_media_t).
void	libvlc_media_release (libvlc_media_t *p_meta_desc)
	Decrement the reference count of a media descriptor object.
char *	libvlc_media_get_mrl (libvlc_media_t *p_md, libvlc_exception_t *p_e)
	Get the media resource locator (mrl) from a media descriptor object.
libvlc_media_t *	libvlc_media_duplicate (libvlc_media_t *)
	Duplicate a media descriptor object.
char *	libvlc_media_get_meta (libvlc_media_t *p_meta_desc, libvlc_meta_t e_meta, libvlc_exception_t *p_e)
	Read the meta of the media.
libvlc_state_t	libvlc_media_get_state (libvlc_media_t *p_meta_desc, libvlc_exception_t *p_e)
	Get current state of media descriptor object.
libvlc_media_list_t *	libvlc_media_subitems (libvlc_media_t *p_md, libvlc_exception_t *p_e)
	Get subitems of media descriptor object.
libvlc_event_manager_t *	libvlc_media_event_manager (libvlc_media_t *p_md, libvlc_exception_t *p_e)
	Get event manager from media descriptor object.
libvlc_time_t	libvlc_media_get_duration (libvlc_media_t *p_md, libvlc_exception_t *p_e)
	Get duration of media descriptor object item.
int	libvlc_media_is_preparsed (libvlc_media_t *p_md, libvlc_exception_t *p_e)
	Get preparsed status for media descriptor object.
void	libvlc_media_set_user_data (libvlc_media_t *p_md, void *p_new_user_data, libvlc_exception_t *p_e)
	Sets media descriptor's user_data.
void *	libvlc_media_get_user_data (libvlc_media_t *p_md, libvlc_exception_t *p_e)
	Get media descriptor's user_data.

---

Detailed Description

LibVLC Media.

---

Typedef Documentation

typedef struct libvlc_media_t libvlc_media_t

---

Enumeration Type Documentation

enum libvlc_meta_t

defgroup libvlc_meta libvlc_meta

LibVLC Media Meta

Enumerator:

libvlc_meta_Title
libvlc_meta_Artist
libvlc_meta_Genre
libvlc_meta_Copyright
libvlc_meta_Album
libvlc_meta_TrackNumber
libvlc_meta_Description
libvlc_meta_Rating
libvlc_meta_Date
libvlc_meta_Setting
libvlc_meta_URL
libvlc_meta_Language
libvlc_meta_NowPlaying
libvlc_meta_Publisher
libvlc_meta_EncodedBy
libvlc_meta_ArtworkURL
libvlc_meta_TrackID

---

Function Documentation

void libvlc_media_add_option	(	libvlc_media_t *	p_md,
		const char *	ppsz_options,
		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"

Parameters:

	p_instance	the instance
	ppsz_options	the options (as a string)
	p_e	an initialized exception pointer

libvlc_media_t* libvlc_media_duplicate

(

libvlc_media_t *

)

Duplicate a media descriptor object.

Parameters:

p_meta_desc

a media descriptor object.

libvlc_event_manager_t* libvlc_media_event_manager	(	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.

Parameters:

	p_md	a media descriptor object
	p_e	an initialized exception object

Returns:

event manager object

libvlc_time_t libvlc_media_get_duration	(	libvlc_media_t *	p_md,
		libvlc_exception_t *	p_e
	)

Get duration of media descriptor object item.

Parameters:

	p_md	media descriptor object
	p_e	an initialized exception object

Returns:

duration of media item

char* libvlc_media_get_meta	(	libvlc_media_t *	p_meta_desc,
		libvlc_meta_t	e_meta,
		libvlc_exception_t *	p_e
	)

Read the meta of the media.

Parameters:

	p_meta_desc	the media to read
	e_meta_desc	the meta to read
	p_e	an initialized exception pointer

Returns:

the media's meta

char* libvlc_media_get_mrl	(	libvlc_media_t *	p_md,
		libvlc_exception_t *	p_e
	)

Get the media resource locator (mrl) from a media descriptor object.

Parameters:

	p_md	a media descriptor object
	p_e	an initialized exception object

Returns:

string with mrl of media descriptor object

libvlc_state_t libvlc_media_get_state	(	libvlc_media_t *	p_meta_desc,
		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 also:

libvlc_state_t

Parameters:

	p_meta_desc	a media descriptor object
	p_e	an initialized exception object

Returns:

state of media descriptor object

void* libvlc_media_get_user_data	(	libvlc_media_t *	p_md,
		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

Parameters:

	p_md	media descriptor object
	p_e	an initialized exception object

int libvlc_media_is_preparsed	(	libvlc_media_t *	p_md,
		libvlc_exception_t *	p_e
	)

Get preparsed status for media descriptor object.

Parameters:

	p_md	media descriptor object
	p_e	an initialized exception object

Returns:

true if media object has been preparsed otherwise it returns false

libvlc_media_t* libvlc_media_new	(	libvlc_instance_t *	p_instance,
		const char *	psz_mrl,
		libvlc_exception_t *	p_e
	)

Create a media with the given MRL.

Parameters:

	p_instance	the instance
	psz_mrl	the MRL to read
	p_e	an initialized exception pointer

Returns:

the newly created media

libvlc_media_t* libvlc_media_new_as_node	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		libvlc_exception_t *	p_e
	)

Create a media as an empty node with the passed name.

Parameters:

	p_instance	the instance
	psz_name	the name of the node
	p_e	an initialized exception pointer

Returns:

the new empty media

void libvlc_media_release

(

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.

Parameters:

p_meta_desc

a media descriptor object.

void libvlc_media_retain

(

libvlc_media_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.

Parameters:

p_meta_desc

a media descriptor object.

void libvlc_media_set_user_data	(	libvlc_media_t *	p_md,
		void *	p_new_user_data,
		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

Parameters:

	p_md	media descriptor object
	p_new_user_data	pointer to user data
	p_e	an initialized exception object

libvlc_media_list_t* libvlc_media_subitems	(	libvlc_media_t *	p_md,
		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.

Parameters:

	p_md	media descriptor object
	p_e	initalized exception object

Returns:

list of media descriptor subitems or NULL

---