net.java.sip.communicator.service.notification
Class SoundNotificationAction

java.lang.Object
  net.java.sip.communicator.service.notification.NotificationAction
      net.java.sip.communicator.service.notification.SoundNotificationAction

public class SoundNotificationAction
extends NotificationAction

An implementation of the SoundNotificationHandlerImpl interface.

Author:

Yana Stamcheva

Field Summary

Fields inherited from class net.java.sip.communicator.service.notification.NotificationAction

ACTION_COMMAND, ACTION_LOG_MESSAGE, ACTION_POPUP_MESSAGE, ACTION_SOUND, NUM_ACTIONS

Constructor Summary

SoundNotificationAction(String soundDescriptor)
Creates an instance of SoundNotification by specifying the sound file descriptor.

SoundNotificationAction(String soundDescriptor, int loopInterval)
Creates an instance of SoundNotification by specifying the sound file descriptor and the loop interval.

Method Summary

String	getDescriptor() Returns the descriptor pointing to the sound to be played.
int	getLoopInterval() Returns the loop interval.

Methods inherited from class net.java.sip.communicator.service.notification.NotificationAction

getActionType, isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

SoundNotificationAction

public SoundNotificationAction(String soundDescriptor)

Creates an instance of SoundNotification by specifying the sound file descriptor. The sound is played once.

Parameters:

soundDescriptor - the sound file descriptor

SoundNotificationAction

public SoundNotificationAction(String soundDescriptor,
                               int loopInterval)

Creates an instance of SoundNotification by specifying the sound file descriptor and the loop interval.

Parameters:

soundDescriptor - the sound file descriptor

loopInterval - the loop interval

Method Detail

getLoopInterval

public int getLoopInterval()

Returns the loop interval. This is the interval of milliseconds to wait before repeating the sound, when playing a sound in loop. By default this method returns -1.

Returns:

the loop interval

getDescriptor

public String getDescriptor()

Returns the descriptor pointing to the sound to be played.

Returns:

the descriptor pointing to the sound to be played.