Edit

Share via

PartyLocalChatControl::PopulateAvailableTextToSpeechProfiles

  • Article

Populates the local chat control's list of supported text-to-speech profiles.

Syntax

PartyError PopulateAvailableTextToSpeechProfiles(  
    void* asyncIdentifier  
)

Parameters

asyncIdentifier   void*
optional

An optional, app-defined, pointer-sized context value that can be used to associate the completion state change with this call.

Return value

PartyError

c_partyErrorSuccess if the asynchronous operation began, or an error code otherwise. If this method fails, no related state changes are generated. The human-readable form of the error code can be retrieved via PartyManager::GetErrorMessage().

Remarks

This is an asynchronous operation; a PartyPopulateAvailableTextToSpeechProfilesCompletedStateChange is provided via PartyManager::StartProcessingStateChanges() on completion.

The asynchronous operation must complete successfully before GetAvailableTextToSpeechProfiles() can be called.

Text-to-speech synthesis functionality internally uses available region and latency measurement estimates to optimize service usage. If the PartyOption::RegionUpdateConfiguration option was used to configure an update mode of PartyRegionUpdateMode::Deferred, then retrieving the set of available regions and measuring connection quality to them may not have started yet, or the last update may have exceeded the configured refresh interval age. If the local device isn't currently connecting or connected to any networks, PopulateAvailableTextToSpeechProfiles() ensures any deferred region update has started and the associated PartyRegionsChangedStateChange is provided prior to this call's PartyPopulateAvailableTextToSpeechProfilesCompletedStateChange completion.

Requirements

Header: Party.h

See also

PartyLocalChatControl
PartyLocalChatControl::GetAvailableTextToSpeechProfiles
PartyLocalChatControl::SetTextToSpeechProfile
PartyLocalChatControl::GetTextToSpeechProfile