Public 成员函数 | |
abstract int | setChannelProfile (int profile) |
abstract int | setClientRole (int role) |
abstract int | setClientRole (int role, ClientRoleOptions options) |
abstract int | sendCustomReportMessage (String id, String category, String event, String label, int value) |
abstract int | joinChannel (String token, String channelName, String optionalInfo, int optionalUid) |
abstract int | joinChannel (String token, String channelName, String optionalInfo, int optionalUid, ChannelMediaOptions options) |
abstract int | switchChannel (String token, String channelName) |
abstract int | switchChannel (String token, String channelName, ChannelMediaOptions options) |
abstract int | leaveChannel () |
abstract int | renewToken (String token) |
abstract int | registerLocalUserAccount (String appId, String userAccount) |
abstract int | joinChannelWithUserAccount (String token, String channelName, String userAccount) |
abstract int | joinChannelWithUserAccount (String token, String channelName, String userAccount, ChannelMediaOptions options) |
abstract int | setCloudProxy (int proxyType) |
abstract int | getUserInfoByUserAccount (String userAccount, UserInfo userInfo) |
abstract int | getUserInfoByUid (int uid, UserInfo userInfo) |
abstract int | enableWebSdkInteroperability (boolean enabled) |
abstract int | getConnectionState () |
abstract int | enableAudio () |
abstract int | disableAudio () |
abstract int | pauseAudio () |
abstract int | resumeAudio () |
abstract int | setAudioProfile (int profile, int scenario) |
abstract int | setHighQualityAudioParameters (boolean fullband, boolean stereo, boolean fullBitrate) |
abstract int | adjustRecordingSignalVolume (int volume) |
abstract int | adjustPlaybackSignalVolume (int volume) |
abstract int | adjustUserPlaybackSignalVolume (int uid, int volume) |
abstract int | enableAudioVolumeIndication (int interval, int smooth, boolean report_vad) |
abstract int | enableAudioQualityIndication (boolean enabled) |
abstract int | enableLocalAudio (boolean enabled) |
abstract int | muteLocalAudioStream (boolean muted) |
abstract int | muteRemoteAudioStream (int uid, boolean muted) |
abstract int | muteAllRemoteAudioStreams (boolean muted) |
abstract int | setDefaultMuteAllRemoteAudioStreams (boolean muted) |
abstract int | enableVideo () |
abstract int | disableVideo () |
abstract int | setVideoProfile (int profile, boolean swapWidthAndHeight) |
abstract int | setVideoProfile (int width, int height, int frameRate, int bitrate) |
abstract int | setVideoEncoderConfiguration (VideoEncoderConfiguration config) |
abstract int | setCameraCapturerConfiguration (CameraCapturerConfiguration config) |
abstract int | setupLocalVideo (VideoCanvas local) |
abstract int | setupRemoteVideo (VideoCanvas remote) |
abstract int | setLocalRenderMode (int mode) |
abstract int | setLocalRenderMode (int renderMode, int mirrorMode) |
abstract int | setRemoteRenderMode (int uid, int mode) |
abstract int | setRemoteRenderMode (int uid, int renderMode, int mirrorMode) |
abstract int | startPreview () |
abstract int | stopPreview () |
abstract int | enableLocalVideo (boolean enabled) |
abstract int | muteLocalVideoStream (boolean muted) |
abstract int | muteRemoteVideoStream (int uid, boolean muted) |
abstract int | muteAllRemoteVideoStreams (boolean muted) |
abstract int | setDefaultMuteAllRemoteVideoStreams (boolean muted) |
abstract int | setBeautyEffectOptions (boolean enabled, BeautyOptions options) |
abstract int | setDefaultAudioRoutetoSpeakerphone (boolean defaultToSpeaker) |
abstract int | setEnableSpeakerphone (boolean enabled) |
abstract boolean | isSpeakerphoneEnabled () |
abstract int | enableInEarMonitoring (boolean enabled) |
abstract int | setInEarMonitoringVolume (int volume) |
abstract int | useExternalAudioDevice () |
abstract int | setLocalVoicePitch (double pitch) |
abstract int | setLocalVoiceEqualization (int bandFrequency, int bandGain) |
abstract int | setLocalVoiceReverb (int reverbKey, int value) |
abstract int | setLocalVoiceChanger (int voiceChanger) |
abstract int | setLocalVoiceReverbPreset (int preset) |
abstract int | setAudioEffectPreset (int preset) |
abstract int | setVoiceBeautifierPreset (int preset) |
abstract int | setVoiceConversionPreset (int preset) |
abstract int | setAudioEffectParameters (int preset, int param1, int param2) |
abstract int | setVoiceBeautifierParameters (int preset, int param1, int param2) |
abstract int | enableDeepLearningDenoise (boolean enabled) |
abstract int | enableSoundPositionIndication (boolean enabled) |
abstract int | setRemoteVoicePosition (int uid, double pan, double gain) |
abstract int | startAudioMixing (String filePath, boolean loopback, boolean replace, int cycle) |
abstract int | stopAudioMixing () |
abstract int | pauseAudioMixing () |
abstract int | resumeAudioMixing () |
abstract int | adjustAudioMixingVolume (int volume) |
abstract int | adjustAudioMixingPlayoutVolume (int volume) |
abstract int | adjustAudioMixingPublishVolume (int volume) |
abstract int | getAudioMixingPlayoutVolume () |
abstract int | getAudioMixingPublishVolume () |
abstract int | getAudioMixingDuration () |
abstract int | getAudioMixingCurrentPosition () |
abstract int | setAudioMixingPosition (int pos) |
abstract int | setAudioMixingPitch (int pitch) |
abstract IAudioEffectManager | getAudioEffectManager () |
abstract int | startAudioRecording (String filePath, int quality) |
abstract int | startAudioRecording (String filePath, int sampleRate, int quality) |
abstract int | stopAudioRecording () |
abstract int | startEchoTest () |
abstract int | startEchoTest (int intervalInSeconds) |
abstract int | stopEchoTest () |
abstract int | enableLastmileTest () |
abstract int | disableLastmileTest () |
abstract int | startLastmileProbeTest (LastmileProbeConfig config) |
abstract int | stopLastmileProbeTest () |
abstract int | setVideoSource (IVideoSource source) |
abstract int | setLocalVideoRenderer (IVideoSink render) |
abstract int | setRemoteVideoRenderer (int uid, IVideoSink render) |
abstract int | setExternalAudioSink (boolean enabled, int sampleRate, int channels) |
abstract int | pullPlaybackAudioFrame (byte[] data, int lengthInByte) |
abstract int | setExternalAudioSource (boolean enabled, int sampleRate, int channels) |
abstract int | pushExternalAudioFrame (byte[] data, long timestamp) |
abstract void | setExternalVideoSource (boolean enable, boolean useTexture, boolean pushMode) |
abstract boolean | pushExternalVideoFrame (AgoraVideoFrame frame) |
abstract boolean | isTextureEncodeSupported () |
abstract int | registerAudioFrameObserver (IAudioFrameObserver observer) |
abstract int | setRecordingAudioFrameParameters (int sampleRate, int channel, int mode, int samplesPerCall) |
abstract int | setPlaybackAudioFrameParameters (int sampleRate, int channel, int mode, int samplesPerCall) |
abstract int | setMixedAudioFrameParameters (int sampleRate, int samplesPerCall) |
abstract int | addVideoWatermark (AgoraImage watermark) |
abstract int | addVideoWatermark (String watermarkUrl, WatermarkOptions options) |
abstract int | clearVideoWatermarks () |
abstract int | setRemoteUserPriority (int uid, int userPriority) |
abstract int | setLocalPublishFallbackOption (int option) |
abstract int | setRemoteSubscribeFallbackOption (int option) |
abstract int | enableDualStreamMode (boolean enabled) |
abstract int | setRemoteVideoStreamType (int uid, int streamType) |
abstract int | setRemoteDefaultVideoStreamType (int streamType) |
abstract int | setEncryptionSecret (String secret) |
abstract int | setEncryptionMode (String encryptionMode) |
abstract int | enableEncryption (boolean enabled, EncryptionConfig config) |
abstract int | addInjectStreamUrl (String url, LiveInjectStreamConfig config) |
abstract int | removeInjectStreamUrl (String url) |
abstract int | addPublishStreamUrl (String url, boolean transcodingEnabled) |
abstract int | removePublishStreamUrl (String url) |
abstract int | setLiveTranscoding (LiveTranscoding transcoding) |
abstract int | createDataStream (boolean reliable, boolean ordered) |
abstract int | createDataStream (DataStreamConfig config) |
abstract int | sendStreamMessage (int streamId, byte[] message) |
abstract int | setVideoQualityParameters (boolean preferFrameRateOverImageQuality) |
abstract int | setLocalVideoMirrorMode (int mode) |
abstract int | switchCamera () |
abstract boolean | isCameraZoomSupported () |
abstract boolean | isCameraTorchSupported () |
abstract boolean | isCameraFocusSupported () |
abstract boolean | isCameraExposurePositionSupported () |
abstract boolean | isCameraAutoFocusFaceModeSupported () |
abstract int | setCameraZoomFactor (float factor) |
abstract float | getCameraMaxZoomFactor () |
abstract int | setCameraFocusPositionInPreview (float positionX, float positionY) |
abstract int | setCameraExposurePosition (float positionXinView, float positionYinView) |
abstract int | enableFaceDetection (boolean enable) |
abstract int | setCameraTorchOn (boolean isOn) |
abstract int | setCameraAutoFocusFaceModeEnabled (boolean enabled) |
abstract String | getCallId () |
abstract int | rate (String callId, int rating, String description) |
abstract int | complain (String callId, String description) |
abstract int | setLogFile (String filePath) |
abstract int | setLogFilter (int filter) |
abstract int | setLogFileSize (int fileSizeInKBytes) |
abstract long | getNativeHandle () |
void | addHandler (IRtcEngineEventHandler handler) |
void | removeHandler (IRtcEngineEventHandler handler) |
abstract boolean | enableHighPerfWifiMode (boolean enable) |
abstract void | monitorHeadsetEvent (boolean monitor) |
abstract void | monitorBluetoothHeadsetEvent (boolean monitor) |
abstract void | setPreferHeadset (boolean enabled) |
abstract int | setParameters (String parameters) |
abstract String | getParameter (String parameter, String args) |
abstract int | registerMediaMetadataObserver (IMetadataObserver observer, int type) |
abstract int | startChannelMediaRelay (ChannelMediaRelayConfiguration channelMediaRelayConfiguration) |
abstract int | stopChannelMediaRelay () |
abstract int | updateChannelMediaRelay (ChannelMediaRelayConfiguration channelMediaRelayConfiguration) |
abstract RtcChannel | createRtcChannel (String channelId) |
静态 Public 成员函数 | |
static synchronized RtcEngine | create (Context context, String appId, IRtcEngineEventHandler handler) throws Exception |
static synchronized RtcEngine | create (RtcEngineConfig config) throws Exception |
static synchronized void | destroy () |
static SurfaceView | CreateRendererView (Context context) |
static TextureView | CreateTextureView (Context context) |
static int | getRecommendedEncoderType () |
static String | getSdkVersion () |
static String | getMediaEngineVersion () |
static String | getErrorDescription (int error) |
|
static |
创建 RtcEngine 实例。
RtcEngine 类的所有接口函数,如无特殊说明,都是异步调用,对接口的调用建议在同一个线程进行。
context | 安卓活动 (Android Activity) 的上下文。 |
appId | Agora 为 app 开发者签发的 App ID,详见获取 App ID。使用同一个 App ID 的 app 才能进入同一个频道进行通话或直播。一个 App ID 只能用于创建一个 RtcEngine。如需更换 App ID,必须先调用 destroy 销毁当前 RtcEngine,并在 destroy 成功返回后,再调用 create 重新创建 RtcEngine。 |
handler | io.agora.rtc.IRtcEngineEventHandler 是一个提供了缺省实现的抽象类,SDK 通过该抽象类向 app 报告 SDK 运行时的各种事件 |
Exception | 调用该方法时可能会发生的异常说明。 |
|
static |
创建 RtcEngine 实例。
RtcEngine 类的所有接口函数,如无特殊说明,都是异步调用,对接口的调用建议在同一个线程进行。
config | RtcEngine 实例的配置,详见 RtcEngineConfig。 |
Exception | 调用该方法时可能会发生的异常说明。 |
|
static |
|
abstract |
设置频道场景。
该方法用于设置 Agora 频道的使用场景。Agora SDK 会针对不同的使用场景采用不同的优化策略,如通信场景偏好流畅,直播场景偏好画质。
profile | 频道使用场景:
|
|
abstract |
设置直播场景下的用户角色。
在加入频道前,用户需要通过本方法设置观众(默认)或主播模式。在加入频道后,用户可以通过本方法切换用户模式。
直播场景下,如果你在加入频道后调用该方法切换用户角色,调用成功后,本地会触发 onClientRoleChanged 回调;远端会触发 onUserJoined/onUserOffline(USER_OFFLINE_BECOME_AUDIENCE) 回调。
role | 用户角色:
|
|
abstract |
设置直播场景下的用户角色。
在加入频道前和加入频道后均可调用该方法设置用户角色。
如果你在加入频道后调用该方法成功切换用户角色,SDK 会触发以下回调:
profile
设为 CHANNEL_PROFILE_LIVE_BROADCASTING
)时生效。示例代码
role | 直播场景中的用户角色: |
options | 用户具体设置,包含用户级别,详见 ClientRoleOptions。 |
|
abstract |
声网提供自定义数据上报和分析服务。
该服务当前处于免费内测期。内测期提供的能力为 6 秒内最多上报 10 条数据,每条自定义数据不能超过 256 字节,每个字符串不能超过 100 字节。如需试用该服务,请联系 sales 开通并商定自定义数据格式。 @ago ra.io
|
abstract |
加入频道。
该方法让用户加入通话频道,在同一个频道内的用户可以互相通话,多个用户加入同一个频道,可以群聊。使用不同 App ID 的 App 是不能互通的。如果已在通话中,用户必须调用 leaveChannel 退出当前通话,才能进入下一个频道。
成功调用该方加入频道后,本地会触发 onJoinChannelSuccess 回调;通信场景下的用户和直播场景下的主播加入频道后,远端会触发 onUserJoined 回调。
在网络状况不理想的情况下,客户端可能会与 Agora 的服务器失去连接;SDK 会自动尝试重连,重连成功后,本地会触发 onRejoinChannelSuccess 回调。
用户成功加入频道后,默认订阅频道内所有其他用户的音频流和视频流,因此产生用量并影响计费。如果想取消订阅,可以通过调用相应的 mute
方法实现。
请确保用于生成 Token 的 App ID 和 create
方法创建 RtcEngine
对象时用的 App ID 一致。
token | 在 app 服务器端生成的用于鉴权的 Token。详见从服务端生成 Token。 |
channelName | 标识通话的频道名称,长度在 64 字节以内的字符串。以下为支持的字符集范围(共 89 个字符):
|
optionalInfo | (非必选项)预留参数。 |
optionalUid | (非必选项)用户 ID,32 位无符号整数。建议设置范围:1 到 (232-1),并保证唯一性。如果不指定(即设为 0),SDK 会自动分配一个,并在 onJoinChannelSuccess 回调方法中返回,App 层必须记住该返回值并维护,SDK 不对该返回值进行维护。optionalUid 在 SDK 内部用 32 位无符号整数表示,由于 Java 不支持无符号整数,optionalUid 被当成 32 位有符号整数处理,对于过大的整数,Java 会表示为负数,如有需要可以用 (uid&0xffffffffL) 转换成 64 位整数。频道内每个用户的 UID 必须是唯一的。如果想要从不同的设备同时接入同一个频道,请确保每个设备上使用的 UID 是不同的。 |
RtcChannel
频道。RtcChannel
加入了一个频道,并在该 RtcChannel
频道中发布了音视频流。由于通过 RtcEngine
加入频道会默认发布音视频流,而 SDK 不支持同时在两个频道发布音视频流,因此会报错。RtcEngine
对象并完成初始化。
|
abstract |
加入频道并设置是否自动订阅音频或视频流。
该方法让用户加入通话频道,在同一个频道内的用户可以互相通话,多个用户加入同一个频道,可以群聊。使用不同 App ID 的 App 是不能互通的。如果已在通话中,用户必须调用 leaveChannel 退出当前通话,才能进入下一个频道。
成功调用该方法加入频道后,本地会触发 onJoinChannelSuccess 回调;通信场景下的用户和直播场景下的主播加入频道后,远端会触发 onUserJoined 回调。
在网络状况不理想的情况下,客户端可能会与 Agora 的服务器失去连接;SDK 会自动尝试重连,重连成功后,本地会触发 onRejoinChannelSuccess 回调。
options
参数,用于配置用户加入频道时是否自动订阅频道内所有远端音视频流。默认情况下,用户订阅频道内所有其他用户的音频流和视频流,因此会产生用量并影响计费。如果想取消订阅,可以通过设置 options
参数或相应的 mute
方法实现。create
方法创建 RtcEngine
对象时用的 App ID 一致。token | 在 app 服务器端生成的用于鉴权的 Token。详见从服务端生成 Token。 |
channelName | 标识通话的频道名称,长度在 64 字节以内的字符串。以下为支持的字符集范围(共 89 个字符):
|
optionalInfo | (非必选项)预留参数。 |
optionalUid | (非必选项)用户 ID,32 位无符号整数。建议设置范围:1 到 (232-1),并保证唯一性。如果不指定(即设为 0),SDK 会自动分配一个,并在 onJoinChannelSuccess 回调方法中返回,App 需自行维护该返回值,SDK 不对该返回值进行维护。optionalUid 在 SDK 内部用 32 位无符号整数表示,由于 Java 不支持无符号整数,optionalUid 被当成 32 位有符号整数处理,对于过大的整数,Java 会表示为负数,如有需要可以用 (uid&0xffffffffL) 转换成 64 位整数。频道内每个用户的 UID 必须是唯一的。如果想要从不同的设备同时接入同一个频道,请确保每个设备上使用的 UID 是不同的。 |
options | 频道媒体设置选项:ChannelMediaOptions. |
RtcChannel
频道。RtcChannel
加入了一个频道,并在该 RtcChannel
频道中发布了音视频流。RtcEngine
对象并完成初始化。
|
abstract |
快速切换直播频道。
当直播频道中的观众想从一个频道切换到另一个频道时,可以调用该方法,实现快速切换。
成功调用该方切换频道后,本地会先收到离开原频道的回调 onLeaveChannel,再收到成功加入新频道的回调 onJoinChannelSuccess。
用户成功切换频道后,默认订阅频道内所有其他用户的音频流和视频流,因此产生用量并影响计费。如果想取消订阅,可以通过调用相应的 mute
方法实现。
token | 在 app 服务端生成的用于鉴权的 Token。详见从服务端生成 Token。 |
channelName | 标识频道的频道名,最大不超过 64 字节。以下为支持的字符集范围(共 89 个字符):
|
|
abstract |
快速切换直播频道,并设置是否自动订阅音频流或视频流。
当直播频道中的观众想从一个频道切换到另一个频道时,可以调用该方法,实现快速切换。
成功调用该方法切换频道后,本地会先收到离开原频道的回调 onLeaveChannel,再收到成功加入新频道的回调 onJoinChannelSuccess。
options
参数,用于配置终端用户在切换到新的频道时是否自动订阅频道内所有远端音视频流。默认情况下,用户订阅新的频道内所有其他用户的音频流和视频流,因此会产生用量并影响计费。如果想取消订阅,可以通过设置 options
参数或相应的 mute
方法实现。token | 在 app 服务端生成的用于鉴权的 Token。详见从服务端生成 Token。 |
channelName | 标识频道的频道名,最大不超过 64 字节。以下为支持的字符集范围(共 89 个字符):
|
options | 频道媒体设置选项:ChannelMediaOptions. |
|
abstract |
离开频道。
离开频道,即挂断或退出通话。
调用 joinChannel 后,必须调用 leaveChannel
结束通话,否则无法开始下一次通话。
不管当前是否在通话中,都可以调用 leaveChannel,没有副作用。
该方法会把会话相关的所有资源释放掉。该方法是异步操作,调用返回时并没有真正退出频道。
成功调用该方法离开频道后,本地会触发 onLeaveChannel 回调;通信场景下的用户和直播场景下的主播离开频道后,远端会触发 onUserOffline 回调。
leaveChannel
后立即调用 destroy 方法,SDK 将无法触发 onLeaveChannel 回调。leaveChannel
方法, SDK 将自动调用 removePublishStreamUrl 方法。
|
abstract |
更新 Token。
该方法用于更新 Token。如果启用了 Token 机制,过一段时间后使用的 Token 会失效。以下两种情况下,app 应重新获取 Token,然后调用 renewToken
更新 Token,否则 SDK 无法和服务器建立连接:
token | 新的 Token。 |
|
abstract |
注册本地用户 User Account。
该方法为本地用户注册一个 User Account。注册成功后,该 User Account 即可标识该本地用户的身份,用户可以使用它加入频道。
成功注册 User Account 后,本地会触发 onLocalUserRegistered 回调,告知本地用户的 UID 和 User Account。
该方法为可选。如果你希望用户使用 User Account 加入频道,可以选用以下两种方式:
两种方式的区别在于,提前调用 registerLocalUserAccount
,可以缩短使用 joinChannelWithUserAccount
进入频道的时间。
userAccount
不能为空,否则该方法不生效。appId | 你的项目在 Agora 控制台注册的 App ID |
userAccount | 用户 User Account。该参数为必填,最大不超过 255 字节,不可填 null。请确保注册的 User Account 的唯一性。以下为支持的字符集范围(共 89 个字符):
|
|
abstract |
使用 User Account 加入频道。
该方法允许本地用户使用 User Account 加入频道。成功加入频道后,会触发以下回调:
用户成功加入频道后,默认订阅频道内所有其他用户的音频流和视频流,因此产生用量并影响计费。如果想取消订阅,可以通过调用相应的 mute
方法实现。
token | 在 app 服务端生成的用于鉴权的 Token。详见从服务端生成 Token。 |
channelName | 标识频道的频道名,最大不超过 64 字节。以下为支持的字符集范围(共 89 个字符):
|
userAccount | 用户 User Account。该参数为必需,最大不超过 255 字节,不可为 null。请确保加入频道的 User Account 的唯一性。以下为支持的字符集范围(共 89 个字符):
|
|
abstract |
使用 User Account 加入频道,并设置是否自动订阅音频或视频流。
该方法允许本地用户使用 User Account 加入频道。 成功加入频道后,会触发以下回调:
options
参数或相应的 mute
方法实现。token | 在 app 服务端生成的用于鉴权的 Token。详见从服务端生成 Token。 |
channelName | 标识频道的频道名,最大不超过 64 字节。以下为支持的字符集范围(共 89 个字符):
|
userAccount | 用户 User Account。该参数为必需,最大不超过 255 字节,不可为 null。请确保加入频道的 User Account 的唯一性。以下为支持的字符集范围(共 89 个字符):
|
options | 频道媒体设置选项:ChannelMediaOptions. |
|
abstract |
设置 Agora 云代理服务。
当用户防火墙限制 IP 和端口号时,你需要参考《使用云代理》开放相应 IP 和端口号,然后调用该方法开启云代理,并将 proxyType
参数设置为 TRANSPORT_TYPE_UDP_PROXY(1)
,即 UDP 协议的云代理。
成功连接云代理后,SDK 会触发 onConnectionStateChanged(CONNECTION_STATE_CONNECTING, CONNECTION_CHANGED_SETTING_PROXY_SERVER)
回调。
如果你想关闭已设置的云代理,请调用 setCloudProxy(NONE_PROXY)
。如果你想更改已设置的云代理类型,请先调用 setCloudProxy(NONE_PROXY)
,再调用 setCloudProxy
并传入你期望的 proxyType
值。
proxyType | 云代理类型。该参数为必填参数,如果你不赋值,SDK 会报错。 |
-2(ERR_INVALID_ARGUMENT)
: 传入的参数无效。-7(ERR_NOT_INITIALIZED)
: SDK 尚未初始化。
|
abstract |
通过 User Account 获取用户信息。
远端用户加入频道后,SDK 会获取到该远端用户的 UID 和 User Account,然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表, 并在本地触发 onUserInfoUpdated 回调。收到这个回调后,你可以调用该方法,通过传入 User Account 获取包含了指定用户 UID 的 UserInfo 对象。
userAccount | 用户 User Account。该参数为必填。 |
userInfo | [in/out] 标识用户信息的 UserInfo 对象,详见 UserInfo 类
|
|
abstract |
通过 UID 获取用户信息。
远端用户加入频道后, SDK 会获取到该远端用户的 UID 和 User Account,然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表,并在本地触发 onUserInfoUpdated 回调。 收到这个回调后,你可以调用该方法,通过传入 UID 获取包含了指定用户 User Account 的 UserInfo 对象。
uid | 用户 ID。该参数为必填。 |
userInfo | [in/out] 标识用户信息的 UserInfo 对象,详见 UserInfo 类
|
|
abstract |
打开与 Web SDK 的互通(仅在直播下适用)。
该方法打开或关闭与 Agora Web SDK 的互通。如果有用户通过 Web SDK 加入频道,请确保调用该方法,否则 Web 端用户看 Native 端的画面会是黑屏。
该方法仅在直播场景下适用,通信场景下默认互通是打开的。
enabled | 是否打开与 Agora Web SDK 的互通:
|
|
abstract |
获取当前网络连接状态。
|
abstract |
启用音频模块(默认为开启状态)。
|
abstract |
关闭音频模块。
|
abstract |
|
abstract |
|
abstract |
设置音频编码配置。
joinChannel
后设置不生效。profile
设置为 MUSIC_HIGH_QUALITY (4),Scenario 设置为 GAME_STREAMING (3)。profile | 设置采样率,码率,编码模式和声道数,详见 AudioProfile。 |
scenario | 设置音频应用场景,详见 AudioScenario。不同的音频场景下,设备的音量类型不同。详见如何区分媒体音量和通话音量。 |
|
abstract |
设置音频高音质选项。
该方法设置音频高音质选项。请在加入频道前调用本方法并一次性设置好三个模式。切勿在加入频道后再次调用本方法。
fullband | 全频带编解码器(48 kHz 采样率), 不兼容 1.7.4 以前版本
|
stereo | 立体声编解码器,不兼容 1.7.4 以前版本
|
fullBitrate | 高码率模式,建议仅在纯音频模式下使用
|
|
abstract |
调节采集信号音量。
volume | 采集信号音量,可在 0~400 范围内进行调节:
|
|
abstract |
调节本地播放的所有远端用户信号音量。
volume | 播放音量,取值范围为 [0, 400]:
|
|
abstract |
调节本地播放的指定远端用户信号音量。
你可以在通话中调用该方法调节指定远端用户在本地播放的音量。如需调节多个用户在本地播放的音量,则需多次调用该方法。
uid | 远端用户的 ID。 |
volume | 播放音量,取值范围为 [0,100]。
|
|
abstract |
启用用户音量提示。
该方法允许 SDK 定期向 app 报告本地发流用户和瞬时音量最高的远端用户(最多 3 位)的音量相关信息。启用该方法后,只要频道内有发流用户,SDK 会在加入频道后按设置的时间间隔触发 onAudioVolumeIndication 回调。
interval | 指定音量提示的时间间隔:
|
smooth | 平滑系数,指定音量提示的灵敏度。取值范围为 [0, 10],建议值为 3,数字越大,波动越灵敏;数字越小,波动越平滑。 |
report_vad | 是否开启人声检测
|
|
abstract |
启用音频质量通知回调。
该方法启用音频质量通知回调。一旦启用,onAudioQuality 将被定期触发。
enabled | 是否启用音频质量通知回调
|
|
abstract |
开启/关闭本地音频采集。
当 app 加入频道时,它的语音功能默认是开启的。该方法可以关闭或重新开启本地语音,即停止或重新开始本地音频采集。
该方法不影响接收或播放远端音频流,enableLocalAudio(false)
适用于只听不发的用户场景。
语音功能关闭或重新开启后,会收到回调 onLocalAudioStateChanged ,并报告 LOCAL_AUDIO_STREAM_STATE_STOPPED(0)
或 LOCAL_AUDIO_STREAM_STATE_CAPTURING(1)
。
enableLocalAudio
开启或关闭本地语音采集及处理。使用 enableLocalAudio
关闭或开启本地采集后,本地听远端播放会有短暂中断。enabled | 是否开启本地语音。
|
|
abstract |
取消或恢复发布本地音频流。
成功调用该方法后,远端会触发 onUserMuteAudio 回调。
setChannelProfile
方法,SDK 会根据你设置的频道场景以及用户角色,重新设置是否取消发布本地音频。因此我们建议在 setChannelProfile
后调用该方法。muted | 是否取消发布本地音频流。
|
|
abstract |
取消或恢复订阅指定远端用户的音频流。
uid | 指定用户的用户 ID。 |
muted | 是否取消订阅指定远端用户的音频流。
|
|
abstract |
取消或恢复订阅所有远端用户的音频流。
自 v3.3.0 起,成功调用该方法后,本地用户会取消或恢复订阅所有远端用户的音频流,包括在调用该方法后加入频道的用户的音频流。
muted | 是否取消订阅所有远端用户的音频流。
|
|
abstract |
设置是否默认接收音频流。
默认取消或恢复订阅远端用户的音频流。
该方法需要在加入频道后调用。调用成功后,本地用户取消或恢复订阅调用时刻之后加入频道的远端用户。
muteRemoteAudioStream(false)
。muted | 是否默认取消订阅远端用户的音频流:
|
|
abstract |
启用视频模块。
该方法用于打开视频模式。可以在加入频道前或者通话中调用,在加入频道前调用,则自动开启视频模式,在通话中调用则由音频模式切换为视频模式。调用 disableVideo 方法可关闭视频模式。
成功调用该方法后,远端会触发 onUserEnableVideo(true) 回调。
|
abstract |
关闭视频模块。
该方法用于关闭视频。可以在加入频道前或者通话中调用,在加入频道前调用,则自动开启纯音频模式,在通话中调用则由视频模式切换为纯音频频模式。调用 enableVideo 方法可开启视频模式。
成功调用该方法后,远端会触发 onUserEnableVideo(false) 回调。
|
abstract |
设置视频属性。
该方法设置视频的编码属性。 该方法在加入频道前后都能调用。 如果用户加入频道后不需要重新设置视频编码属性,则 Agora 建议在 enableVideo 前调用该方法,可以加快首帧出图的时间。
profile | 视频属性,详细定义见 Video Profile |
swapWidthAndHeight | SDK 会按照你选择的视频属性 (profile) 输出固定宽高的视频。该参数设置是否交换宽和高:
|
|
abstract |
手动设置视频属性。
该方法手动设置视频的编码属性。 如果用户加入频道后不需要重新设置视频编码属性,则 Agora 建议在 enableVideo 前调用该方法,可以加快首帧出图的时间。
width | 你想要设置的视频宽度,宽 × 高的最大值不超过 1280 × 720。 |
height | 你想要设置的视频高度,宽 × 高的最大值不超过 1280 × 720。 |
frameRate | 你想要设置的视频帧率,最高值不超过 30,如: 5、10、15、24、30 等。 |
bitrate | 你想要设置的视频码率,需要开发者根据想要设置的视频的宽、高和帧率,根据 Bitrate 中的码率参考表,手动推算出合适值。宽和高固定的情况下,码率随帧率的变化而变化:
|
|
abstract |
设置视频编码属性。
该方法设置视频编码属性。每个属性对应一套视频参数,如分辨率、帧率、码率、视频方向等。 所有设置的参数均为理想情况下的最大值。当视频引擎因网络环境等原因无法达到设置的分辨率、帧率或码率的最大值时,会取最接近最大值的那个值。
如果用户加入频道后不需要重新设置视频编码属性,则 Agora 建议在 enableVideo 前调用该方法,可以加快首帧出图的时间。
config | 视频编码属性,详细定义见 VideoEncoderConfiguration |
|
abstract |
设置摄像头的采集配置。
一般的视频通话或直播中,默认由 SDK 自动控制摄像头的输出参数。在如下特殊场景中,默认的参数通常无法满足需求,或可能引起设备性能问题,我们推荐调用该接口设置摄像头的采集配置:
config | 摄像头采集配置,详细定义见 CameraCapturerConfiguration |
|
abstract |
初始化本地视图。
该方法初始化本地视图并设置本地用户视频显示信息,只影响本地用户看到的视频画面,不影响本地发布视频。 调用该方法绑定本地视频流的显示视窗(View),并设置本地用户视图的渲染模式和镜像模式。
local | 本地视频显示属性,详细定义见 Video Canvas。 |
|
abstract |
初始化远端用户视图。
该方法绑定远端用户和显示视图,并设置远端用户视图在本地显示时的渲染模式和镜像模式,只影响本地用户看到的视频画面。
如果 App 不能事先知道对方的用户 ID,可以在 APP 收到 onUserJoined 事件时设置。如果启用了视频录制功能,视频录制服务会做为一个哑客户端加入频道,因此其他客户端也会收到它的 onUserJoined 事件,App 不应给它绑定视图(因为它不会发送视频流),如果 App 不能识别哑客户端,可以在 onFirstRemoteVideoDecoded 事件时再绑定视图。解除某个用户的绑定视图可以把 view 设置为空。退出频道后,SDK 会把远程用户的绑定关系清除掉。
remote | 远端视图属性,详细定义见 Video Canvas。 |
|
abstract |
设置本地视频显示模式。
该方法设置本地视频显示模式。App 可以多次调用此方法更改显示模式。
mode | 视频显示模式:
|
|
abstract |
更新本地视图显示模式。
初始化本地用户视图后,你可以调用该方法更新本地用户视图的渲染和镜像模式。该方法只影响本地用户看到的视频画面,不影响本地发布视频。
renderMode | 本地视图的渲染模式。
|
mirrorMode | 本地视图的镜像模式。
|
|
abstract |
设置远端视频显示模式。
该方法设置远端视频显示模式。App 可以多次调用此方法更改显示模式。
uid | 远端用户 ID |
mode | 视频显示模式:
|
|
abstract |
更新远端视图显示模式。
初始化远端用户视图后,你可以调用该方法更新远端用户在本地显示时的渲染和镜像模式。该方法只影响本地用户看到的视频画面。
uid | 远端用户的 ID。 |
renderMode | 远端用户视图的渲染模式。
|
mirrorMode | 远端用户视图的镜像模式。
|
|
static |
创建 RendererView。
该方法创建视频 RendererView,返回 SurfaceView 的类型。View 的操作和布局由 app 管理, Agora SDK 在 app 提供的 View 上进行渲染。显示视频视图必须调用该方法,而不是直接调用 SurfaceView。
如果你需要使用 SurfaceView,请调用本方法;如果你需要使用 TextureView,请调用 CreateTextureView 方法。详见 TextureView 和 SurfaceView 的区别和选择 SurfaceView 或 TextureView。
context | 安卓活动 (Android Activity) 的上下文。 |
|
static |
创建 TextureView。
该方法创建 TextureView,适用于需要对视频画面进行缩放、旋转和平移的场景,如屏幕共享。View 的操作和布局由 app 管理,SDK 仅在 app 提供的 View 上进行渲染。
如果你需要使用 TextureView,请调用本方法。如果你需要使用 SurfaceView,请调用 CreateRendererView 方法。详见 TextureView 和 SurfaceView 的区别和选择 SurfaceView 或 TextureView。
Agora 推荐你在视频通话和直播场景使用 SurfaceView,在需要对视频画面进行缩放、旋转和平移的场景(如屏幕共享场景)使用 TextureView。
context | 安卓活动 (Android Activity) 的上下文。 |
|
abstract |
开启视频预览。
该方法用于在进入频道前启动本地视频预览。调用该 API 前,必须:
|
abstract |
停止视频预览。
|
abstract |
开启/关闭本地视频采集。
该方法禁用或重新启用本地视频采集。不影响接收远端视频。
调用 enableVideo 后,本地视频即默认开启。 你可以调用 enableLocalVideo(false) 关闭本地视频采集。关闭后如果想重新开启,则可调用 enableLocalVideo(true)。
成功禁用或启用本地视频采集后,远端会触发 onUserEnableLocalVideo 回调。
enabled | 是否启用本地视频:
|
|
abstract |
取消或恢复发布本地视频流。
成功调用该方法后,远端会触发 onUserMuteVideo 回调。
setChannelProfile
后调用该方法。muted | 是否取消发布本地视频流。
|
|
abstract |
取消或恢复订阅指定远端用户的视频流。
uid | 指定用户的用户 ID。 |
muted | 是否取消订阅指定远端用户的视频流。
|
|
abstract |
取消或恢复订阅所有远端用户的视频流。
自 v3.3.0 起,成功调用该方法后,本地用户会取消或恢复订阅所有远端用户的视频流,包括在调用该方法后加入频道的用户的视频流。
muted | 是否取消订阅所有远端用户的视频流。
|
|
abstract |
设置是否默认接收视频流。
默认取消或恢复订阅远端用户的视频流。
该方法需要在加入频道后调用。调用成功后,本地用户取消或恢复订阅调用时刻之后加入频道的远端用户。
muteRemoteVideoStream(false)
。muted | 是否默认取消订阅远端用户的视频流:
|
|
abstract |
开启本地美颜功能,并设置美颜效果选项。
enabled | 是否开启美颜功能:
|
options | 美颜选项,详细定义见 BeautyOptions |
|
abstract |
设置默认的音频播放路由。
该方法设置接收到的语音从听筒或扬声器出声。如果用户不调用本方法,则语音默认从听筒出声。 如果你想要在加入频道后修改语音路由,可以使用 setEnableSpeakerphone.
各场景下默认的语音路由:
disableVideo
或 muteLocalVideoStream
和 muteAllRemoteVideoStreams
关闭视频,则语音路由会自动切换回听筒。defaultToSpeaker |
|
|
abstract |
启用/关闭扬声器播放。
该方法设置是否将语音路由设到扬声器(外放)。调用该方法后,SDK 将触发 onAudioRouteChanged 回调提示状态已更改。
scenario
及 setChannelProfile 的设置会影响 setEnableSpeakerphone
的行为。setEnableSpeakerphone
不生效的情况如下:scenario
为 AUDIO_SCENARIO_GAME_STREAMING
时,所有用户都无法切换音频播放路由。scenario
为 AUDIO_SCENARIO_DEFAULT
或 AUDIO_SCENARIO_SHOWROOM
时,直播场景中的观众无法切换音频播放路由,且当频道中只有一个主播时,该主播也无法切换音频播放路由。scenario
为 AUDIO_SCENARIO_EDUCATION
时,直播场景中的观众无法切换音频播放路由。enabled | 是否将音频路由到外放:
|
|
abstract |
检查扬声器状态启用状态。
该方法检查扬声器是否已开启。
|
abstract |
开启耳返功能。
该方法打开或关闭耳返功能。
enabled |
|
|
abstract |
设置耳返音量。
volume | 设置耳返音量,取值范围在 0 到 100 间。默认值为 100。 |
|
abstract |
|
abstract |
设置本地语音音调。
该方法改变本地说话人声音的音调。
pitch | 语音频率。可以在 [0.5, 2.0] 范围内设置。取值越小,则音调越低。默认值为 1.0,表示不需要修改音调。 |
|
abstract |
设置本地语音音效均衡。
bandFrequency | 频谱子带索引,取值范围是 [0-9],分别代表 10 个频带,对应的中心频率是 [31,62,125,250,500,1k,2k,4k,8k,16k] Hz |
bandGain | 每个 band 的增益,单位是 dB,每一个值的范围是 [-15,15],默认值为 0 |
|
abstract |
设置本地音效混响。
reverbKey | 混响音效 Key。该方法共有 5 个混响音效 Key,分别如 value 栏列出。 |
value | 各混响音效 Key 所对应的值:
|
|
abstract |
设置本地语音变声、美音或语聊美声效果。
setAudioEffectPreset
:音效。setVoiceBeautifierPreset
:美声效果。setVoiceConversionPreset
:变声效果。 该方法在频道内外均可调用。
通信场景下的用户或直播场景下的主播均可调用该方法为本地语音设置以下效果。成功设置以后,频道内的所有用户均可听到声音效果。
profile
参数设置为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
或 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
。voiceChanger | 本地语音的变声、美音或语聊美声效果选项:
|
|
abstract |
设置本地语音混响(含虚拟立体声效果)。
setAudioEffectPreset
或 setVoiceBeautifierPreset
。 该方法在频道内外均可调用。
通信场景下的用户或直播场景下的主播均可调用该方法设置本地语音混响。成功设置以后,频道内的所有用户均可听到声音效果。
AUDIO_REVERB_FX
为前缀的枚举值时,请确保在调用该方法前将 setAudioProfile 的 profile
参数设置为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
或 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
,否则该方法设置无效。AUDIO_VIRTUAL_STEREO
时,Agora 推荐在调用该方法前将 setAudioProfile 的 profile
参数设置为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
。preset | 本地语音混响选项。为达到更好的混响效果,Agora 推荐使用以 AUDIO_REVERB_FX 为前缀的枚举值。
|
|
abstract |
设置 SDK 预设的人声音效。
调用该方法可以为本地发流用户设置 SDK 预设的人声音效,且不会改变原声的性别特征。设置音效后,频道 内所有用户都能听到该效果。
根据不同的场景,你可以为用户设置不同的音效,各音效的适用场景可参考《设置人声效果》。
为获取更好的人声效果,Agora 推荐你在调用该方法前将 setAudioProfile 的 scenario
设为 AUDIO_SCENARIO_GAME_STREAMING(3)
。
setAudioProfile
的 profile
参数设置为 AUDIO_PROFILE_SPEECH_STANDARD(1)
,否则该方法不生效。ROOM_ACOUSTICS_3D_VOICE
或 PITCH_CORRECTION
外的枚举,请勿再调用 setAudioEffectParameters,否则该方法设置的效果会被覆盖。
|
abstract |
设置 SDK 预设的美声效果。
调用该方法可以为本地发流用户设置 SDK 预设的人声美化效果。设置美声效果后,频道内所有用户都能听到该效果。根据不同的场景,你可以为用户设置不同的美声效果,各美声效果的适用场景可参考《设置人声效果》。
为获取更好的人声效果,Agora 推荐你在调用该方法前将 setAudioProfile 的 scenario
设为 AUDIO_SCENARIO_GAME_STREAMING(3)
,并将 profile
设为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
或 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
。
setAudioProfile
的 profile
参数设置为 AUDIO_PROFILE_SPEECH_STANDARD(1)
,否则该方法不生效。
|
abstract |
设置 SDK 预设的变声效果。
调用该方法可以为本地发流用户设置 SDK 预设的变声效果。设置变声效果后,频道内所有用户都能听到该效果。根据不同的场景,你可以为用户设置不同的变声效果,各变声效果的适用场景可参考《设置人声效果》。
为获取更好的人声效果,Agora 推荐你在调用该方法前将 setAudioProfile 的 scenario
设为 AUDIO_SCENARIO_GAME_STREAMING(3)
,并将 profile
设为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
或 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
。
setAudioProfile
的 profile
参数设置为 AUDIO_PROFILE_SPEECH_STANDARD(1)
,否则该方法不生效。preset | 预设的变声效果选项: |
|
abstract |
设置 SDK 预设人声音效的参数。
调用该方法可以对本地发流用户进行如下设置:
设置后,频道内所有用户都能听到该效果。
scenario
设为 AUDIO_SCENARIO_GAME_STREAMING(3)
。setAudioProfile
的 profile
参数设置为 AUDIO_PROFILE_SPEECH_STANDARD(1)
,否则该方法不生效。preset | SDK 预设的音效:
|
param1 |
|
param2 |
|
|
abstract |
设置 SDK 预设美声效果的参数。
调用该方法可以设置歌唱美声效果的性别特征和混响效果。该方法对本地发流用户进行设置。设置后,频道内所有用户都能听到该效果。
为获取更好的人声效果,Agora 推荐你在调用该方法前将 setAudioProfile 的 scenario
设为 AUDIO_SCENARIO_GAME_STREAMING(3)
,并将 profile
设为 AUDIO_PROFILE_MUSIC_HIGH_QUALITY(4)
或 AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO(5)
。
setAudioProfile
的 profile
参数设置为 AUDIO_PROFILE_SPEECH_STANDARD(1)
,否则该方法不生效。preset | SDK 预设的音效:
|
param1 | 歌声的性别特征:
|
param2 | 歌声的混响效果:
|
|
abstract |
开启或关闭 AI 降噪模式。
SDK 默认开启传统降噪模式,以消除大部分平稳噪声。如果你还需要消除非平稳噪声,Agora 推荐你按如下步骤开启 AI 降噪模式:
libs
文件夹中的 libagora_ai_denoise_extension.so
集成到项目中。enableDeepLearningDenoise(true)
。AI 降噪模式对设备性能有要求。只有在设备性能良好的情况下,SDK 才会成功开启 AI 降噪模式。
成功开启 AI 降噪模式后,如果 SDK 检测到当前设备的性能不足,SDK 会自动关闭 AI 降噪模式,并开启传统降噪模式。
在频道内,如果你调用了 enableDeepLearningDenoise(false)
或 SDK 自动关闭了 AI 降噪模式,当你需要重新开启 AI 降噪模式时,你需要先调用 leaveChannel
,再调用 enableDeepLearningDenoise(true)
。
libagora_ai_denoise_extension.so
,所以 Agora 推荐在加入频道前调用该方法。enabled | 是否开启 AI 降噪模式:
|
-157
(ERR_MODULE_NOT_FOUND
): 未集成 AI 降噪库。
|
abstract |
开启/关闭远端用户的语音立体声。
如果想调用 setRemoteVoicePosition 实现听声辨位的功能,请确保在调用 joinChannel 方法前调用该方法。
enabled | 是否开启远端用户语音立体声:
|
|
abstract |
设置远端用户声音的空间位置和音量,方便本地用户听声辨位。
用户通过调用该接口,设置远端用户声音出现的位置,左右声道的声音差异会让用户产生声音的方位感,从而判断出远端用户的实时位置。在多人在线游戏场景,如吃鸡游戏中,该方法能有效增加游戏角色的方位感,模拟真实场景。
uid | 远端用户的 ID |
pan | 设置远端用户声音出现的位置,取值范围为 [-1.0, 1.0]:
|
gain | 设置远端用户声音的音量,取值范围为 [0.0, 100.0],默认值为 100.0,表示该用户的原始音量。取值越小,则音量越低 |
|
abstract |
开始播放音乐文件及混音。
该方法指定本地或在线音频文件来和麦克风采集的音频流进行混音或替换。替换是指用音频文件替换麦克风采集的音频流。该方法可以选择是否让对方听到本地播放的音频,并指定循环播放的次数。 成功调用该方法后,本地会触发 onAudioMixingStateChanged(MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY) 回调。播放结束后,会收到 onAudioMixingStateChanged(MEDIA_ENGINE_AUDIO_EVENT_MIXING_STOPPED) 回调。
filePath | 指定需要混音的本地或在线音频文件的绝对路径(包含文件名后缀),如 /sdcard/emulated/0/audio.mp4 。支持的音频格式包括:mp3、mp4、m4a、aac、3gp、mkv 及 wav。
|
loopback |
|
replace |
|
cycle | 音频文件循环播放的次数:
|
|
abstract |
停止播放音乐文件及混音。
该方法停止播放伴奏。请在频道内调用该方法。
|
abstract |
暂停播放音乐文件及混音。
该方法暂停播放伴奏。请在频道内调用该方法。
|
abstract |
恢复播放音乐文件及混音。
该方法恢复混音,继续播放伴奏。请在频道内调用该方法。
|
abstract |
调节音乐文件的播放音量。
该方法调节混音里伴奏在本端和远端播放的音量大小。
你需要在调用 startAudioMixing 并收到 onAudioMixingStateChanged(MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY) 回调后调用该方法。
volume | 伴奏音量范围为 0~100。默认 100 为原始文件音量。 |
|
abstract |
调节音乐文件的本地播放音量。
该方法调节混音里音乐文件在本端播放的音量大小。
你需要在调用 startAudioMixing 并收到 onAudioMixingStateChanged(MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY) 回调后调用该方法。
volume | 伴奏音量范围为 0~100。默认 100 为原始文件音量。 |
|
abstract |
调节音乐文件的远端播放音量。
该方法调节混音里音乐文件在远端播放的音量大小。
你需要在调用 startAudioMixing 并收到 onAudioMixingStateChanged(MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY) 回调后调用该方法。
volume | 伴奏音量范围为 0~100。默认 100 为原始文件音量。 |
|
abstract |
获取音乐文件的本地播放音量。
该方法获取音乐文件的本地播放音量。该接口可以方便开发者排查音量相关问题。
你需要在调用 startAudioMixing 并收到 onAudioMixingStateChanged(MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY) 回调后调用该方法。
|
abstract |
获取音乐文件的远端播放音量。
该方法获取音乐文件的远端播放音量。该接口可以方便开发者排查音量相关问题。
你需要在调用 startAudioMixing 并收到 onAudioMixingStateChanged(MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY) 回调后调用该方法。
|
abstract |
获取音乐文件的时长。
该方法获取音乐文件时长,单位为毫秒。请在频道内调用该方法。如果返回值 < 0,表明调用失败。
你需要在调用 startAudioMixing 并收到 onAudioMixingStateChanged(MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY) 回调后调用该方法。
|
abstract |
获取音乐文件的播放进度。
该方法获取当前伴奏播放进度,单位为毫秒。
你需要在调用 startAudioMixing 并收到 onAudioMixingStateChanged(MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY) 回调后调用该方法。
|
abstract |
设置音乐文件的播放位置。
该方法可以设置音频文件的播放位置,这样你可以根据实际情况播放文件,而不是非得从头到尾播放一个文件。
你需要在调用 startAudioMixing 并收到 onAudioMixingStateChanged(MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY) 回调后调用该方法。
pos | 整数。进度条位置,单位为毫秒。 |
|
abstract |
调整本地播放的音乐文件的音调。
本地人声和播放的音乐文件混音时,调用该方法可以仅调节音乐文件的音调。
你需要在调用 startAudioMixing 并收到 onAudioMixingStateChanged(MEDIA_ENGINE_AUDIO_EVENT_MIXING_PLAY) 回调后调用该方法。
pitch | 按半音音阶调整本地播放的音乐文件的音调,默认值为 0,即不调整音调。取值范围为 [-12,12],每相邻两个值的音高距离相差半音。取值的绝对值越大,音调升高或降低得越多。 |
|
abstract |
获取 IAudioEffectManager 类,以管理音效文件。
|
abstract |
开始客户端录音。
Agora SDK 支持通话过程中在客户端进行录音。该方法录制频道内所有用户的音频,并生成一个包含所有用户声音的录音文件,录音文件格式可以为:
该方法的录制采样率固定为 32 kHz。
该接口需在加入频道之后调用。如果调用 leaveChannel 时还在录音,录音会自动停止。
filePath | 录音文件的本地保存路径,由用户自行指定,需精确到文件名及格式,例如:/sdcard/emulated/0/audio.aac 。请确保目录存在且可写。 |
quality | 录音音质: |
|
abstract |
开始客户端录音。
Agora SDK 支持通话过程中在客户端进行录音。调用该方法后,你可以录制频道内所有用户的音频,并得到一个包含所有用户声音的录音文件。录音文件格式可以为:
sampleRate
设为 44.1 kHz 或 48 kHz 时,建议将 quality
设为 AUDIO_RECORDING_QUALITY_MEDIUM 或 AUDIO_RECORDING_QUALITY_HIGH。filePath | 录音文件在本地保存的绝对路径,由用户自行制定,需精确到文件名及格式,例如:/dir1/dir2/dir3/audio.aac。 |
sampleRate | 录音采样率 (Hz),可以设置为以下值:
|
quality | 录音音质: |
|
abstract |
停止客户端录音。
该方法停止录音。该接口需要在 leaveChannel 之前调用,不然会在调用 leaveChannel 时自动停止。
|
abstract |
开始语音通话回路测试。
|
abstract |
开始语音通话回路测试。
该方法启动语音通话测试,目的是测试系统的音频设备(耳麦、扬声器等)和网络连接是否正常。在测试过程中,用户先说一段话,声音会在设置的时间间隔(单位为秒)后回放出来。如果用户能正常听到自己刚才说的话,就表示系统音频设备和网络连接都是正常的。
intervalInSeconds | 设置返回语音通话回路测试结果的时间间隔,取值范围为 [2, 10],单位为秒,默认为 10 秒。 |
|
abstract |
停止语音通话回路测试。
|
abstract |
启用网络测试。
该方法启用网络连接质量测试,用于检测用户网络接入质量。默认该功能为关闭状态。该方法主要用于以下两种场景:
无论哪种场景,启用该方法会消耗一定的网络流量,影响通话质量。在收到 onLastmileQuality 回调后须调用 disableLastmileTest 停止测试,再加入频道或切换用户角色。
|
abstract |
关闭网络测试。
|
abstract |
开始通话前网络质量探测,向用户反馈上下行网络的带宽、丢包、网络抖动和往返时延数据。
启用该方法后,SDK 会依次返回如下 2 个回调:
该方法主要用于以下两种场景:
config | Last-mile 网络探测配置,详细定义见 LastmileProbeConfig。 |
|
abstract |
停止通话前网络质量探测。
|
abstract |
设置自定义的视频源。
实时通信过程中,Agora SDK 会启动默认的视频输入设备,即内置的摄像头,采集视频。但是,如果你需要自定义视频输入设备,你可以先通过 IVideoSource 类自定义视频源,再调用该方法将自定义的视频源加入到 SDK 中。
该方法在加入频道前后都能调用。
source | 自定义的视频源。详细定义见 IVideoSource |
|
abstract |
自定义本地视频渲染器。
该方法设置本地视频渲染器。实时通讯过程中,Agora SDK 通常会启动默认的视频渲染器进行视频渲染。当需要自定义视频渲染设备时,App 可以先通过 IVideoSink 自定义渲染器,然后调用该方法将视频渲染器加入到 SDK 中。 该方法在加入频道前后都能调用。
render | 自定义的本地视频渲染器。详细定义见 IVideoSink |
|
abstract |
自定义远端视频渲染器。
该方法设置远端视频渲染器。实时通讯过程中,Agora SDK 通常会启动默认的视频渲染器进行视频渲染。当需要自定义视频渲染设备时,App 可以先通过 IVideoSink 自定义渲染器,然后调用该方法将视频渲染器加入到 SDK 中。 该方法在加入频道前后都能调用。如果在加入频道前调用,需要自行维护远端用户的 uid。
uid | 远端用户 ID |
render | 自定义的远端视频渲染器。详细定义见 IVideoSink |
|
abstract |
设置外部音频渲染。
该方法适用于需要自行渲染音频的场景。开启外部音频渲染后,你可以通过调用 pullPlaybackAudioFrame 方法拉取远端音频数据。App 可以对拉取到的原始音频数据进行处理后再渲染,获取想要的音频效果。
该方法需要在加入频道前调用
enabled | 设置是否开启外部音频渲染:
|
sampleRate | 外部音频渲染的采样率 (Hz),可设置为 16000,32000,44100 或 48000。 |
channels | 外部音频渲染的声道数,可设置为 1 或 2:
|
|
abstract |
拉取外部音频数据。
使用该方法前,你需要调用 setExternalAudioSink(enabled: true) 方法通知 App 开启并设置外部渲染。
该方法需要在加入频道后调用。 调用该方法后,app 会采取主动拉取的方式获取远端已解码和混音后的音频数据,用于音频播放。
onPlaybackFrame
回调相比,区别在于:onPlaybackFrame
:SDK 通过该回调将音频数据传输给 app。如果 app 处理延时,可能会导致音频播放抖动。pullPlaybackAudioFrame
:app 主动拉取音频数据。通过设置音频数据,SDK 可以调整缓存,帮助 app 处理延时,从而有效避免音频播放抖动。data | 需要拉取的音频数据,格式为 byte[]。 |
lengthInByte | 待拉取音频数据的字节数,单位为 byte。该参数的取值与音频数据的时长、你在 setExternalAudioSink 中设置的 sampleRate 和 channels 参数相关。Agora 建议音频数据的时长至少为 10 毫秒。计算公式为:lengthInByte = sampleRate/1000 × 2 × channels × 音频数据时长(毫秒)。 |
|
abstract |
设置外部音频采集参数。
enabled | 是否开启外部音频采集。
|
sampleRate | 外部音频源的采样率(Hz),可设置为 8000,16000,32000,44100 或 48000。 |
channels | 外部音频源的通道数,可设置为:
|
|
abstract |
推送外部音频帧。
该方法需要在加入频道后调用。
data | 外部音频数据 |
timestamp | 外部音频帧的时间戳,单位为毫秒。该参数为必填。你可以使用该时间戳还原音频帧顺序;在有视频的场景中(包含使用外部视频源的场景),该参数可以帮助音视频同步 |
|
abstract |
配置外部视频源。
该方法需要在加入频道前调用。
enable | 是否使用外部视频源:
|
useTexture | 是否使用 Texture 作为输入:
|
pushMode | 是否外部视频源需要调用 PushExternalVideoFrame 将视频帧主动推送给 Agora SDK:
|
|
abstract |
推送外部视频帧。
该方法主动将视频帧数据用 AgoraVideoFrame 类封装后传递给 SDK。请确保在你调用本方法前已调用 setExternalVideoSource,并将参数 pushMode 设为 true,不然调用本方法后会一直报错。 该方法需要在加入频道后调用。
frame | 视频帧的数据信息。详细定义见 Agora Video Frame |
|
abstract |
检查视频是否支持 Texture 编码。
|
abstract |
注册语音观测器对象。
该方法用于注册语音观测器对象,即注册回调。当需要 SDK 给出 onRecordFrame 或 onPlaybackFrame 回调时,需要使用该方法注册回调。 该方法需要在加入频道前调用。
observer | 接口对象实例:IAudioFrameObserver。传入 null 表示取消注册。我们建议在收到 onLeaveChannel 后调用,来释放语音观测器对象。 |
|
abstract |
设置采集的音频格式。
该方法设置 onRecordFrame 回调数据的格式。 该方法需要在加入频道前调用。
samplesPerCall
、sampleRate
和 channel
参数计算出采样间隔,计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。 请确保采样间隔不得小于 0.01 (s)。SDK 会根据该采样间隔触发 onRecordFrame
回调。sampleRate | onRecordFrame 中返回数据的采样率,可设置为 8000,16000,32000,44100 或 48000。 |
channel | onRecordFrame 中返回数据的通道数,可设置为:
|
mode | onRecordFrame 的使用模式:
|
samplesPerCall | onRecordFrame 中返回数据的采样点数,如 RTMP/RTMPS 推流应用中通常为 1024。 |
|
abstract |
设置播放的声音格式。
该方法设置 onPlaybackFrame 回调数据的格式。 该方法需要在加入频道前调用。
samplesPerCall
、sampleRate
和 channel
参数计算出采样间隔,计算公式为采样间隔 = samplesPerCall/(sampleRate × channel)。 请确保采样间隔不得小于 0.01 (s)。SDK 会根据该采样间隔触发 onPlaybackFrame
回调。sampleRate | onPlaybackFrame 中返回数据的采样率,可设置为 8000,16000,32000,44100 或 48000。 |
channel | onPlaybackFrame 中返回数据的通道数,可设置为:
|
mode | onPlaybackFrame 的使用模式:
|
samplesPerCall | onPlaybackFrame 中返回数据的采样点数,如 RTMP/RTMPS 推流应用中通常为 1024。 |
|
abstract |
设置录制和播放声音混音后的数据格式。
该方法设置 onMixedAudioFrame 回调数据的格式。 该方法需要在加入频道前调用。
samplesPerCall
、sampleRate
和 AudioFrame 中的 channels
参数计算出采样间隔,计算公式为采样间隔 = samplesPerCall/(sampleRate × channels)。 请确保采样间隔不得小于 0.01 (s)。SDK 会根据该采样间隔触发onMixedAudioFrame 回调。sampleRate | 指定 onMixedAudioFrame 中返回数据的采样率,可设置为 8000,16000,32000,44100 或 48000 |
samplesPerCall | 指定 onMixedAudioFrame 中返回数据的采样点数,如 RTMP/RTMPS 推流应用中通常为 1024。 |
|
abstract |
添加本地视频水印。
该方法将一张 PNG 图片作为水印添加到本地发布的直播视频流上,同一直播频道中的观众,旁路直播观众,甚至采集设备都能看到或采集到该水印图片。 如果你仅仅希望在旁路直播推流中添加水印,请参考 设置直播转码 setLiveTranscoding 中描述的用法。