|
SoundComposer.ItemSpeechVoiceGet method |
  
|
|
SoundComposer.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 SoundComposer.ItemSpeechVoiceSet 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 ItemSpeechVoiceGet ( nPlayerIndex as Int16, nUniqueId as Int32, ByRef nVoice as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ItemSpeechVoiceGet ( Int16 nPlayerIndex, Int32 nUniqueId, ref Int32 nVoice ); |
[C++] public: enumErrorCodes ItemSpeechVoiceGet ( Int16 nPlayerIndex, Int32 nUniqueId, Int32 __gc *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 |
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 (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |
