Symbian^3 Product Developer Library >

CTtsHwDevice Class Reference

class CTtsHwDevice : public CASRSHwDevice

Class to provide speech synthesis

asrsttshwdevice.lib
Since
2.8

Inherits from

Public Member Functions
~CTtsHwDevice()
IMPORT_C TTtsStyleIDAddStyleL(const TTtsStyle &)
IMPORT_C voidAnalyzeProsodyL(CTtsParsedText &)
IMPORT_C voidAnalyzeStructureL(CTtsParsedText &)
IMPORT_C voidBufferProcessed(const TDesC8 &)
IMPORT_C voidDeleteStyleL(TTtsStyleID)
IMPORT_C voidGetPositionL(TTimeIntervalMicroSeconds &)
IMPORT_C voidGetPositionL(TTtsSegment &, TInt &)
IMPORT_C TBoolIsLanguageSupported(TLanguage)
IMPORT_C CTtsHwDevice *NewL(MTtsHwDeviceObserver &, TUint, TUint)
IMPORT_C TUint16NumberOfStyles()
IMPORT_C voidPause()
IMPORT_C voidPrimeSynthesisL(MTtsSegmentStream &)
IMPORT_C voidPrimeSynthesisL(CTtsParsedText &)
IMPORT_C voidSetPositionL(const TTimeIntervalMicroSeconds &)
IMPORT_C voidSetPositionL(const TTtsSegment &, TInt)
IMPORT_C voidStop()
IMPORT_C TTtsStyle &StyleL(TTtsStyleID)
IMPORT_C TTtsStyle &StyleL(TUint16)
IMPORT_C voidSynthesizeL()
Private Member Functions
CTtsHwDevice()
voidConstructL(MTtsHwDeviceObserver &, TUint, TUint)
Inherited Functions
CASRSHwDevice::CASRSHwDevice()
CASRSHwDevice::Clear()
CASRSHwDevice::CustomInterface(TUid)
CASRSHwDevice::InitializeL()
CASRSHwDevice::NewL()
CASRSHwDevice::~CASRSHwDevice()
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
CTtsAlgorithm *iAlgorithm
TAny *iReserved

Constructor & Destructor Documentation

CTtsHwDevice()

CTtsHwDevice()[private]

C++ default constructor.

~CTtsHwDevice()

IMPORT_C~CTtsHwDevice()[virtual]

Destructor.

Member Functions Documentation

AddStyleL(const TTtsStyle &)

IMPORT_C TTtsStyleIDAddStyleL(const TTtsStyle &aStyle)
Adds new style to the collection. If equal style exists already, new style is not added.
Since
2.8

Parameters

const TTtsStyle & aStyleStyle to be added.

AnalyzeProsodyL(CTtsParsedText &)

IMPORT_C voidAnalyzeProsodyL(CTtsParsedText &aText)
Analyses stucture of text and adds style information.
Since
2.8

Parameters

CTtsParsedText & aTextUpdates text object by dividing it into segments with new styles.

AnalyzeStructureL(CTtsParsedText &)

IMPORT_C voidAnalyzeStructureL(CTtsParsedText &aText)
Analyses stucture of text by finding paragraphs and sentences.
Since
2.8

Parameters

CTtsParsedText & aTextUpdates text object by segmenting it into paragraphs and sentences.

BufferProcessed(const TDesC8 &)

IMPORT_C voidBufferProcessed(const TDesC8 &aBuffer)
Notifies that the buffer has been processed
Since
2.8

Parameters

const TDesC8 & aBufferThe buffer which has been processed

ConstructL(MTtsHwDeviceObserver &, TUint, TUint)

voidConstructL(MTtsHwDeviceObserver &aObserver,
TUintaSamplingRate,
TUintaBufferSize
)[private]

By default Symbian 2nd phase constructor is private.

Parameters

MTtsHwDeviceObserver & aObserver
TUint aSamplingRate
TUint aBufferSize

