LibVLC VLM

Functions
LIBVLC_API void	libvlc_vlm_release (libvlc_instance_t *p_instance)
LIBVLC_API int	libvlc_vlm_add_broadcast (libvlc_instance_t *p_instance, const char *psz_name, const char *psz_input, const char *psz_output, int i_options, const char *const *ppsz_options, int b_enabled, int b_loop)
LIBVLC_API int	libvlc_vlm_add_vod (libvlc_instance_t *p_instance, const char *psz_name, const char *psz_input, int i_options, const char *const *ppsz_options, int b_enabled, const char *psz_mux)
LIBVLC_API int	libvlc_vlm_del_media (libvlc_instance_t *p_instance, const char *psz_name)
LIBVLC_API int	libvlc_vlm_set_enabled (libvlc_instance_t *p_instance, const char *psz_name, int b_enabled)
LIBVLC_API int	libvlc_vlm_set_output (libvlc_instance_t *p_instance, const char *psz_name, const char *psz_output)
LIBVLC_API int	libvlc_vlm_set_input (libvlc_instance_t *p_instance, const char *psz_name, const char *psz_input)
LIBVLC_API int	libvlc_vlm_add_input (libvlc_instance_t *p_instance, const char *psz_name, const char *psz_input)
LIBVLC_API int	libvlc_vlm_set_loop (libvlc_instance_t *p_instance, const char *psz_name, int b_loop)
LIBVLC_API int	libvlc_vlm_set_mux (libvlc_instance_t *p_instance, const char *psz_name, const char *psz_mux)
LIBVLC_API int	libvlc_vlm_change_media (libvlc_instance_t *p_instance, const char *psz_name, const char *psz_input, const char *psz_output, int i_options, const char *const *ppsz_options, int b_enabled, int b_loop)
LIBVLC_API int	libvlc_vlm_play_media (libvlc_instance_t *p_instance, const char *psz_name)
LIBVLC_API int	libvlc_vlm_stop_media (libvlc_instance_t *p_instance, const char *psz_name)
LIBVLC_API int	libvlc_vlm_pause_media (libvlc_instance_t *p_instance, const char *psz_name)
LIBVLC_API int	libvlc_vlm_seek_media (libvlc_instance_t *p_instance, const char *psz_name, float f_percentage)
LIBVLC_API const char *	libvlc_vlm_show_media (libvlc_instance_t *p_instance, const char *psz_name)
LIBVLC_API float	libvlc_vlm_get_media_instance_position (libvlc_instance_t *p_instance, const char *psz_name, int i_instance)
LIBVLC_API int	libvlc_vlm_get_media_instance_time (libvlc_instance_t *p_instance, const char *psz_name, int i_instance)
LIBVLC_API int	libvlc_vlm_get_media_instance_length (libvlc_instance_t *p_instance, const char *psz_name, int i_instance)
LIBVLC_API int	libvlc_vlm_get_media_instance_rate (libvlc_instance_t *p_instance, const char *psz_name, int i_instance)
LIBVLC_API libvlc_event_manager_t *	libvlc_vlm_get_event_manager (libvlc_instance_t *p_instance)

Detailed Description

Function Documentation

LIBVLC_API int libvlc_vlm_add_broadcast	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		const char *	psz_input,
		const char *	psz_output,
		int	i_options,
		const char *const *	ppsz_options,
		int	b_enabled,
		int	b_loop
	)

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 ?

Returns

0 on success, -1 on error

LIBVLC_API int libvlc_vlm_add_input	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		const char *	psz_input
	)

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

Returns

0 on success, -1 on error

LIBVLC_API int libvlc_vlm_add_vod	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		const char *	psz_input,
		int	i_options,
		const char *const *	ppsz_options,
		int	b_enabled,
		const char *	psz_mux
	)

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

Returns

0 on success, -1 on error

LIBVLC_API int libvlc_vlm_change_media	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		const char *	psz_input,
		const char *	psz_output,
		int	i_options,
		const char *const *	ppsz_options,
		int	b_enabled,
		int	b_loop
	)

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 ?

Returns

0 on success, -1 on error

LIBVLC_API int libvlc_vlm_del_media	(	libvlc_instance_t *	p_instance,
		const char *	psz_name
	)

Delete a media (VOD or broadcast).

Parameters

p_instance	the instance
psz_name	the media to delete

