COM Objects > TracksBoard object > Methods > TracksBoard.ItemSpeechVoiceGet method

Remarks

Obtains the voice used to render the speech text of the given item. The voice of the item can be modified through the TracksBoard.ItemSpeechVoiceSet 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]

control.TracksBoard.ItemSpeechVoiceGet (

nUniqueId as Long,

ByRef nVoice as Long

) as enumErrorCodes

[C++]

short control.TracksBoard.ItemSpeechVoiceGet (

long nUniqueId,

long *nVoice

);

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

nVoice

Reference that, on return from the method call, will contain the zero-based index of the speaking voice. The total number of voices installed inside the system can be obtained through the SoundGenerator.SpeechVoicesNumGet method and related attributes can be obtained through the SoundGenerator.SpeechVoiceAttributeGet method.

Return value

Value	Meaning

Negative value	An error occurred, check the LastError property value in order to get the error code
enumErrorCodes.ERR_NOERROR (0)	The method call was successful