org.jitsi.service.audionotifier

Interface SCAudioClip

All Known Implementing Classes:

AbstractSCAudioClip, AudioSystemClipImpl, JavaSoundClipImpl

public interface SCAudioClip

Represents an audio clip which could be played (optionally, in a loop) and stopped..

Author:

Yana Stamcheva, Lyubomir Marinov

Method Summary

Modifier and Type	Method and Description
boolean	isStarted() Determines whether this audio is started i.e.
void	play() Starts playing this audio once only.
void	play(int loopInterval, Callable<Boolean> loopCondition) Starts playing this audio.
void	stop() Stops playing this audio.

Method Detail

play

void play()

Starts playing this audio once only. The method behaves as if play(int, Callable) was invoked with a negative loopInterval and/or null loopCondition.

play

void play(int loopInterval,
          Callable<Boolean> loopCondition)

Starts playing this audio. Optionally, the playback is looped.

Parameters:

loopInterval - the interval of time in milliseconds between consecutive plays of this audio. If negative, this audio is played once only and loopCondition is ignored.

loopCondition - a Callable which is called at the beginning of each iteration of looped playback of this audio except the first one to determine whether to continue the loop. If loopInterval is negative or loopCondition is null, this audio is played once only.

stop

void stop()

Stops playing this audio.

isStarted

boolean isStarted()

Determines whether this audio is started i.e. a play method was invoked and no subsequent stop has been invoked yet.

Returns:

true if this audio is started; otherwise, false