【端午节社区活动】文档找茬挑战赛


#103

1、请提供发现问题的文档链接
https://docs.agora.io/cn/Interactive%20Broadcast/switch_device_web?platform=Web

2、请指出哪里有问题
音视频设备测试与切换 web的方案中,无法通过 volume-indicator这个回调拿到本地的音量提醒,这个接口只能拿到远端流的音量值

3、请提供你建议的修改方式
需要改成getaudiolevel来拿到本地的音量值


#104
  1. 请提供发现问题的文档链接
    https://docs.agora.io/en/Agora%20Platform/sdk_behaviors

  2. 请指出哪里有问题
    Edit链接:https://github.com/AgoraIO/Documentation/tree/master/en/Agora%20Platform/sdk_behaviors.md 404

  3. 请提供你建议的修改方式
    提供正确链接


#105
  1. 请提供发现问题的文档链接
    https://docs.agora.io/en/Agora%20Platform/recording_how_to

  2. 请指出哪里有问题
    See Recording API. Recording API对应的链接404

  3. 请提供你建议的修改方式
    提供正确的链接


#106
  1. 请提供发现问题的文档链接
    https://docs.agora.io/en/Interactive%20Broadcast/broadcast_video_android?platform=Android

  2. 请指出哪里有问题
    Edit链接地址:https://github.com/AgoraIO/Documentation/tree/master/en/Interactive%20Broadcast/broadcast_video_android.md 是404

  3. 请提供你建议的修改方式
    提供正确链接


#107

【文档链接引用错误】
1、发现问题的文档链接
https://docs.agora.io/cn/Interactive%20Broadcast/API%20Reference/oc/Protocols/AgoraRtcEngineDelegate.html#//api/name/rtcEngine:streamPublishedWithUrl:errorCode:
2、问题所在
该链接中的addPublishStreamUrl引用错误,这里引用的是addInjectStreamUrlhttps://docs.agora.io/cn/Interactive%20Broadcast/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/addInjectStreamUrl:config:
image
3、修改方式
addPublishStreamUrl的正确链接是:https://docs.agora.io/cn/Interactive%20Broadcast/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/addPublishStreamUrl:transcodingEnabled:


#108
  1. 请提供发现问题的文档链接
    https://docs.agora.io/en/Interactive%20Broadcast/API%20Reference/oc/Classes/AgoraCameraCapturerConfiguration.html
    https://docs.agora.io/en/Interactive%20Broadcast/API%20Reference/oc/Classes/AgoraBeautyOptions.html
    https://docs.agora.io/en/Interactive%20Broadcast/API%20Reference/oc/Classes/AgoraLastmileProbeConfig.html
    https://docs.agora.io/en/Interactive%20Broadcast/API%20Reference/oc/Classes/AgoraLastmileProbeOneWayResult.html
    https://docs.agora.io/en/Interactive%20Broadcast/API%20Reference/oc/Classes/AgoraScreenCaptureParameters.html
    等等

  2. 请指出哪里有问题
    有些API方法老版本没有,当在下拉框选择老版本的时候,会出现404

  3. 请提供你建议的修改方式
    前端需要做出判断,优化展示方式


#109
  1. 请提供发现问题的文档链接
    https://docs.agora.io/cn/Interactive%20Gaming/game_cocos_android?platform=Cocos

  2. 请指出哪里有问题
    你也可以直接从 Github下载

  3. 请提供你建议的修改方式
    Github对应链接地址404


#110
  1. 请提供发现问题的文档链接
    https://docs.agora.io/cn/cloud-recording/cloud_recording_api?platform=CPP#ErrorCode

  2. 请指出哪里有问题
    max_idle_time参数是有一个取值范围的,但是文档中没有提到。实际测试出最小取值为5s,设置小于5s都会被强制设为5s,上限不确定。

  3. 请提供你建议的修改方式
    请给出实际可取值范围,并说明超出取值范围会强制设的值是多少。


#111
  1. 请提供发现问题的文档链接
    https://docs.agora.io/en/Interactive%20Gaming/game_cocos_android?platform=Cocos

  2. 请指出哪里有问题
    Call the APIs in Interactive Gaming API to implement the required functions.
    Interactive Gaming API对应链接404

  3. 请提供你建议的修改方式
    提供正确链接


