git.sesse.net Git - vlc/blob - bindings/java/org/videolan/jvlc/VLMIntf.java

   1 /*****************************************************************************
   2  * VLMIntf.java: VLM 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 package org.videolan.jvlc;
  30
  31 public interface VLMIntf {
  32
  33         /**
  34          * Add a broadcast, with one input
  35          * @param name the name of the new broadcast
  36          * @param input the input MRL
  37          * @param output the output MRL (the parameter to the "sout" variable)
  38          * @param options additional options
  39          * @param enabled boolean for enabling the new broadcast
  40          * @param loop Should this broadcast be played in loop ?
  41          */
  42     void addBroadcast( String name, String input, String output, String[] options, boolean enabled, boolean loop )
  43         throws VLCException;
  44
  45     /**
  46      * Delete a media (vod or broadcast)
  47      * @param name the media to delete
  48      */
  49     void deleteMedia( String name ) throws VLCException;
  50
  51     /**
  52      * Enable or disable a media (vod or broadcast)
  53      * @param name the media to work on
  54      * @param enabled the new status
  55      */
  56     void setEnabled( String name, boolean enabled ) throws VLCException;
  57
  58     /**
  59      * Set the output for a media
  60      * @param name the media to work on
  61      * @param output the output MRL (the parameter to the "sout" variable)
  62      */
  63     void setOutput( String name, String output ) throws VLCException;
  64
  65     /**
  66      * Set a media's input MRL. This will delete all existing inputs and
  67      * add the specified one.
  68      * @param name the media to work on
  69      * @param input the input MRL
  70      */
  71     void setInput( String name, String input ) throws VLCException;
  72
  73     /**
  74      * Set loop mode for a media
  75      * @param name the media to work on
  76      * @param loop the new status
  77      */
  78     void setLoop( String name, boolean loop ) throws VLCException;
  79
  80     /**
  81      * Edit the parameters of a media. This will delete all existing inputs and
  82      * add the specified one.
  83      * @param name the name of the new broadcast
  84      * @param input the input MRL
  85      * @param output the output MRL (the parameter to the "sout" variable)
  86      * @param options additional options
  87      * @param enabled boolean for enabling the new broadcast
  88      * @param loop Should this broadcast be played in loop ?
  89      */
  90     void changeMedia( String name, String input, String output, String[] options, boolean enabled, boolean loop )
  91         throws VLCException;
  92     /**
  93      * Plays a media
  94      * @param name of the broadcast to play
  95      */
  96     void playMedia(String name) throws VLCException;
  97
  98     /**
  99      * Stops a media
 100      * @param name of the broadcast to stop
 101      */
 102     void stopMedia(String name) throws VLCException;
 103
 104     /**
 105      * Pauses a media
 106      * @param name name of the broadcast to pause
 107      */
 108     void pauseMedia(String name) throws VLCException;
 109
 110 }