org.jitsi.service.neomedia.event

Class VolumeChangeEvent

java.lang.Object

java.util.EventObject

org.jitsi.service.neomedia.event.VolumeChangeEvent

All Implemented Interfaces:

Serializable

public class VolumeChangeEvent
extends EventObject

Represents the event fired when playback volume value has changed.

Author:

Damian Minkov

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
VolumeChangeEvent(VolumeControl source, float level, boolean mute) Initializes a new VolumeChangeEvent which is to notify about a specific volume level and its mute state.

Method Summary

Modifier and Type	Method and Description
float	getLevel() Gets the volume level notified about by this VolumeChangeEvent.
boolean	getMute() Gets the indicator which determines whether the volume is muted.
VolumeControl	getSourceVolumeControl() Gets the VolumeControl which is the source of the change notified about by this VolumeChangeEvent.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VolumeChangeEvent

public VolumeChangeEvent(VolumeControl source,
                         float level,
                         boolean mute)

Initializes a new VolumeChangeEvent which is to notify about a specific volume level and its mute state.

Parameters:

source - the VolumeControl which is the source of the change

level - the volume level

mute - true if the volume is muted; otherwise, false

Throws:

IllegalArgumentException - if source is null

Method Detail

getSourceVolumeControl

public VolumeControl getSourceVolumeControl()

Gets the VolumeControl which is the source of the change notified about by this VolumeChangeEvent.

Returns:

the VolumeControl which is the source of the change notified about by this VolumeChangeEvent

getLevel

public float getLevel()

Gets the volume level notified about by this VolumeChangeEvent.

Returns:

the volume level notified about by this VolumeChangeEvent

getMute

public boolean getMute()

Gets the indicator which determines whether the volume is muted.

Returns:

true if the volume is muted; otherwise, false