src/net/java/sip/communicator/service/neomedia/VolumeControl.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

/*
 * SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Distributable under LGPL license.
 * See terms of license at gnu.org.
 */
package net.java.sip.communicator.service.neomedia;

import net.java.sip.communicator.service.neomedia.event.*;

/**
 * Control for volume level in media service.
 * @see InputVolumeControl
 * @see OutputVolumeControl
 *
 * @author Damian Minkov
 */
public interface VolumeControl
{
    /**
     * Current volume value.
     * @return the current volume level.
     */
    public float getVolume();

    /**
     * Returns the minimum allowed volume value.
     * @return the minimum allowed volume value.
     */
    public float getMinValue();

    /**
     * Returns the maximum allowed volume value.
     * @return the maximum allowed volume value.
     */
    public float getMaxValue();

    /**
     * Changes volume level.
     * @param value the new level to set.
     * @return the actual level which was set.
     */
    public float setVolume(float value);

    /**
     * Mutes current sound playback.
     * @param mute mutes/unmutes playback.
     */
    public void setMute(boolean mute);

    /**
     * Get mute state of sound playback.
     * @return mute state of sound playback.
     */
    public boolean getMute();

    /**
     * Adds a <tt>VolumeChangeListener</tt> to be informed for any change
     * in the volume levels.
     *
     * @param listener volume change listener.
     */
    public void addVolumeChangeListener(VolumeChangeListener listener);

    /**
     * Removes a <tt>VolumeChangeListener</tt>.
     * @param listener the volume change listener to be removed.
     */
    public void removeVolumeChangeListener(VolumeChangeListener listener);
}