org.andengine.audio

Class BaseAudioEntity

java.lang.Object

org.andengine.audio.BaseAudioEntity

All Implemented Interfaces:

IAudioEntity

Direct Known Subclasses:

Music, Sound

public abstract class BaseAudioEntity
extends java.lang.Object
implements IAudioEntity

(c) 2010 Nicolas Gramlich (c) 2011 Zynga Inc.

Since:

16:35:37 - 13.06.2010

Field Summary

Fields

Modifier and Type	Field and Description
protected float	mLeftVolume
protected float	mRightVolume

Constructor Summary

Constructors

Constructor and Description
BaseAudioEntity(IAudioManager<? extends IAudioEntity> pAudioManager)

Method Summary

Modifier and Type	Method and Description
protected void	assertNotReleased()
float	getActualLeftVolume()
float	getActualRightVolume()
protected IAudioManager<? extends IAudioEntity>	getAudioManager()
float	getLeftVolume()
protected float	getMasterVolume()
float	getRightVolume()
float	getVolume()
boolean	isReleased()
void	onMasterVolumeChanged(float pMasterVolume)
void	pause()
void	play()
void	release()
void	resume()
void	setLooping(boolean pLooping)
void	setVolume(float pVolume)
void	setVolume(float pLeftVolume, float pRightVolume)
void	stop()
protected abstract void	throwOnReleased()

Methods inherited from class java.lang.Object

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

Field Detail

mLeftVolume

protected float mLeftVolume

mRightVolume

protected float mRightVolume

Constructor Detail

BaseAudioEntity

public BaseAudioEntity(IAudioManager<? extends IAudioEntity> pAudioManager)

Method Detail

isReleased

public boolean isReleased()

getAudioManager

protected IAudioManager<? extends IAudioEntity> getAudioManager()
                                                         throws AudioException

Throws:

AudioException

getActualLeftVolume

public float getActualLeftVolume()
                          throws AudioException

Throws:

AudioException

getActualRightVolume

public float getActualRightVolume()
                           throws AudioException

Throws:

AudioException

getMasterVolume

protected float getMasterVolume()
                         throws AudioException

Throws:

AudioException

throwOnReleased

protected abstract void throwOnReleased()
                                 throws AudioException

Throws:

AudioException

getVolume

public float getVolume()
                throws AudioException

Specified by:

getVolume in interface IAudioEntity

Throws:

AudioException

getLeftVolume

public float getLeftVolume()
                    throws AudioException

Specified by:

getLeftVolume in interface IAudioEntity

Throws:

AudioException

getRightVolume

public float getRightVolume()
                     throws AudioException

Specified by:

getRightVolume in interface IAudioEntity

Throws:

AudioException

setVolume

public final void setVolume(float pVolume)
                     throws AudioException

Specified by:

setVolume in interface IAudioEntity

Throws:

AudioException

setVolume

public void setVolume(float pLeftVolume,
                      float pRightVolume)
               throws AudioException

Specified by:

setVolume in interface IAudioEntity

Throws:

AudioException

onMasterVolumeChanged

public void onMasterVolumeChanged(float pMasterVolume)
                           throws AudioException

Specified by:

onMasterVolumeChanged in interface IAudioEntity

Throws:

AudioException

play

public void play()
          throws AudioException

Specified by:

play in interface IAudioEntity

Throws:

AudioException

pause

public void pause()
           throws AudioException

Specified by:

pause in interface IAudioEntity

Throws:

AudioException

resume

public void resume()
            throws AudioException

Specified by:

resume in interface IAudioEntity

Throws:

AudioException

stop

public void stop()
          throws AudioException

Specified by:

stop in interface IAudioEntity

Throws:

AudioException

setLooping

public void setLooping(boolean pLooping)
                throws AudioException

Specified by:

setLooping in interface IAudioEntity

Throws:

AudioException

release

public void release()
             throws AudioException

Specified by:

release in interface IAudioEntity

Throws:

AudioException

assertNotReleased

protected void assertNotReleased()
                          throws AudioException

Throws:

AudioException