libvlc_vlm.h
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:12k
源码类别:

midi

开发平台:

Unix_Linux

  1. /*****************************************************************************
  2.  * libvlc_vlm.h:  libvlc_* new external API
  3.  *****************************************************************************
  4.  * Copyright (C) 1998-2008 the VideoLAN team
  5.  * $Id: c3305badee3758f50ad4e5053ff1c7db8648157a $
  6.  *
  7.  * Authors: Clément Stenac <zorglub@videolan.org>
  8.  *          Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
  9.  *
  10.  * This program is free software; you can redistribute it and/or modify
  11.  * it under the terms of the GNU General Public License as published by
  12.  * the Free Software Foundation; either version 2 of the License, or
  13.  * (at your option) any later version.
  14.  *
  15.  * This program is distributed in the hope that it will be useful,
  16.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18.  * GNU General Public License for more details.
  19.  *
  20.  * You should have received a copy of the GNU General Public License
  21.  * along with this program; if not, write to the Free Software
  22.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23.  *****************************************************************************/
  24. #ifndef LIBVLC_VLM_H
  25. #define LIBVLC_VLM_H 1
  26. /**
  27.  * file
  28.  * This file defines libvlc_vlm_* external API
  29.  */
  30. # ifdef __cplusplus
  31. extern "C" {
  32. # endif
  33. /*****************************************************************************
  34.  * VLM
  35.  *****************************************************************************/
  36. /** defgroup libvlc_vlm libvlc_vlm
  37.  * ingroup libvlc
  38.  * LibVLC VLM
  39.  * @{
  40.  */
  41. /**
  42.  * Release the vlm instance related to the given libvlc_instance_t
  43.  *
  44.  * param p_instance the instance
  45.  * param p_e an initialized exception pointer
  46.  */
  47. VLC_PUBLIC_API void libvlc_vlm_release( libvlc_instance_t *, libvlc_exception_t * );
  48. /**
  49.  * Add a broadcast, with one input.
  50.  *
  51.  * param p_instance the instance
  52.  * param psz_name the name of the new broadcast
  53.  * param psz_input the input MRL
  54.  * param psz_output the output MRL (the parameter to the "sout" variable)
  55.  * param i_options number of additional options
  56.  * param ppsz_options additional options
  57.  * param b_enabled boolean for enabling the new broadcast
  58.  * param b_loop Should this broadcast be played in loop ?
  59.  * param p_e an initialized exception pointer
  60.  */
  61. VLC_PUBLIC_API void libvlc_vlm_add_broadcast( libvlc_instance_t *,
  62.                                               const char *, const char *,
  63.                                               const char * , int,
  64.                                               const char * const*,
  65.                                               int, int,
  66.                                               libvlc_exception_t * );
  67. /**
  68.  * Add a vod, with one input.
  69.  *
  70.  * param p_instance the instance
  71.  * param psz_name the name of the new vod media
  72.  * param psz_input the input MRL
  73.  * param i_options number of additional options
  74.  * param ppsz_options additional options
  75.  * param b_enabled boolean for enabling the new vod
  76.  * param psz_mux the muxer of the vod media
  77.  * param p_e an initialized exception pointer
  78.  */
  79. VLC_PUBLIC_API void libvlc_vlm_add_vod( libvlc_instance_t *,
  80.                                         const char *, const char *,
  81.                                         int, const char * const*,
  82.                                         int, const char *,
  83.                                         libvlc_exception_t * );
  84. /**
  85.  * Delete a media (VOD or broadcast).
  86.  *
  87.  * param p_instance the instance
  88.  * param psz_name the media to delete
  89.  * param p_e an initialized exception pointer
  90.  */
  91. VLC_PUBLIC_API void libvlc_vlm_del_media( libvlc_instance_t *,
  92.                                           const char *,
  93.                                           libvlc_exception_t * );
  94. /**
  95.  * Enable or disable a media (VOD or broadcast).
  96.  *
  97.  * param p_instance the instance
  98.  * param psz_name the media to work on
  99.  * param b_enabled the new status
  100.  * param p_e an initialized exception pointer
  101.  */
  102. VLC_PUBLIC_API void libvlc_vlm_set_enabled( libvlc_instance_t *, const char *,
  103.                                             int, libvlc_exception_t * );
  104. /**
  105.  * Set the output for a media.
  106.  *
  107.  * param p_instance the instance
  108.  * param psz_name the media to work on
  109.  * param psz_output the output MRL (the parameter to the "sout" variable)
  110.  * param p_e an initialized exception pointer
  111.  */
  112. VLC_PUBLIC_API void libvlc_vlm_set_output( libvlc_instance_t *, const char *,
  113.                                            const char *,
  114.                                            libvlc_exception_t * );
  115. /**
  116.  * Set a media's input MRL. This will delete all existing inputs and
  117.  * add the specified one.
  118.  *
  119.  * param p_instance the instance
  120.  * param psz_name the media to work on
  121.  * param psz_input the input MRL
  122.  * param p_e an initialized exception pointer
  123.  */
  124. VLC_PUBLIC_API void libvlc_vlm_set_input( libvlc_instance_t *, const char *,
  125.                                           const char *,
  126.                                           libvlc_exception_t * );
  127. /**
  128.  * Add a media's input MRL. This will add the specified one.
  129.  *
  130.  * param p_instance the instance
  131.  * param psz_name the media to work on
  132.  * param psz_input the input MRL
  133.  * param p_e an initialized exception pointer
  134.  */
  135. VLC_PUBLIC_API void libvlc_vlm_add_input( libvlc_instance_t *, const char *,
  136.                                           const char *,
  137.                                           libvlc_exception_t * );
  138. /**
  139.  * Set a media's loop status.
  140.  *
  141.  * param p_instance the instance
  142.  * param psz_name the media to work on
  143.  * param b_loop the new status
  144.  * param p_e an initialized exception pointer
  145.  */
  146. VLC_PUBLIC_API void libvlc_vlm_set_loop( libvlc_instance_t *, const char *,
  147.                                          int, libvlc_exception_t * );
  148. /**
  149.  * Set a media's vod muxer.
  150.  *
  151.  * param p_instance the instance
  152.  * param psz_name the media to work on
  153.  * param psz_mux the new muxer
  154.  * param p_e an initialized exception pointer
  155.  */
  156. VLC_PUBLIC_API void libvlc_vlm_set_mux( libvlc_instance_t *, const char *,
  157.                                         const char *, libvlc_exception_t * );
  158. /**
  159.  * Edit the parameters of a media. This will delete all existing inputs and
  160.  * add the specified one.
  161.  *
  162.  * param p_instance the instance
  163.  * param psz_name the name of the new broadcast
  164.  * param psz_input the input MRL
  165.  * param psz_output the output MRL (the parameter to the "sout" variable)
  166.  * param i_options number of additional options
  167.  * param ppsz_options additional options
  168.  * param b_enabled boolean for enabling the new broadcast
  169.  * param b_loop Should this broadcast be played in loop ?
  170.  * param p_e an initialized exception pointer
  171.  */
  172. VLC_PUBLIC_API void libvlc_vlm_change_media( libvlc_instance_t *,
  173.                                              const char *, const char *,
  174.                                              const char* , int,
  175.                                              const char * const *, int, int,
  176.                                              libvlc_exception_t * );
  177. /**
  178.  * Play the named broadcast.
  179.  *
  180.  * param p_instance the instance
  181.  * param psz_name the name of the broadcast
  182.  * param p_e an initialized exception pointer
  183.  */
  184. VLC_PUBLIC_API void libvlc_vlm_play_media ( libvlc_instance_t *, const char *,
  185.                                             libvlc_exception_t * );
  186. /**
  187.  * Stop the named broadcast.
  188.  *
  189.  * param p_instance the instance
  190.  * param psz_name the name of the broadcast
  191.  * param p_e an initialized exception pointer
  192.  */
  193. VLC_PUBLIC_API void libvlc_vlm_stop_media ( libvlc_instance_t *, const char *,
  194.                                             libvlc_exception_t * );
  195. /**
  196.  * Pause the named broadcast.
  197.  *
  198.  * param p_instance the instance
  199.  * param psz_name the name of the broadcast
  200.  * param p_e an initialized exception pointer
  201.  */
  202. VLC_PUBLIC_API void libvlc_vlm_pause_media( libvlc_instance_t *, const char *,
  203.                                             libvlc_exception_t * );
  204. /**
  205.  * Seek in the named broadcast.
  206.  *
  207.  * param p_instance the instance
  208.  * param psz_name the name of the broadcast
  209.  * param f_percentage the percentage to seek to
  210.  * param p_e an initialized exception pointer
  211.  */
  212. VLC_PUBLIC_API void libvlc_vlm_seek_media( libvlc_instance_t *, const char *,
  213.                                            float, libvlc_exception_t * );
  214. /**
  215.  * Return information about the named broadcast.
  216.  * bug will always return NULL
  217.  * param p_instance the instance
  218.  * param psz_name the name of the broadcast
  219.  * param p_e an initialized exception pointer
  220.  * return string with information about named media
  221.  */
  222. VLC_PUBLIC_API char* libvlc_vlm_show_media( libvlc_instance_t *, const char *,
  223.                                             libvlc_exception_t * );
  224. /**
  225.  * Get vlm_media instance position by name or instance id
  226.  *
  227.  * param p_instance a libvlc instance
  228.  * param psz_name name of vlm media instance
  229.  * param i_instance instance id
  230.  * param p_e an initialized exception pointer
  231.  * return position as float
  232.  */
  233. VLC_PUBLIC_API float libvlc_vlm_get_media_instance_position( libvlc_instance_t *,
  234.                                                              const char *, int,
  235.                                                              libvlc_exception_t * );
  236. /**
  237.  * Get vlm_media instance time by name or instance id
  238.  *
  239.  * param p_instance a libvlc instance
  240.  * param psz_name name of vlm media instance
  241.  * param i_instance instance id
  242.  * param p_e an initialized exception pointer
  243.  * return time as integer
  244.  */
  245. VLC_PUBLIC_API int libvlc_vlm_get_media_instance_time( libvlc_instance_t *,
  246.                                                        const char *, int,
  247.                                                        libvlc_exception_t * );
  248. /**
  249.  * Get vlm_media instance length by name or instance id
  250.  *
  251.  * param p_instance a libvlc instance
  252.  * param psz_name name of vlm media instance
  253.  * param i_instance instance id
  254.  * param p_e an initialized exception pointer
  255.  * return length of media item
  256.  */
  257. VLC_PUBLIC_API int libvlc_vlm_get_media_instance_length( libvlc_instance_t *,
  258.                                                          const char *, int ,
  259.                                                          libvlc_exception_t * );
  260. /**
  261.  * Get vlm_media instance playback rate by name or instance id
  262.  *
  263.  * param p_instance a libvlc instance
  264.  * param psz_name name of vlm media instance
  265.  * param i_instance instance id
  266.  * param p_e an initialized exception pointer
  267.  * return playback rate
  268.  */
  269. VLC_PUBLIC_API int libvlc_vlm_get_media_instance_rate( libvlc_instance_t *,
  270.                                                        const char *, int,
  271.                                                        libvlc_exception_t * );
  272. /**
  273.  * Get vlm_media instance title number by name or instance id
  274.  * bug will always return 0
  275.  * param p_instance a libvlc instance
  276.  * param psz_name name of vlm media instance
  277.  * param i_instance instance id
  278.  * param p_e an initialized exception pointer
  279.  * return title as number
  280.  */
  281. VLC_PUBLIC_API int libvlc_vlm_get_media_instance_title( libvlc_instance_t *,
  282.                                                         const char *, int,
  283.                                                         libvlc_exception_t * );
  284. /**
  285.  * Get vlm_media instance chapter number by name or instance id
  286.  * bug will always return 0
  287.  * param p_instance a libvlc instance
  288.  * param psz_name name of vlm media instance
  289.  * param i_instance instance id
  290.  * param p_e an initialized exception pointer
  291.  * return chapter as number
  292.  */
  293. VLC_PUBLIC_API int libvlc_vlm_get_media_instance_chapter( libvlc_instance_t *,
  294.                                                           const char *, int,
  295.                                                           libvlc_exception_t * );
  296. /**
  297.  * Is libvlc instance seekable ?
  298.  * bug will always return 0
  299.  * param p_instance a libvlc instance
  300.  * param psz_name name of vlm media instance
  301.  * param i_instance instance id
  302.  * param p_e an initialized exception pointer
  303.  * return 1 if seekable, 0 if not
  304.  */
  305. VLC_PUBLIC_API int libvlc_vlm_get_media_instance_seekable( libvlc_instance_t *,
  306.                                                            const char *, int,
  307.                                                            libvlc_exception_t * );
  308. /** @} */
  309. # ifdef __cplusplus
  310. }
  311. # endif
  312. #endif /* <vlc/libvlc_vlm.h> */