crystalspace.jbind.impl.sound.handle
Class csSoundHandle

java.lang.Object
  crystalspace.jbind.impl.csNativeObject
      crystalspace.jbind.impl.csutil.scf.csBase
          crystalspace.jbind.impl.sound.handle.csSoundHandle

All Implemented Interfaces:

iBase, iPointer, iSoundHandle

public class csSoundHandle

extends csBase

implements iSoundHandle

Author:

Quentin Anciaux

Field Summary

Fields inherited from class crystalspace.jbind.impl.csNativeObject

ImplFactory, nPointer

Constructor Summary

csSoundHandle(iPointer nPointer)

Method Summary

iSoundSource	createSource(int Mode3d) create a sound source
java.lang.String	getName() Return the name of the interface
int	getVersion() Return the version of the interface
protected boolean	isNativePointerValidSafe(long pointer)
boolean	isStatic() is this a static or streamed handle?
iSoundSource	play() play an instance of this sound For Loop == true it returns a iSoundSource you have to Stop (); if you want to get rid of the looping sound (also if you want to unload your SoundRenderer); If Loop is false 0 is returned
iSoundSource	play(boolean Loop) play an instance of this sound For Loop == true it returns a iSoundSource you have to Stop (); if you want to get rid of the looping sound (also if you want to unload your SoundRenderer); If Loop is false 0 is returned
void	resetStream() Reset the stream to the beginning (only for streamed sound);.
void	startStream(boolean Loop) Start playing the stream (only for streamed sound);.
void	stopStream() Stop playing the stream (only for streamed 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

csSoundHandle

public csSoundHandle(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)

createSource

public iSoundSource createSource(int Mode3d)

Description copied from interface: iSoundHandle

create a sound source

Specified by:

createSource in interface iSoundHandle

Parameters:

Mode3d -

Returns:

See Also:

iSoundHandle.createSource(int)

isStatic

public boolean isStatic()

Description copied from interface: iSoundHandle

is this a static or streamed handle?

Specified by:

isStatic in interface iSoundHandle

Returns:

See Also:

iSoundHandle.isStatic()

play

public iSoundSource play()

Description copied from interface: iSoundHandle

play an instance of this sound For Loop == true it returns a iSoundSource you have to Stop (); if you want to get rid of the looping sound (also if you want to unload your SoundRenderer); If Loop is false 0 is returned

Specified by:

play in interface iSoundHandle

Returns:

See Also:

iSoundHandle.play()

play

public iSoundSource play(boolean Loop)

Description copied from interface: iSoundHandle

play an instance of this sound For Loop == true it returns a iSoundSource you have to Stop (); if you want to get rid of the looping sound (also if you want to unload your SoundRenderer); If Loop is false 0 is returned

Specified by:

play in interface iSoundHandle

Parameters:

Loop -

Returns:

See Also:

iSoundHandle.play(boolean)

resetStream

public void resetStream()

Description copied from interface: iSoundHandle

Reset the stream to the beginning (only for streamed sound);.

Specified by:

resetStream in interface iSoundHandle

See Also:

iSoundHandle.resetStream()

startStream

public void startStream(boolean Loop)

Description copied from interface: iSoundHandle

Start playing the stream (only for streamed sound);.

Specified by:

startStream in interface iSoundHandle

Parameters:

Loop -

See Also:

iSoundHandle.startStream(boolean)

stopStream

public void stopStream()

Description copied from interface: iSoundHandle

Stop playing the stream (only for streamed sound);.

Specified by:

stopStream in interface iSoundHandle

See Also:

iSoundHandle.stopStream()