net.java.sip.communicator.service.audionotifier
Interface AudioNotifierService

All Known Implementing Classes:

AudioNotifierServiceImpl

public interface AudioNotifierService

The AudioNotifierService is meant to be used to control all sounds in the application. An audio could be created by calling the createAudio method. In order to stop all sounds in the application one could call the setMute method. To check whether the sound is currently enabled the isMute method could be used.

Author:

Yana Stamcheva

Method Summary

SCAudioClip	createAudio(String uri) Creates an SCAudioClip and returns it.
void	destroyAudio(SCAudioClip audio) Destroys the given audio.
boolean	isMute() Specifies if currently the sound is off.
void	setMute(boolean isMute) Stops/Restores all currently playing sounds.

Method Detail

createAudio

SCAudioClip createAudio(String uri)

Creates an SCAudioClip and returns it.

Parameters:

uri - the uri, which will be the source of the audio

Returns:

the created SCAudioClip, that could be played.

destroyAudio

void destroyAudio(SCAudioClip audio)

Destroys the given audio.

Parameters:

audio - SCAudioClip to destroy

setMute

void setMute(boolean isMute)

Stops/Restores all currently playing sounds.

Parameters:

isMute - mute or not currently playing sounds

isMute

boolean isMute()

Specifies if currently the sound is off.

Returns:

TRUE if currently the sound is off, FALSE otherwise