cd45cb8b4f46fee68b58e6b943614cc8fc0148fc
[vlc/bindings/jvlc.git] / org / videolan / jvlc / PlaylistIntf.java
1 /*****************************************************************************
2  * PlaylistIntf.java: The playlist interface
3  *****************************************************************************
4  *
5  * Copyright (C) 1998-2006 the VideoLAN team
6  * 
7  * Author: Filippo Carone <filippo@carone.org>
8  *
9  * Created on 28-feb-2006
10  *
11  * $Id$
12  *
13  * This program is free software; you can redistribute it
14  * and/or modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2 of the
16  * License, or (at your option) any later version.
17  * 
18  * This program is distributed in the hope that it will be useful, but
19  * WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21  * General Public License for more details.
22  * 
23  * You should have received a copy of the GNU General Public
24  * License along with this program; if not, write to the Free Software
25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26  * 
27  */
28
29
30 package org.videolan.jvlc;
31
32 public interface PlaylistIntf {
33     /**
34      * @param id The ID to play
35      * @param options Options to play the item withs
36      */
37     void play(int id, String[] options) throws VLCException;
38     
39     /**
40      * Plays the current item
41      */
42     void play() throws VLCException;
43     
44     /**
45      * Toggles pause for the current item.
46      */
47     void togglePause() throws VLCException;
48     
49     /**
50      * Stops the playlist.
51      */
52     void stop() throws VLCException;
53     
54     /**
55      * @return True if playlist is not stopped
56      */
57     boolean isRunning() throws VLCException;
58     
59     /**
60      * @return Current number of items in the playlist
61      */
62     int itemsCount() throws VLCException;
63     
64     /**
65      * Move to next item
66      */
67     void next() throws VLCException;
68     
69     /**
70      * Move to previous item
71      */
72     void prev() throws VLCException;
73     
74     /**
75      * Clear the playlist
76      */
77     void clear() throws VLCException;
78     
79     /**
80      * Add a new item in the playlist
81      * @param uri Location of the item
82      * @param name Name of the item
83      * @return The item ID
84      */
85     int add(String uri, String name) throws VLCException;
86     
87     /**
88      * Currently not implemented
89      */
90     void addExtended();
91     
92
93 }