org.jsfml.audio

Class SoundRecorder

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.audio.SoundRecorder

Direct Known Subclasses:

SoundBufferRecorder

public abstract class SoundRecorder
extends SFMLNativeObject

Abstract base class for sound recorders, which provide functionality to capture audio data.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SoundRecorder() Constructs a sound recorder.

Method Summary

Methods

Modifier and Type	Method and Description
int	getSampleRate() Gets the sample rate that audio is being captured with.
static boolean	isAvailable() Checks whether audio capturing is available on this system.
protected long	nativeCreate() Deprecated.
protected void	nativeDelete() Deprecated.
protected void	nativeSetExPtr() Deprecated.
protected abstract boolean	onProcessSamples(short[] samples) Called when a new batch of audio samples comes in.
protected abstract boolean	onStart() Called when the sound recorder starts recording.
protected abstract void	onStop() Called when the audio capture has stopped.
void	start() Starts capturing audio data with a sample rate of 44,100 Hz.
void	start(int sampleRate) Starts capturing audio data with the specified sample rate.
void	stop() Stops capturing audio data.

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

SoundRecorder

protected SoundRecorder()

Constructs a sound recorder.

Method Detail

isAvailable

public static boolean isAvailable()

Checks whether audio capturing is available on this system.

Returns:

true if audio capturing is available, false otherwise.

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.

Specified by:

nativeCreate in class SFMLNativeObject

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.

Specified by:

nativeSetExPtr in class SFMLNativeObject

nativeDelete

@Deprecated
protected void nativeDelete()

Deprecated.

Description copied from class: SFMLNativeObject

Deletes the underlying SFML object.

Specified by:

nativeDelete in class SFMLNativeObject

start

public final void start(int sampleRate)

Starts capturing audio data with the specified sample rate.

Parameters:

sampleRate - the sample rate in samples per second.

start

public final void start()

Starts capturing audio data with a sample rate of 44,100 Hz.

stop

public final void stop()

Stops capturing audio data.

getSampleRate

public final int getSampleRate()

Gets the sample rate that audio is being captured with.

Returns:

the audio sample rate in samples per second.

onStart

protected abstract boolean onStart()

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.

Returns:

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

onProcessSamples

protected abstract boolean onProcessSamples(short[] samples)

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.

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 abstract void onStop()

Called when the audio capture has stopped.

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