Agora Java API Reference for Android

0：本地视频质量不变。

1：因网络带宽增加，本地视频质量改善。

2：因网络带宽减少，本地视频质量变差。

1：本次 Last-mile 质量探测的结果是完整的。

2：本次 Last-mile 质量探测未进行带宽预测，因此结果不完整。一个可能的原因是测试资源暂时受限。

3：未进行 Last-mile 质量探测。一个可能的原因是网络连接中断。

0：质量未知。

1：质量极好。

2：用户主观感觉和极好差不多，但码率可能略低于极好。

3：用户主观感受有瑕疵但不影响沟通。

4：勉强能沟通但不顺畅。

5：网络质量非常差，基本不能沟通。

6：网络连接已断开，完全无法沟通。

7: 网络质量探测功能不可使用。 (目前没有使用。)

8: 网络质量探测中。

8：指定的 View 无效，使用视频功能时需要指定 View，如果 View 尚未指定，则返回该警告。

16：初始化视频功能失败。有可能是因视频资源被占用导致的。用户无法看到视频画面，但不影响语音通信。

20：请求处于待定状态。一般是由于某个模块还没准备好，请求被延迟处理。

103：没有可用的频道资源。可能是因为服务端没法分配频道资源。

104：查找频道超时。在加入频道时 SDK 先要查找指定的频道，出现该警告一般是因为网络太差，连接不到服务器。

105：查找频道请求被服务器拒绝。服务器可能没有办法处理这个请求或请求是非法的。

弃用:

从 v2.4.1 起废弃。请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_REJECTED_BY_SERVER(10)。

106：打开频道超时。查找到指定频道后，SDK 接着打开该频道，超时一般是因为网络太差，连接不到服务器。

107：打开频道请求被服务器拒绝。服务器可能没有办法处理该请求或该请求是非法的。

111：切换直播视频超时。

118：直播场景下设置用户模式超时。

119：直播场景下用户模式未授权。

121：TICKET 非法，打开频道失败。

122：尝试打开另一个服务器。

701：打开伴奏出错。

1014：音频设备模块：运行时播放设备出现警告。

1016：音频设备模块：运行时录音设备出现警告。

1019：音频设备模块：没有采集到有效的声音数据。

1020: 音频设备模块：播放频率异常，可能造成音频卡顿。该异常原因为系统 CPU 占用率高，建议结束其他可能占用 CPU 的 app。

1021: 音频设备模块：录制频率异常，可能造成音频卡顿。该异常原因为系统 CPU 占用率高，建议结束其他可能占用 CPU 的 app。

1025：音频播放或采集被系统事件（如来电）打扰。

1031：音频设备模块：录到的声音太低。

1032：音频设备模块：播放的声音太低。

1033：音频设备模块：录音设备被占用。

1051：（仅适用于通信场景）音频信号处理模块：录制音频时监测到啸叫。

1052：音频设备模块：音频播放会卡顿。

1053：音频信号处理模块：检测到残余回声，该回声可能由系统线程调度不及时或信号溢出导致。

0：没有错误。

1：一般性的错误（没有明确归类的错误原因）。

2：API 调用了无效的参数。例如指定的频道名含有非法字符。

3：SDK 初始化失败。处理方法：

• 检查音频设备状态。
• 检查程序集完整性。
• 尝试重新初始化 SDK。

4：SDK 当前状态不支持此操作。

5：调用被拒绝。

6：传入的缓冲区大小不足以存放返回的数据。

7：SDK 尚未初始化，就调用其 API。

9：没有操作权限。请检查用户是否授予 app 音视频设备使用权限。

10：API 调用超时。有些 API 调用需要 SDK 返回结果，如果 SDK 处理时间过长，超过 10 秒没有返回，会出现此错误。

11：请求被取消。仅供 SDK 内部使用，不通过 API 或者回调事件返回给 App。

12：调用频率太高。仅供 SDK 内部使用，不通过 API 或者回调事件返回给 App。

