Copyright © 2008-2018 MultiMedia Soft

SoundComposer.ItemSpeechTextGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the string of text or the pathname of the text file for a specific speech item. The pathname of the text file or the string of text to speech can be modified through the SoundComposer.ItemSpeechFileSet method or through the SoundComposer.ItemSpeechStringSet method.

 

For further details about sound composing see the the SoundComposer object and the How to compose a sound tutorial.

 

 

Syntax

 

[Visual Basic]

control.SoundComposer.ItemSpeechTextGet (

nUniqueId as Long,

ByRef bIsFile as enumBoolean

) as String


 

[C++]

string control.SoundComposer.ItemSpeechTextGet (

long nUniqueId,

long *bIsFile

);


 

Parameter

Description

 

 

nUniqueId

The unique identifier of the element previously returned by the call to the SoundComposer.ItemSpeechFromStringAdd method or to the SoundComposer.ItemSpeechFromFileAdd method.

bIsFile

Reference to a value that, on return from the method call, will contain a boolean value stating if the returned string is the text to speech or the absolute pathname of a file containing the text to speech.

Supported values are the following:

Mnemonic Value

Meaning

BOOL_FALSE

The returned string represents the text to speech

BOOL_TRUE

The returned string represents the absolute pathname of a file containing the text to speech

 

 

Return value

 

Value

Meaning

 

 

Empty string

The information is not available or an error occurred (see the LastError property for further error details)

Valid string

String containing the text to speech or the absolute pathname of a file containing the text to speech.