社区提问指南

建议大家在提问前,详细阅读 官方文档,遇到问题可首先参考 FAQ 汇总帖:

「Agora RTC SDK」FAQ 汇总
「Agora RTM SDK」FAQ 汇总
「Agora 云端录制」FAQ 汇总
「Agora 本地服务端录制」FAQ 汇总


一、撰写一个能概括问题的标题

标题清晰明了,尽量用一句话描述清楚问题,写明具体是哪个功能遇到了问题。

反例:

用火狐浏览器听不见声音了

正确姿势:

集成Web SDK,接收端使用火狐浏览器,听不见远端用户的声音

二、添加标签

为更有效更快速的解决问题,请在提问时添加与问题相关的标签:

  • 平台:小程序/Electron/iOS/MacOS/Android/Windows/Web/Unity/Linux/Flutter/React-Native/RestfulAPI/Cocos/APICloud 等
  • 产品类型:RTC/录制/云录制/RTM/推流/水晶球/云代理
  • 问题类型:产品功能咨询/集成问题/Demo问题/需求及优化建议

三、清晰的表述问题

1. 概述

  • 利用排版,提高可读性 :相关代码、log、报错、崩溃栈等均建议复制粘贴为文本或上传为 TXT 文本,在段落前后加上三个`符号可以形成代码段。
  • 清楚详细地描述问题 :请避免使用 以前可以,现在不行 这种对解决问题毫无帮助的模糊的描述,请提供具体的时间分割点,以及在时间点前后你们所做的改动(如修改了代码或重新配置了系统环境等)。
  • 提供有效而完整的信息 :请根据实际问题类型,阅读如下说明,提供相对应的信息。

2. 产品功能咨询

  1. 你需要咨询的产品。例如:Android 视频通话 SDK(如果没有特定的平台,可以不做具体说明)
  2. 你为解决该疑问做了什么工作(搜索了什么,得到了什么信息)
  3. 具体描述你的疑问。例如:业务场景,具体想要实现什么样的功能,预期结果是什么等等

3. 集成过程中遇到的问题

  1. 你所使用的产品是什么。例如:视频通话 SDK / 语音通话 SDK / RTM SDK / 云录制等等,或者某个社区版的 SDK/Demo,并附上对应的 GitHub 链接 )
  2. 集成的 SDK 的 具体版本号 。请 避免使用最新版本 这样的模糊描述词。
  3. 使用官网 demo 是否有同样的问题,若 demo 没有问题,建议请参照 demo 调整你自己的代码逻辑。
  4. 出现问题的平台,例如 iOS 、Android、Web、Windows 等。如果只有某个设备才会出现问题,请提供该设备的具体系统和机型。
  5. 导致该问题出现的具体操作步骤(请具体到每一步,以便于我们测试复现)、具体调用的哪一个 API 或 API 调用时序 、观测到的具体现象(必要时可截图、录屏)
  6. 完整的 log 信息(上传 TXT 文件或直接粘贴文本,请参考 如何获取日志文件
  7. 你自己有做过的排查步骤和结果,你的猜测。
  8. 如果是 crash 问题,除了上述几点外,还需确认和提供以下信息:
  • 对应的现象是闪退还是卡住?
  • 必现还是偶现?如果是必现,一般是集成逻辑的问题,建议请根据第 3 点进行自查;如果是偶现,请告知发生概率大约是多少?
  • 崩溃堆栈信息(粘贴文本)。如果是 iOS 平台,需要符号化堆栈后再提供给我们。
  • 设备架构(例如:armeabi-v7a)、设备型号、系统型号。

4. Demo 问题

  1. 你所使用的 demo 是什么,最好能附上对应的下载链接或 GitHub 链接。
  2. demo 中会包含 readme 文件,请检查是否有按照 readme 中的步骤集成 SDK 并编译运行。一般而言,严格参照 readme 运行,可以解决 90% 的问题。
  3. 如果是编译时出现报错,请提供控制台的报错信息(粘贴文本)。
  4. 如果是运行时遇到问题,请提供导致该问题出现的具体操作步骤(例如:点击加入频道,本地预览黑屏)、观测到的具体现象(必要时可截图、录屏)、完整的 log 信息(上传 TXT 文件或直接粘贴文本,请参考 如何获取日志文件
  5. 你自己有做过的排查步骤和结果,你的猜测。

5. 需求及优化建议

  1. 请先确认当前声网的产品是否支持该功能
  • 建议先在官网文档论坛搜索关键词,看下 SDK 是否已经包含了该功能哦~
  1. 你在什么业务场景下需要该功能
  2. 具体需求描述
  3. 该功能对你的价值