libvlc_vlm
[libvlc]

Collaboration diagram for libvlc_vlm:
LibVLC VLM. More...

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 *, const char *, const char *, const char *, int, const char *const *, int, int, libvlc_exception_t *)
 Add a broadcast, with one input.
VLC_PUBLIC_API void libvlc_vlm_add_vod (libvlc_instance_t *, const char *, const char *, int, const char *const *, int, const char *, libvlc_exception_t *)
 Add a vod, with one input.
VLC_PUBLIC_API void libvlc_vlm_del_media (libvlc_instance_t *, const char *, libvlc_exception_t *)
 Delete a media (VOD or broadcast).
VLC_PUBLIC_API void libvlc_vlm_set_enabled (libvlc_instance_t *, const char *, int, libvlc_exception_t *)
 Enable or disable a media (VOD or broadcast).
VLC_PUBLIC_API void libvlc_vlm_set_output (libvlc_instance_t *, const char *, const char *, libvlc_exception_t *)
 Set the output for a media.
VLC_PUBLIC_API void libvlc_vlm_set_input (libvlc_instance_t *, const char *, const char *, libvlc_exception_t *)
 Set a media's input MRL.
VLC_PUBLIC_API void libvlc_vlm_add_input (libvlc_instance_t *, const char *, const char *, libvlc_exception_t *)
 Add a media's input MRL.
VLC_PUBLIC_API void libvlc_vlm_set_loop (libvlc_instance_t *, const char *, int, libvlc_exception_t *)
 Set a media's loop status.
VLC_PUBLIC_API void libvlc_vlm_set_mux (libvlc_instance_t *, const char *, const char *, libvlc_exception_t *)
 Set a media's vod muxer.
VLC_PUBLIC_API void libvlc_vlm_change_media (libvlc_instance_t *, const char *, const char *, const char *, int, const char *const *, int, int, libvlc_exception_t *)
 Edit the parameters of a media.
VLC_PUBLIC_API void libvlc_vlm_play_media (libvlc_instance_t *, const char *, libvlc_exception_t *)
 Play the named broadcast.
VLC_PUBLIC_API void libvlc_vlm_stop_media (libvlc_instance_t *, const char *, libvlc_exception_t *)
 Stop the named broadcast.
VLC_PUBLIC_API void libvlc_vlm_pause_media (libvlc_instance_t *, const char *, libvlc_exception_t *)
 Pause the named broadcast.
VLC_PUBLIC_API void libvlc_vlm_seek_media (libvlc_instance_t *, const char *, float, libvlc_exception_t *)
 Seek in the named broadcast.
VLC_PUBLIC_API const char * libvlc_vlm_show_media (libvlc_instance_t *, const char *, libvlc_exception_t *)
 Return information about the named media as a JSON string representation.
VLC_PUBLIC_API float libvlc_vlm_get_media_instance_position (libvlc_instance_t *, const char *, int, libvlc_exception_t *)
 Get vlm_media instance position by name or instance id.
VLC_PUBLIC_API int libvlc_vlm_get_media_instance_time (libvlc_instance_t *, const char *, int, libvlc_exception_t *)
 Get vlm_media instance time by name or instance id.
VLC_PUBLIC_API int libvlc_vlm_get_media_instance_length (libvlc_instance_t *, const char *, int, libvlc_exception_t *)
 Get vlm_media instance length by name or instance id.
VLC_PUBLIC_API int libvlc_vlm_get_media_instance_rate (libvlc_instance_t *, const char *, int, libvlc_exception_t *)
 Get vlm_media instance playback rate by name or instance id.
VLC_PUBLIC_API int libvlc_vlm_get_media_instance_title (libvlc_instance_t *, const char *, int, libvlc_exception_t *)
 Get vlm_media instance title number by name or instance id.
VLC_PUBLIC_API int libvlc_vlm_get_media_instance_chapter (libvlc_instance_t *, const char *, int, libvlc_exception_t *)
 Get vlm_media instance chapter number by name or instance id.
VLC_PUBLIC_API int libvlc_vlm_get_media_instance_seekable (libvlc_instance_t *, const char *, int, libvlc_exception_t *)
 Is libvlc instance seekable ?
VLC_PUBLIC_API
libvlc_event_manager_t * 		libvlc_vlm_get_event_manager (libvlc_instance_t *, libvlc_exception_t *)
 Get libvlc_event_manager from a vlm media.

Detailed Description

LibVLC VLM.

Function Documentation

