Edit

Share via

PartyLocalChatControl::GetTextToSpeechProfile

  • Article

Gets the profile that was last configured from a successfully completed SetTextToSpeechProfile() operation for a specified type of text-to-speech operation.

Syntax

PartyError GetTextToSpeechProfile(  
    PartySynthesizeTextToSpeechType type,  
    PartyTextToSpeechProfile** profile  
)

Parameters

type   PartySynthesizeTextToSpeechType

The type of text-to-speech operations for which the profile should be retrieved.

profile   PartyTextToSpeechProfile**
library-allocated output, may return nullptr

The output profile. The profile may be nullptr if none has been set for the specified type. The pointer is only valid until the next call to PartyManager::StartProcessingStateChanges().

Return value

PartyError

c_partyErrorSuccess if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PartyManager::GetErrorMessage().

Remarks

If no profile has been successfully configured for the specified type of text-to-speech operation, the retrieved profile will be null.

The retrieved profile will update when a PartySetTextToSpeechProfileCompletedStateChange associated with a call to SetTextToSpeechProfile(), which specified the same value for type, is provided via PartyManager::StartProcessingStateChanges().

Requirements

Header: Party.h

See also

PartyLocalChatControl
PartyLocalChatControl::SetTextToSpeechProfile