MTextReaderInput Class Reference

#include <textreaderinput.h>

class MTextReaderInput

Public Member Functions
pure virtual TInt	AppendAudioL(TInt, const RFile &)
pure virtual TInt	AppendGroupL()
pure virtual TInt	AppendPauseL(TInt, TTimeIntervalMicroSeconds)
pure virtual TInt	AppendTextL(TInt, const TDesC &, const TTtsStyle *)
pure virtual TInt	AppendToneL(TInt, TTimeIntervalMicroSeconds, TInt)
pure virtual void	RemoveGroupL(TInt)
pure virtual void	ReplaceItemAudioL(TInt, TInt, const RFile &)
pure virtual void	ReplaceItemPauseL(TInt, TInt, TTimeIntervalMicroSeconds)
pure virtual void	ReplaceItemTextL(TInt, TInt, const TDesC &, const TTtsStyle *)
pure virtual void	ReplaceItemToneL(TInt, TInt, TTimeIntervalMicroSeconds, TInt)
pure virtual void	ResetGroupL(TInt)

Detailed Description

Interface definition for giving input for a text reader

Member Function Documentation

AppendAudioL ( TInt, const RFile & )

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

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 ( )

TInt

AppendGroupL

(

)

[pure virtual]

Append a group to queue

Return Value: Id of a created group

AppendPauseL ( TInt, TTimeIntervalMicroSeconds )

TInt	AppendPauseL	(	TInt	aGroupId,
			TTimeIntervalMicroSeconds	aDuration
		)	[pure virtual]

Append pause item to group

Parameters
aGroupId	Identifier for group
aDuration	Duration of pause

Return Value: Identifier for appended item inside group

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

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

Append text item to group

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

Return Value: Identifier for appended item inside group

AppendToneL ( TInt, TTimeIntervalMicroSeconds, TInt )

TInt	AppendToneL	(	TInt	aGroupId,
			TTimeIntervalMicroSeconds	aDuration,
			TInt	aFrequency
		)	[pure virtual]

Append tone item to group

Parameters
aGroupId	Identifier for group
aDuration	Duration of tone
aFrequency	Frequency of tone

Return Value: Identifier for appended item inside group

RemoveGroupL ( TInt )

void

RemoveGroupL

(

TInt

aGroupId

)

[pure virtual]

Deletes a group from queue

Parameters
aGroupId	Id of deleted group

ReplaceItemAudioL ( TInt, TInt, const RFile & )

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

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 )

void	ReplaceItemPauseL	(	TInt	aGroupId,
			TInt	aItemId,
			TTimeIntervalMicroSeconds	aDuration
		)	[pure virtual]

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 * )

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

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 )

void	ReplaceItemToneL	(	TInt	aGroupId,
			TInt	aItemId,
			TTimeIntervalMicroSeconds	aDuration,
			TInt	aFrequency
		)	[pure virtual]

Replace existing item with a tone item

Parameters
aGroupId	Identifier for group
aItemId	Identifier for item inside a group
aDuration	Duration of tone
aFrequency	Frequency of tone

ResetGroupL ( TInt )

void

ResetGroupL

(

TInt

aGroupId

)

[pure virtual]

Resets a group, ie. removes all items it has.

Parameters
aGroupId	Id of group to be resetted