PartyLocalChatControl::SetTextToSpeechProfile

将配置文件配置为用于指定类型的文本到语音转换操作。

语法

PartyError SetTextToSpeechProfile(  
    PartySynthesizeTextToSpeechType type,  
    PartyString profileIdentifier,  
    void* asyncIdentifier  
)  

参数

type PartySynthesizeTextToSpeechType

应检索配置文件的文本到语音转换操作的类型。

profileIdentifier PartyString

指定类型的文本到语音转换操作应使用的配置文件的标识符。

asyncIdentifier void*
可选

一个可选应用定义的指针大小的上下文值,可用于将完成状态更改与此调用关联起来。

返回值

PartyError

如果设置文本到语音转换配置文件的异步操作已开始,则为 c_partyErrorSuccess;否则为错误代码。 如果此方法失败,则不会生成任何相关的状态更改。 可通过 PartyManager::GetErrorMessage() 检索错误代码的可读形式。

备注

提供的配置文件用于 SynthesizeTextToSpeech() 的所有后续调用,这些调用为 type 指定相同的值。 在至少调用一次 SetTextToSpeechProfile() 之前,不会配置任何配置文件。 因此,必须至少调用一次此方法,然后任何对 SynthesizeTextToSpeech() 的调用才会成功。

此方法接受配置文件标识符来指示配置文件选择,以便游戏可以传入 PartyTextToSpeechProfile::GetIdentifier() 的结果,或者提供从以前的 Party 库会话缓存的配置文件标识符。

可以启动多个 SetTextToSpeechProfile() 操作,它们会异步排队。 每个操作都按顺序处理和完成。

这是一个异步操作;会在完成时通过 PartyManager::StartProcessingStateChanges() 提供 PartySetTextToSpeechProfileCompletedStateChange

文本到语音合成功能在内部使用可用区域和延迟度量估算值来优化服务使用情况。 如果使用了 PartyOption::RegionUpdateConfiguration 选项来配置 PartyRegionUpdateMode::Deferred 的更新模式,则可能尚未开始检索可用区域集和测量它们的连接质量,或者上次更新时间可能超过了配置的刷新间隔期限。 如果本地设备当前未连接任何网络,则 SetTextToSpeechProfile() 确保已启动任何延迟的区域更新,并且在此调用的 PartySetTextToSpeechProfileCompletedStateChange 完成之前提供了关联的 PartyRegionsChangedStateChange

要求

标题: Party.h

另请参阅

PartyLocalChatControl
PartyLocalChatControl::GetTextToSpeechProfile