NERtc Android SDK
V4.6.0
|
Public 成员函数 | |
abstract int | muteLocalAudioStream (boolean mute) |
abstract int | muteLocalVideoStream (boolean mute) |
abstract int | sendSEIMsg (String seiMsg, NERtcVideoStreamType streamType) |
abstract int | sendSEIMsg (String seiMsg) |
abstract int | switchCamera () |
abstract int | getCurrentCamera () |
abstract boolean | isCameraZoomSupported () |
abstract void | setCameraZoomFactor (int zoomValue) |
abstract int | getCameraCurrentZoom () |
abstract int | getCameraMaxZoom () |
abstract boolean | isCameraTorchSupported () |
abstract int | setCameraTorchOn (boolean on) |
abstract boolean | isCameraExposurePositionSupported () |
abstract int | setCameraExposurePosition (float x, float y) |
abstract boolean | isCameraFocusSupported () |
abstract int | setCameraFocusPosition (float x, float y) |
abstract boolean | isSpeakerphoneOn () |
abstract int | setSpeakerphoneOn (boolean enable) |
abstract int | setAudioFocusMode (int focusMode) |
abstract int | startAudioDump () |
abstract int | startAudioDumpWithType (int dumpType) |
abstract int | stopAudioDump () |
abstract int | setAudioEffectPreset (int preset) |
abstract int | setVoiceBeautifierPreset (int preset) |
abstract int | setLocalVoicePitch (double pitch) |
abstract int | setLocalVoiceEqualization (int bandFrequency, int bandGain) |
abstract int | setupLocalSubStreamVideoCanvas (IVideoRender render) |
abstract int | setupRemoteSubStreamVideoCanvas (IVideoRender render, long uid) |
abstract int | startScreenCapture (NERtcScreenConfig screenConfig, Intent mediaProjectionPermissionResultData, MediaProjection.Callback mediaProjectionCallback) |
abstract void | stopScreenCapture () |
abstract int | enableLoopbackRecording (boolean enable, Intent mediaProjectionResultIntent, MediaProjection.Callback callback) |
abstract int | adjustLoopBackRecordingSignalVolume (int volume) |
abstract int | subscribeRemoteSubStreamVideo (long uid, boolean subscribe) |
abstract int | setExternalVideoSource (boolean enable) |
abstract boolean | pushExternalVideoFrame (NERtcVideoFrame frame) |
abstract int | setExternalAudioSource (boolean enabled, int sample_rate, int channels) |
abstract int | pushExternalAudioFrame (NERtcAudioExternalFrame frame) |
abstract int | setExternalAudioRender (boolean enable, int sampleRate, int channels) |
abstract int | pullExternalAudioFrame (ByteBuffer buffer, int len) |
abstract void | setVideoCallback (NERtcVideoCallback videoCallback, boolean textureWithI420) |
abstract int | setAudioFrameObserver (NERtcAudioFrameObserver observer) |
abstract int | setAudioProcessObserver (NERtcAudioProcessObserver audioProcessObserver) |
abstract int | setRecordingAudioFrameParameters (NERtcAudioFrameRequestFormat format) |
abstract int | setPlaybackAudioFrameParameters (NERtcAudioFrameRequestFormat format) |
abstract int | setMixedAudioFrameParameters (NERtcAudioFrameRequestFormat format) |
abstract void | postOnGLThread (Runnable runnable) |
abstract void | setStatsObserver (NERtcStatsObserver statsObserver) |
abstract int | enableAudioVolumeIndication (boolean enable, int interval) |
abstract int | adjustRecordingSignalVolume (int volume) |
abstract int | adjustPlaybackSignalVolume (int volume) |
abstract int | startAudioMixing (NERtcCreateAudioMixingOption option) |
abstract int | stopAudioMixing () |
abstract int | pauseAudioMixing () |
abstract int | resumeAudioMixing () |
abstract int | setAudioMixingSendVolume (int volume) |
abstract int | getAudioMixingSendVolume () |
abstract int | setAudioMixingPlaybackVolume (int volume) |
abstract int | getAudioMixingPlaybackVolume () |
abstract long | getAudioMixingDuration () |
abstract long | getAudioMixingCurrentPosition () |
abstract int | setAudioMixingPosition (long position) |
abstract int | playEffect (int effectId, NERtcCreateAudioEffectOption option) |
abstract int | stopEffect (int effectId) |
abstract int | stopAllEffects () |
abstract int | pauseEffect (int effectId) |
abstract int | resumeEffect (int effectId) |
abstract int | pauseAllEffects () |
abstract int | resumeAllEffects () |
abstract int | setEffectSendVolume (int effectId, int volume) |
abstract int | getEffectSendVolume (int effectId) |
abstract int | setEffectPlaybackVolume (int effectId, int volume) |
abstract int | getEffectPlaybackVolume (int effectId) |
abstract int | enableEarback (boolean enabled, int volume) |
abstract int | setEarbackVolume (int volume) |
abstract int | setPlayoutDeviceMute (boolean enable) |
abstract boolean | isPlayoutDeviceMute () |
abstract int | setRecordDeviceMute (boolean enable) |
abstract boolean | isRecordDeviceMute () |
abstract void | uploadSdkInfo () |
abstract int | addLiveStreamTask (NERtcLiveStreamTaskInfo taskInfo, AddLiveTaskCallback addLiveTaskCallback) |
abstract int | updateLiveStreamTask (NERtcLiveStreamTaskInfo taskInfo, UpdateLiveTaskCallback updateLiveTaskCallback) |
abstract int | removeLiveStreamTask (String taskId, DeleteLiveTaskCallback deleteLiveTaskCallback) |
abstract int | setChannelProfile (int channelProfile) |
abstract int | enableDualStreamMode (boolean enable) |
abstract int | getConnectionState () |
abstract int | setClientRole (int role) |
abstract int | setLocalCanvasWatermarkConfigs (NERtcVideoStreamType type, NERtcCanvasWatermarkConfig config) |
abstract int | setRemoteCanvasWatermarkConfigs (long uid, NERtcVideoStreamType type, NERtcCanvasWatermarkConfig config) |
abstract int | takeLocalSnapshot (NERtcVideoStreamType streamType, NERtcTakeSnapshotCallback callback) |
abstract int | takeRemoteSnapshot (long uid, NERtcVideoStreamType streamType, NERtcTakeSnapshotCallback callback) |
abstract int | switchChannel (String token, String channelName) |
abstract int | startAudioRecording (String filePath, int sampleRate, int quality) |
abstract int | startAudioRecordingWithConfig (NERtcAudioRecordingConfiguration audioRecordConfig) |
abstract int | stopAudioRecording () |
abstract int | setLocalMediaPriority (int priority, boolean isPreemptive) |
abstract int | startChannelMediaRelay (NERtcMediaRelayParam.ChannelMediaRelayConfiguration config) |
abstract int | updateChannelMediaRelay (NERtcMediaRelayParam.ChannelMediaRelayConfiguration config) |
abstract int | stopChannelMediaRelay () |
abstract int | adjustUserPlaybackSignalVolume (long uid, int volume) |
abstract int | setLocalPublishFallbackOption (int option) |
abstract int | setRemoteSubscribeFallbackOption (int option) |
abstract long | getEffectDuration (int effectId) |
abstract long | getEffectCurrentPosition (int effectId) |
abstract int | enableSuperResolution (boolean enable) |
abstract int | enableEncryption (boolean enable, NERtcEncryptionConfig config) |
abstract NERtcChannel | createChannel (String channelName) |
abstract int | startLastmileProbeTest (LastmileProbeConfig config) |
abstract int | stopLastmileProbeTest () |
abstract int | enableVideoCorrection (boolean enable) |
abstract int | setVideoCorrectionConfig (NERtcVideoCorrectionConfiguration config) |
abstract int | setRemoteHighPriorityAudioStream (boolean enabled, long uid) |
abstract int | setCloudProxy (int proxyType) |
Public 成员函数 继承自 com.netease.lava.nertc.sdk.NERtc | |
abstract void | init (Context context, String appkey, NERtcCallback callback, NERtcOption option) throws Exception |
abstract void | release () |
abstract int | joinChannel (String token, String channelName, long uid) |
abstract int | leaveChannel () |
abstract int | enableLocalAudio (boolean enable) |
abstract int | subscribeRemoteAudioStream (long uid, boolean subscribe) |
abstract int | subscribeAllRemoteAudioStreams (boolean subscribe) |
abstract int | setAudioProfile (int profile, int scenario) |
abstract int | setLocalVideoConfig (NERtcVideoConfig videoConfig) |
abstract int | setCameraCaptureConfig (NERtcCameraCaptureConfig captureConfig) |
abstract int | startVideoPreview () |
abstract int | stopVideoPreview () |
abstract int | setupLocalVideoCanvas (IVideoRender render) |
abstract int | setupRemoteVideoCanvas (IVideoRender render, long uid) |
abstract int | enableLocalVideo (boolean enable) |
abstract int | subscribeRemoteVideoStream (long uid, NERtcRemoteVideoStreamType streamType, boolean subscribe) |
abstract void | setParameters (NERtcParameters params) throws IllegalArgumentException |
静态 Public 成员函数 | |
static NERtcEx | getInstance () |
静态 Public 成员函数 继承自 com.netease.lava.nertc.sdk.NERtc | |
static NERtcVersion | version () |
static List< String > | checkPermission (Context context) |
|
abstract |
添加房间推流任务。
成功调用该方法后,当前用户可以收到该直播流的状态通知。
taskInfo | 推流任务信息,详细信息请参考 live.NERtcLiveStreamTaskInfo。 |
addLiveTaskCallback | 操作结果回调,方法调用成功后会触发对应回调。详细信息请参考 live.AddLiveTaskCallback。 |
|
abstract |
调整共享音频音量。
volume | 采集信号量。该参数的取值范围为 0 ~ 100。 |
|
abstract |
调节本地播放的所有远端用户信号音量。
volume | 播放音量。取值范围为 [0, 400]。其中:
|
|
abstract |
调节采集信号音量。
volume | 采集信号音量,取值范围为 [0, 400]。其中:
|
|
abstract |
调节本地播放的指定远端用户的信号音量。 加入房间后,您可以多次调用该方法设置本地播放的不同远端用户的音量;也可以反复调节本地播放的某个远端用户的音量。
uid | 远端用户 ID。 |
volume | 播放音量,取值范围为 [0,100]。
|
|
abstract |
创建并获取一个 NERtcChannel 对象。
channelName | 房间名称,设置相同房间名称的用户会进入同一个通话房间。 |
|
abstract |
启用说话者音量提示。
该方法允许 SDK 定期向 App 反馈本地发流用户和瞬时音量最高的远端用户(最多 3 位)的音量相关信息,即当前谁在说话以及说话者的音量。
启用该方法后,只要房间内有发流用户,无论是否有人说话,SDK 都会在加入房间后根据预设的时间间隔触发 onRemoteAudioVolumeIndication 回调。
{
enable | 是否启用说话者音量提示。
|
interval | 指定音量提示的时间间隔。单位为毫秒。必须设置为 100 毫秒的整数倍值,建议设置为 200 毫秒以上。 |
|
abstract |
设置是否开启视频大小流模式。
该方法设置单流或者双流模式。发送端开启双流模式后,接收端可以选择接收大流还是小流。其中,大流指高分辨率、高码率的视频流,小流指低分辨率、低码率的视频流。
enable | 指定是否开启双流模式。
|
|
abstract |
开启或关闭耳返功能。
enabled | 是否开启耳返功能。
|
volume | 设置耳返音量,可设置为 0~100,默认为 100。 |
|
abstract |
开启或关闭媒体流加密。
enable | 是否开启媒体流加密。
|
config | 媒体流加密方案。详细信息请参考 NERtcEncryptionConfig。 |
|
abstract |
开启或关闭音频共享。
enable | 是否开启音频共享。
|
mediaProjectionResultIntent | Android 的系统权限请求 Intent,在请求权限时返回。 |
callback | 音频共享状态回调,用于监听音频共享任务的结束通知。 |
|
abstract |
启用或停止 AI 超分。
enable | 是否启用 AI 超分。默认为关闭状态。 |
|
abstract |
是否启用视频图像畸变矫正。
enable | 是否开启视频图像矫正。
|
|
abstract |
获取音乐文件的播放进度。
该方法获取当前伴奏播放进度,单位为毫秒。请在房间内调用该方法。
|
abstract |
获取伴奏时长。
该方法获取伴奏时长,单位为毫秒。
|
abstract |
获取伴奏播放音量。
该方法获取混音里伴奏的播放音量大小。请在房间内调用该方法。
|
abstract |
获取伴奏发送音量。
该方法获取混音里伴奏的发送音量大小。请在房间内调用该方法。
|
abstract |
获取当前摄像头缩放比例。
|
abstract |
获取摄像头支持的最大缩放比例。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
|
abstract |
获取当前房间连接状态。
|
abstract |
查看当前摄像头配置。
|
abstract |
获取音效的播放进度。
effectId | 音效 ID。 |
|
abstract |
获取音效文件时长。
effectId | 音效 ID。 |
|
abstract |
获取音效文件播放音量。
请在加入房间后调用该方法。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
|
abstract |
获取指定音效文件发送音量。
请在加入房间后调用该方法。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
|
static |
|
abstract |
检测设备是否支持手动曝光功能。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
|
abstract |
检测设备是否支持手动对焦功能。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
|
abstract |
检测设备是否支持闪光灯常亮。
|
abstract |
检测设备当前使用的摄像头是否支持缩放功能。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
|
abstract |
查看当前音频播放设备是否静音。
|
abstract |
查看当前音频采集设备是否静音。
|
abstract |
检查扬声器状态启用状态。
|
abstract |
开关本地音频发送。
该方法用于允许或禁止上行本地音频流。
mute | 是否开启本地音频发送。
|
|
abstract |
取消或恢复发布本地视频流。
mute | 是否取消发布本地视频流。
|
|
abstract |
暂停播放所有音效文件。
请在加入房间后调用该方法。
|
abstract |
暂停播放音乐文件及混音。
该方法暂停播放伴奏。请在房间内调用该方法。
|
abstract |
暂停播放指定音效文件。
请在加入房间后调用该方法。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
|
abstract |
播放指定音效文件。 该方法播放指定的本地或在线音效文件。
effectId | 指定音效的 ID。每个音效均应有唯一的 ID。 |
option | 音效相关参数,包括混音任务类型、混音文件路径等。详细信息请参考 audio.NERtcCreateAudioEffectOption。 |
|
abstract |
将操作设置到具有GLContext的线程中。
第三方滤镜时需要用到,例如销毁第三方滤镜资源。
runnable | 具体操作任务。 |
|
abstract |
拉取外部音频数据。
该方法将从内部引擎拉取音频数据。 通过 setExternalAudioRender 启用外部音频数据渲染功能成功后,可以使用 pullExternalAudioFrame 接口获取音频 PCM 数据。
buffer | 需要填充的 buffer 数组。需要调用方创建,且必须使用 ByteBuffer.allocateDirect 创建。 |
len | 待拉取音频数据的字节数,单位为 byte。建议音频数据的时长至少为 10 毫秒,数据长度不能超过 7680字节。 计算公式为: len = sampleRate/1000 × 2 × channels × 音频数据时长(毫秒)。 |
|
abstract |
推送外部音频帧。
将外部音频数据帧推送给内部引擎。 通过 setExternalAudioSource 启用外部音频数据输入功能成功后,可以使用 pushExternalAudioFrame 接口发送音频 PCM 数据。
frame | 外部音频帧数据;数据长度不能超过 7680 字节,和调用周期时长一致。 |
|
abstract |
推送外部视频帧。
该方法主动将视频帧数据用 NERtcVideoFrame 类封装后传递给 SDK。
frame | 外部视频帧的数据信息。详细信息请参考 video.NERtcVideoFrame。 |
|
abstract |
删除房间推流任务。
taskId | 推流任务 ID。 |
deleteLiveTaskCallback | 操作结果回调,方法调用成功后会触发对应回调。详细信息请参考 live.DeleteLiveTaskCallback。 |
|
abstract |
恢复播放所有音效文件。
请在加入房间后调用该方法。
|
abstract |
恢复播放伴奏。
该方法恢复混音,继续播放伴奏。请在房间内调用该方法。
|
abstract |
恢复播放指定音效文件。
请在加入房间后调用该方法。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
|
abstract |
通过主流通道发送媒体补充增强信息(SEI)。
在本端推流传输视频流数据同时,发送流媒体补充增强信息来同步一些其他附加信息。当推流方发送 SEI 后,拉流方可通过监听 onRecvSEIMsg 的回调获取 SEI 内容。
seiMsg | 自定义 SEI 数据。 |
|
abstract |
指定主流或辅流通道发送媒体增强补充信息(SEI)。
在本端推流传输视频流数据同时,发送流媒体补充增强信息来同步一些其他附加信息。当推流方发送 SEI 后,拉流方可通过监听 onRecvSEIMsg 的回调获取 SEI 内容。
seiMsg | 自定义 SEI 数据。 |
streamType | 发送 SEI 时,使用的流通道类型。详细信息请参考 video.NERtcVideoStreamType。 |
|
abstract |
设置 SDK 预设的人声的变声音效。
设置变声音效可以将人声原音调整为多种特殊效果,改变声音特性。
preset | 预设的变声音效。默认关闭变声音效。详细信息请参考 audio.NERtcVoiceChangerType 。 |
|
abstract |
设置音频焦点模式。
|
abstract |
注册语音观测器对象。
该方法用于设置音频采集/播放 PCM 回调,可用于声音处理等操作。当需要引擎返回 NERtcAudioFrameObserver#onPlaybackFrame() 或 NERtcAudioFrameObserver#onRecordFrame() 回调时,需要使用该方法注册回调。
observer | 接口对象实例。 如果传入 NULL,则取消注册,同时会清理 audio.NERtcAudioFrameRequestFormat 相关设置。详细信息请参考 audio.NERtcAudioFrameObserver。 |
|
abstract |
调节伴奏播放音量。
该方法调节混音里伴奏的播放音量大小。请在房间内调用该方法。
volume | 伴奏发送音量。取值范围为 0~100。默认 100,即原始文件音量。 |
|
abstract |
设置音乐文件的播放位置。
该方法可以设置音频文件的播放位置,这样你可以根据实际情况播放文件,而非从头到尾播放整个文件。
position | 音乐文件的播放位置,单位为毫秒。 |
|
abstract |
调节伴奏发送音量。
该方法调节混音里伴奏的发送音量大小。请在房间内调用该方法。
volume | 伴奏发送音量。取值范围为 0~100。默认 100,即原始文件音量。 |
|
abstract |
注册音频处理观测器对象。
调用本方法注册音频处理观测器后,如果检测到啸叫,会发送 onAudioHasHowling 回调。
audioProcessObserver | 注册音频处理观测器对象。详细说明请参考 audio.NERtcAudioProcessObserver。 |
|
abstract |
设置手动对焦位置。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
成功调用该方法后,本地会触发 onCameraFocusChanged 回调。
x | 触摸点相对于视图的横坐标。 |
y | 触摸点相对于视图的纵坐标。 |
|
abstract |
设置手动对焦位置。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
成功调用该方法后,本地会触发 onCameraFocusChanged 回调。
x | 触摸点相对于视图的横坐标。 |
y | 触摸点相对于视图的纵坐标。 |
|
abstract |
设置是否打开闪光灯。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
on | 是否打开闪光灯。
|
|
abstract |
设置摄像头缩放比例。
zoomValue | 摄像头缩放比例。 |
|
abstract |
设置房间场景。
房间场景可设置为通话(默认)或直播场景。针对不同场景采取的优化策略不同,如通话场景侧重语音流畅度,直播场景侧重视频清晰度。
channelProfile | 设置房间场景。详细信息请参考 NERtcConstants.RTCChannelProfile。 |
|
abstract |
在直播场景中设置用户角色。
用户角色支持设置为主播或观众,主播和观众的权限不同。
如果你在加入频道后调用该方法切换角色,调用成功后会收到以下回调:
role | 用户角色。详细信息请参考 com.netease.lava.nertc.sdk.NERtcConstants.UserRole。 |
|
abstract |
开启并设置云代理服务。
在内网环境下,如果用户防火墙开启了网络限制,请参考《使用云代理》将指定 IP 地址和端口号加入防火墙白名单,然后调用此方法开启云代理,并将 proxyType 参数设置为 TRANSPORT_TYPE_UDP_PROXY(1),即指定使用 UDP 协议的云代理。
onConnectionStateChanged(CONNECTION_STATE_CONNECTING, CONNECTION_CHANGED_SETTING_PROXY_SERVER)
回调。setCloudProxy(NONE_PROXY)
。 proxyType | 云代理类型。详细信息请参考 NERtcConstants.TransportType。该参数为必填参数,若未赋值,SDK 会报错。 |
|
abstract |
设置耳返音量。
volume | 设置耳返音量,可设置为 0~100,默认为 100。 |
|
abstract |
设置音效文件播放音量。
请在加入房间后调用该方法。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
volume | 音效播放音量。范围为 0~100,默认为 100。 |
|
abstract |
设置音效文件发送音量。
请在加入房间后调用该方法。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
volume | 音效发送音量。范围为0~100,默认为100,表示原始音量。 |
|
abstract |
设置外部音频渲染。
该方法适用于需要自行渲染音频的场景。默认为关闭状态。当该方法调用成功后,音频播放设备选择和异常重启失效。 调用成功后可以使用 pullExternalAudioFrame 接口获取音频 PCM 数据。
enable | 设置是否开启外部音频渲染:
|
sampleRate | 外部音频渲染的采样率 (Hz),可设置为 16000,32000,44100 或 48000。 |
channels | 外部音频渲染的声道数,可设置为:
|
|
abstract |
开启或关闭外部音频源数据输入。
当该方法调用成功后,音频输入设备选择和异常重启会失效。调用成功后可以使用 pushExternalAudioFrame 接口发送音频 PCM 数据。
enabled | 是否开启外部数据输入。默认为 false。 可设置为:
|
sample_rate | 外部音频源的数据采样率,单位为 Hz。建议设置为 8000,16000,32000,44100 或 48000。 |
channels | 外部音频源的数据声道数。可设置为:
|
|
abstract |
开启或关闭外部视频源数据输入。
该方法启用外部视频数据输入功能。
enable | 是否使用外部视频源。
|
|
abstract |
添加本地视频画布水印。
type | 视频流类型。支持设置为主流或辅流。详细信息请参考 video.NERtcVideoStreamType。 |
config | 画布水印设置。支持设置文字水印、图片水印和时间戳水印,设置为 null 表示清除水印。 详细信息请参考 watermark.NERtcCanvasWatermarkConfig。 |
|
abstract |
设置本地用户的媒体流优先级。 如果某个用户的优先级为高,那么该用户媒体流的优先级就会高于其他用户,弱网环境下 SDK 会优先保证高优先级用户收到的媒体流的质量。
priority | 本地用户的媒体流优先级,默认为 NERtcConstants.MediaPriority#MEDIA_PRIORITY_NORMAL,详细信息请参考 NERtcConstants.MediaPriority。 |
isPreemptive | 是否开启抢占模式。
|
|
abstract |
设置弱网条件下发布的音视频流回退选项。 在网络不理想的环境下,发布的音视频质量都会下降。使用该接口并将 option 设置为 NERtcConstants.StreamFallbackOption#AUDIO_ONLY 后:
option | 本地发布流回退处理选项。 默认为不回退处理 NERtcConstants.StreamFallbackOption#DISABLED。 |
|
abstract |
设置本地语音音效均衡,即自定义设置本地人声均衡波段的中心频率。
bandFrequency | 频谱子带索引,取值范围是 [0-9],分别代表 10 个频带,对应的中心频率是 [31,62,125,250,500,1k,2k,4k,8k,16k] Hz。 |
bandGain | 每个 band 的增益,单位是 dB,每一个值的范围是 [-15,15],默认值为 0。 |
|
abstract |
设置本地语音音调。
该方法改变本地说话人声音的音调。
pitch | 语音频率。可以在 [0.5, 2.0] 范围内设置。取值越小,则音调越低。默认值为 1.0,表示不需要修改音调。 |
|
abstract |
设置录制和播放声音混音后的数据格式。
该方法设置 NERtcAudioFrameObserver#onMixedAudioFrame 回调的声音格式。
format | 指定 NERtcAudioFrameObserver#onMixedAudioFrame(NERtcAudioFrame)(com.netease.lava.nertc.sdk.audio.NERtcAudioFrame) 中返回数据的采样率和数据的通道数。允许传入 NULL,默认为 NULL。详细信息请参考 NERtcAudioFrameRequestFormat。 |
|
abstract |
设置播放的声音格式。
该方法设置 NERtcAudioFrameObserver#onPlaybackFrame 回调的播放声音格式。
format | 指定 NERtcAudioFrameObserver#onPlaybackFrame(com.netease.lava.nertc.sdk.audio.NERtcAudioFrame) 中返回数据的采样率和数据的通道数。允许传入 NULL,默认为 NULL。详细信息请参考 audio.NERtcAudioFrameRequestFormat。 |
|
abstract |
设置是否静音音频播放设备。
enable | 是否静音音频播放设备。
|
|
abstract |
设置是否静音音频采集设备。
enable | 是否静音音频采集设备。
|
|
abstract |
设置采集的音频格式。
该方法设置 NERtcEx#setAudioFrameObserver 回调的采集声音格式。
注意:
format | 指定 NERtcAudioFrameObserver#onRecordFrame(com.netease.lava.nertc.sdk.audio.NERtcAudioFrame) 中返回数据的采样率和数据的通道数。允许传入 NULL,默认为 NULL。详细信息请参考 audio.NERtcAudioFrameRequestFormat。 |
|
abstract |
添加远端视频画布水印。
uid | 远端用户 ID。 |
type | 视频流类型。支持设置为主流或辅流。详细信息请参考 video.NERtcVideoStreamType。 |
config | 画布水印设置。支持设置文字水印、图片水印和时间戳水印,设置为 null 表示清除水印。 详细信息请参考 watermark.NERtcCanvasWatermarkConfig。 |
|
abstract |
设置远端用户音频流的高优先级。 支持在音频自动订阅的情况下,设置某一个远端用户的音频为最高优先级,可以优先听到该用户的音频。
enabled | 是否设置音频订阅优先级。
|
uid | 用户 uid |
|
abstract |
设置弱网条件下订阅的音视频流回退选项。 弱网环境下,订阅的音视频质量会下降。调用该接口并将 option 设置为 NERtcConstants.StreamFallbackOption#VIDEO_STREAM_LOW 或者 NERtcConstants.StreamFallbackOption#AUDIO_ONLY 后:
option | 订阅音视频流的回退选项,默认为 NERtcConstants.StreamFallbackOption#VIDEO_STREAM_LOW 弱网时回退到视频小流。 |
|
abstract |
启用或关闭扬声器播放。
该方法设置是否将语音路由到扬声器,即设备外放。
enable | 是否将音频路由到外放:
|
|
abstract |
注册统计信息观测器,设置统计信息回调。
statsObserver | 统计信息观测器。详细信息请参考 stats.NERtcStatsObserver。 |
|
abstract |
设置本地辅流视频画布。
该方法设置本地辅流视频显示信息。App 通过调用此接口绑定本地辅流的显示视窗(view)。 在 App 开发中,通常在初始化后调用该方法进行本地视频设置,然后再加入房间。
render | 视频画布设置,详细信息请参考 video.NERtcVideoView。 |
|
abstract |
设置远端的辅流视频画布。
该方法绑定远端用户和辅流显示视图,即指定某个 uid 使用对应的画布显示。
render | 视频画布设置:
|
uid | 远端用户 ID。 |
|
abstract |
设置视频采集数据回调,用于美颜等操作。
videoCallback | 视频采集数据,详细信息请参考 video.NERtcVideoCallback。 |
textureWithI420 | 是否需要同时返回 YUV I420 和 Texture 格式的数据,仅在第三方滤镜率需要 YUV 数据时设置。默认情况下 SDK 仅返回 Texture 数据。 |
|
abstract |
设置视频图像矫正参数。
config | 视频图像矫正相关参数。详细说明请参考 NERtcVideoCorrectionConfiguration。 |
|
abstract |
设置 SDK 预设的美声效果。
调用该方法可以为本地发流用户设置 SDK 预设的人声美声效果。
preset | 预设的美声效果模式。默认关闭美声效果。详细信息请参考 audio.NERtcVoiceBeautifierType 。 |
|
abstract |
开始记录音频 dump。
音频 dump 可用于分析音频问题。
|
abstract |
开始播放音乐文件。
该方法指定本地或在线音频文件来和录音设备采集的音频流进行混音。
支持的音乐文件类型包括 MP3、M4A、AAC、3GP、WMA 和 WAV 格式,支持本地文件或在线 URL。
option | 创建混音任务配置的选项,包括混音任务类型、混音文件全路径或 URL 等,详细信息请参考 audio.NERtcCreateAudioMixingOption。 |
|
abstract |
开始客户端录音。 调用该方法后,客户端会录制房间内所有用户混音后的音频流,并将其保存在本地一个录音文件中。录制开始或结束时,自动触发 onAudioRecording() 回调。 指定的录音音质不同,录音文件会保存为不同格式:
filePath | 录音文件在本地保存的绝对路径,需要精确到文件名及格式。例如:sdcard/xxx/audio.aac。
|
sampleRate | 录音采样率(Hz),可以设为 16000、32000(默认)、44100 或 48000。 |
quality | 录音音质,只在 AAC 格式下有效。详细说明请参考 NERtcConstants.AudioRecordingQuality 。 |
recordPosition | 录音对象。默认为录制房间内所有成员混流后的音频数据。 |
recordCycleTime | 循环缓存的最大时长跨度。默认为 0,即实时写文件。 |
|
abstract |
开始客户端录音。 调用该方法后,客户端会录制房间内所有用户混音后的音频流,并将其保存在本地一个录音文件中。录制开始或结束时,自动触发 onAudioRecording() 回调。 指定的录音音质不同,录音文件会保存为不同格式:
recordFilePath | 录音文件在本地保存的绝对路径,需要精确到文件名及格式。例如:sdcard/xxx/audio.aac。
|
recordSampleRate | 录音采样率(Hz),可以设为 16000、32000(默认)、44100 或 48000。 |
recordQuality | 录音音质,只在 AAC 格式下有效。详细说明请参考 NERtcConstants.AudioRecordingQuality 。 |
recordPosition | 录音对象。
|
recordCycleTime | 循环缓存的最大时长跨度。该参数单位为秒,可以设为 0、10、60、360、900,默认值为 0,即实时写文件。 |
|
abstract |
开始跨房间媒体流转发。
config | 跨房间媒体流转发参数配置信息。详细信息请参考 NERtcMediaRelayParam.ChannelMediaRelayConfiguration。 |
|
abstract |
开始通话前网络质量探测。
启用该方法后,SDK 会通过回调方式反馈上下行网络的质量状态与质量探测报告,包括带宽、丢包率、网络抖动和往返时延等数据。一般用于通话前的网络质量探测场景,用户加入房间之前可以通过该方法预估音视频通话中本地用户的主观体验和客观网络状态。
相关回调如下:
onLastmileQuality
:网络质量状态回调,以打分形式描述上下行网络质量的主观体验。该回调视网络情况在约 5 秒内返回。onLastmileProbeResult
:网络质量探测报告回调,报告中通过客观数据反馈上下行网络质量。该回调视网络情况在约 30 秒内返回。 onLastmileQuality
和 onLastmileProbeResult
回调之前请不要调用其他方法,否则可能会由于 API 操作过于频繁导致此方法无法执行。 config | Last mile 网络探测配置。详细说明请参考 LastmileProbeConfig。 |
|
abstract |
开启屏幕共享,屏幕共享内容以辅流形式发送。
如果您在加入房间后调用该方法开启辅流,调用成功后,远端触发 onUserSubStreamVideoStart 回调。
screenConfig | 本地辅流发送配置,详细信息请参考 video.NERtcScreenConfig。 |
mediaProjectionPermissionResultData | Android 的录屏请求 Intent,在请求录屏权限时返回。 |
mediaProjectionCallback | 录屏状态回调,用于监听录屏的结束通知。 |
|
abstract |
停止播放所有音效文件。
|
abstract |
结束记录音频 dump。
|
abstract |
停止播放音乐文件及混音。
该方法停止播放伴奏。请在房间内调用该方法。
|
abstract |
停止客户端录音。 本端离开房间时自动停止录音,您也可以在通话中随时调用 stopAudioRecording 手动停止录音。
|
abstract |
停止跨房间媒体流转发。 主播离开房间时,跨房间媒体流转发自动停止,您也可以在需要的时候随时调用 stopChannelMediaRelay 方法,此时主播会退出所有目标房间。
|
abstract |
停止播放指定音效文件。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
|
abstract |
停止通话前网络质量探测。
|
abstract |
关闭辅流形式的屏幕共享。
如果您在加入房间后调用该方法关闭辅流,调用成功后,远端触发 onUserSubStreamVideoStop 回调。
|
abstract |
订阅或取消订阅远端的屏幕共享辅流视频,订阅之后才能接收远端的辅流视频数据。
uid | 远端用户 ID。 |
subscribe | 是否订阅远端的屏幕共享辅流视频:
|
|
abstract |
切换前置/后置摄像头。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
|
abstract |
快速切换音视频房间。 房间场景为直播场景时,房间中角色为观众的成员可以调用该方法从当前房间快速切换至另一个房间。 成功调用该方切换房间后:
token | 在服务器端生成的用于鉴权的安全认证签名(Token)。可设置为:
|
channelName | 期望切换到的目标房间名称。 |
|
abstract |
本地视频画面截图。 调用 takeLocalSnapshot 截取本地主流或本地辅流的视频画面,并通过 NERtcTakeSnapshotCallback 的 onTakeSnapshotResult 回调返回截图画面的数据。
streamType | 截图的视频流类型。详细信息请参考 video.NERtcVideoStreamType。 |
callback | 截图回调。详细信息请参考 video.NERtcTakeSnapshotCallback。 |
|
abstract |
远端视频画面截图。 调用 takeRemoteSnapshot 截取指定 uid 远端主流和远端辅流的视频画面,并通过 NERtcTakeSnapshotCallback 的 onTakeSnapshotResult 回调返回截图画面的数据。
uid | 远端用户 ID。 |
streamType | 截图的视频流类型。支持设置为主流或辅流。详细信息请参考 video.NERtcVideoStreamType。 |
callback | 截图回调。详细信息请参考 video.NERtcTakeSnapshotCallback。 |
|
abstract |
更新媒体流转发的目标房间。 成功开始跨房间转发媒体流后,如果你希望将流转发到多个目标房间,或退出当前的转发房间,可以调用该方法。
config | 跨房间媒体流转发参数配置信息。详细信息请参考 NERtcMediaRelayParam.ChannelMediaRelayConfiguration。 |
|
abstract |
更新修改房间推流任务。
taskInfo | 推流任务信息,详细信息请参考 live.NERtcLiveStreamTaskInfo。 |
updateLiveTaskCallback | 操作结果回调,方法调用成功后会触发对应回调。详细信息请参考 live.UpdateLiveTaskCallback。 |
|
abstract |
上传 SDK 信息。
只能在加入房间后调用。上传的信息包括 log 和 Audio dump 等文件。