Returns

0 on success, -1 on error

LIBVLC_API libvlc_event_manager_t* libvlc_vlm_get_event_manager

(

libvlc_instance_t *

p_instance

)

Get libvlc_event_manager from a vlm media. The p_event_manager is immutable, so you don't have to hold the lock

Parameters

p_instance

a libvlc instance

Returns

libvlc_event_manager

LIBVLC_API int libvlc_vlm_get_media_instance_length	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		int	i_instance
	)

Get vlm_media instance length by name or instance id

Parameters

p_instance	a libvlc instance
psz_name	name of vlm media instance
i_instance	instance id

Returns

length of media item or -1 on error

LIBVLC_API float libvlc_vlm_get_media_instance_position	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		int	i_instance
	)

Get vlm_media instance position by name or instance id

Parameters

p_instance	a libvlc instance
psz_name	name of vlm media instance
i_instance	instance id

Returns

position as float or -1. on error

LIBVLC_API int libvlc_vlm_get_media_instance_rate	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		int	i_instance
	)

Get vlm_media instance playback rate by name or instance id

Parameters

p_instance	a libvlc instance
psz_name	name of vlm media instance
i_instance	instance id

Returns

playback rate or -1 on error

LIBVLC_API int libvlc_vlm_get_media_instance_time	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		int	i_instance
	)

Get vlm_media instance time by name or instance id

Parameters

p_instance	a libvlc instance
psz_name	name of vlm media instance
i_instance	instance id

Returns

time as integer or -1 on error

LIBVLC_API int libvlc_vlm_pause_media	(	libvlc_instance_t *	p_instance,
		const char *	psz_name
	)

Pause the named broadcast.

Parameters

p_instance	the instance
psz_name	the name of the broadcast

Returns

0 on success, -1 on error

LIBVLC_API int libvlc_vlm_play_media	(	libvlc_instance_t *	p_instance,
		const char *	psz_name
	)

Play the named broadcast.

Parameters

p_instance	the instance
psz_name	the name of the broadcast

Returns

0 on success, -1 on error

LIBVLC_API void libvlc_vlm_release

(

libvlc_instance_t *

p_instance

)

Release the vlm instance related to the given libvlc_instance_t

Parameters

p_instance

the instance

LIBVLC_API int libvlc_vlm_seek_media	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		float	f_percentage
	)

Seek in the named broadcast.

Parameters

p_instance	the instance
psz_name	the name of the broadcast
f_percentage	the percentage to seek to

Returns

0 on success, -1 on error

LIBVLC_API int libvlc_vlm_set_enabled	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		int	b_enabled
	)

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

Returns

0 on success, -1 on error

LIBVLC_API int libvlc_vlm_set_input	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		const char *	psz_input
	)

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

Returns

0 on success, -1 on error

LIBVLC_API int libvlc_vlm_set_loop	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		int	b_loop
	)

Set a media's loop status.

Parameters

p_instance	the instance
psz_name	the media to work on
b_loop	the new status

Returns

0 on success, -1 on error

LIBVLC_API int libvlc_vlm_set_mux	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		const char *	psz_mux
	)

Set a media's vod muxer.

Parameters

p_instance	the instance
psz_name	the media to work on
psz_mux	the new muxer

Returns

0 on success, -1 on error

LIBVLC_API int libvlc_vlm_set_output	(	libvlc_instance_t *	p_instance,
		const char *	psz_name,
		const char *	psz_output
	)

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)

Returns

0 on success, -1 on error

LIBVLC_API const char* libvlc_vlm_show_media	(	libvlc_instance_t *	p_instance,
		const char *	psz_name
	)

Return information about the named media as a JSON string representation.

This function is mainly intended for debugging use, if you want programmatic access to the state of a vlm_media_instance_t, please use the corresponding libvlc_vlm_get_media_instance_xxx -functions. Currently there are no such functions available for vlm_media_t though.

Parameters

p_instance	the instance
psz_name	the name of the media, if the name is an empty string, all media is described

Returns

string with information about named media, or NULL on error

LIBVLC_API int libvlc_vlm_stop_media	(	libvlc_instance_t *	p_instance,
		const char *	psz_name
	)

Stop the named broadcast.

Parameters

p_instance	the instance
psz_name	the name of the broadcast

Returns

0 on success, -1 on error