libvlc_vlm
[libvlc]

Collaboration diagram for libvlc_vlm:

LibVLC VLM. More...

Defines
#define	LIBVLC_VLM_GET_MEDIA_ATTRIBUTE(attr, returnType, getType, default)
	Get information about media attribute from vlm.
Functions
VLC_PUBLIC_API void	libvlc_vlm_release (libvlc_instance_t *, libvlc_exception_t *)
	Release the vlm instance related to the given libvlc_instance_t.
VLC_PUBLIC_API void	libvlc_vlm_add_broadcast (libvlc_instance_t *, char *, char *, char *, int, char **, int, int, libvlc_exception_t *)
	Add a broadcast, with one input.
VLC_PUBLIC_API void	libvlc_vlm_add_vod (libvlc_instance_t *, char *, char *, int, char **, int, char *, libvlc_exception_t *)
	Add a vod, with one input.
VLC_PUBLIC_API void	libvlc_vlm_del_media (libvlc_instance_t *, char *, libvlc_exception_t *)
	Delete a media (VOD or broadcast).
VLC_PUBLIC_API void	libvlc_vlm_set_enabled (libvlc_instance_t *, char *, int, libvlc_exception_t *)
	Enable or disable a media (VOD or broadcast).
VLC_PUBLIC_API void	libvlc_vlm_set_output (libvlc_instance_t *, char *, char *, libvlc_exception_t *)
	Set the output for a media.
VLC_PUBLIC_API void	libvlc_vlm_set_input (libvlc_instance_t *, char *, char *, libvlc_exception_t *)
	Set a media's input MRL.
VLC_PUBLIC_API void	libvlc_vlm_add_input (libvlc_instance_t *, char *, char *, libvlc_exception_t *p_exception)
	Add a media's input MRL.
VLC_PUBLIC_API void	libvlc_vlm_set_loop (libvlc_instance_t *, char *, int, libvlc_exception_t *)
	Set a media's loop status.
VLC_PUBLIC_API void	libvlc_vlm_set_mux (libvlc_instance_t *p_instance, char *psz_name, char *psz_mux, libvlc_exception_t *p_exception)
	Set a media's vod muxer.
VLC_PUBLIC_API void	libvlc_vlm_change_media (libvlc_instance_t *, char *, char *, char *, int, char **, int, int, libvlc_exception_t *)
	Edit the parameters of a media.
VLC_PUBLIC_API void	libvlc_vlm_play_media (libvlc_instance_t *, char *, libvlc_exception_t *)
	Play the named broadcast.
VLC_PUBLIC_API void	libvlc_vlm_stop_media (libvlc_instance_t *, char *, libvlc_exception_t *)
	Stop the named broadcast.
VLC_PUBLIC_API void	libvlc_vlm_pause_media (libvlc_instance_t *, char *, libvlc_exception_t *)
	Pause the named broadcast.
VLC_PUBLIC_API void	libvlc_vlm_seek_media (libvlc_instance_t *, char *, float, libvlc_exception_t *)
	Seek in the named broadcast.
VLC_PUBLIC_API char *	libvlc_vlm_show_media (libvlc_instance_t *, char *, libvlc_exception_t *)
	Return information about the named broadcast.
VLC_PUBLIC_API float	libvlc_vlm_get_media_instance_position (libvlc_instance_t *, char *, int, libvlc_exception_t *)
VLC_PUBLIC_API int	libvlc_vlm_get_media_instance_time (libvlc_instance_t *, char *, int, libvlc_exception_t *)
VLC_PUBLIC_API int	libvlc_vlm_get_media_instance_length (libvlc_instance_t *, char *, int, libvlc_exception_t *)
VLC_PUBLIC_API int	libvlc_vlm_get_media_instance_rate (libvlc_instance_t *, char *, int, libvlc_exception_t *)
VLC_PUBLIC_API int	libvlc_vlm_get_media_instance_title (libvlc_instance_t *, char *, int, libvlc_exception_t *)
VLC_PUBLIC_API int	libvlc_vlm_get_media_instance_chapter (libvlc_instance_t *, char *, int, libvlc_exception_t *)
VLC_PUBLIC_API int	libvlc_vlm_get_media_instance_seekable (libvlc_instance_t *, char *, int, libvlc_exception_t *)