VLC_PUBLIC_API void libvlc_vlm_add_broadcast ( libvlc_instance_t *  ,
const char *  ,
const char *  ,
const char *  ,
int  ,
const char *const *  ,
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

References vlm_media_t::b_enabled, vlm_media_t::b_loop, vlm_media_t::b_vod, vlm_media_t::broadcast, vlm_media_t::i_input, vlm_media_t::i_option, libvlc_exception_raise(), libvlc_printerr(), vlm_media_t::ppsz_input, vlm_media_t::ppsz_option, vlm_media_t::psz_name, vlm_media_t::psz_output, strdup(), TAB_APPEND, VLM, VLM_ADD_MEDIA, vlm_Control(), vlm_media_Clean(), and vlm_media_Init().

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

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

References VLM_CHANGE, and VLM_CHANGE_CODE.

VLC_PUBLIC_API void libvlc_vlm_add_vod ( libvlc_instance_t *  ,
const char *  ,
const char *  ,
int  ,
const char *const *  ,
int  ,
const 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

References vlm_media_t::b_enabled, vlm_media_t::b_vod, vlm_media_t::i_input, vlm_media_t::i_option, libvlc_exception_raise(), libvlc_printerr(), vlm_media_t::ppsz_input, vlm_media_t::ppsz_option, vlm_media_t::psz_mux, vlm_media_t::psz_name, strdup(), TAB_APPEND, VLM, VLM_ADD_MEDIA, vlm_Control(), vlm_media_Clean(), vlm_media_Init(), and vlm_media_t::vod.

VLC_PUBLIC_API void libvlc_vlm_change_media ( libvlc_instance_t *  ,
const char *  ,
const char *  ,
const char *  ,
int  ,
const char *const *  ,
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

References VLM_CHANGE, and VLM_CHANGE_CODE.

VLC_PUBLIC_API void libvlc_vlm_del_media ( libvlc_instance_t *  ,
const 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

References libvlc_exception_raise(), libvlc_printerr(), VLM, vlm_Control(), VLM_DEL_MEDIA, and VLM_GET_MEDIA_ID.

VLC_PUBLIC_API libvlc_event_manager_t* libvlc_vlm_get_event_manager ( libvlc_instance_t *  ,
libvlc_exception_t *   
)

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
p_exception an initialized exception pointer
Returns:
libvlc_event_manager

References libvlc_instance_t::libvlc_vlm, libvlc_vlm_t::p_event_manager, and VLM_RET.

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

Get vlm_media instance chapter number by name or instance id.

Bug:
will always return 0
Parameters:
p_instance a libvlc instance
psz_name name of vlm media instance
i_instance instance id
p_e an initialized exception pointer
Returns:
chapter as number

References libvlc_vlm_get_media_instance(), and vlm_media_instance_Delete().

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

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
p_e an initialized exception pointer
Returns:
length of media item

References vlm_media_instance_t::i_length, libvlc_vlm_get_media_instance(), and vlm_media_instance_Delete().

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

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
p_e an initialized exception pointer
Returns:
position as float

References vlm_media_instance_t::d_position, libvlc_vlm_get_media_instance(), and vlm_media_instance_Delete().

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

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
p_e an initialized exception pointer
Returns:
playback rate

References vlm_media_instance_t::i_rate, libvlc_vlm_get_media_instance(), and vlm_media_instance_Delete().

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

Is libvlc instance seekable ?

Bug:
will always return 0
Parameters:
p_instance a libvlc instance
psz_name name of vlm media instance
i_instance instance id
p_e an initialized exception pointer
Returns:
1 if seekable, 0 if not

References libvlc_vlm_get_media_instance(), and vlm_media_instance_Delete().

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

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
p_e an initialized exception pointer
Returns:
time as integer

References vlm_media_instance_t::i_time, libvlc_vlm_get_media_instance(), and vlm_media_instance_Delete().

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

Get vlm_media instance title number by name or instance id.

Bug:
will always return 0
Parameters:
p_instance a libvlc instance
psz_name name of vlm media instance
i_instance instance id
p_e an initialized exception pointer
Returns:
title as number

References libvlc_vlm_get_media_instance(), and vlm_media_instance_Delete().

VLC_PUBLIC_API void libvlc_vlm_pause_media ( libvlc_instance_t *  ,
const 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

References libvlc_exception_raise(), libvlc_printerr(), VLM, vlm_Control(), VLM_GET_MEDIA_ID, and VLM_PAUSE_MEDIA_INSTANCE.

VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *  ,
const 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

References libvlc_exception_raise(), libvlc_printerr(), VLM, vlm_Control(), VLM_GET_MEDIA_ID, and VLM_START_MEDIA_BROADCAST_INSTANCE.

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

References libvlc_vlm_release_internal(), and VLC_UNUSED.

VLC_PUBLIC_API void libvlc_vlm_seek_media ( libvlc_instance_t *  ,
const 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

References libvlc_exception_raise(), libvlc_printerr(), VLM, vlm_Control(), VLM_GET_MEDIA_ID, and VLM_SET_MEDIA_INSTANCE_POSITION.

VLC_PUBLIC_API void libvlc_vlm_set_enabled ( libvlc_instance_t *  ,
const 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

References VLM_CHANGE, and VLM_CHANGE_CODE.

VLC_PUBLIC_API void libvlc_vlm_set_input ( libvlc_instance_t *  ,
const char *  ,
const 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

References VLM_CHANGE, and VLM_CHANGE_CODE.

VLC_PUBLIC_API void libvlc_vlm_set_loop ( libvlc_instance_t *  ,
const 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

References VLM_CHANGE, and VLM_CHANGE_CODE.

VLC_PUBLIC_API void libvlc_vlm_set_mux ( libvlc_instance_t *  ,
const char *  ,
const char *  ,
libvlc_exception_t *   
)

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

References VLM_CHANGE, and VLM_CHANGE_CODE.

VLC_PUBLIC_API void libvlc_vlm_set_output ( libvlc_instance_t *  ,
const char *  ,
const 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

References VLM_CHANGE, and VLM_CHANGE_CODE.

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

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
p_e an initialized exception pointer
Returns:
string with information about named media

References asprintf(), vlm_message_t::child, libvlc_exception_raise(), libvlc_printerr(), vlm_message_t::psz_value, recurse_answer(), vlm_ExecuteCommand(), and VLM_RET.

VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *  ,
const 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

References libvlc_exception_raise(), libvlc_printerr(), VLM, vlm_Control(), VLM_GET_MEDIA_ID, and VLM_STOP_MEDIA_INSTANCE.

Generated on Sat Nov 7 08:06:07 2009 for VLC by  doxygen 1.5.6