crystalspace.jbind.interfaces.isound.handle
Interface iSoundHandle

All Superinterfaces:

iBase, iPointer

All Known Implementing Classes:

csSoundHandle

public interface iSoundHandle

extends iBase

The sound handle is a sound in the state that is needed by the sound renderer. It can be used to create instances of the sound, the sound sources (the Play() method is only a convenience method to create and play a sound source). Sounds can be either static or streamed, depending on the sound data the handle is created from. There is a basic difference between these two modes how they are used: You can create any number of totally independent sound sources from a static sound, but not from a streamed sound. All sources that are created from the same streamed sound *always* play the same sequence of samples, if they play sound at all. So the Play() and Stop() methods of a streamed sound source only set the source to active or quiet mode, but they don't control the position that is currently played. Instead this position is controlled with the sound handle interface.

Author:

Java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/devapi/structiSoundHandle.php

Method Summary

iSoundSource	createSource(int Mode3d) create a sound source
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 interface crystalspace.jbind.interfaces.iutil.scf.iBase

decRef, getName, getRefCount, getVersion, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Method Detail

createSource

public iSoundSource createSource(int Mode3d)

create a sound source

Parameters:

Mode3d -

Returns:

isStatic

public boolean isStatic()

is this a static or streamed handle?

Returns:

play

public 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

Returns:

play

public 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

Parameters:

Loop -

Returns:

resetStream

public void resetStream()

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

startStream

public void startStream(boolean Loop)

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

Parameters:

Loop -

stopStream

public void stopStream()

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