libvlc_media_library
[libvlc]

Collaboration diagram for libvlc_media_library:

LibVLC Media Library. More...

Typedefs
typedef struct libvlc_media_library_t	libvlc_media_library_t
Functions
VLC_PUBLIC_API libvlc_media_library_t *	libvlc_media_library_new (libvlc_instance_t *p_inst, libvlc_exception_t *p_e)
	Create an new Media Library object.
VLC_PUBLIC_API void	libvlc_media_library_release (libvlc_media_library_t *p_mlib)
	Release media library object.
VLC_PUBLIC_API void	libvlc_media_library_retain (libvlc_media_library_t *p_mlib)
	Retain a reference to a media library object.
VLC_PUBLIC_API void	libvlc_media_library_load (libvlc_media_library_t *p_mlib, libvlc_exception_t *p_e)
	Load media library.
VLC_PUBLIC_API void	libvlc_media_library_save (libvlc_media_library_t *p_mlib, libvlc_exception_t *p_e)
	Save media library.
VLC_PUBLIC_API libvlc_media_list_t *	libvlc_media_library_media_list (libvlc_media_library_t *p_mlib, libvlc_exception_t *p_e)
	Get media library subitems.

---

Detailed Description

LibVLC Media Library.

---

Typedef Documentation

typedef struct libvlc_media_library_t libvlc_media_library_t

---

Function Documentation

VLC_PUBLIC_API void libvlc_media_library_load	(	libvlc_media_library_t *	p_mlib,
		libvlc_exception_t *	p_e
	)

Load media library.

Parameters:

	p_mlib	media library object
	p_e	an initialized exception object.

References asprintf(), config_GetUserDir(), DIR_SEP, libvlc_exception_raise(), libvlc_media_list_add_file_content(), libvlc_media_list_new(), libvlc_media_list_release(), libvlc_printerr(), libvlc_media_library_t::p_libvlc_instance, libvlc_media_library_t::p_mlist, and VLC_DATA_DIR.

VLC_PUBLIC_API libvlc_media_list_t* libvlc_media_library_media_list	(	libvlc_media_library_t *	p_mlib,
		libvlc_exception_t *	p_e
	)

Get media library subitems.

Parameters:

	p_mlib	media library object
	p_e	an initialized exception object.

Returns:

media list subitems

References libvlc_media_list_retain(), and libvlc_media_library_t::p_mlist.

VLC_PUBLIC_API libvlc_media_library_t* libvlc_media_library_new	(	libvlc_instance_t *	p_inst,
		libvlc_exception_t *	p_e
	)

Create an new Media Library object.

Parameters:

	p_libvlc_instance	the libvlc instance
	p_e	an initialized exception pointer

References libvlc_media_library_t::i_refcount, libvlc_event_manager_new(), libvlc_media_library_t::p_event_manager, libvlc_media_library_t::p_libvlc_instance, and libvlc_media_library_t::p_mlist.

VLC_PUBLIC_API void libvlc_media_library_release

(

libvlc_media_library_t *

p_mlib

)

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.

Parameters:

p_mlib

media library object

References libvlc_media_library_t::i_refcount, libvlc_event_manager_release(), and libvlc_media_library_t::p_event_manager.

VLC_PUBLIC_API void libvlc_media_library_retain

(

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.

Parameters:

p_mlib

media library object

References libvlc_media_library_t::i_refcount.

VLC_PUBLIC_API void libvlc_media_library_save	(	libvlc_media_library_t *	p_mlib,
		libvlc_exception_t *	p_e
	)

Save media library.

Parameters:

	p_mlib	media library object
	p_e	an initialized exception object.

References libvlc_exception_raise(), and libvlc_printerr().