PartySynthesizeTextToSpeechCompletedStateChange

Information specific to the SynthesizeTextToSpeechCompleted type of state change.

Syntax

struct PartySynthesizeTextToSpeechCompletedStateChange : PartyStateChange {  
    PartyStateChangeResult result;  
    PartyError errorDetail;  
    PartyLocalChatControl* localChatControl;  
    PartySynthesizeTextToSpeechType type;  
    PartyString textToSynthesize;  
    void* asyncIdentifier;  
}  

Members

result   PartyStateChangeResult

Indicates that the operation Succeeded or the reason that it failed.

errorDetail   PartyError

A diagnostic value providing additional troubleshooting information regarding any potential error condition.

The human-readable form of this error detail can be retrieved via PartyManager::GetErrorMessage().

localChatControl   PartyLocalChatControl*

The chat control used in the call associated with this state change.

type   PartySynthesizeTextToSpeechType

The type of text-to-speech operation provided to the call associated with this state change.

textToSynthesize   PartyString

The synthesized text provided to the call associated with this state change.

If the accompanying result was a success, the audio synthesized for this text has been queued in the audio stream but may not have been transmitted yet.

asyncIdentifier   void*

The async identifier provided to the call associated with this state change.

Requirements

Header: Party.h

See also

Party members
PartyLocalChatControl::SynthesizeTextToSpeech