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

midi

开发平台:

Unix_Linux

  1. /*****************************************************************************
  2.  * deprecated.h:  libvlc deprecated API
  3.  *****************************************************************************
  4.  * Copyright (C) 1998-2008 the VideoLAN team
  5.  * $Id: 2cb82e11034c42b79115efd043f41fdfd06aa1eb $
  6.  *
  7.  * Authors: Clément Stenac <zorglub@videolan.org>
  8.  *          Jean-Paul Saman <jpsaman@videolan.org>
  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_DEPRECATED_H
  25. #define LIBVLC_DEPRECATED_H 1
  26. /**
  27.  * file
  28.  * This file defines libvlc depreceated API
  29.  */
  30. /**
  31.  * This is the legacy representation of a platform-specific drawable. Because
  32.  * it cannot accomodate a pointer on most 64-bits platforms, it should not be
  33.  * used anymore.
  34.  */
  35. typedef int libvlc_drawable_t;
  36. # ifdef __cplusplus
  37. extern "C" {
  38. # endif
  39. /**
  40.  * Set the drawable where the media player should render its video output.
  41.  *
  42.  * On Windows 32-bits, a window handle (HWND) is expected.
  43.  * On Windows 64-bits, this function will always fail.
  44.  *
  45.  * On OSX 32-bits, a CGrafPort is expected.
  46.  * On OSX 64-bits, this function will always fail.
  47.  *
  48.  * On other platforms, an existing X11 window ID is expected. See
  49.  * libvlc_media_player_set_xid() for details.
  50.  *
  51.  * param p_mi the Media Player
  52.  * param drawable the libvlc_drawable_t where the media player
  53.  *        should render its video
  54.  * param p_e an initialized exception pointer
  55.  */
  56. VLC_DEPRECATED_API void libvlc_media_player_set_drawable ( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
  57. /**
  58.  * Get the drawable where the media player should render its video output
  59.  *
  60.  * param p_mi the Media Player
  61.  * param p_e an initialized exception pointer
  62.  * return the libvlc_drawable_t where the media player
  63.  *         should render its video
  64.  */
  65. VLC_DEPRECATED_API libvlc_drawable_t
  66.                     libvlc_media_player_get_drawable ( libvlc_media_player_t *, libvlc_exception_t * );
  67. /**
  68.  * Set the default video output's parent.
  69.  *
  70.  * This setting will be used as default for any video output.
  71.  *
  72.  * param p_instance libvlc instance
  73.  * param drawable the new parent window
  74.  *                 (see libvlc_media_player_set_drawable() for details)
  75.  * param p_e an initialized exception pointer
  76.  * @deprecated Use libvlc_media_player_set_drawable
  77.  */
  78. VLC_DEPRECATED_API void libvlc_video_set_parent( libvlc_instance_t *, libvlc_drawable_t, libvlc_exception_t * );
  79. /**
  80.  * Set the default video output parent.
  81.  *
  82.  * This setting will be used as default for all video outputs.
  83.  *
  84.  * param p_instance libvlc instance
  85.  * param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
  86.  * param p_e an initialized exception pointer
  87.  * @deprecated Use libvlc_media_player_get_drawable
  88.  */
  89. VLC_DEPRECATED_API libvlc_drawable_t libvlc_video_get_parent( libvlc_instance_t *, libvlc_exception_t * );
  90. /**
  91.  * Does nothing. Do not use this function.
  92.  */
  93. VLC_DEPRECATED_API int libvlc_video_reparent( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
  94. /**
  95.  * Resize the current video output window.
  96.  * This might crash. Please use libvlc_video_set_scale() instead.
  97.  *
  98.  * param p_mi media player instance
  99.  * param width new width for video output window
  100.  * param height new height for video output window
  101.  * param p_e an initialized exception pointer
  102.  * return the success status (boolean)
  103.  */
  104. VLC_DEPRECATED_API void libvlc_video_resize( libvlc_media_player_t *, int, int, libvlc_exception_t *);
  105. /**
  106.  * Tell windowless video output to redraw rectangular area (MacOS X only).
  107.  * This might crash. Do not use this function.
  108.  *
  109.  * param p_mi media player instance
  110.  * param area coordinates within video drawable
  111.  * param p_e an initialized exception pointer
  112.  */
  113. VLC_DEPRECATED_API void libvlc_video_redraw_rectangle( libvlc_media_player_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
  114. /**
  115.  * Set the default video output size.
  116.  * This setting will be used as default for all video outputs.
  117.  *
  118.  * param p_instance libvlc instance
  119.  * param width new width for video drawable
  120.  * param height new height for video drawable
  121.  * param p_e an initialized exception pointer
  122.  */
  123. VLC_DEPRECATED_API void libvlc_video_set_size( libvlc_instance_t *, int, int, libvlc_exception_t * );
  124. /**
  125.  * Set the default video output viewport for a windowless video output
  126.  * (MacOS X only). This might crash. Do not use this function.
  127.  *
  128.  * This setting will be used as default for all video outputs.
  129.  *
  130.  * param p_instance libvlc instance
  131.  * param p_mi media player instance
  132.  * param view coordinates within video drawable
  133.  * param clip coordinates within video drawable
  134.  * param p_e an initialized exception pointer
  135.  */
  136. VLC_DEPRECATED_API void libvlc_video_set_viewport( libvlc_instance_t *, libvlc_media_player_t *, const libvlc_rectangle_t *, const libvlc_rectangle_t *, libvlc_exception_t * );
  137. /*
  138.  * This function shall not be used at all. It may lead to crash and race condition.
  139.  */
  140. VLC_DEPRECATED_API int libvlc_video_destroy( libvlc_media_player_t *, libvlc_exception_t *);
  141. /*****************************************************************************
  142.  * Playlist (Deprecated)
  143.  *****************************************************************************/
  144. /** defgroup libvlc_playlist libvlc_playlist (Deprecated)
  145.  * ingroup libvlc
  146.  * LibVLC Playlist handling (Deprecated)
  147.  * @deprecated Use media_list
  148.  * @{
  149.  */
  150. /**
  151.  * Set the playlist's loop attribute. If set, the playlist runs continuously
  152.  * and wraps around when it reaches the end.
  153.  *
  154.  * param p_instance the playlist instance
  155.  * param loop the loop attribute. 1 sets looping, 0 disables it
  156.  * param p_e an initialized exception pointer
  157.  */
  158. VLC_DEPRECATED_API void libvlc_playlist_loop( libvlc_instance_t* , int,
  159.                                           libvlc_exception_t * );
  160. /**
  161.  * Start playing.
  162.  *
  163.  * Additionnal playlist item options can be specified for addition to the
  164.  * item before it is played.
  165.  *
  166.  * param p_instance the playlist instance
  167.  * param i_id the item to play. If this is a negative number, the next
  168.  *        item will be selected. Otherwise, the item with the given ID will be
  169.  *        played
  170.  * param i_options the number of options to add to the item
  171.  * param ppsz_options the options to add to the item
  172.  * param p_e an initialized exception pointer
  173.  */
  174. VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
  175.                                           char **, libvlc_exception_t * );
  176. /**
  177.  * Toggle the playlist's pause status.
  178.  *
  179.  * If the playlist was running, it is paused. If it was paused, it is resumed.
  180.  *
  181.  * param p_instance the playlist instance to pause
  182.  * param p_e an initialized exception pointer
  183.  */
  184. VLC_DEPRECATED_API void libvlc_playlist_pause( libvlc_instance_t *,
  185.                                            libvlc_exception_t * );
  186. /**
  187.  * Checks whether the playlist is running
  188.  *
  189.  * param p_instance the playlist instance
  190.  * param p_e an initialized exception pointer
  191.  * return 0 if the playlist is stopped or paused, 1 if it is running
  192.  */
  193. VLC_DEPRECATED_API int libvlc_playlist_isplaying( libvlc_instance_t *,
  194.                                               libvlc_exception_t * );
  195. /**
  196.  * Get the number of items in the playlist
  197.  *
  198.  * Expects the playlist instance to be locked already.
  199.  *
  200.  * param p_instance the playlist instance
  201.  * param p_e an initialized exception pointer
  202.  * return the number of items
  203.  */
  204. VLC_DEPRECATED_API int libvlc_playlist_items_count( libvlc_instance_t *,
  205.                                                 libvlc_exception_t * );
  206. VLC_DEPRECATED_API int libvlc_playlist_get_current_index( libvlc_instance_t *,
  207.                                                  libvlc_exception_t *);
  208. /**
  209.  * Lock the playlist.
  210.  *
  211.  * param p_instance the playlist instance
  212.  */
  213. VLC_DEPRECATED_API void libvlc_playlist_lock( libvlc_instance_t * );
  214. /**
  215.  * Unlock the playlist.
  216.  *
  217.  * param p_instance the playlist instance
  218.  */
  219. VLC_DEPRECATED_API void libvlc_playlist_unlock( libvlc_instance_t * );
  220. /**
  221.  * Stop playing.
  222.  *
  223.  * param p_instance the playlist instance to stop
  224.  * param p_e an initialized exception pointer
  225.  */
  226. VLC_DEPRECATED_API void libvlc_playlist_stop( libvlc_instance_t *,
  227.                                           libvlc_exception_t * );
  228. /**
  229.  * Go to the next playlist item. If the playlist was stopped, playback
  230.  * is started.
  231.  *
  232.  * param p_instance the playlist instance
  233.  * param p_e an initialized exception pointer
  234.  */
  235. VLC_DEPRECATED_API void libvlc_playlist_next( libvlc_instance_t *,
  236.                                           libvlc_exception_t * );
  237. /**
  238.  * Go to the previous playlist item. If the playlist was stopped, playback
  239.  * is started.
  240.  *
  241.  * param p_instance the playlist instance
  242.  * param p_e an initialized exception pointer
  243.  */
  244. VLC_DEPRECATED_API void libvlc_playlist_prev( libvlc_instance_t *,
  245.                                           libvlc_exception_t * );
  246. /**
  247.  * Empty a playlist. All items in the playlist are removed.
  248.  *
  249.  * param p_instance the playlist instance
  250.  * param p_e an initialized exception pointer
  251.  */
  252. VLC_DEPRECATED_API void libvlc_playlist_clear( libvlc_instance_t *,
  253.                                            libvlc_exception_t * );
  254. /**
  255.  * Append an item to the playlist. The item is added at the end. If more
  256.  * advanced options are required, see libvlc_playlist_add_extended instead.
  257.  *
  258.  * param p_instance the playlist instance
  259.  * param psz_uri the URI to open, using VLC format
  260.  * param psz_name a name that you might want to give or NULL
  261.  * param p_e an initialized exception pointer
  262.  * return the identifier of the new item
  263.  */
  264. VLC_DEPRECATED_API int libvlc_playlist_add( libvlc_instance_t *, const char *,
  265.                                         const char *, libvlc_exception_t * );
  266. /**
  267.  * Append an item to the playlist. The item is added at the end, with
  268.  * additional input options.
  269.  *
  270.  * param p_instance the playlist instance
  271.  * param psz_uri the URI to open, using VLC format
  272.  * param psz_name a name that you might want to give or NULL
  273.  * param i_options the number of options to add
  274.  * param ppsz_options strings representing the options to add
  275.  * param p_e an initialized exception pointer
  276.  * return the identifier of the new item
  277.  */
  278. VLC_DEPRECATED_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
  279.                                                  const char *, int, const char **,
  280.                                                  libvlc_exception_t * );
  281. /**
  282.  * Append an item to the playlist. The item is added at the end, with
  283.  * additional input options from an untrusted source.
  284.  *
  285.  * param p_instance the playlist instance
  286.  * param psz_uri the URI to open, using VLC format
  287.  * param psz_name a name that you might want to give or NULL
  288.  * param i_options the number of options to add
  289.  * param ppsz_options strings representing the options to add
  290.  * param p_e an initialized exception pointer
  291.  * return the identifier of the new item
  292.  */
  293. VLC_DEPRECATED_API int libvlc_playlist_add_extended_untrusted( libvlc_instance_t *, const char *,
  294.                                                  const char *, int, const char **,
  295.                                                  libvlc_exception_t * );
  296. /**
  297.  * Delete the playlist item with the given ID.
  298.  *
  299.  * param p_instance the playlist instance
  300.  * param i_id the id to remove
  301.  * param p_e an initialized exception pointer
  302.  * return 0 in case of success, a non-zero value otherwise
  303.  */
  304. VLC_DEPRECATED_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
  305.                                                 libvlc_exception_t * );
  306. /** Get the input that is currently being played by the playlist.
  307.  *
  308.  * param p_instance the playlist instance to use
  309.  * param p_e an initialized exception pointern
  310.  * return a media instance object
  311.  */
  312. VLC_DEPRECATED_API libvlc_media_player_t * libvlc_playlist_get_media_player(
  313.                                 libvlc_instance_t *, libvlc_exception_t * );
  314. /** @}*/
  315. # ifdef __cplusplus
  316. }
  317. # endif
  318. #endif /* _LIBVLC_DEPRECATED_H */