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  * \return media list player instance or NULL on error
  63  */
  64 VLC_PUBLIC_API libvlc_media_list_player_t *
  65     libvlc_media_list_player_new( libvlc_instance_t * p_instance );
  66
  67 /**
  68  * Release media_list_player.
  69  *
  70  * \param p_mlp media list player instance
  71  */
  72 VLC_PUBLIC_API void
  73     libvlc_media_list_player_release( libvlc_media_list_player_t * p_mlp );
  74
  75 /**
  76  * Return the event manager of this media_list_player.
  77  *
  78  * \param p_mlp media list player instance
  79  */
  80 VLC_PUBLIC_API libvlc_event_manager_t *
  81     libvlc_media_list_player_event_manager(libvlc_media_list_player_t * p_mlp);
  82
  83 /**
  84  * Replace media player in media_list_player with this instance.
  85  *
  86  * \param p_mlp media list player instance
  87  * \param p_mi media player instance
  88  */
  89 VLC_PUBLIC_API void
  90     libvlc_media_list_player_set_media_player(
  91                                      libvlc_media_list_player_t * p_mlp,
  92                                      libvlc_media_player_t * p_mi );
  93
  94 VLC_PUBLIC_API void
  95     libvlc_media_list_player_set_media_list(
  96                                      libvlc_media_list_player_t * p_mlp,
  97                                      libvlc_media_list_t * p_mlist );
  98
  99 /**
 100  * Play media list
 101  *
 102  * \param p_mlp media list player instance
 103  */
 104 VLC_PUBLIC_API
 105 void libvlc_media_list_player_play(libvlc_media_list_player_t * p_mlp);
 106
 107 /**
 108  * Pause media list
 109  *
 110  * \param p_mlp media list player instance
 111  */
 112 VLC_PUBLIC_API
 113 void libvlc_media_list_player_pause(libvlc_media_list_player_t * p_mlp);
 114
 115 /**
 116  * Is media list playing?
 117  *
 118  * \param p_mlp media list player 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
 124 /**
 125  * Get current libvlc_state of media list player
 126  *
 127  * \param p_mlp media list player instance
 128  * \return libvlc_state_t for media list player
 129  */
 130 VLC_PUBLIC_API libvlc_state_t
 131     libvlc_media_list_player_get_state( libvlc_media_list_player_t * p_mlp );
 132
 133 /**
 134  * Play media list item at position index
 135  *
 136  * \param p_mlp media list player instance
 137  * \param i_index index in media list to play
 138  * \return 0 upon success -1 if the item wasn't found
 139  */
 140 VLC_PUBLIC_API
 141 int libvlc_media_list_player_play_item_at_index(libvlc_media_list_player_t * p_mlp,
 142                                                 int i_index);
 143
 144 VLC_PUBLIC_API
 145 int libvlc_media_list_player_play_item(libvlc_media_list_player_t * p_mlp,
 146                                        libvlc_media_t * p_md);
 147
 148 /**
 149  * Stop playing media list
 150  *
 151  * \param p_mlp media list player instance
 152  */
 153 VLC_PUBLIC_API void
 154     libvlc_media_list_player_stop( libvlc_media_list_player_t * p_mlp);
 155
 156 /**
 157  * Play next item from media list
 158  *
 159  * \param p_mlp media list player instance
 160  * \return 0 upon success -1 if there is no next item
 161  */
 162 VLC_PUBLIC_API
 163 int libvlc_media_list_player_next(libvlc_media_list_player_t * p_mlp);
 164
 165 /**
 166  * Play previous item from media list
 167  *
 168  * \param p_mlp media list player instance
 169  * \return 0 upon success -1 if there is no previous item
 170  */
 171 VLC_PUBLIC_API
 172 int libvlc_media_list_player_previous(libvlc_media_list_player_t * p_mlp);
 173
 174
 175
 176 /**
 177  * Sets the playback mode for the playlist
 178  *
 179  * \param p_mlp media list player instance
 180  * \param e_mode playback mode specification
 181  */
 182 VLC_PUBLIC_API
 183 void libvlc_media_list_player_set_playback_mode(libvlc_media_list_player_t * p_mlp,
 184                                                 libvlc_playback_mode_t e_mode );
 185
 186 /** @} media_list_player */
 187
 188 # ifdef __cplusplus
 189 }
 190 # endif
 191
 192 #endif /* LIBVLC_MEDIA_LIST_PLAYER_H */