---

Detailed Description

LibVLC VLM.

---

Define Documentation

#define LIBVLC_VLM_GET_MEDIA_ATTRIBUTE	(	attr,
		returnType,
		getType,
		default		)

Value:

returnType libvlc_vlm_get_media_instance_## attr( libvlc_instance_t *, \
                        char *, int , libvlc_exception_t * );

Get information about media attribute from vlm.

Parameters:

	libvlc	instance
	type	of information
	default	value

Returns:

value of media attribute

---

Function Documentation

VLC_PUBLIC_API void libvlc_vlm_add_broadcast	(	libvlc_instance_t *	,
		char *	,
		char *	,
		char *	,
		int	,
		char **	,
		int	,
		int	,
		libvlc_exception_t *
	)

Add a broadcast, with one input.

Parameters:

	p_instance	the instance
	psz_name	the name of the new broadcast
	psz_input	the input MRL
	psz_output	the output MRL (the parameter to the "sout" variable)
	i_options	number of additional options
	ppsz_options	additional options
	b_enabled	boolean for enabling the new broadcast
	b_loop	Should this broadcast be played in loop ?
	p_e	an initialized exception pointer

VLC_PUBLIC_API void libvlc_vlm_add_input	(	libvlc_instance_t *	,
		char *	,
		char *	,
		libvlc_exception_t *	p_exception
	)

Add a media's input MRL.

This will add the specified one.

Parameters:

	p_instance	the instance
	psz_name	the media to work on
	psz_input	the input MRL
	p_e	an initialized exception pointer

VLC_PUBLIC_API void libvlc_vlm_add_vod	(	libvlc_instance_t *	,
		char *	,
		char *	,
		int	,
		char **	,
		int	,
		char *	,
		libvlc_exception_t *
	)

Add a vod, with one input.

Parameters:

	p_instance	the instance
	psz_name	the name of the new vod media
	psz_input	the input MRL
	i_options	number of additional options
	ppsz_options	additional options
	b_enabled	boolean for enabling the new vod
	psz_mux	the muxer of the vod media
	p_e	an initialized exception pointer

VLC_PUBLIC_API void libvlc_vlm_change_media	(	libvlc_instance_t *	,
		char *	,
		char *	,
		char *	,
		int	,
		char **	,
		int	,
		int	,
		libvlc_exception_t *
	)

Edit the parameters of a media.

This will delete all existing inputs and add the specified one.

Parameters:

	p_instance	the instance
	psz_name	the name of the new broadcast
	psz_input	the input MRL
	psz_output	the output MRL (the parameter to the "sout" variable)
	i_options	number of additional options
	ppsz_options	additional options
	b_enabled	boolean for enabling the new broadcast
	b_loop	Should this broadcast be played in loop ?
	p_e	an initialized exception pointer

VLC_PUBLIC_API void libvlc_vlm_del_media	(	libvlc_instance_t *	,
		char *	,
		libvlc_exception_t *
	)

Delete a media (VOD or broadcast).

Parameters:

	p_instance	the instance
	psz_name	the media to delete
	p_e	an initialized exception pointer

VLC_PUBLIC_API int libvlc_vlm_get_media_instance_chapter	(	libvlc_instance_t *	,
		char *	,
		int	,
		libvlc_exception_t *
	)

VLC_PUBLIC_API int libvlc_vlm_get_media_instance_length	(	libvlc_instance_t *	,
		char *	,
		int	,
		libvlc_exception_t *
	)

VLC_PUBLIC_API float libvlc_vlm_get_media_instance_position	(	libvlc_instance_t *	,
		char *	,
		int	,
		libvlc_exception_t *
	)

