git.sesse.net Git - vlc/blob - include/vlc/libvlc_media_list_player.h

   1 /*****************************************************************************
   2  * libvlc_media_list.h:  libvlc_media_list API
   3  *****************************************************************************
   4  * Copyright (C) 1998-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Pierre d'Herbemont
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef LIBVLC_MEDIA_LIST_PLAYER_H
  25 #define LIBVLC_MEDIA_LIST_PLAYER_H 1
  26
  27 /**
  28  * \file
  29  * This file defines libvlc_media_list_player API
  30  */
  31
  32 # ifdef __cplusplus
  33 extern "C" {
  34 # endif
  35
  36 /*****************************************************************************
  37  * Media List Player
  38  *****************************************************************************/
  39 /** \defgroup libvlc_media_list_player libvlc_media_list_player
  40  * \ingroup libvlc
  41  * LibVLC Media List Player, play a media_list. You can see that as a media
  42  * instance subclass
  43  * @{
  44  */
  45
  46 typedef struct libvlc_media_list_player_t libvlc_media_list_player_t;
  47
  48 /**
  49  * Create new media_list_player.
  50  *
  51  * \param p_instance libvlc instance
  52  * \param p_e initialized exception instance
  53  * \return media list player instance
  54  */
  55 VLC_PUBLIC_API libvlc_media_list_player_t *
  56     libvlc_media_list_player_new( libvlc_instance_t * p_instance,
  57                                   libvlc_exception_t * p_e );
  58
  59 /**
  60  * Release media_list_player.
  61  *
  62  * \param p_mlp media list player instance
  63  */
  64 VLC_PUBLIC_API void
  65     libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
  66
  67 /**
  68  * Return the event manager of this media_list_player.
  69  *
  70  * \param p_mlp media list player instance
  71  */
  72 VLC_PUBLIC_API libvlc_event_manager_t *
  73     libvlc_media_list_player_event_manager(libvlc_media_list_player_t * p_mlp);
  74
  75 /**
  76  * Replace media player in media_list_player with this instance.
  77  *
  78  * \param p_mlp media list player instance
  79  * \param p_mi media player instance
  80  * \param p_e initialized exception instance
  81  */
  82 VLC_PUBLIC_API void
  83     libvlc_media_list_player_set_media_player(
  84                                      libvlc_media_list_player_t * p_mlp,
  85                                      libvlc_media_player_t * p_mi,
  86                                      libvlc_exception_t * p_e );
  87
  88 VLC_PUBLIC_API void
  89     libvlc_media_list_player_set_media_list(
  90                                      libvlc_media_list_player_t * p_mlp,
  91                                      libvlc_media_list_t * p_mlist,
  92                                      libvlc_exception_t * p_e );
  93
  94 /**
  95  * Play media list
  96  *
  97  * \param p_mlp media list player instance
  98  * \param p_e initialized exception instance
  99  */
 100 VLC_PUBLIC_API void
 101     libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
 102                                    libvlc_exception_t * p_e );
 103
 104 /**
 105  * Pause media list
 106  *
 107  * \param p_mlp media list player instance
 108  * \param p_e initialized exception instance
 109  */
 110 VLC_PUBLIC_API void
 111     libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
 112                                    libvlc_exception_t * p_e );
 113
 114 /**
 115  * Is media list playing?
 116  *
 117  * \param p_mlp media list player instance
 118  * \param p_e initialized exception instance
 119  * \return true for playing and false for not playing
 120  */
 121 VLC_PUBLIC_API int
 122     libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp,
 123                                          libvlc_exception_t * p_e );
 124
 125 /**
 126  * Get current libvlc_state of media list player
 127  *
 128  * \param p_mlp media list player instance
 129  * \param p_e initialized exception instance
 130  * \return libvlc_state_t for media list player
 131  */
 132 VLC_PUBLIC_API libvlc_state_t
 133     libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp,
 134                                         libvlc_exception_t * p_e );
 135
 136 /**
 137  * Play media list item at position index
 138  *
 139  * \param p_mlp media list player instance
 140  * \param i_index index in media list to play
 141  * \param p_e initialized exception instance
 142  */
 143 VLC_PUBLIC_API void
 144     libvlc_media_list_player_play_item_at_index(
 145                                    libvlc_media_list_player_t * p_mlp,
 146                                    int i_index,
 147                                    libvlc_exception_t * p_e );
 148
 149 VLC_PUBLIC_API void
 150     libvlc_media_list_player_play_item(
 151                                    libvlc_media_list_player_t * p_mlp,
 152                                    libvlc_media_t * p_md,
 153                                    libvlc_exception_t * p_e );
 154
 155 /**
 156  * Stop playing media list
 157  *
 158  * \param p_mlp media list player instance
 159  * \param p_e initialized exception instance
 160  */
 161 VLC_PUBLIC_API void
 162     libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp,
 163                                    libvlc_exception_t * p_e );
 164
 165 /**
 166  * Play next item from media list
 167  *
 168  * \param p_mlp media list player instance
 169  * \param p_e initialized exception instance
 170  */
 171 VLC_PUBLIC_API void
 172     libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
 173                                    libvlc_exception_t * p_e );
 174
 175 /* NOTE: shouldn't there also be a libvlc_media_list_player_prev() */
 176
 177 /** @} media_list_player */
 178
 179 # ifdef __cplusplus
 180 }
 181 # endif
 182
 183 #endif /* LIBVLC_MEDIA_LIST_PLAYER_H */