at.ac.fhstp.sonitalk

Class SoniTalkDecoder

java.lang.Object

at.ac.fhstp.sonitalk.SoniTalkDecoder

public class SoniTalkDecoder
extends java.lang.Object

Handles the capture of audio, the detection of messages and their decoding. The receiveBackground functions execute in a worker Thread and need to be stopped when your application stops. Please call stopReceiving() when you are done with receiving to release the resources (e.g. microphone access)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SoniTalkDecoder.MessageListener Interface defining the callbacks to implement in order to receive messages from a SoniTalk Decoder.
static interface	SoniTalkDecoder.SpectrumListener Interface defining the callbacks to implement in order to receive the spectrum of received messages.

Method Summary

Modifier and Type	Method and Description
void	addMessageListener(SoniTalkDecoder.MessageListener listener)
void	addSpectrumListener(SoniTalkDecoder.SpectrumListener listener)
void	pause() Pauses the current capturing/decoding process without cancelling the potential timers.
void	receiveBackground(int requestCode) Captures audio and tries detecting/decoding messages.
void	receiveBackground(long delayMilliseconds, int requestCode) Captures audio and tries decoding for delayMilliseconds ms.
boolean	removeMessageListener(SoniTalkDecoder.MessageListener listener)
boolean	removeSpectrumListener(SoniTalkDecoder.SpectrumListener listener)
void	resume() Resumes audio capturing and detecting/decoding messages.
boolean	returnsRawAudio() Returns true if detected messages will be returned with the original audio.
void	setReturnRawAudio(boolean returnRawAudio) Decides if detected messages will be returned with the original audio or not.
void	stopReceiving() Stops the capturing and decoding process.

Methods inherited from class java.lang.Object

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

Method Detail

receiveBackground

public void receiveBackground(long delayMilliseconds,
                              int requestCode)
                       throws DecoderStateException

Captures audio and tries decoding for delayMilliseconds ms. Audio processing occurs in a separate Thread. Detected messages will be notified to listeners via the onMessageReceived callback. Cancellation will be called on the Thread currently calling this method.

Parameters:

delayMilliseconds - Duration you want to try and receive a message before cancelling.

Throws:

DecoderStateException

receiveBackground

public void receiveBackground(int requestCode)
                       throws DecoderStateException

Captures audio and tries detecting/decoding messages. Audio processing occurs in a separate Thread. Detected messages will be notified to listeners via the onMessageReceived callback. It is possible to cancel using stopReceiving().

Throws:

DecoderStateException

stopReceiving

public void stopReceiving()

Stops the capturing and decoding process. This must be called at the latest in your app onStop() or in your Service onDestroy() to release resources. Please do not keep the microphone access when you do not need it anymore.

pause

public void pause()

Pauses the current capturing/decoding process without cancelling the potential timers.

resume

public void resume()
            throws DecoderStateException

Resumes audio capturing and detecting/decoding messages. Audio processing occurs in a separate Thread. Detected messages will be notified to listeners via the onMessageReceived callback. It is possible to cancel using stopReceiving().

Throws:

DecoderStateException

addMessageListener

public void addMessageListener(SoniTalkDecoder.MessageListener listener)

removeMessageListener

public boolean removeMessageListener(SoniTalkDecoder.MessageListener listener)

addSpectrumListener

public void addSpectrumListener(SoniTalkDecoder.SpectrumListener listener)

removeSpectrumListener

public boolean removeSpectrumListener(SoniTalkDecoder.SpectrumListener listener)

returnsRawAudio

public boolean returnsRawAudio()

Returns true if detected messages will be returned with the original audio.

Returns:

true if detected messages will be returned with the original audio

setReturnRawAudio

public void setReturnRawAudio(boolean returnRawAudio)

Decides if detected messages will be returned with the original audio or not. Useful for debugging or replaying a message.

Parameters:

returnRawAudio -