[Visual Basic]

Public Function StreamElementSpeechTextGet (

nPlayerIndex as Int16,

nUniqueId as Int32,

ByRef bIsFile as bool

) as String

[C#]

public string StreamElementSpeechTextGet (

Int16 nPlayerIndex,

Int32 nUniqueId,

ref bool bIsFile

);

[C++]

public: string StreamElementSpeechTextGet (

Int16 nPlayerIndex,,

Int32 nUniqueId,

bool __gc  *bIsFile

);

Parameter

Description

nPlayerIndex

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:

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.