|
SoundComposer.ItemSpeechTextGet method |
  
|
|
SoundComposer.ItemSpeechTextGet method |
|
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 SoundComposerMan class and the How to compose a sound tutorial.
Syntax
[Visual Basic] Public Function ItemSpeechTextGet ( nUniqueId as Int32, ByRef bIsFile as Boolean ) as String |
[C#] public string ItemSpeechTextGet ( Int32 nUniqueId, ref bool bIsFile ); |
[C++] public: string ItemSpeechTextGet ( Int32 nUniqueId, bool __gc *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:
|
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. |
