marytts.server

Class Request

java.lang.Object

marytts.server.Request

public class Request
extends Object

A request consists of input data, a desired output data type and the means to process the input data into the data of the output type.

A request is used as follows. First, its basic properties are set in the constructor, such as its input and output types. Second, the input data is provided to the request either by directly setting it (setInputData()) or by reading it from a Reader (readInputData()). Third, the request is processed (process()). Finally, the output data is either accessed directly (getOutputData()) or written to an output stream (writeOutputData).

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	abortRequested
protected AppendableSequenceAudioInputStream	appendableAudioStream
protected AudioFileFormat	audioFileFormat
protected String	defaultEffects
protected Locale	defaultLocale
protected String	defaultStyle
protected Voice	defaultVoice
protected int	id
protected MaryData	inputData
protected MaryDataType	inputType
protected org.apache.log4j.Logger	logger
protected MaryData	outputData
protected MaryDataType	outputType
protected String	outputTypeParams
protected boolean	streamAudio
protected Map<MaryModule,Long>	timingInfo
protected Set<MaryModule>	usedModules

Constructor Summary

Constructors

Constructor and Description
Request(MaryDataType inputType, MaryDataType outputType, Locale defaultLocale, Voice defaultVoice, String defaultEffects, String defaultStyle, int id, AudioFileFormat audioFileFormat)
Request(MaryDataType inputType, MaryDataType outputType, Locale defaultLocale, Voice defaultVoice, String defaultEffects, String defaultStyle, int id, AudioFileFormat audioFileFormat, boolean streamAudio, String outputTypeParams)

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Inform this request that any further processing does not make sense.
AppendableSequenceAudioInputStream	getAudio()
AudioFileFormat	getAudioFileFormat()
String	getDefaultEffects()
Locale	getDefaultLocale()
String	getDefaultStyle()
Voice	getDefaultVoice()
int	getId()
MaryDataType	getInputType()
MaryData	getOutputData() Direct access to the output data.
MaryDataType	getOutputType()
boolean	getStreamAudio()
void	process() Process the input data to produce the output data.
void	readInputData(Reader inputReader) Read the input data from a Reader.
void	setInputData(MaryData inputData) Set the input data directly, in case it is already in the form of a MaryData object.
void	setInputData(String inputText)
void	writeOutputData(OutputStream outputStream) Write the output data to the specified OutputStream.

Methods inherited from class java.lang.Object

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

Field Detail

inputType

protected MaryDataType inputType

outputType

protected MaryDataType outputType

outputTypeParams

protected String outputTypeParams

audioFileFormat

protected AudioFileFormat audioFileFormat

appendableAudioStream

protected AppendableSequenceAudioInputStream appendableAudioStream

defaultLocale

protected Locale defaultLocale

defaultVoice

protected Voice defaultVoice

defaultStyle

protected String defaultStyle

defaultEffects

protected String defaultEffects

id

protected int id

logger

protected org.apache.log4j.Logger logger

inputData

protected MaryData inputData

outputData

protected MaryData outputData

streamAudio

protected boolean streamAudio

abortRequested

protected boolean abortRequested

usedModules

protected Set<MaryModule> usedModules

timingInfo

protected Map<MaryModule,Long> timingInfo

Constructor Detail

Request

public Request(MaryDataType inputType,
       MaryDataType outputType,
       Locale defaultLocale,
       Voice defaultVoice,
       String defaultEffects,
       String defaultStyle,
       int id,
       AudioFileFormat audioFileFormat)

Request

public Request(MaryDataType inputType,
       MaryDataType outputType,
       Locale defaultLocale,
       Voice defaultVoice,
       String defaultEffects,
       String defaultStyle,
       int id,
       AudioFileFormat audioFileFormat,
       boolean streamAudio,
       String outputTypeParams)

Method Detail

getInputType

public MaryDataType getInputType()

getOutputType

public MaryDataType getOutputType()

getDefaultLocale

public Locale getDefaultLocale()

getDefaultVoice

public Voice getDefaultVoice()

getDefaultStyle

public String getDefaultStyle()

getDefaultEffects

public String getDefaultEffects()

getId

public int getId()

getAudioFileFormat

public AudioFileFormat getAudioFileFormat()

getAudio

public AppendableSequenceAudioInputStream getAudio()

getStreamAudio

public boolean getStreamAudio()

abort

public void abort()

Inform this request that any further processing does not make sense.

setInputData

public void setInputData(MaryData inputData)

Set the input data directly, in case it is already in the form of a MaryData object.

Parameters:

inputData - inputData

readInputData

public void readInputData(Reader inputReader)
                   throws Exception

Read the input data from a Reader.

Parameters:

inputReader - inputReader

Throws:

Exception - Exception

setInputData

public void setInputData(String inputText)
                  throws Exception

Throws:

Exception

process

public void process()
             throws Exception

Process the input data to produce the output data.

Throws:

Exception - Exception

See Also:

for direct access to the resulting output data, for writing the output data to a stream

getOutputData

public MaryData getOutputData()

Direct access to the output data.

Returns:

outputdata

writeOutputData

public void writeOutputData(OutputStream outputStream)
                     throws Exception

Write the output data to the specified OutputStream.

Parameters:

outputStream - outputStream

Throws:

Exception - Exception