SoundComposer.ItemSpeechVoiceSet method |
|
Remarks
Modifies the voice used to render the speech text of the given item. The current voice of the item can be obtained through the SoundComposer.ItemSpeechVoiceGet 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 ItemSpeechVoiceSet ( nUniqueId as Int32, nVoice as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ItemSpeechVoiceSet ( Int32 nUniqueId, Int32 nVoice ); |
[C++] public: enumErrorCodes ItemSpeechVoiceSet ( Int32 nUniqueId, Int32 nVoice ); |
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. |
nVoice |
The zero-based index of the speaking voice. The total number of voices installed inside the system can be obtained through the SpeechVoicesNumGet method and related attributes can be obtained through the SpeechVoiceAttributeGet method. |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |