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  *  Defines playback modes for playlist.
  50  */
  51 typedef enum libvlc_playback_mode_t
  52 {
  53     libvlc_playback_mode_default,
  54     libvlc_playback_mode_loop,
  55     libvlc_playback_mode_repeat
  56 } libvlc_playback_mode_t;
  57
  58 /**
  59  * Create new media_list_player.
  60  *
  61  * \param p_instance libvlc instance
  62  * \param p_e initialized exception instance
  63  * \return media list player instance or NULL on error
  64  */
  65 VLC_PUBLIC_API libvlc_media_list_player_t *
  66     libvlc_media_list_player_new( libvlc_instance_t * p_instance );
  67
  68 /**
  69  * Release media_list_player.
  70  *
  71  * \param p_mlp media list player instance
  72  */
  73 VLC_PUBLIC_API void
  74     libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
  75
  76 /**
  77  * Return the event manager of this media_list_player.
  78  *
  79  * \param p_mlp media list player instance
  80  */
  81 VLC_PUBLIC_API libvlc_event_manager_t *
  82     libvlc_media_list_player_event_manager(libvlc_media_list_player_t * p_mlp);
  83
  84 /**
  85  * Replace media player in media_list_player with this instance.
  86  *
  87  * \param p_mlp media list player instance
  88  * \param p_mi media player instance
  89  * \param p_e initialized exception instance
  90  */
  91 VLC_PUBLIC_API void
  92     libvlc_media_list_player_set_media_player(
  93                                      libvlc_media_list_player_t * p_mlp,
  94                                      libvlc_media_player_t * p_mi );
  95
  96 VLC_PUBLIC_API void
  97     libvlc_media_list_player_set_media_list(
  98                                      libvlc_media_list_player_t * p_mlp,
  99                                      libvlc_media_list_t * p_mlist );
 100
 101 /**
 102  * Play media list
 103  *
 104  * \param p_mlp media list player instance
 105  * \param p_e initialized exception instance
 106  */
 107 VLC_PUBLIC_API void
 108     libvlc_media_list_player_play( libvlc_media_list_player_t * p_mlp,
 109                                    libvlc_exception_t * p_e );
 110
 111 /**
 112  * Pause media list
 113  *
 114  * \param p_mlp media list player instance
 115  * \param p_e initialized exception instance
 116  */
 117 VLC_PUBLIC_API void
 118     libvlc_media_list_player_pause( libvlc_media_list_player_t * p_mlp,
 119                                    libvlc_exception_t * p_e );
 120
 121 /**
 122  * Is media list playing?
 123  *
 124  * \param p_mlp media list player instance
 125  * \param p_e initialized exception instance
 126  * \return true for playing and false for not playing
 127  */
 128 VLC_PUBLIC_API int
 129     libvlc_media_list_player_is_playing( libvlc_media_list_player_t * p_mlp );
 130
 131 /**
 132  * Get current libvlc_state of media list player
 133  *
 134  * \param p_mlp media list player instance
 135  * \return libvlc_state_t for media list player
 136  */
 137 VLC_PUBLIC_API libvlc_state_t
 138     libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp );
 139
 140 /**
 141  * Play media list item at position index
 142  *
 143  * \param p_mlp media list player instance
 144  * \param i_index index in media list to play
 145  * \param p_e initialized exception instance
 146  */
 147 VLC_PUBLIC_API void
 148     libvlc_media_list_player_play_item_at_index(
 149                                    libvlc_media_list_player_t * p_mlp,
 150                                    int i_index,
 151                                    libvlc_exception_t * p_e );
 152
 153 VLC_PUBLIC_API void
 154     libvlc_media_list_player_play_item(
 155                                    libvlc_media_list_player_t * p_mlp,
 156                                    libvlc_media_t * p_md,
 157                                    libvlc_exception_t * p_e );
 158
 159 /**
 160  * Stop playing media list
 161  *
 162  * \param p_mlp media list player instance
 163  */
 164 VLC_PUBLIC_API void
 165     libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp );
 166
 167 /**
 168  * Play next item from media list
 169  *
 170  * \param p_mlp media list player instance
 171  * \param p_e initialized exception instance
 172  */
 173 VLC_PUBLIC_API void
 174     libvlc_media_list_player_next( libvlc_media_list_player_t * p_mlp,
 175                                    libvlc_exception_t * p_e );
 176
 177 /**
 178  * Play previous item from media list
 179  *
 180  * \param p_mlp media list player instance
 181  * \param p_e initialized exception instance
 182  */
 183 VLC_PUBLIC_API void
 184     libvlc_media_list_player_previous( libvlc_media_list_player_t * p_mlp,
 185                                        libvlc_exception_t * p_e );
 186
 187
 188
 189 /**
 190  * Sets the playback mode for the playlist
 191  *
 192  * \param p_mlp media list player instance
 193  * \param e_mode playback mode specification
 194  */
 195 VLC_PUBLIC_API void
 196     libvlc_media_list_player_set_playback_mode(
 197                                         libvlc_media_list_player_t * p_mlp,
 198                                         libvlc_playback_mode_t e_mode );
 199
 200 /** @} media_list_player */
 201
 202 # ifdef __cplusplus
 203 }
 204 # endif
 205
 206 #endif /* LIBVLC_MEDIA_LIST_PLAYER_H */