语法
成员
result PartyStateChangeResult
指示转录操作是否成功,或提供其失败的原因。
成功时,transcription 字段是一个非零长度的字符串。失败时,该字符串为空。失败表示尝试为讲话者进行转录操作但无法完成。如果根据与聊天控件关联的用户请求启用了转录,并且通过 UI 显示转录消息,建议也向用户指示失败,以便就转录是否正在等待或已失败提供反馈。
errorDetail PartyError
提供有关任何潜在错误情况的其他故障排除信息的诊断值。
可通过 PartyManager::GetErrorMessage() 检索此错误详细信息的人类可读形式。
senderChatControl PartyChatControl*
发起转录消息的聊天控件对象。
receiverChatControlCount uint32_t
转录消息所寻址的本地接收方聊天控件的数量。
receiverChatControls PartyLocalChatControlArray大小为
receiverChatControlCount 的数组
转录消息所寻址的本地接收方聊天控件。
sourceType PartyAudioSourceType
此转录表示的音频源的类型。
音频源类型可以选择用于游戏场景,其中来自不同源类型的转录应以不同方式处理。例如,可以根据转录是与麦克风还是与文本转语音音频关联,显示不同的图标。
languageCode PartyString
转录的语言代码。
当 result 字段指示成功时,始终提供语言代码。否则,语言代码为空字符串。语言代码采用 BCP 47 格式,例如 en-US 表示英语(美国)。支持的语言代码在语言支持中枚举。
transcription PartyString
转录的语音聊天文本。
该字符串最长可为 c_maxChatTextMessageLength 个字符(不包括 null 终止符)。当 result 字段指示失败时,该字符串始终为空。
type PartyVoiceChatTranscriptionPhraseType
指示 transcription 字段中提供的文本的短语类型。
当 result 字段指示失败时,类型始终为 PartyVoiceChatTranscriptionPhraseType::Final。
translationCount uint32_t
与转录的语音聊天文本关联的翻译数量。
如果之前已通过此设备本地的聊天控件上的 PartyLocalChatControl::SetTranscriptionOptions() 指定了 PartyVoiceChatTranscriptionOptions::TranslateToLocalLanguage,则会提供翻译。如果多个本地聊天控件已启用翻译并且本地聊天控件通过 PartyLocalDevice::CreateChatControl() 指定了不同的语言,则可能有多个翻译。在这种情况下,应用可以将 translations 中每个 PartyTranslation 的 languageCode 字段与通过 PartyLocalChatControl::GetLanguage() 获取的、receiverChatControls 中每个本地聊天控件的语言代码进行比较,以确定每个翻译的目标本地聊天控件。
translations PartyTranslation*大小为
translationCount 的数组
一个包含语音聊天转录字符串翻译的数组。
如果之前已通过此设备本地的聊天控件上的 PartyLocalChatControl::SetTranscriptionOptions() 指定了 PartyVoiceChatTranscriptionOptions::TranslateToLocalLanguage,则会提供翻译。如果多个本地聊天控件已启用翻译并且本地聊天控件通过 PartyLocalDevice::CreateChatControl() 指定了不同的语言,则可能有多个翻译。在这种情况下,应用可以将 translations 中每个 PartyTranslation 的 languageCode 字段与通过 PartyLocalChatControl::GetLanguage() 获取的、receiverChatControls 中每个本地聊天控件的语言代码进行比较,以确定每个翻译的目标本地聊天控件。系统会为
receiverChatControls 中每个已启用翻译的聊天控件提供其对应语言的翻译,即使讲话方聊天控件的语言与本地聊天控件的语言相同也是如此。在这种情况下,转录和翻译字符串相同。
要求
头文件: Party.h另请参阅
Party 成员PartyLocalDevice::CreateChatControl
PartyLocalChatControl::SetTranscriptionOptions