通知
本站点除 Legacy 产品与方案外，已迁移至 声网新文档中心 ，当前页面不再维护
文档中心
全部产品
Console 官网 社区 技术支持
简体中文
search-icon

Agora Java API Reference for Android

概览 RtcEngine IRtcEngineEventHandler RtcChannel IRtcChannelEventHandler 警告码 错误码
成员 io.agora.rtc.Constants.ERR_INVALID_TOKEN
从 v2.4.1 起废弃。请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_INVALID_TOKEN(8)。
成员 io.agora.rtc.Constants.ERR_START_CAMERA
从 v2.4.1 起废弃。请改用 onLocalVideoStateChanged 回调中的 LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4)。
成员 io.agora.rtc.Constants.ERR_TOKEN_EXPIRED
从 v2.4.1 起废弃。请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_TOKEN_EXPIRED(9)。
成员 io.agora.rtc.Constants.ERR_VCM_ENCODER_SET_ERROR
该错误码已废弃。 1603：视频设备模块：视频设置错误。
成员 io.agora.rtc.Constants.RENDER_MODE_ADAPTIVE
该模式已废弃。声网不建议你使用。 3：适配模式。
成员 io.agora.rtc.Constants.STREAM_LIFE_CYCLE_BIND2CHANNEL
该方法已废弃。声网不建议你使用。 1：将 RTMP 流的生命周期与频道的生命周期绑定，即频道内所有主播离开，服务端转码推流会在 30 秒之后停止。
成员 io.agora.rtc.Constants.STREAM_LIFE_CYCLE_BIND2OWNER
该方法已废弃。声网不建议你使用。 2：将 RTMP 流的生命周期与启动服务端转码推流的主播生命周期绑定，即该主播离开，服务端转码推流会立刻停止。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_1080P
60：分辨率 1920 × 1080，帧率 15 fps，码率 2080 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_1080P_3
62：分辨率 1920 × 1080，帧率 30 fps，码率 3150 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_1080P_5
64：分辨率 1920 × 1080，帧率 60 fps，码率 4780 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_120P
0：分辨率 160 × 120，帧率 15 fps，码率 65 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_120P_3
2：分辨率 120 × 120，帧率 15 fps，码率 50 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_1440P
66：分辨率 2560 × 1440，帧率 30 fps，码率 4850 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_1440P_2
67：分辨率 2560 × 1440，帧率 60 fps，码率 7350 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_180P
10：分辨率 320 × 180，帧率 15 fps，码率 140 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_180P_3
12：分辨率 180 × 180，帧率 15 fps，码率 100 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_180P_4
13：分辨率 240 × 180，帧率 15 fps，码率 120 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_240P
20：分辨率 320 × 240，帧率 15 fps，码率 200 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_240P_3
22：分辨率 240 × 240，帧率 15 fps，码率 140 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_240P_4
23：分辨率 424 × 240，帧率 15 fps，码率 220 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_360P
30：分辨率 640 × 360，帧率 15 fps，码率 400 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_360P_10
39：分辨率 640 × 360，帧率 24 fps，码率 800 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_360P_11
100：分辨率 640 × 360，帧率 24 fps，码率 1000 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_360P_3
32：分辨率 360 × 360，帧率 15 fps，码率 260 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_360P_4
33：分辨率 640 × 360，帧率 30 fps，码率 600 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_360P_6
35：分辨率 360 × 360，帧率 30 fps，码率 400 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_360P_7
36：分辨率 480 × 360，帧率 15 fps，码率 320 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_360P_8
37：分辨率 480 × 360，帧率 30 fps，码率 490 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_360P_9
38：分辨率 640 × 360，帧率 15 fps，码率 800 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_480P
40：分辨率 640 × 480，帧率 15 fps，码率 500 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_480P_10
49：分辨率 640 × 480，帧率 10 fps，码率 400 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_480P_3
42：分辨率 480 × 480，帧率 15 fps，码率 400 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_480P_4
43：分辨率 640 × 480，帧率 30 fps，码率 750 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_480P_6
45：分辨率 480 × 480，帧率 30 fps，码率 600 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_480P_8
47：分辨率 848 × 480，帧率 15 fps，码率 610 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_480P_9
48：分辨率 848 × 480，帧率 30 fps，码率 930 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_4K
70：分辨率 3840 × 2160，分辨率 30 fps，码率 8910 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_4K_3
72：分辨率 3840 × 2160，帧率 60 fps，码率 13500 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_720P
50：分辨率 1280 × 720，帧率 15 fps，码率 1130 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_720P_3
52：分辨率 1280 × 720，帧率 30 fps，码率 1710 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_720P_5
54：分辨率 960 × 720，帧率 15 fps，码率 910 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_720P_6
55：分辨率 960 × 720，帧率 30 fps，码率 1380 Kbps。
成员 io.agora.rtc.Constants.VIDEO_PROFILE_DEFAULT
默认视频属性：分辨率 640 × 360，帧率 15 fps，码率 400 Kbps。
成员 io.agora.rtc.Constants.WARN_LOOKUP_CHANNEL_REJECTED
从 v2.4.1 起废弃。请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_REJECTED_BY_SERVER(10)。
成员 io.agora.rtc.IAudioEffectManager.playEffect (int soundId, String filePath, int loop, double pitch, double pan, double gain)
该方法已废弃。声网不建议你使用。如果你想要播放指定的音效文件，请改用 playEffect2 方法。
成员 io.agora.rtc.IRtcEngineEventHandler.ErrorCode.ERR_INVALID_TOKEN
从 v2.4.1 起废弃。请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_INVALID_TOKEN(8)。
成员 io.agora.rtc.IRtcEngineEventHandler.ErrorCode.ERR_START_CAMERA
从 v2.4.1 起废弃。请改用 onLocalVideoStateChanged 回调中的 LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE(4)。
成员 io.agora.rtc.IRtcEngineEventHandler.ErrorCode.ERR_TOKEN_EXPIRED
从 v2.4.1 起废弃。请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_TOKEN_EXPIRED(9)。
成员 io.agora.rtc.IRtcEngineEventHandler.ErrorCode.ERR_VCM_ENCODER_SET_ERROR
该错误码已废弃。
成员 io.agora.rtc.IRtcEngineEventHandler.onAudioMixingFinished ()
该回调已废弃。我们建议你使用 onAudioMixingStateChanged。 当调用 startAudioMixing 播放伴奏音乐结束后，会触发该回调。 如果该方法调用失败，会在 onWarning 回调里，返回警告码 WARN_AUDIO_MIXING_OPEN_ERROR。
成员 io.agora.rtc.IRtcEngineEventHandler.onAudioQuality (int uid, int quality, short delay, short lost)
从 v2.3.2 起废弃。声网不建议你使用。如果你希望获取远端音频的质量回调，请改用 onRemoteAudioStats 方法。
成员 io.agora.rtc.IRtcEngineEventHandler.onCameraReady ()
从 v2.4.1 起废弃。请改用 onLocalVideoStateChanged 回调中的 LOCAL_VIDEO_STREAM_STATE_CAPTURING(1)。
成员 io.agora.rtc.IRtcEngineEventHandler.onConnectionBanned ()
从 v2.3.2 起废弃。声网不建议你使用。如果你希望获取 SDK 的网络连接状态改变事件，请改用 onConnectionStateChanged 回调。
成员 io.agora.rtc.IRtcEngineEventHandler.onConnectionInterrupted ()
从 v2.3.2 起废弃。声网不建议你使用。如果你希望获取 SDK 的网络连接状态改变事件，请改用 onConnectionStateChanged 回调。
成员 io.agora.rtc.IRtcEngineEventHandler.onFirstRemoteAudioDecoded (int uid, int elapsed)
v3.0.0。该回调已废弃，请改用 onRemoteAudioStateChanged 中的 REMOTE_AUDIO_STATE_DECODING(2)。
成员 io.agora.rtc.IRtcEngineEventHandler.onFirstRemoteAudioFrame (int uid, int elapsed)
v3.0.0。该回调已废弃。请改用 onRemoteAudioStateChanged 中的 REMOTE_AUDIO_STATE_STARTING(1)。
成员 io.agora.rtc.IRtcEngineEventHandler.onFirstRemoteVideoDecoded (int uid, int width, int height, int elapsed)
v2.9.0。该回调已废弃。请改用 onRemoteVideoStateChanged 回调中的 REMOTE_VIDEO_STATE_STARTING(1) 或 REMOTE_VIDEO_STATE_DECODING(2)。
成员 io.agora.rtc.IRtcEngineEventHandler.onFirstRemoteVideoFrame (int uid, int width, int height, int elapsed)
v3.0.0。该回调已废弃，请改用 onRemoteVideoStateChanged。
成员 io.agora.rtc.IRtcEngineEventHandler.onLocalVideoStat (int sentBitrate, int sentFrameRate)
该方法已废弃。声网不建议你使用。如果你希望获取本地视频统计信息回调，请改用 onLocalVideoStats 方法。
成员 io.agora.rtc.IRtcEngineEventHandler.onMicrophoneEnabled (boolean enabled)
v2.9.0。该回调已废弃。请改用 onLocalAudioStateChanged 回调中的 LOCAL_AUDIO_STREAM_STATE_STOPPED(0) 或 LOCAL_AUDIO_STREAM_STATE_RECORDING(1)。
成员 io.agora.rtc.IRtcEngineEventHandler.onRemoteAudioTransportStats (int uid, int delay, int lost, int rxKBitRate)
该回调已删除。请改用 onRemoteAudioStats。
成员 io.agora.rtc.IRtcEngineEventHandler.onRemoteVideoStat (int uid, int delay, int receivedBitrate, int receivedFrameRate)
该方法已废弃。声网不建议你使用。如果你希望获取远端视频统计信息回调，请改用 onRemoteVideoStats 方法。
成员 io.agora.rtc.IRtcEngineEventHandler.onRemoteVideoTransportStats (int uid, int delay, int lost, int rxKBitRate)
该回调已废弃。请改用 onRemoteVideoStats。
成员 io.agora.rtc.IRtcEngineEventHandler.onStreamPublished (String url, int error)
该回调已废弃。请改用 onRtmpStreamingStateChanged。
成员 io.agora.rtc.IRtcEngineEventHandler.onStreamUnpublished (String url)
该回调已废弃。请改用 onRtmpStreamingStateChanged。
成员 io.agora.rtc.IRtcEngineEventHandler.onUserEnableLocalVideo (int uid, boolean enabled)
v2.9.0。该回调已废弃。请改用 onRemoteVideoStateChanged 回调中的如下参数：
  • REMOTE_VIDEO_STATE_STOPPED(0) 和 REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5)
  • REMOTE_VIDEO_STATE_DECODING(2) 和 REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6)
