|
SoundComposer.ItemSpeechStringSet method |
  
|
|
SoundComposer.ItemSpeechStringSet method |
|
Remarks
Modifies the string of text to speech of the given item. The current string of text to speech can be obtained through the SoundComposer.ItemContentGet method.
Due to the fact that modifying the string of text may certainly modify the original duration of the item, invoking the SoundComposer.ItemInfoGet method would allow keeping the duration updated.
For further details about sound composing see the the SoundComposerMan class and the How to compose a sound tutorial.
Syntax
[Visual Basic] Public Function ItemSpeechStringSet ( nPlayerIndex as Int16, ByRef nUniqueId as Int32, strTextToSpeech as String ) as enumErrorCodes |
[C#] public enumErrorCodes ItemSpeechStringSet ( Int16 nPlayerIndex, Int32 nUniqueId, string strTextToSpeech ); |
[C++] public: enumErrorCodes ItemSpeechStringSet ( Int16 nPlayerIndex, Int32 nUniqueId, string strTextToSpeech ); |
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. |
strTextToSpeech |
String of text to speech |
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. |