13：SDK 内部绑定到网络 Socket 失败。仅供 SDK 内部使用，不通过 API 或者回调事件返回给 App。

14：网络不可用。仅供 SDK 内部使用，不通过 API 或者回调事件返回给 App。

15：没有网络缓冲区可用。仅供 SDK 内部使用，不通过 API 或者回调事件返回给 App。

17：加入频道被拒绝。一般有以下原因：

• 用户已进入频道，再次调用加入频道的 API，例如 joinChannel。
• 用户在调用 startEchoTest 进行通话测试时，尝试加入频道。通话测试开始后，需要先调用 stopEchoTest 结束当前测试，再加入频道。

18：离开频道失败。一般有以下原因：

• 用户已离开频道，再次调用退出频道的 API，例如 leaveChannel，会返回此错误。停止调用该方法即可。
• 用户尚未加入频道，就调用退出频道的 API。这种情况下无需额外操作。

19：资源已被占用，不能重复使用。

101：不是有效的 App ID。请更换有效的 App ID 重新加入频道。

102：不是有效的频道名。请更换有效的频道名重新加入频道。

103: 无法获取当前指定区域的服务器资源。请在调用 create 方法时尝试指定其他区域。

109：当前使用的 Token 过期，不再有效。

弃用:

从 v2.4.1 起废弃。请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_TOKEN_EXPIRED(9)。

一般有以下原因：

• Token 授权时间戳无效：Token 授权时间戳为 Token 生成时的时间戳，自 1970 年 1 月 1 日开始到当前时间的描述。授权该 Token 在生成后的 24 小时内可以访问 Agora 服务。如果 24 小时内没有访问，则该 Token 无法再使用。需要重新在服务端申请生成 Token。
• Token 服务到期时间戳已过期：用户设置的服务到期时间戳小于当前时间戳，无法继续使用 Agora 服务（比如正在进行的通话会被强制终止）；设置服务到期时间并不意味着 Token 失效，而仅仅用于限制用户使用当前服务的时间。需要重新在服务端申请生成 Token。

110：生成的 Token 无效。

弃用:

从 v2.4.1 起废弃。请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_INVALID_TOKEN(8)。

一般有以下原因：

• 用户在控制台上启用了 App Certificate，但仍旧在代码里仅使用了 App ID。当启用了 App Certificate，必须使用 Token。
• 字段 uid 为生成 Token 的必须字段，用户在调用 joinChannel() 加入频道时必须设置相同的 uid。

111：网络连接中断。仅适用于 Agora Web SDK。

112：网络连接丢失。仅适用于 Agora Web SDK。

113：用户不在频道内。

114：在调用 sendStreamMessage 时，当发送的数据长度大于 1024 个字节时，会发生该错误。

115：在调用 sendStreamMessage 时，当发送的数据码率超过限制（6KB/s）时，会发生该错误。

116：在调用 createDataStream 时，如果创建的数据通道过多（超过 5 个通道），会发生该错误。

120：解密失败，可能是用户加入频道用了不同的密码。请检查加入频道时的设置，或尝试重新加入频道。

123：客户端被服务器禁止。

124：水印文件参数错误。

125：水印文件路径错误。

126：水印文件格式错误。

127：水印文件信息错误。

128：水印文件数据格式错误。

129：水印文件读取错误。

130：在调用 addPublishStreamUrl 时，如果开启了加密，则会返回该错误（推流不支持加密流）。

134：无效的 User account。

151：CDN 相关错误。请调用 removePublishStreamUrl 方法删除原来的推流地址，然后调用 addPublishStreamUrl 方法重新推流到新地址。

152：单个主播的推流地址数目达到上限 10。请删掉一些不用的推流地址再增加推流地址。

153：操作不属于主播自己的流，如更新其他主播的流参数、停止其他主播的流。请检查 App 逻辑。

154：推流服务器出现错误。请调用 addPublishStreamUrl 重新推流。

155：服务器未找到这个流。

156：推流地址格式有错误。请检查推流地址格式是否正确。

1: RTMP 推流时，添加背景图或水印出错。

1001：加载媒体引擎失败。

1002：启动媒体引擎开始通话失败。请尝试重新进入频道。

1003：启动摄像头失败，请检查摄像头是否被其他应用占用，或者尝试重新进入频道。

弃用:

从 v2.4.1 起废弃。请改用 onLocalVideoStateChanged 回调中的 LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4)。

1004：启动视频渲染模块失败。

1005：音频设备模块：音频设备出现错误（未明确指明为何种错误）。请检查音频设备是否被其他应用占用，或者尝试重新进入频道。

1006：音频设备模块：使用 java 资源出现错误。

1007：音频设备模块：设置的采样频率出现错误。

1008：音频设备模块：初始化播放设备出现错误。请检查播放设备是否被其他应用占用，或者尝试重新进入频道。

1009：音频设备模块：启动播放设备出现错误。请检查播放设备是否正常，或者尝试重新进入频道。

1010：音频设备模块：停止播放设备出现错误。

1011：音频设备模块：初始化录音设备时出现错误。请检查录音设备是否正常，或者尝试重新进入频道。

1012：音频设备模块：启动录音设备出现错误。请检查录音设备是否正常，或者尝试重新进入频道。

1013：音频设备模块：停止录音设备出现错误。

1015：音频设备模块：运行时播放出现错误。请检查播放设备是否正常，或者尝试重新进入频道。

1017：音频设备模块：运行时录音错误。请检查录音设备是否正常，或者尝试重新进入频道。

1018：音频设备模块：录音失败。

1022：音频设备模块：初始化 Loopback 设备错误。

1023：音频设备模块：启动 Loopback 设备错误。

1030：音频路由：连接蓝牙通话失败，默认路由会被启用。

1359：音频设备模块：无录制设备。请检查是否有可用的录放音设备或者录放音设备是否已经被其他应用占用。

1360：音频设备模块：无播放设备。

1501：视频设备模块：没有摄像头使用权限。请检查是否已经打开摄像头权限。

1600：视频设备模块：未知错误。

1601：视频设备模块：视频编码器初始化错误。该错误为严重错误，请尝试重新加入频道。

1602：视频设备模块：视频编码器错误。该错误为严重错误，请尝试重新加入频道。

弃用:

该错误码已废弃。 1603：视频设备模块：视频设置错误。

弃用:

0：分辨率 160 × 120，帧率 15 fps，码率 65 Kbps。

弃用:

2：分辨率 120 × 120，帧率 15 fps，码率 50 Kbps。

弃用:

10：分辨率 320 × 180，帧率 15 fps，码率 140 Kbps。

弃用:

12：分辨率 180 × 180，帧率 15 fps，码率 100 Kbps。

弃用:

13：分辨率 240 × 180，帧率 15 fps，码率 120 Kbps。

弃用:

20：分辨率 320 × 240，帧率 15 fps，码率 200 Kbps。

弃用:

22：分辨率 240 × 240，帧率 15 fps，码率 140 Kbps。

弃用:

23：分辨率 424 × 240，帧率 15 fps，码率 220 Kbps。

弃用:

30：分辨率 640 × 360，帧率 15 fps，码率 400 Kbps。

弃用:

32：分辨率 360 × 360，帧率 15 fps，码率 260 Kbps。

弃用:

33：分辨率 640 × 360，帧率 30 fps，码率 600 Kbps。

弃用:

35：分辨率 360 × 360，帧率 30 fps，码率 400 Kbps。

弃用:

36：分辨率 480 × 360，帧率 15 fps，码率 320 Kbps。

弃用:

37：分辨率 480 × 360，帧率 30 fps，码率 490 Kbps。

弃用:

38：分辨率 640 × 360，帧率 15 fps，码率 800 Kbps。

注解

该视频属性仅适用于直播频道模式。

弃用:

39：分辨率 640 × 360，帧率 24 fps，码率 800 Kbps。

注解

