Youme 游密
文档导航 UE4

文档目录

本页目录

Talk SDK for UnrealEngine4 使用指南

适用范围

本规范仅适应于使用游戏实时语音引擎UnrealEngine4插件（C++接口、蓝图接口）开发多人实时语音功能的开发者。

SDK目录概述

Talk SDK以UnrealEngine4的Plugin形式集成到UnrealEngine4当中，插件的文件格式如下：

├─ YouMeTalk ├─ Content ├─ Resources ├─ Source ├─ YouMeTalk ├─ Private ├─ Public ├─ YouMeTalkLibrary ├─ include └─ lib

  • Content：包含一个使用TalkSDK的Demo，使用蓝图方法，快速演示如何使用TalkSDK。
  • Resources：包含插件资源文件，如插件封面图。
  • Public：封装UE4可用的TalkSDK接口的头文件。
  • Private：封装UE4可用的TalkSDK接口的源代码。
  • include：TalkSDK原始接口的头文件。
  • lib：TalkSDK原始接口的库文件，分为Android平台和iOS平台。Android平台下包括ARMv5、ARMv7和X86三种CPU架构下的libyoume_voice_engine.so文件，还包括youme_voice_engine.jar。iOS平台下包含libyoume_voice_engine.a文件和libYouMeCommon.a文件。

开发环境集成

  1. 将YouMeTalk插件复制到工程根目录的Plugins文件夹中，如下图。（如果没有Plugins文件夹，那就创建一个）

    image-20210706105939642

  2. 重新生成文件结构，并编译工程。

    image-20210706110619003

    image-20210706110737713

  3. 蓝图中引入插件：打开UE4引擎编辑器，在（Edit | Plugins | Project | Other）选项中勾选启用YouMeTalk插件，重启引擎，即可使用插件。

    image-20210706111009744

  4. C++中引入插件：打开工程的Visual Studio，在工程主模块的build.cs（文件路径：[ ProjectName / Source / ProjectName / ]）文件中，包含TalkSDK插件，代码如下：

TEXT
PrivateDependencyModuleNames.AddRange(new string[] { "YouMeTalk" });

API接口调用流程

API调用的基本流程如下图所示，具体接口说明参见 TalkSDKforUnrealEngine4 API接口手册。

img

回调与通话流程

使用 BindObserver 注册实现 IYouMeTalkObserver 的对象，通过 OnEvent 或对应蓝图事件接收初始化及进退频道结果。销毁监听对象前调用 UnbindObserver；插件将事件派发到游戏主线程。

接入顺序：注册/提供回调对象 → 初始化 → 等待初始化成功 → 加入频道 → 等待进房成功 → 设置麦克风和扬声器 → 请求离房并等待完成 → 反初始化。异步接口返回成功表示请求已受理，最终结果按回调处理；同步查询按实际返回类型读取。

各接口的语法、功能、参数、返回值和异步回调见 API 手册。