Copyright © 2001-2019 MultiMedia Soft

SoundComposer.ItemSpeechVoiceSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Modifies the voice used to render the speech text of the given item. The current voice of the item can be obtained through the SoundComposer.ItemSpeechVoiceGet method.

 

Due to the fact that modifying the speaking voice 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 SoundComposer object and the How to compose a sound tutorial.

 

 

Syntax

 

[Visual Basic]

control.SoundGenerator.ItemSpeechVoiceSet (

nPlayer as Integer,

nUniqueId as Long,

nVoice as Long

) as enumErrorCodes


 

[C++]

short control.SoundGenerator.ItemSpeechVoiceSet (

short nPlayer,

long nUniqueId,

long nVoice

);


 

Parameter

Description

 

 

nPlayer

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.

nVoice

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

 

 

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.