org.jsfml.audio

Class SoundBufferRecorder

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.audio.SoundRecorder

org.jsfml.audio.SoundBufferRecorder

public class SoundBufferRecorder
extends SoundRecorder

A SoundRecorder which stores captured audio data into a SoundBuffer.

Constructor Summary

Constructors

Constructor and Description
SoundBufferRecorder() Constructs a sound buffer recorder.

Method Summary

Methods

Modifier and Type	Method and Description
ConstSoundBuffer	getBuffer() Gets the sound buffer containing the captured audio data.
protected long	nativeCreate() Deprecated.
protected void	nativeDelete() Deprecated.
protected void	nativeSetExPtr() Deprecated.
protected boolean	onProcessSamples(short[] samples) Called when a new batch of audio samples comes in.
protected boolean	onStart() Called when the sound recorder starts recording.
protected void	onStop() Called when the audio capture has stopped.

Methods inherited from class org.jsfml.audio.SoundRecorder

getSampleRate, isAvailable, start, start, stop

Methods inherited from class org.jsfml.internal.SFMLNativeObject

finalize

Methods inherited from class java.lang.Object

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

Constructor Detail

SoundBufferRecorder

public SoundBufferRecorder()

Constructs a sound buffer recorder.

Method Detail

nativeCreate

@Deprecated
protected long nativeCreate()

Deprecated.

Description copied from class: SFMLNativeObject

Creates a new native SFML object of the represented SFML class in the JVM memory heap.

Overrides:

nativeCreate in class SoundRecorder

Returns:

the pointer to the newly created native SFML object.

nativeSetExPtr

@Deprecated
protected void nativeSetExPtr()

Deprecated.

Description copied from class: SFMLNativeObject

This method is expected to fill the extra pointers array, if any.

It is called after the object has been created or wrapped around an already existing pointer.

Overrides:

nativeSetExPtr in class SoundRecorder

nativeDelete

@Deprecated
protected void nativeDelete()

Deprecated.

Description copied from class: SFMLNativeObject

Deletes the underlying SFML object.

Overrides:

nativeDelete in class SoundRecorder

getBuffer

public ConstSoundBuffer getBuffer()

Gets the sound buffer containing the captured audio data.

The sound buffer will remain empty until any sound has been successfully captured using the SoundRecorder.start(int) and SoundRecorder.stop() methods.

Returns:

the sound buffer containing the captured audio data.

onStart

protected final boolean onStart()

Description copied from class: SoundRecorder

Called when the sound recorder starts recording.

This method can be implemented by deriving classes to perform any actions necessary before audio recording actually starts.

Specified by:

onStart in class SoundRecorder

Returns:

true to start recording after this method is done, false to cancel.

onProcessSamples

protected final boolean onProcessSamples(short[] samples)

Description copied from class: SoundRecorder

Called when a new batch of audio samples comes in.

Implementing classes can then process the captured audio data.

Note that this method will be called in a separate audio capturing thread.

Also note that this method is currently hardcoded to be called every 100ms, which might be changed in the future.

Specified by:

onProcessSamples in class SoundRecorder

Parameters:

samples - the 16-bit mono samples that were captured.

Returns:

true to continue recording after this method is done, false to stop recording.

onStop

protected final void onStop()

Description copied from class: SoundRecorder

Called when the audio capture has stopped.

Note that this method will be called in a separate audio capturing thread.

Specified by:

onStop in class SoundRecorder