Symbian^3 Application Developer Library >

TTtsSegment Class Reference

class TTtsSegment

Class to store segment information

nssttscommon.lib
Since
2.8
Public Member Functions
TTtsSegment (const TTtsStyleID , const TDesC &, const TDesC8 &, const TTimeIntervalMicroSeconds32 &)
IMPORT_C const TDesC8 & PhonemeSequencePtr ()
IMPORT_C void ResetStyle ()
IMPORT_C void SetPhonemeSequencePtr (const TDesC8 &)
IMPORT_C void SetStyle ( TTtsStyle &)
IMPORT_C void SetStyleID ( TTtsStyleID )
IMPORT_C void SetTextPtr (const TDesC &)
IMPORT_C void SetTrailingSilenceL (const TTimeIntervalMicroSeconds32 &)
IMPORT_C TTtsStyleID StyleID ()
IMPORT_C TTtsStyle & StyleL ()
IMPORT_C const TDesC & TextPtr ()
IMPORT_C const TTimeIntervalMicroSeconds32 & TrailingSilence ()
Private Attributes
TBool iIncludesStyle
TPtrC8 iPhonemeSequence
TTtsStyle iStyle
TTtsStyleID iStyleID
TPtrC iText
TTimeIntervalMicroSeconds32 iTrailingSilenceDuration

Constructor & Destructor Documentation

TTtsSegment(const TTtsStyleID, const TDesC &, const TDesC8 &, const TTimeIntervalMicroSeconds32 &)

IMPORT_C TTtsSegment ( const TTtsStyleID aStyleID,
const TDesC & aText =  KNullDesC ,
const TDesC8 & aPhonemeSequence =  KNullDesC8 ,
const TTimeIntervalMicroSeconds32 & aTrailingSilenceDuration = KTtsUndefinedDuration
)
C++ default constructor.
Since
2.8

Parameters

const TTtsStyleID aStyleID Indentifier of style.
const TDesC & aText =  KNullDesC Text for segment
const TDesC8 & aPhonemeSequence =  KNullDesC8 Corresponding phoneme sequence for text
const TTimeIntervalMicroSeconds32 & aTrailingSilenceDuration = KTtsUndefinedDuration The duration of trailing silence.

Member Functions Documentation

PhonemeSequencePtr()

IMPORT_C const TDesC8 & PhonemeSequencePtr ( ) const
Returns phoneme sequence pointer of the segment.
Since
2.8

ResetStyle()

IMPORT_C void ResetStyle ( )

Resets previously set style and segment will use the style ID.

Since
3.1

SetPhonemeSequencePtr(const TDesC8 &)

IMPORT_C void SetPhonemeSequencePtr ( const TDesC8 & aPhonemeSequence )
Sets phoneme sequence pointer. The phoneme sequence cannot be deleted during the life time of this object.
Since
2.8

Parameters

const TDesC8 & aPhonemeSequence Phoneme sequence.

SetStyle(TTtsStyle &)

IMPORT_C void SetStyle ( TTtsStyle & aStyle )

Sets style object for segment.

Since
3.1

Parameters

TTtsStyle & aStyle Style reference.

SetStyleID(TTtsStyleID)

IMPORT_C void SetStyleID ( TTtsStyleID aStyleID )
Sets style for segment. The style cannot be deleted during this object life time.
Since
2.8

Parameters

TTtsStyleID aStyleID The identifier of the style.

SetTextPtr(const TDesC &)

IMPORT_C void SetTextPtr ( const TDesC & aText )
Sets text pointer. The text cannot be deleted during the life time of this object.
Since
2.8

Parameters

const TDesC & aText Text.

SetTrailingSilenceL(const TTimeIntervalMicroSeconds32 &)

IMPORT_C void SetTrailingSilenceL ( const TTimeIntervalMicroSeconds32 & aDuration )
Sets duration of trailing silence.
Since
2.8

Parameters

const TTimeIntervalMicroSeconds32 & aDuration Duration of silence.

StyleID()

IMPORT_C TTtsStyleID StyleID ( ) const
Returns identifier of used style.
Since
2.8

StyleL()

IMPORT_C TTtsStyle & StyleL ( )

Returns style object.

Since
3.1

TextPtr()

IMPORT_C const TDesC & TextPtr ( ) const
Returns text pointer of the segment.
Since
2.8

TrailingSilence()

IMPORT_C const TTimeIntervalMicroSeconds32 & TrailingSilence ( ) const
Gets duration of trailing silence.
Since
2.8

Member Data Documentation

TBool iIncludesStyle

TBool iIncludesStyle [private]

TPtrC8 iPhonemeSequence

TPtrC8 iPhonemeSequence [private]

TTtsStyle iStyle

TTtsStyle iStyle [private]

TTtsStyleID iStyleID

TTtsStyleID iStyleID [private]

TPtrC iText

TPtrC iText [private]

TTimeIntervalMicroSeconds32 iTrailingSilenceDuration

TTimeIntervalMicroSeconds32 iTrailingSilenceDuration [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.