|
TracksBoard.ItemSpeechFromStringAdd method |
  
|
|
TracksBoard.ItemSpeechFromStringAdd method |
|
Remarks
Adds a speech item, contained inside a string, to the audio stream previously created through the TracksBoard.Create method. The text string can be eventually modified at a later time through the TracksBoard.ItemSpeechStringSet method.
In case you should need to add a text to speech stream from contents of a text file you may use the TracksBoard.ItemSpeechFromFileAdd method.
The string of text may eventually contain XML markups: see the MSDN documentation for a tutorial about XML markup syntax.
Important note about items overlapping
Overlapping of two items on the same track is now allowed so, in case the new item should cause an overlapping and upon space availability, the new item will be automatically moved to the next track or to the previous track; if both previous and next tracks should in any case suffer an overlapping, a new track will be automatically inserted on the nearest position.
|
For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.
For further details about methods of the TracksBoard refer to the TracksBoard class section.
Syntax
[Visual Basic] Public Function ItemSpeechFromStringAdd ( strFriendlyName as String, nTrack as Int32, strTextToSpeech as String, nVoice as Int32, bRemoveFinalSilence as Boolean, nOffsetMs as Int32, ByRef nUniqueId as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ItemSpeechFromStringAdd ( string strFriendlyName, Int32 nChannel, string strTextToSpeech, Int32 nVoice, bool bRemoveFinalSilence, Int32 nOffsetMs, ref Int32 nUniqueId ); |
[C++] public: enumErrorCodes ItemSpeechFromStringAdd ( string strFriendlyName, Int32 nChannel, string strTextToSpeech, Int32 nVoice, bool bRemoveFinalSilence, Int32 nOffsetMs, Int32 __gc *nUniqueId ); |
Parameter |
Description |
||||||
|
|
||||||
strFriendlyName |
Friendly name of the item |
||||||
nTrack |
Zero-based index of the track where the item will be placed. The current number of tracks can be obtained through the TracksBoard.TracksCountGet method. |
||||||
strTextToSpeech |
String of text to speech |
||||||
nVoice |
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. |
||||||
bRemoveFinalSilence |
Boolean flag that specifies to remove the final silence usually introduced by the Speech API. Supported values are the following:
|
||||||
fAmplitude |
Amplitude of the voice. - value 0.0 means that the voice is muted - values higher than 0.0 and lower than 1.0 attenuate the voice - value 1.0 sets the voice at full volume - values higher than 1.0 amplify the voice |
||||||
nOffsetMs |
Offset of the voice, expressed in milliseconds, respect to the beginning of the audio stream. |
||||||
nUniqueId |
Reference to a value that, on return from the method call, will contain the unique identifier of the newly added item: this unique identifier will be used in order to invoke further methods related to the use of this specific item. |
Return value
Value |
Meaning |
|
|
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 |