成员 io.agora.rtc.IRtcEngineEventHandler.onUserEnableVideo (int uid, boolean enabled)
v2.9.0。该回调已废弃。请改用 onRemoteVideoStateChanged 回调中的如下参数：
  • REMOTE_VIDEO_STATE_STOPPED(0) 和 REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5)
  • REMOTE_VIDEO_STATE_DECODING(2) 和 REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6)
成员 io.agora.rtc.IRtcEngineEventHandler.onUserMuteAudio (int uid, boolean muted)
v3.0.0。该回调已废弃，请改用 onRemoteAudioStateChanged 回调中的如下参数实现相同功能：
  • REMOTE_AUDIO_STATE_STOPPED(0) 和 REMOTE_AUDIO_REASON_REMOTE_MUTED(5)
  • REMOTE_AUDIO_STATE_DECODING(2 和 REMOTE_AUDIO_REASON_REMOTE_UNMUTED(6)
成员 io.agora.rtc.IRtcEngineEventHandler.onUserMuteVideo (int uid, boolean muted)
v3.0.0。该回调已废弃。请改用 onRemoteVideoStateChanged 回调中的如下参数实现相同功能：
  • REMOTE_VIDEO_STATE_STOPPED(0) 和 REMOTE_VIDEO_STATE_REASON_REMOTE_MUTED(5)
  • REMOTE_VIDEO_STATE_DECODING(2) 和 REMOTE_VIDEO_STATE_REASON_REMOTE_UNMUTED(6) 该回调是由远端用户调用 muteLocalVideoStream 方法关闭或开启视频发送触发的。
成员 io.agora.rtc.IRtcEngineEventHandler.onVideoStopped ()
从 v2.4.1 起废弃。请改用 onLocalVideoStateChanged 回调中的 LOCAL_VIDEO_STREAM_STATE_STOPPED(0)。
成员 io.agora.rtc.IRtcEngineEventHandler.RemoteVideoStats.delay
该参数已废弃。声网不建议你使用。 在有音画同步机制的音视频场景中，你可以参考 RemoteAudioStats 里的 networkTransportDelay 和 jitterBufferDelay 成员的值，了解视频的延迟数据。
类 io.agora.rtc.IRtcEngineEventHandler.VideoProfile
从 v2.3.0 废弃。声网不建议你使用。
成员 io.agora.rtc.IRtcEngineEventHandler.WarnCode.WARN_LOOKUP_CHANNEL_REJECTED
从 v2.4.1 起废弃。请改用 onConnectionStateChanged 回调中的 CONNECTION_CHANGED_REJECTED_BY_SERVER(10)。
成员 io.agora.rtc.live.LiveTranscoding.backgroundColor
该参数已废弃。声网不建议你使用。如果你希望设置旁路直播的背景颜色，请改用 setBackgroundColor。
成员 io.agora.rtc.live.LiveTranscoding.getBlue ()
获取背景蓝色分量。
成员 io.agora.rtc.live.LiveTranscoding.getGreen ()
获取背景绿色分量。
成员 io.agora.rtc.live.LiveTranscoding.getRed ()
获取背景红色分量。
成员 io.agora.rtc.live.LiveTranscoding.lowLatency
从 v2.8.0 起废弃。Agora 不推荐使用。
成员 io.agora.rtc.live.LiveTranscoding.metadata
该参数已废弃。
成员 io.agora.rtc.live.LiveTranscoding.setBlue (int blue)
设置背景蓝色分量。
成员 io.agora.rtc.live.LiveTranscoding.setGreen (int green)
设置背景绿色分量。
成员 io.agora.rtc.live.LiveTranscoding.setRed (int red)
设置背景红色分量。
成员 io.agora.rtc.live.LiveTranscoding.userCount
该参数已废弃。声网不建议你使用。如果你希望获取旁路直播中的用户人数，请改用 getUserCount 方法。
成员 io.agora.rtc.RtcEngine.addVideoWatermark (AgoraImage watermark)
从 v2.9.1 废弃。请改用 addVideoWatermark2。
成员 io.agora.rtc.RtcEngine.enableAudioQualityIndication (boolean enabled)
从 v2.4.1 起废弃。
成员 io.agora.rtc.RtcEngine.enableHighPerfWifiMode (boolean enable)
该方法已废弃。声网不建议你使用。
成员 io.agora.rtc.RtcEngine.enableWebSdkInteroperability (boolean enabled)
v3.0.0。自 Native SDK 3.0.0 及之后，SDK 自动开启与 Web SDK 的互通，无需调用该方法开启。
成员 io.agora.rtc.RtcEngine.getMediaEngineVersion ()
该方法已废弃。声网不建议你使用。
成员 io.agora.rtc.RtcEngine.getRecommendedEncoderType ()
该方法已废弃。声网不建议你使用。
成员 io.agora.rtc.RtcEngine.monitorBluetoothHeadsetEvent (boolean monitor)
该方法已废弃。声网不建议你使用。
成员 io.agora.rtc.RtcEngine.monitorHeadsetEvent (boolean monitor)
该方法已废弃。声网不建议你使用。
成员 io.agora.rtc.RtcEngine.pauseAudio ()
该方法已废弃。声网不建议你使用。如果你想禁用频道中的音频功能，请改用 disableAudio 方法。
成员 io.agora.rtc.RtcEngine.resumeAudio ()
该方法已废弃。声网不建议你使用。如果你想启用频道中的音频功能，请改用 enableAudio 方法。
成员 io.agora.rtc.RtcEngine.setHighQualityAudioParameters (boolean fullband, boolean stereo, boolean fullBitrate)
该方法已废弃。声网不建议你使用。如果你希望设置音频高音质选项，请改用 setAudioProfile 方法。
成员 io.agora.rtc.RtcEngine.setLocalRenderMode (int mode)
v3.0.0。该方法已废弃，请改用 setLocalRenderMode2 方法。
成员 io.agora.rtc.RtcEngine.setLocalVideoMirrorMode (int mode)
从 v3.0.0 起废弃。请改用 setupLocalVideo 或 setLocalRenderMode。
成员 io.agora.rtc.RtcEngine.setPreferHeadset (boolean enabled)
该方法已废弃。声网不建议你使用。
成员 io.agora.rtc.RtcEngine.setRemoteRenderMode (int uid, int mode)
v3.0.0. 该方法已废弃，请改用 setRemoteRenderMode2。
成员 io.agora.rtc.RtcEngine.setVideoProfile (int profile, boolean swapWidthAndHeight)
从 v2.3.2 起废弃。声网不建议你使用。如果你希望设置视频编码属性，请改用 setVideoEncoderConfiguration 方法。
成员 io.agora.rtc.RtcEngine.setVideoProfile (int width, int height, int frameRate, int bitrate)
从 v2.3.2 起废弃。声网不建议你使用。如果你希望设置视频编码属性，请改用 setVideoEncoderConfiguration 方法。
成员 io.agora.rtc.RtcEngine.setVideoQualityParameters (boolean preferFrameRateOverImageQuality)
从 v2.4.0 起废弃。声网建议使用 VideoEncoderConfiguration 类中的 degradationPrefer 参数设置视频质量偏好。 该方法允许用户设置视频的优化选项。
成员 io.agora.rtc.RtcEngine.startAudioRecording (String filePath, int quality)
从 v2.9.1 起废弃。请改用 startAudioRecording2。
成员 io.agora.rtc.RtcEngine.startEchoTest ()
从 v2.4.0 起废弃。声网建议使用 startEchoTest 方法开始语音回路测试。 该方法启动语音通话测试，目的是测试系统的音频设备（耳麦、扬声器等）和网络连接是否正常。在测试过程中，用户先说一段话，在 10 秒后，声音会回放出来。如果 10 秒后用户能正常听到自己刚才说的话，就表示系统音频设备和网络连接都是正常的。
成员 io.agora.rtc.RtcEngine.useExternalAudioDevice ()
该方法已废弃。声网不建议你使用。
成员 io.agora.rtc.video.VideoCanvas.RENDER_MODE_ADAPTIVE
该模式已废弃。声网不建议你使用。 3：适配模式。