|
SoundGenerator.StreamElementSpeechVoiceGet method |
  
|
|
SoundGenerator.StreamElementSpeechVoiceGet method |
|
Remarks
Obtains the voice used to speech for the given text to speech element.
For further details about sound generation see the SoundGenerator object and the How to generate wave tones, noises, DTMF tones and text to speech tutorial.
Syntax
[Visual Basic] Public Function StreamElementSpeechVoiceGet ( nPlayerIndex as Int16, nUniqueId as Int32, ByRef nVoice as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes StreamElementSpeechVoiceGet ( Int16 nPlayerIndex, Int32 nUniqueId, ref Int32 nVoice ); |
[C++] public: enumErrorCodes StreamElementSpeechVoiceGet ( Int16 nPlayerIndex, Int32 nUniqueId, Int32 __gc *nVoice ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
nUniqueId |
The unique identifier of the element previously returned by one of the following calls: - SoundGenerator.StreamChannelAddSpeechFromFile |
nVoice |
Reference to a value that, on return from the method call, will contain the zero-based index of the voice used to speech. The total number of voices installed inside the system can be obtained through the SoundGenerator.SpeechVoicesNumGet method while attributes of each single voice 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. |
