CTextReader Class Reference

#include <textreader.h>

Link against: textreader.lib

class CTextReader : public CBase, public MTextReaderInput, public MTextReaderController

Inherits from

CTextReader

Public Member Functions
virtual	~CTextReader()
virtual IMPORT_C TInt	AppendAudioL(TInt, const RFile &)
virtual IMPORT_C TInt	AppendGroupL()
virtual IMPORT_C TInt	AppendPauseL(TInt, TTimeIntervalMicroSeconds)
virtual IMPORT_C TInt	AppendTextL(TInt, const TDesC &, const TTtsStyle *)
virtual IMPORT_C TInt	AppendToneL(TInt, TTimeIntervalMicroSeconds, TInt)
virtual IMPORT_C TTimeIntervalMicroSeconds	Duration()
virtual IMPORT_C TBool	ForwardL()
IMPORT_C void	GetMessageReaderLanguagesL(RArray< TLanguage > &)
IMPORT_C void	InitializeL()
IMPORT_C TInt	InsertGroupL(TInt)
virtual IMPORT_C TInt	MaxVolume()
IMPORT_C CTextReader *	NewL(MTextReaderControllerObserver &)
IMPORT_C CTextReader *	NewLC(MTextReaderControllerObserver &)
virtual IMPORT_C TBool	NextL()
virtual IMPORT_C void	Pause()
IMPORT_C void	PlayL(TInt)
virtual IMPORT_C TTimeIntervalMicroSeconds	Position()
virtual IMPORT_C TBool	PreviousL()
virtual IMPORT_C void	RemoveGroupL(TInt)
virtual IMPORT_C void	ReplaceItemAudioL(TInt, TInt, const RFile &)
virtual IMPORT_C void	ReplaceItemPauseL(TInt, TInt, TTimeIntervalMicroSeconds)
virtual IMPORT_C void	ReplaceItemTextL(TInt, TInt, const TDesC &, const TTtsStyle *)
virtual IMPORT_C void	ReplaceItemToneL(TInt, TInt, TTimeIntervalMicroSeconds, TInt)
virtual IMPORT_C void	ResetGroupL(TInt)
virtual IMPORT_C TBool	RewindL()
virtual IMPORT_C void	SetAudioOutputL(TInt)
virtual IMPORT_C void	SetSpeakingRateL(TInt)
virtual IMPORT_C void	SetVolume(TInt)
virtual IMPORT_C void	Stop()
virtual IMPORT_C TInt	Volume()

Inherited Functions
	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()
	MTextReaderController::PlayL(TBool)

Detailed Description

Text Reader

Constructor & Destructor Documentation

~CTextReader ( )

IMPORT_C

~CTextReader

(

)

[virtual]

Member Function Documentation

AppendAudioL ( TInt, const RFile & )

IMPORT_C TInt	AppendAudioL	(	TInt	aGroupId,
			const RFile &	aFile
		)	[virtual]

Reimplemented from MTextReaderInput::AppendAudioL(TInt,const RFile &)

Append audio item to group

Parameters
aGroupId	Identifier for group
aFile	File handle to the audio file

Return Value: Identifier for appended item inside group

AppendGroupL ( )

IMPORT_C TInt

AppendGroupL

(

)

[virtual]

Reimplemented from MTextReaderInput::AppendGroupL()

Append a group to queue

Return Value: Id of a created group

AppendPauseL ( TInt, TTimeIntervalMicroSeconds )

IMPORT_C TInt	AppendPauseL	(	TInt	aGroupId,
			TTimeIntervalMicroSeconds	aDuration = KDefaultPauseDuration
		)	[virtual]

Reimplemented from MTextReaderInput::AppendPauseL(TInt,TTimeIntervalMicroSeconds)

Append pause item to group

Parameters
aGroupId	Identifier for group

Return Value: Identifier for appended item inside group

AppendTextL ( TInt, const TDesC &, const TTtsStyle * )

IMPORT_C TInt	AppendTextL	(	TInt	aGroupId,
			const TDesC &	aText,
			const TTtsStyle *	aStyle = 0
		)	[virtual]

Reimplemented from MTextReaderInput::AppendTextL(TInt,const TDesC &,const TTtsStyle *)

Append text item to group

Parameters
aGroupId	Identifier for group
aText	Text to be added (copied)
aStyle	Synthesis settings

Return Value: Identifier for appended item inside group

AppendToneL ( TInt, TTimeIntervalMicroSeconds, TInt )

IMPORT_C TInt	AppendToneL	(	TInt	aGroupId,
			TTimeIntervalMicroSeconds	aDuration = KDefaultToneDuration ,
			TInt	aFrequency = KDefaultToneFrequency
		)	[virtual]

Reimplemented from MTextReaderInput::AppendToneL(TInt,TTimeIntervalMicroSeconds,TInt)

Append tone item to group

Parameters
aGroupId	Identifier for group

Return Value: Identifier for appended item inside group

Duration ( )

IMPORT_C TTimeIntervalMicroSeconds

Duration

(

)

[virtual]

Reimplemented from MTextReaderController::Duration()

From MTextReaderController Give duration

Return Value: Duration in ms

ForwardL ( )

IMPORT_C TBool

ForwardL

(

)

[virtual]

Reimplemented from MTextReaderController::ForwardL()

Forward to next item.

Return Value: ETrue if can be forwarded otherwise EFalse

GetMessageReaderLanguagesL ( RArray< TLanguage > & )

IMPORT_C void

GetMessageReaderLanguagesL

(

RArray< TLanguage > &

aLanguages

)

For getting supported TTS languages to be used in MR (Klatt languages are ignored)

InitializeL ( )

IMPORT_C void

InitializeL

(

)

InsertGroupL ( TInt )

IMPORT_C TInt

InsertGroupL

(

TInt

aPos

)

Insert a group to array

Return Value: Id of a created group

MaxVolume ( )

IMPORT_C TInt

MaxVolume

(

)

[virtual]

Reimplemented from MTextReaderController::MaxVolume()

From MTextReaderController Max volume

Return Value: Maximum volume level

NewL ( MTextReaderControllerObserver & )

IMPORT_C CTextReader *

NewL

(

MTextReaderControllerObserver &

aObserver

)

[static]

NewLC ( MTextReaderControllerObserver & )

IMPORT_C CTextReader *

NewLC

(

MTextReaderControllerObserver &

aObserver

)

[static]

NextL ( )

IMPORT_C TBool

NextL

(

)

[virtual]

Reimplemented from MTextReaderController::NextL()

Move to the next group of items.

Return Value: ETrue if can be moved otherwise EFalse

Pause ( )

IMPORT_C void

Pause

(

)

[virtual]

Reimplemented from MTextReaderController::Pause()

Pause playing

PlayL ( TInt )

IMPORT_C void

PlayL

(

TInt

aIndex

)

Start playback

Position ( )

IMPORT_C TTimeIntervalMicroSeconds

Position

(

)

[virtual]

Reimplemented from MTextReaderController::Position()

From MTextReaderController Gives position

Return Value: Position in ms

PreviousL ( )

IMPORT_C TBool

PreviousL

(

)

[virtual]

Reimplemented from MTextReaderController::PreviousL()

Move to the previous group of items.

Return Value: ETrue if can be forwarded otherwise EFalse

RemoveGroupL ( TInt )

IMPORT_C void

RemoveGroupL

(

TInt

aGroupId

)

[virtual]

Reimplemented from MTextReaderInput::RemoveGroupL(TInt)

Deletes a group from queue

Parameters
aGroupId	Id of deleted group

ReplaceItemAudioL ( TInt, TInt, const RFile & )

IMPORT_C void	ReplaceItemAudioL	(	TInt	aGroupId,
			TInt	aItemId,
			const RFile &	aFile
		)	[virtual]

Reimplemented from MTextReaderInput::ReplaceItemAudioL(TInt,TInt,const RFile &)

Replace existing item with an audio item

Parameters
aGroupId	Identifier for group
aItemId	Identifier for item inside a group
aFile	File handle to the audio file

ReplaceItemPauseL ( TInt, TInt, TTimeIntervalMicroSeconds )

IMPORT_C void	ReplaceItemPauseL	(	TInt	aGroupId,
			TInt	aItemId,
			TTimeIntervalMicroSeconds	aDuration = KDefaultPauseDuration
		)	[virtual]

Reimplemented from MTextReaderInput::ReplaceItemPauseL(TInt,TInt,TTimeIntervalMicroSeconds)

Replace existing item with a pause item

Parameters
aGroupId	Identifier for group
aItemId	Identifier for item inside a group
aDuration	Duration of pause

ReplaceItemTextL ( TInt, TInt, const TDesC &, const TTtsStyle * )

IMPORT_C void	ReplaceItemTextL	(	TInt	aGroupId,
			TInt	aItemId,
			const TDesC &	aText,
			const TTtsStyle *	aStyle = 0
		)	[virtual]

Reimplemented from MTextReaderInput::ReplaceItemTextL(TInt,TInt,const TDesC &,const TTtsStyle *)

Replace existing item with a text item

Parameters
aGroupId	Identifier for group
aItemId	Identifier for item inside a group
aText	Text to be added (copied)
aStyle	Synthesis settings, ownership stays in client

ReplaceItemToneL ( TInt, TInt, TTimeIntervalMicroSeconds, TInt )

IMPORT_C void	ReplaceItemToneL	(	TInt	aGroupId,
			TInt	aItemId,
			TTimeIntervalMicroSeconds	aDuration = KDefaultToneDuration ,
			TInt	aFrequency = KDefaultToneFrequency
		)	[virtual]