#112
  1. 请提供发现问题的文档链接
    https://docs.agora.io/cn/Real-time-Messaging/API%20Reference/RTM_oc/docs/API-Overview.html

  2. 请指出哪里有问题
    向指定用户发送点对点消息。
    成功:本地用户收到 AgoraRtmSendChannelMessageBlock 回调和AgoraRtmSendChannelMessageErrorOk 状态码

  3. 请提供你建议的修改方式
    此处是点对点消息,不应该是频道消息的回调和状态码


#113
  1. 请提供发现问题的文档链接
    https://docs.agora.io/cn/Real-time-Messaging/API%20Reference/RTM_oc/Classes/AgoraRtmSendMessageOptions.html#//api/name/enableOfflineMessaging

  2. 请指出哪里有问题
    true: 开启离线消息

  3. 请提供你建议的修改方式
    OC下true和false对应的值应该是YES和NO


#114
  1. 请提供发现问题的文档链接
    文档对于web sdk 教育场景没有最佳指南
  2. 请指出哪里有问题
    很多客户都需要最佳集成的指引
  3. 请提供你建议的修改方式

Web SDK 教育场景最佳集成指南

上课前

  • 课前浏览器版本检测
    调用checkSystemRequirements 确定是我们支持的浏览器版本(客户如果也可以用浏览器通用的API navigator.userAgent 来获取版本)
  • 课前设备检测
    1、分别创建纯音频流、纯视频流,play到相应的dom上,音频用getLocalAudioStats获取具体的采集音量值(RecordingLevel 一般超过1k就是有声音的),视频就直接看效果,确定音视频设备的完整可用性。
    2、客户也可以选择webrtc的接口getUserMedia去做相应的检测。
  • 课前网络监测
    1、加入频道,创建本地流 ,pub本地流之后通过统计数据接口getstats 去拿到本地上行发送的音视频发送码率、丢包数(计算得到丢包率)等信息 通过这个操作可以拿到用户的上行数据,然后再用一个接受端加入频道订阅刚才pub的流,这样就可以通过getstats 拿到本地下行的一些数据。
    2、加入频道,用network-quality 回调拿到用户上下行的质量打分,然后再退出。

正式上课

  • 日志上传 在createclient之前调用AgoraRTC.Logger.enableLogUpload()接口,打开成功之后 argus中session事件的详情里面会这么显示:extend: {“willUploadConsoleLog”:true}(这里的true表示开启日志上传成功)(如果有用户自咨询日志上传的请求频率,直接回答新版本sdk日志上传的频率是2秒一次,旧版本是1秒一条)

  • join状态判断,因为经常会出现客户join频道无响应的问题(一般都是用户本地的dns解析不了我们服务器的域名导致),所以一定要客户做一个超时处理,调用join之后10秒钟如果还没有触发join的成功回调,就主动弹出提示告知最终用户可能你的网络DNS出了问题,及时联系支持。这个判断可以和getConnectionState(获取本地与gateway连接状态)这个api一起用。

  • exception 回调对于音视频采集、发送、解码状态的监听,必须要做,在监听到问题的时候提示给用户提示,然后建议用户做一些操作。

  • play操作需要注意,2.6.1.100之前的版本play没有成功回调,所以在这之前的版本因为autoplay的影响需要客户做一些处理,2.6.1.100之后版本play的处理代码请点击链接:play code


#115
  1. 请提供发现问题的文档链接
    https://docs.agora.io/cn/Video/API%20Reference/web/interfaces/agorartc.client.html#on
  2. 请指出哪里有问题
    error这个回调里面没有说明哪些错误会通过这个回调抛出来
  3. 请提供你建议的修改方式
    需要写出这个回调会抛出的错误,这样客户也比较好处理这个回调触发之后的操作,比如SOCKET_DISCONNECTED是通过这个回调抛出的,可以说明一下

#116
  1. 请提供发现问题的文档链接
    https://docs.agora.io/cn/Agora%20Platform/websdk_related_faq
  2. 请指出哪里有问题
    很多FAQ都比较旧了,可能不太适用现在的sdk版本和现在的浏览器版本
  3. 请提供你建议的修改方式

1)设备类报错
NotAllowedError [拒绝错误]

用户拒绝了获取音视频设备的请求

OverConstrainedError [无法满足要求错误]

