io.spokestack.spokestack

Class SpeechPipeline.Builder

java.lang.Object

io.spokestack.spokestack.SpeechPipeline.Builder

Enclosing class:

SpeechPipeline

public static final class SpeechPipeline.Builder
extends Object

speech pipeline builder.

Constructor Summary

Constructors

Constructor and Description
Builder() initializes a new builder instance.

Method Summary

Modifier and Type	Method and Description
SpeechPipeline.Builder	addOnSpeechEventListener(OnSpeechEventListener listen) adds a pipeline event listener.
SpeechPipeline.Builder	addStageClass(String value) adds a single pipeline stage component class name.
SpeechPipeline	build() creates and initializes the speech pipeline.
SpeechPipeline.Builder	setAndroidContext(android.content.Context androidContext) Sets the android context for the pipeline.
SpeechPipeline.Builder	setConfig(SpeechConfig value) attaches a pipeline configuration object.
SpeechPipeline.Builder	setInputClass(String value) sets the class name of the audio input component.
SpeechPipeline.Builder	setProperty(String key, Object value) sets a pipeline configuration value.
SpeechPipeline.Builder	setStageClasses(List<String> value) sets the class names of the pipeline stage components in bulk.
SpeechPipeline.Builder	useProfile(String profileClass) applies configuration from a PipelineProfile to the current builder, returning the modified builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

initializes a new builder instance.

Method Detail

setInputClass

public SpeechPipeline.Builder setInputClass(String value)

sets the class name of the audio input component.

Parameters:

value - input component class name

Returns:

this

setStageClasses

public SpeechPipeline.Builder setStageClasses(List<String> value)

sets the class names of the pipeline stage components in bulk.

Parameters:

value - list of pipeline component names

Returns:

this

addStageClass

public SpeechPipeline.Builder addStageClass(String value)

adds a single pipeline stage component class name.

Parameters:

value - stage component class name

Returns:

this

setConfig

public SpeechPipeline.Builder setConfig(SpeechConfig value)

attaches a pipeline configuration object.

Parameters:

value - configuration to attach

Returns:

this

setAndroidContext

public SpeechPipeline.Builder setAndroidContext(android.content.Context androidContext)

Sets the android context for the pipeline. Some components may require an application context instead of an activity context; see individual component documentation for details.

Parameters:

androidContext - the android context for the pipeline.

Returns:

this

See Also:

AndroidSpeechRecognizer

setProperty

public SpeechPipeline.Builder setProperty(String key,
                                          Object value)

sets a pipeline configuration value.

Parameters:

key - configuration property name

value - property value

Returns:

this

useProfile

public SpeechPipeline.Builder useProfile(String profileClass)
                                  throws IllegalArgumentException

applies configuration from a PipelineProfile to the current builder, returning the modified builder. subsequent calls to useProfile or setProperty can override configuration set by a profile.

Parameters:

profileClass - class name of the profile to apply.

Returns:

an updated builder

Throws:

IllegalArgumentException - if the specified profile does not exist

addOnSpeechEventListener

public SpeechPipeline.Builder addOnSpeechEventListener(OnSpeechEventListener listen)

adds a pipeline event listener.

Parameters:

listen - listener callback

Returns:

this

build

public SpeechPipeline build()

creates and initializes the speech pipeline.

Returns:

configured pipeline instance