Copyright © 2001-2018 MultiMedia Soft

SoundGenerator.StreamElementSpeechVoiceGet method

Previous pageReturn to chapter overviewNext page



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..





[Visual Basic]

control.SoundGenerator.StreamElementSpeechVoiceGet (

nPlayer as Integer,

nUniqueId as Long,

ByRef nVoice as Long

) as enumErrorCodes



short control.SoundGenerator.StreamElementSpeechVoiceGet (

short nPlayer,

long nUniqueId,

long *nVoice








Number representing the zero-based index of the involved player


The unique identifier of the element previously returned by one of the following calls:

- SoundGenerator.StreamChannelAddSpeechFromFile

- SoundGenerator.StreamChannelAddSpeechFromString

- SoundGenerator.StreamChannelElementUniqueIdGet


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






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