|
SoundGenerator.SpeechGenerateFromFile method |
  
|
|
SoundGenerator.SpeechGenerateFromFile method |
|
Remarks
Generates and load into the editor a speech audio stream from a file containing text.
The text file may eventually contain XML markup: see the MSDN documentation for a tutorial about XML markup syntax.
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] control.SoundGenerator.SpeechGenerateFromFile ( nSampleRate as Long, nChannels as Integer, strPathname as String, nVoice as Long, fAmplitude as Single, bRemoveFinalSilence as enumBoolean ) as enumErrorCodes |
[C++] short control.SoundGenerator.SpeechGenerateFromFile ( long nSampleRate, short nChannels, LPCTSTR strPathname, long nVoice, float fAmplitude, short bRemoveFinalSilence ); |
Parameter |
Description |
||||||||||||
|
|
||||||||||||
nSampleRate |
Sample rate of the stream, e.g. 44100 |
||||||||||||
nChannels |
Number of channels of the audio stream. Supported values are the following:
|
||||||||||||
strPathname |
Absolute pathname of the text file |
||||||||||||
nVoice |
Zero-based index of the speaking voice. The total number of voices installed inside the system can be obtained through the SpeechVoicesNumGet method. |
||||||||||||
fAmplitude |
Audio stream amplitude. - value 0.0 means that sound volume is muted - values higher than 0.0 and lower than 1.0 attenuate the sound volume - value 1.0 sets the sound at full volume - values higher than 1.0 amplify the sound volume |
||||||||||||
bRemoveFinalSilence |
Boolean flag that specifies to remove the final silence usually introduced by the Speech API. Supported values are the following:
|
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred, check the LastError property value in order to see the error code meaning |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful. |
