Classes > TracksBoard class > Methods > TracksBoard.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 TracksBoard.ItemSpeechFileSet method or through the TracksBoard.ItemSpeechStringSet method.

For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.

For further details about methods of the TracksBoard refer to the TracksBoard class section.

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

Unique identification number assigned to the sound item after being generated by one of the following methods:

•	TracksBoard.ItemSpeechFromStringAdd and TracksBoard.ItemSpeechFromFileAdd for text to speech items

•	TracksBoard.ItemClone when an existing speech item has been cloned

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
false	The returned string represents the text to speech
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.