> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PartyLocalChatControl::PopulateAvailableTextToSpeechProfiles

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

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

## Syntax

```cpp theme={null}
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()](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_geterrormessage).

## Remarks

This is an asynchronous operation; a [PartyPopulateAvailableTextToSpeechProfilesCompletedStateChange](/services/playfab/multiplayer/networking/reference/structs/partypopulateavailabletexttospeechprofilescompletedstatechange) is provided via [PartyManager::StartProcessingStateChanges()](/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_startprocessingstatechanges) on completion. <br /><br /> The asynchronous operation must complete successfully before GetAvailableTextToSpeechProfiles() can be called.   <br /><br /> Text-to-speech synthesis functionality internally uses available region and latency measurement estimates to optimize service usage. If the [PartyOption::RegionUpdateConfiguration](/services/playfab/multiplayer/networking/reference/enums/partyoption) option was used to configure an update mode of [PartyRegionUpdateMode::Deferred](/services/playfab/multiplayer/networking/reference/enums/partyregionupdatemode), 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](/services/playfab/multiplayer/networking/reference/structs/partyregionschangedstatechange) is provided prior to this call's [PartyPopulateAvailableTextToSpeechProfilesCompletedStateChange](/services/playfab/multiplayer/networking/reference/structs/partypopulateavailabletexttospeechprofilescompletedstatechange) completion.

## Requirements

**Header:** Party.h

## See also

[PartyLocalChatControl](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/partylocalchatcontrol)\
[PartyLocalChatControl::GetAvailableTextToSpeechProfiles](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getavailabletexttospeechprofiles)\
[PartyLocalChatControl::SetTextToSpeechProfile](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_settexttospeechprofile)\
[PartyLocalChatControl::GetTextToSpeechProfile](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_gettexttospeechprofile)


## Related topics

- [PartyLocalChatControl::GetAvailableTextToSpeechProfiles](/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_getavailabletexttospeechprofiles.md)
- [PartyTextToSpeechProfile](/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/partytexttospeechprofile.md)
- [PartyPopulateAvailableTextToSpeechProfilesCompletedStateChange](/services/playfab/multiplayer/networking/reference/structs/partypopulateavailabletexttospeechprofilescompletedstatechange.md)
- [PlayFab Party text-to-speech and text input UX Guidelines](/services/playfab/community/voice-communications/party-text-to-speech-ux-guidelines.md)
- [PartyRegionUpdateMode](/services/playfab/multiplayer/networking/reference/enums/partyregionupdatemode.md)