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

   1 /*****************************************************************************
   2  * AudioIntf.java: Audio methods 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  *
  14  * This program is free software; you can redistribute it
  15  * and/or modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2 of the
  17  * License, or (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22  * General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public
  25  * License along with this program; if not, write to the Free Software
  26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  27  *
  28  */
  29
  30 package org.videolan.jvlc;
  31
  32 public interface AudioIntf {
  33
  34
  35         /**
  36          * Constant for left channel audio
  37          */
  38         final int LEFT_CHANNEL          = 3;
  39
  40         /**
  41          * Constant for right channel audio
  42          */
  43         final int RIGHT_CHANNEL         = 4;
  44
  45         /**
  46          * Constant for reverse channel audio
  47          */
  48         final int REVERSE_CHANNEL       = 2;
  49         /**
  50          * Constant for stereo channel audio
  51          */
  52         final int STEREO_CHANNEL        = 1;
  53         /**
  54          * Constant for dolby channel audio
  55          */
  56         final int DOLBY_CHANNEL         = 5;
  57
  58         /**
  59          * @return audio track
  60          * @throws VLCException
  61          */
  62         int getTrack() throws VLCException;
  63
  64         /**
  65          * @param audio track
  66          * @throws VLCException
  67          */
  68         void setTrack(int track) throws VLCException;
  69
  70         /**
  71          * @return channel
  72          * @throws VLCException
  73          */
  74         int getChannel() throws VLCException;
  75
  76         /**
  77          * @param channel
  78          * @throws VLCException
  79          */
  80         void setChannel(int channel) throws VLCException;
  81
  82
  83     /**
  84      * @return True if input is currently muted.
  85      * @throws VLCException
  86      */
  87     boolean getMute() throws VLCException;
  88
  89     /**
  90      * @param value If true, then the input is muted.
  91      * @throws VLCException
  92      */
  93     void setMute(boolean value) throws VLCException;
  94
  95     /**
  96      * Toggles mute
  97      * @throws VLCException
  98      */
  99     void toggleMute() throws VLCException;
 100
 101     /**
 102      * @return The volume level
 103      * @throws VLCException
 104      */
 105     int getVolume() throws VLCException;
 106
 107     /**
 108      * @param volume The volume level (0-200) to set.
 109      * @throws VLCException
 110      */
 111     void setVolume(int volume) throws VLCException;
 112 }