DeleteStyleL(TTtsStyleID)

IMPORT_C voidDeleteStyleL(TTtsStyleIDaStyleID)
Deletes style.
Since
2.8

Parameters

TTtsStyleID aStyleIDIdentifier of style to be deleted.

GetPositionL(TTimeIntervalMicroSeconds &)

IMPORT_C voidGetPositionL(TTimeIntervalMicroSeconds &aTime)
Gives current position of synthesizing.
Since
2.8

Parameters

TTimeIntervalMicroSeconds & aTimeTime of the synthesizing position.

GetPositionL(TTtsSegment &, TInt &)

IMPORT_C voidGetPositionL(TTtsSegment &aSegment,
TInt &aWordIndex
)
Gives current position of synthesizing.
Since
2.8

Parameters

TTtsSegment & aSegmentThe segment being synthesizing
TInt & aWordIndexThe index of word being synthesizing

IsLanguageSupported(TLanguage)

IMPORT_C TBoolIsLanguageSupported(TLanguageaLanguage)
Ask if a language is supported or not.
Since
2.8

Parameters

TLanguage aLanguageSynthesizing language.

NewL(MTtsHwDeviceObserver &, TUint, TUint)

IMPORT_C CTtsHwDevice *NewL(MTtsHwDeviceObserver &aObserver,
TUintaSamplingRate,
TUintaBufferSize
)[static]

Two-phased constructor.

Parameters

MTtsHwDeviceObserver & aObserverObserver which implements callback functions.
TUint aSamplingRateSampling rate for output audio
TUint aBufferSizeBuffer size for output audio

NumberOfStyles()

IMPORT_C TUint16NumberOfStyles()const
Gives number of styles.
Since
2.8

Pause()

IMPORT_C voidPause()
Pauses synthesizing.
Since
2.8

PrimeSynthesisL(MTtsSegmentStream &)

IMPORT_C voidPrimeSynthesisL(MTtsSegmentStream &aStream)
Prepares for synthesizing.
Since
2.8

Parameters

MTtsSegmentStream & aStreamStream to be synthesized.

PrimeSynthesisL(CTtsParsedText &)

IMPORT_C voidPrimeSynthesisL(CTtsParsedText &aText)
Prepares for synthesizing.
Since
2.8

Parameters

CTtsParsedText & aTextText containing segments to be synthesized.

SetPositionL(const TTimeIntervalMicroSeconds &)

IMPORT_C voidSetPositionL(const TTimeIntervalMicroSeconds &aTime)
Sets new position for synthesizing.
Since
2.8

Parameters

const TTimeIntervalMicroSeconds & aTimeTime of the synthesizing postion.

SetPositionL(const TTtsSegment &, TInt)

IMPORT_C voidSetPositionL(const TTtsSegment &aSegment,
TIntaWordIndex
)
Sets new position for synthesizing.
Since
2.8

Parameters

const TTtsSegment & aSegmentThe segment being synthesizing
TInt aWordIndexThe index of word being synthesizing

Stop()

IMPORT_C voidStop()
Stops synthesizing and releases resources of synthesizing. The method does nothing if already stopped.
Since
2.8

StyleL(TTtsStyleID)

IMPORT_C TTtsStyle &StyleL(TTtsStyleIDaStyleID)
Receives style information
Since
2.8

Parameters

TTtsStyleID aStyleIDStyle identifier

StyleL(TUint16)

IMPORT_C TTtsStyle &StyleL(TUint16aIndex)
Receives style information
Since
2.8

Parameters

TUint16 aIndexIndex to style: 0..NumberOfStyles()

SynthesizeL()

IMPORT_C voidSynthesizeL()
Starts waveform production. The synthesized audio buffers are send back to client using MthdProcessBuffer().
Since
2.8

Member Data Documentation

CTtsAlgorithm * iAlgorithm

CTtsAlgorithm *iAlgorithm[private]

TAny * iReserved

TAny *iReserved[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.