VLC_PUBLIC_API int libvlc_vlm_get_media_instance_rate	(	libvlc_instance_t *	,
		char *	,
		int	,
		libvlc_exception_t *
	)

VLC_PUBLIC_API int libvlc_vlm_get_media_instance_seekable	(	libvlc_instance_t *	,
		char *	,
		int	,
		libvlc_exception_t *
	)

VLC_PUBLIC_API int libvlc_vlm_get_media_instance_time	(	libvlc_instance_t *	,
		char *	,
		int	,
		libvlc_exception_t *
	)

VLC_PUBLIC_API int libvlc_vlm_get_media_instance_title	(	libvlc_instance_t *	,
		char *	,
		int	,
		libvlc_exception_t *
	)

VLC_PUBLIC_API void libvlc_vlm_pause_media	(	libvlc_instance_t *	,
		char *	,
		libvlc_exception_t *
	)

Pause the named broadcast.

Parameters:

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

VLC_PUBLIC_API void libvlc_vlm_play_media	(	libvlc_instance_t *	,
		char *	,
		libvlc_exception_t *
	)

Play the named broadcast.

Parameters:

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

VLC_PUBLIC_API void libvlc_vlm_release	(	libvlc_instance_t *	,
		libvlc_exception_t *
	)

Release the vlm instance related to the given libvlc_instance_t.

Parameters:

	p_instance	the instance
	p_e	an initialized exception pointer

VLC_PUBLIC_API void libvlc_vlm_seek_media	(	libvlc_instance_t *	,
		char *	,
		float	,
		libvlc_exception_t *
	)

Seek in the named broadcast.

Parameters:

	p_instance	the instance
	psz_name	the name of the broadcast
	f_percentage	the percentage to seek to
	p_e	an initialized exception pointer

VLC_PUBLIC_API void libvlc_vlm_set_enabled	(	libvlc_instance_t *	,
		char *	,
		int	,
		libvlc_exception_t *
	)

Enable or disable a media (VOD or broadcast).

Parameters:

	p_instance	the instance
	psz_name	the media to work on
	b_enabled	the new status
	p_e	an initialized exception pointer

VLC_PUBLIC_API void libvlc_vlm_set_input	(	libvlc_instance_t *	,
		char *	,
		char *	,
		libvlc_exception_t *
	)

Set a media's input MRL.

This will delete all existing inputs and add the specified one.

Parameters:

	p_instance	the instance
	psz_name	the media to work on
	psz_input	the input MRL
	p_e	an initialized exception pointer

VLC_PUBLIC_API void libvlc_vlm_set_loop	(	libvlc_instance_t *	,
		char *	,
		int	,
		libvlc_exception_t *
	)

Set a media's loop status.

Parameters:

	p_instance	the instance
	psz_name	the media to work on
	b_loop	the new status
	p_e	an initialized exception pointer

VLC_PUBLIC_API void libvlc_vlm_set_mux	(	libvlc_instance_t *	p_instance,
		char *	psz_name,
		char *	psz_mux,
		libvlc_exception_t *	p_exception
	)

Set a media's vod muxer.

Parameters:

	p_instance	the instance
	psz_name	the media to work on
	psz_mux	the new muxer
	p_e	an initialized exception pointer

VLC_PUBLIC_API void libvlc_vlm_set_output	(	libvlc_instance_t *	,
		char *	,
		char *	,
		libvlc_exception_t *
	)

Set the output for a media.

Parameters:

	p_instance	the instance
	psz_name	the media to work on
	psz_output	the output MRL (the parameter to the "sout" variable)
	p_e	an initialized exception pointer

VLC_PUBLIC_API char* libvlc_vlm_show_media	(	libvlc_instance_t *	,
		char *	,
		libvlc_exception_t *
	)

Return information about the named broadcast.

Parameters:

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

Returns:

string with information about named media

VLC_PUBLIC_API void libvlc_vlm_stop_media	(	libvlc_instance_t *	,
		char *	,
		libvlc_exception_t *
	)

Stop the named broadcast.

Parameters:

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

---