|
SoundComposer.ItemSpeechVoiceSet method |
  
|
|
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.
Due to the fact that modifying the speaking voice may certainly modify the original duration of the item, invoking the SoundComposer.ItemInfoGet method would allow keeping the duration updated.
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 ( nPlayerIndex as Int16, nUniqueId as Int32, nVoice as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ItemSpeechVoiceSet ( Int16 nPlayerIndex, Int32 nUniqueId, Int32 nVoice ); |
[C++] public: enumErrorCodes ItemSpeechVoiceSet ( Int16 nPlayerIndex, Int32 nUniqueId, Int32 nVoice ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the player that owns the sound composer session |
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 SoundGenerator.SpeechVoicesNumGet method and related attributes can be obtained through the SoundGenerator.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. |