指定的要求无法被设备满足,此异常是一个类型为0verconst rainedError的对象,拥有一个constraint属性,这个属性包含了当前无法被满足的constraint对,如果你开启了多个Tab页同时推流,请确定分辨率采集是一致的。

NotFoundError [找不到错误]

找不到满足请求参数的媒体类型。

NotReadableError [无法读取错误]

尽管用户已经授权使用相应的设备,操作系统上某个硬件、浏览器或者网页层面发生的错误导致设备无法被访问。

AbortError [中止错误]

尽管用户和操作系统都授予了访问设备硬件的权利,并且也没有出现NotReadableError这类硬件引起的问题,但仍然有一些问题的出现
导致了设备无法被使用。

TypeError [类型错误]

constraints对象未设置[空],或者都被设置为false。

SecurityError[安全错误]

没有使用HTTPS协议

2)集成类报错

  • **User is not in the session ** :websocket未建立连接。基本都是客户调用API时序不正确导致连接释放了还在调用API,或者连接还没建立就调用部分API。

  • cannot read property “appendChild” of null 这个报错一般是play指定的dom不存在或者id没有找到,基本都是客户那边处理的问题(play之前没有及时生成相应的父容器)。

  • Invalid elementID:play的时候指定的容器不符合参数规则

  • UID_CONFLICT:同一个uid 多次加入一个频道导致互踢

3)编解码详解
PC端、手机端 浏览器VP8使用的是软编解,H264默认都使用硬编解;
PC端chrome、firefox 均支持vp8、H264编解码,safari在12.1版本之前的版本只支持H264编解码,12.1及以上支持vp8编解码;
手机端 ios上safari和pc上safari表现一致,android 端浏览器 H264的编解码需要芯片的支持(高通大部分系列和三星猎户座支持H264硬编解码)


#117

https://docs.agora.io/cn/Interactive%20Broadcast/dashboard_restful_live?platform=All_Platforms


退出后去的是水晶球页面 请修改


#118

https://docs.agora.io/cn/Interactive%20Broadcast/API%20Reference/cpp/namespaceagora_1_1rtc.html#ab5e06b511f978f1a997008401da46505


#119

https://docs.agora.io/cn/Interactive%20Broadcast/API%20Reference/cpp/classagora_1_1rtc_1_1_i_audio_device_manager.html#aa13c99d575d89e7ceeeb139be723b18a

ipod 等蓝牙耳机会有左右之分 这样会获取到2个play 的播放设备 这里最好可以提供有采集的那个 并不需提供2个 用户如果选择的非麦克风那个也就是左边的 会导致麦克风采集失败


#120

1、请提供发现问题的文档链接
英文文档 https://docs.agora.io/en/Recording/recording_cmd_java?platform=Java
中文文档 https://docs.agora.io/cn/Recording/recording_cmd_java?platform=Java

2、请指出哪里有问题
这个是Java的版本,但是文档中多处链接会跳转到CPP的版本。
例如图中的 “mixResolution” 和 “MIXED_AV_CODEC_TYPE”。

3、请提供你建议的修改方式
修改中文版和英文版跳转的链接地址,使其指向正确的链接文档。

例如“mixResolution”应该指向https://docs.agora.io/cn/Recording/API%20Reference/recording_java/classio_1_1agora_1_1recording_1_1common_1_1_recording_config.html

而不是
https://docs.agora.io/cn/Recording/API%20Reference/recording_cpp/structagora_1_1recording_1_1_recording_config.html#a522a74ca1a09cecf04c5e127cd70eddf

其他的可能要文档的小伙伴帮忙找一下。


#121
  1. 请提供发现问题的文档链接
    https://docs.agora.io/cn/Voice/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_i_rtc_engine_event_handler.html#a0841fb3453a1a271249587fa3d3b3c88

  2. 请指出哪里有问题
    ost 音频包从发送端到接收端的丢包率()

  3. 请提供你建议的修改方式
    丢包率后面没有单位


#122
  1. 请提供发现问题的文档链接
    https://docs.agora.io/cn/Voice/in_call_statistics_android_audio?platform=Android

  2. 请指出哪里有问题
    质量打分对照表如下:

  3. 请提供你建议的修改方式
    现在还有个6:网络连接断开,完全无法沟通。这里没有