COM Objects > SoundGenerator object > Methods > SoundGenerator.StreamElementSpeechTextGet method

Remarks

Obtains the string of text to speech for the given element.

For further details about sound generation see the SoundGenerator object and the How to generate wave tones, noises, DTMF tones and text to speech tutorial..

Syntax

[Visual Basic]

control.SoundGenerator.StreamElementSpeechTextGet (

nPlayer as Integer,

nUniqueId as Long,

ByRef bIsFile as enumBoolean

) as String

[C++]

BSTR control.SoundGenerator.StreamElementSpeechTextGet (

short nPlayer,

long nUniqueId,

long *bIsFile

);

Parameter

Description

nPlayer

Number representing the zero-based index of the involved player

nUniqueId

The unique identifier of the element previously returned by one of the following calls:

- SoundGenerator.StreamChannelAddSpeechFromFile

- SoundGenerator.StreamChannelAddSpeechFromString

- SoundGenerator.StreamChannelElementUniqueIdGet

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.