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

# PartyLocalChatControl::GetTextToSpeechProfile

> Gets the profile that was last configured from a successfully completed.

Gets the profile that was last configured from a successfully completed [SetTextToSpeechProfile()](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_settexttospeechprofile.md) operation for a specified type of text-to-speech operation.

## Syntax

```cpp theme={null}
PartyError GetTextToSpeechProfile(  
    PartySynthesizeTextToSpeechType type,  
    PartyTextToSpeechProfile** profile  
)  
```

### Parameters

**`type`**   [PartySynthesizeTextToSpeechType](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/enums/partysynthesizetexttospeechtype.md)

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

**`profile`**   [PartyTextToSpeechProfile\*\*](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/partytexttospeechprofile.md)\
*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()](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_startprocessingstatechanges.md).

### 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()](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_geterrormessage.md).

## 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](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/structs/partysettexttospeechprofilecompletedstatechange.md) associated with a call to SetTextToSpeechProfile(), which specified the same value for `type`, is provided via [PartyManager::StartProcessingStateChanges()](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_startprocessingstatechanges.md).

## Requirements

**Header:** Party.h

## See also

[PartyLocalChatControl](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/partylocalchatcontrol.md)\
[PartyLocalChatControl::SetTextToSpeechProfile](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_settexttospeechprofile.md)


## Related topics

- [PartyLocalChatControl::PopulateAvailableTextToSpeechProfiles](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_populateavailabletexttospeechprofiles.md)
- [PartyTextToSpeechProfile](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyTextToSpeechProfile/partytexttospeechprofile.md)
- [PartyLocalChatControl::SetTextToSpeechProfile](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_settexttospeechprofile.md)
- [PartySynthesizeTextToSpeechType](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/enums/partysynthesizetexttospeechtype.md)
- [PartySetTextToSpeechProfileCompletedStateChange](https://docs.xbox.com/services/playfab/multiplayer/networking/reference/structs/partysettexttospeechprofilecompletedstatechange.md)