io.spokestack.spokestack

Class SpeechContext

java.lang.Object

io.spokestack.spokestack.SpeechContext

public final class SpeechContext
extends Object

Spokestack speech recognition context

This class maintains global state for the speech pipeline, allowing pipeline components to communicate information among themselves and event handlers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpeechContext.Event speech event types.

Constructor Summary

Constructors

Constructor and Description
SpeechContext(SpeechConfig config) initializes a new configuration instance.

Method Summary

Modifier and Type	Method and Description
SpeechContext	addOnSpeechEventListener(OnSpeechEventListener listener) attaches a speech listener.
SpeechContext	attachBuffer(Deque<ByteBuffer> value) attaches a frame buffer to the context.
boolean	canTrace(EventTracer.Level level) indicates whether a message will be traced at a level.
SpeechContext	detachBuffer() removes the attached frame buffer.
SpeechContext	dispatch(SpeechContext.Event event) dispatches a speech event.
android.content.Context	getAndroidContext()
Deque<ByteBuffer>	getBuffer()
double	getConfidence()
Throwable	getError()
String	getMessage()
String	getTranscript()
boolean	isActive()
boolean	isManaged()
boolean	isSpeech()
SpeechContext	removeOnSpeechEventListener(OnSpeechEventListener listener) detaches a speech listener.
SpeechContext	reset() resets the context to the default state.
SpeechContext	setActive(boolean value) activates speech recognition.
void	setAndroidContext(android.content.Context androidContext) sets the Android context.
SpeechContext	setConfidence(double value) updates the current speech confidence level.
SpeechContext	setError(Throwable value) raises an error with the speech context.
void	setManaged(boolean value) signals whether the speech context is being externally managed (audio is not being read from the microphone by Spokestack's speech pipeline).
SpeechContext	setSpeech(boolean value) sets speech detected indicator.
SpeechContext	setTranscript(String value) updates the current speech transcript.
SpeechContext	trace(EventTracer.Level level, String format, Object... params) raises a trace event.
SpeechContext	traceDebug(String format, Object... params) traces a debug level message.
SpeechContext	traceInfo(String format, Object... params) traces an informational level message.
SpeechContext	tracePerf(String format, Object... params) traces a performance level message.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpeechContext

public SpeechContext(SpeechConfig config)

initializes a new configuration instance.

Parameters:

config - speech configuration

Method Detail

getAndroidContext

@Nullable
public android.content.Context getAndroidContext()

Returns:

the Android context if set

setAndroidContext

public void setAndroidContext(@Nullable
                              android.content.Context androidContext)

sets the Android context.

Parameters:

androidContext - The Android context

getBuffer

public Deque<ByteBuffer> getBuffer()

Returns:

speech frame buffer

attachBuffer

public SpeechContext attachBuffer(Deque<ByteBuffer> value)

attaches a frame buffer to the context.

Parameters:

value - frame buffer to attach

Returns:

this

detachBuffer

public SpeechContext detachBuffer()

removes the attached frame buffer.

Returns:

this

isSpeech

public boolean isSpeech()

Returns:

speech detected indicator

setSpeech

public SpeechContext setSpeech(boolean value)

sets speech detected indicator.

Parameters:

value - value to assign

Returns:

this

isActive

public boolean isActive()

Returns:

speech recognition active indicator

setActive

public SpeechContext setActive(boolean value)

activates speech recognition.

Parameters:

value - value to assign

Returns:

this

isManaged

public boolean isManaged()

Returns:

whether the context is being managed externally.

setManaged

public void setManaged(boolean value)

signals whether the speech context is being externally managed (audio is not being read from the microphone by Spokestack's speech pipeline).

Parameters:

value - true if audio is being managed by an external component.

getTranscript

public String getTranscript()

Returns:

the current speech transcript.

setTranscript

public SpeechContext setTranscript(String value)

updates the current speech transcript.

Parameters:

value - speech text value to assign

Returns:

this

getConfidence

public double getConfidence()

Returns:

the current speech recognition confidence: [0-1)

setConfidence

public SpeechContext setConfidence(double value)

updates the current speech confidence level.

Parameters:

value - speech confidence to assign

Returns:

this

getError

public Throwable getError()

Returns:

the last error raised on the context

setError

public SpeechContext setError(Throwable value)

raises an error with the speech context.

Parameters:

value - the exception to attach

Returns:

this

getMessage

public String getMessage()

Returns:

the current trace message

reset

public SpeechContext reset()

resets the context to the default state.

Returns:

this

traceDebug

public SpeechContext traceDebug(String format,
                                Object... params)

traces a debug level message.

Parameters:

format - trace message format string

params - trace message format parameters

Returns:

this

tracePerf

public SpeechContext tracePerf(String format,
                               Object... params)

traces a performance level message.

Parameters:

format - trace message format string

params - trace message format parameters

Returns:

this

traceInfo

public SpeechContext traceInfo(String format,
                               Object... params)

traces an informational level message.

Parameters:

format - trace message format string

params - trace message format parameters

Returns:

this

canTrace

public boolean canTrace(EventTracer.Level level)

indicates whether a message will be traced at a level.

Parameters:

level - tracing level

Returns:

true if tracing will occur, false otherwise

trace

public SpeechContext trace(EventTracer.Level level,
                           String format,
                           Object... params)

raises a trace event.

Parameters:

level - tracing level

format - trace message format string

params - trace message format parameters

Returns:

this

dispatch

public SpeechContext dispatch(SpeechContext.Event event)

dispatches a speech event.

Parameters:

event - the event to publish

Returns:

this

addOnSpeechEventListener

public SpeechContext addOnSpeechEventListener(OnSpeechEventListener listener)

attaches a speech listener.

Parameters:

listener - listener callback to attach

Returns:

this

removeOnSpeechEventListener

public SpeechContext removeOnSpeechEventListener(OnSpeechEventListener listener)

detaches a speech listener.

Parameters:

listener - listener callback to remove

Returns:

this