/***************************************************************************** * libvlc_vlm.h: libvlc_* new external API ***************************************************************************** * Copyright (C) 1998-2008 the VideoLAN team * $Id: f09dbe506ef2f21b2d894e9086d91e11672bf2b9 $ * * Authors: Clément Stenac * Jean-Paul Saman * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ #ifndef LIBVLC_VLM_H #define LIBVLC_VLM_H 1 /** * \file * This file defines libvlc_vlm_* external API */ # ifdef __cplusplus extern "C" { # endif /***************************************************************************** * VLM *****************************************************************************/ /** \defgroup libvlc_vlm LibVLC VLM * \ingroup libvlc * @{ */ /** * Release the vlm instance related to the given libvlc_instance_t * * \param p_instance the instance */ VLC_PUBLIC_API void libvlc_vlm_release( libvlc_instance_t *p_instance ); /** * Add a broadcast, with one input. * * \param p_instance the instance * \param psz_name the name of the new broadcast * \param psz_input the input MRL * \param psz_output the output MRL (the parameter to the "sout" variable) * \param i_options number of additional options * \param ppsz_options additional options * \param b_enabled boolean for enabling the new broadcast * \param b_loop Should this broadcast be played in loop ? * \return 0 on success, -1 on error */ VLC_PUBLIC_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 vod, with one input. * * \param p_instance the instance * \param psz_name the name of the new vod media * \param psz_input the input MRL * \param i_options number of additional options * \param ppsz_options additional options * \param b_enabled boolean for enabling the new vod * \param psz_mux the muxer of the vod media * \return 0 on success, -1 on error */ VLC_PUBLIC_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 ); /** * Delete a media (VOD or broadcast). * * \param p_instance the instance * \param psz_name the media to delete * \return 0 on success, -1 on error */ VLC_PUBLIC_API int libvlc_vlm_del_media( libvlc_instance_t * p_instance, const char *psz_name ); /** * Enable or disable a media (VOD or broadcast). * * \param p_instance the instance * \param psz_name the media to work on * \param b_enabled the new status * \return 0 on success, -1 on error */ VLC_PUBLIC_API int libvlc_vlm_set_enabled( libvlc_instance_t *p_instance, const char *psz_name, int b_enabled ); /** * Set the output for a media. * * \param p_instance the instance * \param psz_name the media to work on * \param psz_output the output MRL (the parameter to the "sout" variable) * \return 0 on success, -1 on error */ VLC_PUBLIC_API int libvlc_vlm_set_output( libvlc_instance_t *p_instance, const char *psz_name, const char *psz_output ); /** * Set a media's input MRL. This will delete all existing inputs and * add the specified one. * * \param p_instance the instance * \param psz_name the media to work on * \param psz_input the input MRL * \return 0 on success, -1 on error */ VLC_PUBLIC_API int libvlc_vlm_set_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. * * \param p_instance the instance * \param psz_name the media to work on * \param psz_input the input MRL * \return 0 on success, -1 on error */ VLC_PUBLIC_API int libvlc_vlm_add_input( libvlc_instance_t *p_instance, const char *psz_name, const char *psz_input ); /** * Set a media's loop status. * * \param p_instance the instance * \param psz_name the media to work on * \param b_loop the new status * \return 0 on success, -1 on error */ VLC_PUBLIC_API int libvlc_vlm_set_loop( libvlc_instance_t *p_instance, const char *psz_name, int b_loop ); /** * Set a media's vod muxer. * * \param p_instance the instance * \param psz_name the media to work on * \param psz_mux the new muxer * \return 0 on success, -1 on error */ VLC_PUBLIC_API int libvlc_vlm_set_mux( libvlc_instance_t *p_instance, const char *psz_name, const char *psz_mux ); /** * Edit the parameters of a media. This will delete all existing inputs and * add the specified one. * * \param p_instance the instance * \param psz_name the name of the new broadcast * \param psz_input the input MRL * \param psz_output the output MRL (the parameter to the "sout" variable) * \param i_options number of additional options * \param ppsz_options additional options * \param b_enabled boolean for enabling the new broadcast * \param b_loop Should this broadcast be played in loop ? * \return 0 on success, -1 on error */ VLC_PUBLIC_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 ); /** * Play the named broadcast. * * \param p_instance the instance * \param psz_name the name of the broadcast * \return 0 on success, -1 on error */ VLC_PUBLIC_API int libvlc_vlm_play_media ( libvlc_instance_t *p_instance, const char *psz_name ); /** * Stop the named broadcast. * * \param p_instance the instance * \param psz_name the name of the broadcast * \return 0 on success, -1 on error */ VLC_PUBLIC_API int libvlc_vlm_stop_media ( libvlc_instance_t *p_instance, const char *psz_name ); /** * Pause the named broadcast. * * \param p_instance the instance * \param psz_name the name of the broadcast * \return 0 on success, -1 on error */ VLC_PUBLIC_API int libvlc_vlm_pause_media( libvlc_instance_t *p_instance, const char *psz_name ); /** * Seek in the named broadcast. * * \param p_instance the instance * \param psz_name the name of the broadcast * \param f_percentage the percentage to seek to * \return 0 on success, -1 on error */ VLC_PUBLIC_API int libvlc_vlm_seek_media( libvlc_instance_t *p_instance, const char *psz_name, float f_percentage ); /** * 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. * * \param p_instance the instance * \param psz_name the name of the media, * if the name is an empty string, all media is described * \return string with information about named media, or NULL on error */ VLC_PUBLIC_API const char* libvlc_vlm_show_media( libvlc_instance_t *p_instance, const char *psz_name ); /** * Get vlm_media instance position by name or instance id * * \param p_instance a libvlc instance * \param psz_name name of vlm media instance * \param i_instance instance id * \return position as float or -1. on error */ VLC_PUBLIC_API float libvlc_vlm_get_media_instance_position( libvlc_instance_t *p_instance, const char *psz_name, int i_instance ); /** * Get vlm_media instance time by name or instance id * * \param p_instance a libvlc instance * \param psz_name name of vlm media instance * \param i_instance instance id * \return time as integer or -1 on error */ VLC_PUBLIC_API int libvlc_vlm_get_media_instance_time( libvlc_instance_t *p_instance, const char *psz_name, int i_instance ); /** * Get vlm_media instance length by name or instance id * * \param p_instance a libvlc instance * \param psz_name name of vlm media instance * \param i_instance instance id * \return length of media item or -1 on error */ VLC_PUBLIC_API int libvlc_vlm_get_media_instance_length( libvlc_instance_t *p_instance, const char *psz_name, int i_instance ); /** * Get vlm_media instance playback rate by name or instance id * * \param p_instance a libvlc instance * \param psz_name name of vlm media instance * \param i_instance instance id * \return playback rate or -1 on error */ VLC_PUBLIC_API int libvlc_vlm_get_media_instance_rate( libvlc_instance_t *p_instance, const char *psz_name, int i_instance ); #if 0 /** * Get vlm_media instance title number by name or instance id * \bug will always return 0 * \param p_instance a libvlc instance * \param psz_name name of vlm media instance * \param i_instance instance id * \return title as number or -1 on error */ VLC_PUBLIC_API int libvlc_vlm_get_media_instance_title( libvlc_instance_t *, const char *, int ); /** * Get vlm_media instance chapter number by name or instance id * \bug will always return 0 * \param p_instance a libvlc instance * \param psz_name name of vlm media instance * \param i_instance instance id * \return chapter as number or -1 on error */ VLC_PUBLIC_API int libvlc_vlm_get_media_instance_chapter( libvlc_instance_t *, const char *, int ); /** * Is libvlc instance seekable ? * \bug will always return 0 * \param p_instance a libvlc instance * \param psz_name name of vlm media instance * \param i_instance instance id * \return 1 if seekable, 0 if not, -1 if media does not exist */ VLC_PUBLIC_API int libvlc_vlm_get_media_instance_seekable( libvlc_instance_t *, const char *, int ); #endif /** * Get libvlc_event_manager from a vlm media. * The p_event_manager is immutable, so you don't have to hold the lock * * \param p_instance a libvlc instance * \return libvlc_event_manager */ VLC_PUBLIC_API libvlc_event_manager_t * libvlc_vlm_get_event_manager( libvlc_instance_t *p_instance ); /** @} */ # ifdef __cplusplus } # endif #endif /* */