net.java.html.sound

Class AudioClip

java.lang.Object

net.java.html.sound.AudioClip

public abstract class AudioClip
extends java.lang.Object

Handle to an audio clip which can be played, paused and etc. Obtain new instance via create factory method and then use it when necessary.

Author:

antonepple

Method Summary

Modifier and Type	Method and Description
static AudioClip	create(java.lang.String src) Creates new instance of an audio clip based on the provided URL.
abstract boolean	isSupported() Check whether the audio clip is supported and can be played.
abstract void	pause() Pauses playback of the clip
abstract void	play() Plays the clip from begining to the end.
abstract void	setVolume(double volume) Specifies the volume of the audio.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static AudioClip create(java.lang.String src)

Creates new instance of an audio clip based on the provided URL. If no suitable audio environment provider is found, the method returns a dummy instance that does nothing and only returns false from its AudioClip.isSupported() method.

The src can be absolute URL or it can be relative to current browser context - e.g. usually to the page that is just being displayed.

Parameters:

src - the URL where to find the audio clip

Returns:

the audio clip handle

Throws:

java.lang.NullPointerException - if src is null

play

public abstract void play()

Plays the clip from begining to the end.

pause

public abstract void pause()

Pauses playback of the clip

setVolume

public abstract void setVolume(double volume)

Specifies the volume of the audio. Must be a number between 0.0 and 1.0:

• 1.0 - highest volume
• 0.5 - 50% volume
• 0.0 - silent

Parameters:

volume - for the playback

isSupported

public abstract boolean isSupported()

Check whether the audio clip is supported and can be played.

Returns:

true if it is likely that after calling AudioClip.play() a sound will be produced