该视频属性仅适用于直播频道模式。

弃用:

100：分辨率 640 × 360，帧率 24 fps，码率 1000 Kbps。

注解

该视频属性仅适用于直播频道模式。

弃用:

40：分辨率 640 × 480，帧率 15 fps，码率 500 Kbps。

弃用:

42：分辨率 480 × 480，帧率 15 fps，码率 400 Kbps。

弃用:

43：分辨率 640 × 480，帧率 30 fps，码率 750 Kbps。

弃用:

45：分辨率 480 × 480，帧率 30 fps，码率 600 Kbps。

弃用:

47：分辨率 848 × 480，帧率 15 fps，码率 610 Kbps。

弃用:

48：分辨率 848 × 480，帧率 30 fps，码率 930 Kbps。

弃用:

49：分辨率 640 × 480，帧率 10 fps，码率 400 Kbps。

弃用:

50：分辨率 1280 × 720，帧率 15 fps，码率 1130 Kbps。

弃用:

52：分辨率 1280 × 720，帧率 30 fps，码率 1710 Kbps。

弃用:

54：分辨率 960 × 720，帧率 15 fps，码率 910 Kbps。

弃用:

55：分辨率 960 × 720，帧率 30 fps，码率 1380 Kbps。

弃用:

60：分辨率 1920 × 1080，帧率 15 fps，码率 2080 Kbps。

弃用:

62：分辨率 1920 × 1080，帧率 30 fps，码率 3150 Kbps。

弃用:

64：分辨率 1920 × 1080，帧率 60 fps，码率 4780 Kbps。

弃用:

66：分辨率 2560 × 1440，帧率 30 fps，码率 4850 Kbps。

弃用:

67：分辨率 2560 × 1440，帧率 60 fps，码率 7350 Kbps。

弃用:

70：分辨率 3840 × 2160，分辨率 30 fps，码率 8910 Kbps。

弃用:

72：分辨率 3840 × 2160，帧率 60 fps，码率 13500 Kbps。

弃用:

默认视频属性：分辨率 640 × 360，帧率 15 fps，码率 400 Kbps。

0：默认设置。

• 通信场景下，该选项代表指定 32 kHz 采样率，语音编码，单声道，编码码率最大值为 18 Kbps。
• 直播场景下，该选项代表指定 48 kHz 采样率，音乐编码，单声道，编码码率最大值为 64 Kbps。

1：指定 32 kHz 采样率，语音编码，单声道，编码码率最大值为 18 Kbps。

2：指定 48 kHz 采样率，音乐编码，单声道，编码码率最大值为 64 Kbps。

3：指定 48 kHz采样率，音乐编码，双声道，编码码率最大值为 80 Kbps。

4：指定 48 kHz 采样率，音乐编码，单声道，编码码率最大值为 96 Kbps。

5：指定 48 kHz 采样率，音乐编码，双声道，编码码率最大值为 128 Kbps。

0：默认音频应用场景。

1：娱乐应用，需要频繁上下麦的场景。

2：教育应用，流畅度和稳定性优先。

3：高音质语聊房应用。

4：秀场应用，音质优先和更好的专业外设支持。

5：游戏开黑。

0：31 Hz。

1：62 Hz。

2：125 Hz。

3：250 Hz。

4：500 Hz。

5：1 kHz。

6：2 kHz。

7：4 kHz。

8：8 kHz。

9：16 kHz。

0：原始声音强度，即所谓的 dry signal，取值范围 [-20, 10]，单位为 dB。

1：早期反射信号强度，即所谓的 wet signal，取值范围 [-20, 10]，单位为 dB。

2：所需混响效果的房间尺寸，一般房间越大，混响越强，取值范围 [0, 100]，单位为 dB。

3：Wet signal 的初始延迟长度，取值范围 [0, 200]，单位为毫秒。

4：混响持续的强度，取值范围为 [0, 100]。

（默认）原声，即关闭本地语音的变声、美音或语聊美声效果。

变声：老男孩

