io.spokestack.spokestack

Class SpokestackAdapter

java.lang.Object

io.spokestack.spokestack.SpokestackAdapter

All Implemented Interfaces:

DialogueListener, OnSpeechEventListener, TTSListener, Callback<NLUResult>, TraceListener

Direct Known Subclasses:

Spokestack

public abstract class SpokestackAdapter
extends Object
implements Callback<NLUResult>, DialogueListener, OnSpeechEventListener, TraceListener, TTSListener

An abstract adapter class for receiving events from Spokestack modules.

This class provides empty implementations of all Spokestack listener methods. It can be extended and individual methods overridden to receive only those events.

Constructor Summary

Constructors

Constructor and Description
SpokestackAdapter()

Method Summary

Modifier and Type	Method and Description
void	call(NLUResult result) Called when an NLU classification result is available if this class is registered as a callback at classification time.
void	error(SpokestackModule module, Throwable err) Receive notifications of errors from any module.
void	eventReceived(TTSEvent event) Receive events from the TTS module.
void	nluResult(NLUResult result) Called when an NLU classification result is available if this class is registered as a callback at classification time.
void	onDialogueEvent(DialogueEvent event) Receive events from the dialogue management module.
void	onError(Throwable err) Receive notifications of errors that occur during NLU classification if this class is registered as a callback at classification time.Adapters added to a Spokestack class at build time are automatically registered for all classifications.
void	onEvent(SpeechContext.Event event, SpeechContext context) Receive events from the speech pipeline.
void	onTrace(EventTracer.Level level, String message) Receive trace messages from the NLU module.
void	speechEvent(SpeechContext.Event event, SpeechContext context) Receive events from the speech pipeline.
void	trace(SpokestackModule module, String message) Receive trace messages from any module.
void	ttsEvent(TTSEvent event) Receive events from the TTS module.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpokestackAdapter

public SpokestackAdapter()

Method Detail

onEvent

public void onEvent(@NotNull
                    SpeechContext.Event event,
                    @NotNull
                    SpeechContext context)

Receive events from the speech pipeline.

Clients should typically override speechEvent(SpeechContext.Event, SpeechContext) instead of this method.

Specified by:

onEvent in interface OnSpeechEventListener

Parameters:

event - The name of the event that was raised.

context - The current speech context.

speechEvent

public void speechEvent(@NotNull
                        SpeechContext.Event event,
                        @NotNull
                        SpeechContext context)

Receive events from the speech pipeline.

Parameters:

event - The name of the event that was raised.

context - The current speech context.

call

public void call(@NotNull
                 NLUResult result)

Called when an NLU classification result is available if this class is registered as a callback at classification time. Adapters added to a Spokestack class at build time are automatically registered for all classifications.

Clients should typically override nluResult(NLUResult) instead of this method.

Specified by:

call in interface Callback<NLUResult>

Parameters:

result - The NLU result.

See Also:

TensorflowNLU.classify(String), AsyncResult

nluResult

public void nluResult(@NotNull
                      NLUResult result)

Called when an NLU classification result is available if this class is registered as a callback at classification time. Adapters added to a Spokestack class at build time are automatically registered for all classifications.

Parameters:

result - The NLU result.

See Also:

TensorflowNLU.classify(String), AsyncResult

onError

public void onError(@NotNull
                    Throwable err)

Receive notifications of errors that occur during NLU classification if this class is registered as a callback at classification time.Adapters added to a Spokestack class at build time are automatically registered for all classifications.

Clients should typically override error(SpokestackModule, Throwable) instead of this method.

Specified by:

onError in interface Callback<NLUResult>

Parameters:

err - An error generated during expected NLU classification.

See Also:

TensorflowNLU.classify(String), AsyncResult

onTrace

public void onTrace(@NotNull
                    EventTracer.Level level,
                    @NotNull
                    String message)

Receive trace messages from the NLU module.

Clients should typically override trace(SpokestackModule, String) instead of this method.

Specified by:

onTrace in interface TraceListener

Parameters:

level - The trace event's severity level.

message - the trace event's message.

eventReceived

public void eventReceived(@NotNull
                          TTSEvent event)

Receive events from the TTS module.

Clients should typically override ttsEvent(TTSEvent) instead of this method.

Specified by:

eventReceived in interface TTSListener

Parameters:

event - The event from the TTS module.

ttsEvent

public void ttsEvent(@NotNull
                     TTSEvent event)

Receive events from the TTS module.

Parameters:

event - The event from the TTS module.

onDialogueEvent

public void onDialogueEvent(@NotNull
                            DialogueEvent event)

Receive events from the dialogue management module.

Specified by:

onDialogueEvent in interface DialogueListener

Parameters:

event - The dialogue event.

trace

public void trace(@NotNull
                  SpokestackModule module,
                  @NotNull
                  String message)

Receive trace messages from any module.

Parameters:

module - The module where the message originated.

message - the trace event's message.

error

public void error(@NotNull
                  SpokestackModule module,
                  @NotNull
                  Throwable err)

Receive notifications of errors from any module.

Parameters:

module - The module where the error originated.

err - An error generated during Spokestack operation.