/* PulseAudioClip.java
   Copyright (C) 2008 Red Hat, Inc.

This file is part of IcedTea.

IcedTea is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as published by
the Free Software Foundation, version 2.

IcedTea is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with IcedTea; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version.
 */

package org.classpath.icedtea.pulseaudio;

/**
 * Represents a Line that supports changing the volume
 */
interface PulseAudioPlaybackLine {

    static final int SECONDS_TO_MICROSECONDS = 1000000;

    /**
     * Set the volume of the Line (ie, sink input, source, or sink)
     * 
     * @return an Operation object which can be used to check if the operation
     *         has completed
     */
    byte[] native_set_volume(float value);

    /**
     * 
     * Update the volume information of a Line (sink input, source or sink)
     * 
     * @return an Operation object which can be used to check if the operation
     *         has been completed
     */
    byte[] native_update_volume();
    
    
    /**
     * Gets the cached volume. To get the current volume, call
     * native_update_volume, and then call this method to get the updated
     * volume.
     * 
     * @return the cached volume of the Line
     */
    float getCachedVolume();

    /**
     * Set the cached value of a line
     * 
     */
    void setCachedVolume(float volume);

    /**
     * Check if a line is open
     * 
     * @return <code>true</code> if line is open
     */
    boolean isOpen();

}