变声：小男孩

变声：小女孩

变声：猪八戒

变声：空灵

变声：绿巨人

美音：浑厚

美音：低沉

美音：圆润

美音：假音

美音：饱满

美音：清澈

美音：高亢

美音：嘹亮

美音：空旷

语聊美声：磁性（男）。此枚举为男声定制化效果，不适用于女声。若女声使用此音效设置，则音频可能会产生失真。

语聊美声：清新（女）。此枚举为女声定制化效果，不适用于男声。若男声使用此音效设置，则音频可能会产生失真。

语聊美声：活力（女）。此枚举为女声定制化效果，不适用于男声。若男声使用此音效设置，则音频可能会产生失真。

原声，即关闭本地语音混响。

KTV（增强版）

演唱会（增强版）

大叔

小姐姐

录音棚（增强版）

流行（增强版）

R&B（增强版）

留声机

流行

R&B

摇滚

嘻哈

演唱会

KTV

录音棚

虚拟立体声。虚拟立体声是指将单声道的音轨渲染出立体声的效果，使频道内所有用户听到有空间感的声音效果。为达到更好的虚拟立体声效果，Agora 推荐在调用该方法前将 setAudioProfile 的 profile 参数设置为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)。

0：通信场景（默认）。

用于常见的一对一通话或群聊，频道中的任何用户可以自由说话。

1：直播场景。

直播场景有主播和观众两种用户角色，可以通过 setClientRole 方法设置主播和观众的角色。主播可以收发语音/视频流，而观众只能接收语音/视频，无法发送。

2：游戏语音场景。

频道内的任何一个可以自由对话。该模式默认采用低功耗低码率的编解码。

1：直播主播。

2：直播观众。

0：用户主动离开。

1：因过长时间收不到对方数据包，超时掉线。

2：用户身份从主播切换为观众时触发。

0：外部视频流导入成功。

1：外部视频流已存在。

2：外部视频流导入未经授权。

3：导入外部视频流超时。

4：外部视频流导入失败。

5：外部视频流停止导入成功。

6：未找到要停止导入的外部视频流。

7：要停止导入的外部视频流未经授权。

8：停止导入外部视频流超时。

9：停止导入外部视频流失败。

10：导入的外部视频流被中断。

0：JSON 格式的质量报告。

1：HTML 格式的质量报告。

1：如果视频大小与显示窗口不同，大则裁剪小则拉伸，以达到适配的目的。

2：等比放大视频直至视频窗口的一边与边框对齐。由于长宽比不一致所造成的未被填满的区域将被涂黑。

弃用:

该模式已废弃。声网不建议你使用。 3：适配模式。

0：默认镜像模式：由 SDK 决定镜像模式。

1：启用镜像模式。

2：关闭镜像模式。

0: （默认）无指定的内容类型。

1: 内容类型为动画。当共享的内容是视频、电影或视频游戏时，推荐选择该内容类型。

2: 内容类型为细节。当共享的内容是图片或文字时，推荐选择该内容类型。

0：不输出任何日志。

0x80f：输出所有的 API 日志。如果你想获取最完整的日志，可以将日志级别设为该等级。

0x0f：输出 CRITICAL、ERROR、WARNING、INFO 级别的日志。我们推荐你将日志级别设为该等级。

0x0e：仅输出 CRITICAL、ERROR、WARNING 级别的日志。

0x0c：仅输出 CRITICAL、ERROR 级别的日志。

0x08：仅输出 CRITICAL 级别的日志。

-1：使用默认的音频路由。

0：使用耳机为语音路由。

1：使用听筒为语音路由。

2：使用不带麦的耳机为语音路由。

3：使用手机的扬声器为语音路由。

4：使用外接的扬声器为语音路由。

5：使用蓝牙耳机为语音路由。

0：视频大流，即高分辨率高码率的视频流。

1：视频小流，即低分辨率低码率的视频流。

50：远端用户的优先级为高。

100：远端用户的优先级为低。

0：硬件编码。