PartyChatControl::ConfigureAudioManipulationVoiceStream

将异步操作排入队列,以配置与此聊天控件关联的音频操作语音流。

语法

PartyError ConfigureAudioManipulationVoiceStream(  
    PartyAudioManipulationSourceStreamConfiguration* configuration,  
    void* asyncIdentifier  
)  

参数

configuration PartyAudioManipulationSourceStreamConfiguration*
可选

流配置。

asyncIdentifier void*
可选

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

返回值

PartyError

如果调用成功,则为 c_partyErrorSuccess,否则为错误代码。 可通过 PartyManager::GetErrorMessage() 检索错误代码的可读形式。

备注

如果配置为非 null,将为此聊天控件创建音频操作语音流。 此类流重定向与此聊天控件关联的语音音频的输出;应用可以使用源流来检索并通过游戏逻辑路由语音音频,而不是使用自动处理语音音频和路由它的库。 如果配置为 null,并且以前已配置语音流,则将销毁语音流。

异步操作完成后,指定非 null 配置时,可以通过 PartyChatControl::GetAudioManipulationVoiceStream() 查询此聊天控件的语音流。 完成由 PartyConfigureAudioManipulationVoiceStreamCompletedStateChange 指示。

平台支持和支持的格式

此功能仅在 Windows、Xbox 和 PlayStation® 5 上受支持。 其他平台上的调用将失败。

Windows 和 Xbox 支持以下格式选项。

格式选项 本地聊天控件的支持值 远程聊天控件的支持值
每秒采样数 24 kHz 24 kHz
频道掩码 0 0
频道计数 1 1
每个样本的位数 32 16
示例类型 PartyAudioSampleType::Float PartyAudioSampleType::Integer
交错 false false



有关 PlayStation® 5 支持的格式选项列表,请参阅与 Party 库包一起分发的 README-RealTimeAudioManipulation.md 文档。

要求

标题: Party.h

另请参阅

PartyChatControl