edu.cmu.sphinx.api

Class Context

java.lang.Object

edu.cmu.sphinx.api.Context

public class Context
extends java.lang.Object

Helps to tweak configuration without touching XML-file directly.

Constructor Summary

Constructors

Constructor and Description
Context(Configuration config) Constructs builder that uses default XML configuration.
Context(java.lang.String path, Configuration config) Constructs builder using user-supplied XML configuration.

Method Summary

Modifier and Type	Method and Description
<C extends Configurable> C	getInstance(java.lang.Class<C> clazz) Returns instance of the XML configuration by its class.
Loader	getLoader() Returns the Loader object used for loading the acoustic model.
void	setAcousticModel(java.lang.String path) Sets acoustic model location.
void	setDictionary(java.lang.String path) Sets dictionary.
void	setGlobalProperty(java.lang.String name, java.lang.Object value) Sets property of a top-level "property" tag.
void	setGrammar(java.lang.String path, java.lang.String name) Sets path to the grammar files.
void	setLanguageModel(java.lang.String path) Sets path to the language model.
void	setLocalProperty(java.lang.String name, java.lang.Object value) Sets property within a "component" tag in configuration.
void	setSampleRate(int sampleRate) Sets sampleRate.
void	setSpeechSource(java.io.InputStream stream) Sets byte stream as the speech source.
void	setSpeechSource(java.io.InputStream stream, TimeFrame timeFrame)

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context(Configuration config)
        throws java.io.IOException,
               java.net.MalformedURLException

Constructs builder that uses default XML configuration.

Parameters:

config - configuration

Throws:

java.net.MalformedURLException - if failed to load configuration file

java.io.IOException

Context

public Context(java.lang.String path,
               Configuration config)
        throws java.io.IOException,
               java.net.MalformedURLException

Constructs builder using user-supplied XML configuration.

Parameters:

path - path to XML-resource with configuration

config - configuration

Throws:

java.net.MalformedURLException - if failed to load configuration file

java.io.IOException - if failed to load configuration file

Method Detail

setAcousticModel

public void setAcousticModel(java.lang.String path)
                      throws java.io.IOException

Sets acoustic model location. It also reads feat.params which should be located at the root of acoustic model and sets corresponding parameters of MelFrequencyFilterBank2 instance.

Parameters:

path - path to directory with acoustic model files

Throws:

java.io.IOException - if failed to read feat.params

setDictionary

public void setDictionary(java.lang.String path)

Sets dictionary.

Parameters:

path - path to directory with dictionary files

setSampleRate

public void setSampleRate(int sampleRate)

Sets sampleRate.

Parameters:

sampleRate - sample rate of the input stream.

setGrammar

public void setGrammar(java.lang.String path,
                       java.lang.String name)

Sets path to the grammar files. Enables static grammar and disables probabilistic language model. JSGF and GrXML formats are supported.

Parameters:

path - path to the grammar files

name - name of the main grammar to use

See Also:

setLanguageModel(String)

setLanguageModel

public void setLanguageModel(java.lang.String path)

Sets path to the language model. Enables probabilistic language model and disables static grammar. Currently it supports ".lm", ".dmp" and ".bin" file formats.

Parameters:

path - path to the language model file

Throws:

java.lang.IllegalArgumentException - if path ends with unsupported extension

See Also:

setGrammar(String, String)

setSpeechSource

public void setSpeechSource(java.io.InputStream stream,
                            TimeFrame timeFrame)

setSpeechSource

public void setSpeechSource(java.io.InputStream stream)

Sets byte stream as the speech source.

Parameters:

stream - stream to process

setLocalProperty

public void setLocalProperty(java.lang.String name,
                             java.lang.Object value)

Sets property within a "component" tag in configuration. Use this method to alter "value" property of a "property" tag inside a "component" tag of the XML configuration.

Parameters:

name - property name

value - property value

See Also:

setGlobalProperty(String, Object)

setGlobalProperty

public void setGlobalProperty(java.lang.String name,
                              java.lang.Object value)

Sets property of a top-level "property" tag. Use this method to alter "value" property of a "property" tag whose parent is the root tag "config" of the XML configuration.

Parameters:

name - property name

value - property value

See Also:

setLocalProperty(String, Object)

getInstance

public <C extends Configurable> C getInstance(java.lang.Class<C> clazz)

Returns instance of the XML configuration by its class.

Type Parameters:

C - generic

Parameters:

clazz - class to look up

Returns:

instance of the specified class or null

getLoader

public Loader getLoader()

Returns the Loader object used for loading the acoustic model.

Returns:

the loader object