文档帮助平台
首页客户端SDK参考 Windows-QT SDK 快速入门 快速入门
快速入门
更新时间：2025-02-11 04:53:12

快速集成

环境要求

环境及工具名称 版本要求 说明
操作系统 Windows 7及以上 硬件要求：内存：4GB及以上
Visual Studio 2019、2017 如果要使用vs2017需要把config_windows.bat里"call project_scripts/config-cmake-win.bat"后面的vs2019改成vs2017
cmake 3.15及以上 将cmake.exe所在目录添加到环境变量Path,下载路径:https://cmake.org/download/
python3 3.8及以上 将python3.exe及pip3.exe所在目录添加到环境变量Path,下载路径:https://www.python.org/downloads/windows/
Qt 5.12及以上 下载路径 https://download.qt.io/archive/qt/5.12/5.12.4/
SDK 下载路径: https://developer.ylyun.com/document/6207

SDK快速集成

介绍集成SDK的主要步骤。

  1. 下载DEMO到本地
  2. 解压DEMO压缩包
  3. 打开source\CMakeLists.txt,将config_local_qt("E:/.conan/099f6fc/1")改为本地Qt安装目录bin文件夹所在的目录,并将Qt_VERSION改为对应的Qt版本
    image
  4. 执行config_windows.bat
  5. 打开build-windows/x86/sdk_demo_qt.sln
  6. 切换到Release模式,如果使用vs2017需要将警告视为错误关闭
  7. 执行编译
  8. 编译成功后运行程序,界面出现SDK加载失败的提示或没有登录入口，需进行鉴权及初始化,鉴权流程参照<<一分钟跑通Demo>>

YLSDK API使用指南

  1. UI-SDK API目前使用C风格的API,API头文件目录为ylsdk_h/sdk_interface_wrap_c_header,UISDK接口分为SDK加载、初始化、鉴权、会议、通话、设置几个模块，可以参考对应的注释进行使用
  2. 在初始化YLSDK之前，请监听SDK对应步骤的回调消息，待收到步骤完成的通知再执行下一个步骤。例如：监听SDK加载的消息通知，收到消息通知后再执行SDK鉴权。 为保证UI-SDK的正确使用，请按照以下流程进行API调用及返回值校验。 步骤： a. 监听SDK消息通知，包括加载结果通知、鉴权结果通知。
    image b. 调用 LoadSDK 执行加载SDK操作，指定UME qa sdk.exe进程所在路径， OnSDKReadyEvent 返回加载结果通知。设置日志回调 SetCallBackFor_onSDKLogEvent 需要在加载SDK之后做。
    image
  3. 在OnSDKReadyEvent中调用InitSDK，该操作阻塞且无消息通知。初始化SDK后，根据实际的App的id和secret调用AuthService_AuthSDK进行鉴权,OnAuthResultEvent返回鉴权结果通知
    image

  4. 根据App下的有效用户账号密码,调用AuthService_Login完成登录,OnLoginResultEvent返回登录结果通知。

  5. 登录成功后，可以调用MeetingService_StartMeeting建立会议。

  6. 应用程序退出应调用CleanUPSDK清理SDK资源。

  7. 应用程序发布 注：

    应用程序需携带“UME qa.exe”所在的bin目录及其bin同级的Resources目录，并确
保LoadSDK传入的是实际的UME qa.exe所在路径。

    例如：sdk_demo_qt中 LoadSDK("../../../ylsdk/bin"); ，则相对目录的上三级即需存在 ylsdk文件夹，ylsdk文件夹下包含bin和Resources文件夹，“UME qa.exe”则存在于bin目 录中。

本页目录