crystalspace.jbind.impl.sound.source
Class csSoundSource

java.lang.Object
  crystalspace.jbind.impl.csNativeObject
      crystalspace.jbind.impl.csutil.scf.csBase
          crystalspace.jbind.impl.sound.source.csSoundSource

All Implemented Interfaces:

iBase, iPointer, iSoundSource

public class csSoundSource

extends csBase

implements iSoundSource

Author:

Quentin Anciaux

Field Summary

Fields inherited from class crystalspace.jbind.impl.csNativeObject

ImplFactory, nPointer

Constructor Summary

csSoundSource(iPointer nPointer)

Method Summary

float	getFrequencyFactor() Get frequency factor.
int	getMode3D() return 3d mode
java.lang.String	getName() Return the name of the interface
csVector3	getPosition() get position of this source
csVector3	getVelocity() get velocity of this source
int	getVersion() Return the version of the interface
float	getVolume() Get volume (range from 0.0 to 1.0);.
protected boolean	isNativePointerValidSafe(long pointer)
void	play() Play the sound.
void	play(long playMethod) Play the sound.
void	setFrequencyFactor(float factor) Set frequency factor : 1 = normal, >1 faster, 0-1 slower.
void	setMode3D(int m) set 3d mode
void	setPosition(csVector3 pos) set position of this source
void	setVelocity(csVector3 spd) set velocity of this source
void	setVolume(float volume) Set volume (range from 0.0 to 1.0);.
void	stop() Stop the sound.

Methods inherited from class crystalspace.jbind.impl.csutil.scf.csBase

decRef, equals, finalize, getRefCount, incRef, nDelete, queryInterface, queryInterfaceSafe

Methods inherited from class crystalspace.jbind.impl.csNativeObject

changePointer, getPointer, getPointer, getPointerArray, hashCode, isMemoryOwner, isNativePointerValid, newNativeObject, setMemoryOwner, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase

decRef, getRefCount, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Constructor Detail

csSoundSource

public csSoundSource(iPointer nPointer)

Parameters:

nPointer -

Method Detail

getVersion

public int getVersion()

Description copied from interface: iBase

Return the version of the interface

Specified by:

getVersion in interface iBase

Specified by:

getVersion in class csBase

See Also:

iBase.getVersion()

getName

public java.lang.String getName()

Description copied from interface: iBase

Return the name of the interface

Specified by:

getName in interface iBase

Specified by:

getName in class csBase

See Also:

iBase.getName()

isNativePointerValidSafe

protected boolean isNativePointerValidSafe(long pointer)

Specified by:

isNativePointerValidSafe in class csNativeObject

See Also:

csNativeObject.isNativePointerValidSafe(long)

getFrequencyFactor

public float getFrequencyFactor()

Description copied from interface: iSoundSource

Get frequency factor.

Specified by:

getFrequencyFactor in interface iSoundSource

Returns:

See Also:

iSoundSource.getFrequencyFactor()

getMode3D

public int getMode3D()

Description copied from interface: iSoundSource

return 3d mode

Specified by:

getMode3D in interface iSoundSource

Returns:

See Also:

iSoundSource.getMode3D()

getPosition

public csVector3 getPosition()

Description copied from interface: iSoundSource

get position of this source

Specified by:

getPosition in interface iSoundSource

Returns:

See Also:

iSoundSource.getPosition()

getVelocity

public csVector3 getVelocity()

Description copied from interface: iSoundSource

get velocity of this source

Specified by:

getVelocity in interface iSoundSource

Returns:

See Also:

iSoundSource.getVelocity()

getVolume

public float getVolume()

Description copied from interface: iSoundSource

Get volume (range from 0.0 to 1.0);.

Specified by:

getVolume in interface iSoundSource

Returns:

See Also:

iSoundSource.getVolume()

play

public void play()

Description copied from interface: iSoundSource

Play the sound. PlayMethod can be set to any combination of SOUND_*.

Specified by:

play in interface iSoundSource

See Also:

iSoundSource.play()

play

public void play(long playMethod)

Description copied from interface: iSoundSource

Play the sound. PlayMethod can be set to any combination of SOUND_*.

Specified by:

play in interface iSoundSource

Parameters:

playMethod -

See Also:

iSoundSource.play(long)

setFrequencyFactor

public void setFrequencyFactor(float factor)

Description copied from interface: iSoundSource

Set frequency factor : 1 = normal, >1 faster, 0-1 slower.

Specified by:

setFrequencyFactor in interface iSoundSource

Parameters:

factor -

See Also:

iSoundSource.setFrequencyFactor(float)

setMode3D

public void setMode3D(int m)

Description copied from interface: iSoundSource

set 3d mode

Specified by:

setMode3D in interface iSoundSource

Parameters:

m -

See Also:

iSoundSource.setMode3D(int)

setPosition

public void setPosition(csVector3 pos)

Description copied from interface: iSoundSource

set position of this source

Specified by:

setPosition in interface iSoundSource

Parameters:

pos -

See Also:

iSoundSource.setPosition(crystalspace.jbind.impl.csgeom.vector3.csVector3)

setVelocity

public void setVelocity(csVector3 spd)

Description copied from interface: iSoundSource

set velocity of this source

Specified by:

setVelocity in interface iSoundSource

Parameters:

spd -

See Also:

iSoundSource.setVelocity(crystalspace.jbind.impl.csgeom.vector3.csVector3)

setVolume

public void setVolume(float volume)

Description copied from interface: iSoundSource

Set volume (range from 0.0 to 1.0);.

Specified by:

setVolume in interface iSoundSource

Parameters:

volume -

See Also:

iSoundSource.setVolume(float)

stop

public void stop()

Description copied from interface: iSoundSource

Stop the sound.

Specified by:

stop in interface iSoundSource

See Also:

iSoundSource.stop()