NERtc Android SDK
V5.5.40
|
Public 成员函数 | |
abstract int | muteLocalAudioStream (boolean mute) |
abstract int | muteLocalVideoStream (boolean mute) |
abstract int | muteLocalVideoStream (NERtcVideoStreamType streamType, boolean mute) |
abstract int | sendSEIMsg (String seiMsg, NERtcVideoStreamType streamType) |
abstract int | sendSEIMsg (String seiMsg) |
abstract int | switchCamera () |
abstract boolean | isCameraZoomSupported () |
abstract void | setCameraZoomFactor (float 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 | setLocalVoiceReverbParam (NERtcReverbParam param) |
abstract int | setupLocalSubStreamVideoCanvas (IVideoRender render) |
abstract int | setupRemoteSubStreamVideoCanvas (IVideoRender render, long uid) |
abstract int | setLocalExternalVideoRenderer (NERtcVideoStreamType streamType, NERtcExternalVideoRenderer renderer) |
abstract int | setRemoteExternalVideoRenderer (NERtcVideoStreamType streamType, long uid, NERtcExternalVideoRenderer renderer) |
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 int | setExternalVideoSource (NERtcVideoStreamType streamType, boolean enable) |
abstract boolean | pushExternalVideoFrame (NERtcVideoFrame frame) |
abstract boolean | pushExternalVideoFrame (NERtcVideoStreamType streamType, NERtcVideoFrame frame) |
abstract int | pushExternalAudioEncodedFrame (NERtcAudioEncodedFrame encodedAudioFrame) |
abstract int | pushExternalSubStreamAudioEncodedFrame (NERtcAudioEncodedFrame encodedAudioFrame) |
abstract int | setPreDecodeObserver (NERtcPreDecodeObserver observer) |
abstract int | pushExternalVideoEncodedFrame (NERtcVideoStreamType streamType, NERtcVideoEncodedFrame encodedFrame) |
abstract int | setVideoEncoderQosObserver (NERtcVideoEncoderQosObserver encoderQosObserver) |
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 | enableAudioVolumeIndication (boolean enable, int interval, boolean enableVad) |
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 | setEffectPosition (int effectId, long position) |
abstract int | setEffectPitch (int effectId, int pitch) |
abstract int | getEffectPitch (int effectId) |
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 | takeLocalSnapshot (NERtcVideoStreamType streamType, NERtcTakeSnapshotCallback callback) |
abstract int | takeRemoteSnapshot (long uid, NERtcVideoStreamType streamType, NERtcTakeSnapshotCallback callback) |
abstract int | switchChannel (String token, String channelName) |
abstract int | switchChannel (String token, String channelName, NERtcJoinChannelOptions channelOptions) |
abstract int | startAudioRecording (String filePath, int sampleRate, int quality) |
abstract int | startAudioRecordingWithConfig (NERtcAudioRecordingConfiguration audioRecordConfig) |
abstract int | stopAudioRecording () |
abstract int | getAudioMixingPitch () |
abstract int | setAudioMixingPitch (int pitch) |
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 | adjustChannelPlaybackSignalVolume (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 | enableVirtualBackground (boolean enabled, NERtcVirtualBackgroundSource backgroundSource) |
abstract int | setRemoteHighPriorityAudioStream (boolean enabled, long uid) |
abstract int | setCloudProxy (int proxyType) |
abstract int | startBeauty () |
abstract void | stopBeauty () |
abstract int | enableBeauty (boolean enable) |
abstract int | setBeautyEffect (NERtcBeautyEffectType beautyType, float level) |
abstract int | addBeautyFilter (String path) |
abstract void | removeBeautyFilter () |
abstract int | setBeautyFilterLevel (float level) |
abstract int | addBeautySticker (String path) |
abstract void | removeBeautySticker () |
abstract int | addBeautyMakeup (String path) |
abstract void | removeBeautyMakeup () |
abstract int | setLocalVideoWatermarkConfigs (NERtcVideoStreamType type, NERtcVideoWatermarkConfig config) |
abstract int | switchCameraWithPosition (int cameraPos) |
abstract int | setAudioSubscribeOnlyBy (long[] uidArray) |
abstract int | enableLocalSubStreamAudio (boolean enable) |
abstract int | subscribeRemoteSubStreamAudio (long uid, boolean subscribe) |
abstract void | setStreamAlignmentProperty (boolean enable) |
abstract long | getNtpTimeOffset () |
abstract int | muteLocalSubStreamAudio (boolean mute) |
abstract int | setExternalSubStreamAudioSource (boolean enabled, int sampleRate, int channels) |
abstract int | pushExternalSubStreamAudioFrame (NERtcAudioExternalFrame frame) |
abstract int | getCurrentCamera () |
abstract int | enableMediaPub (int mediaType, boolean enable) |
abstract int | enableLocalData (boolean enabled) |
abstract int | subscribeRemoteData (boolean subscribe, long userID) |
abstract int | sendData (NERtcDataExternalFrame frame) |
abstract int | reportCustomEvent (String eventName, String customIdentify, HashMap< String, Object > param) |
abstract int | setNERtcCallback (NERtcCallback callback) |
abstract void | setCallbackHandler (Handler callbackHandler) |
abstract int | setAudioRecvRange (int audible_distance, int conversational_distance, NERtcDistanceRolloffModel roll_off) |
abstract int | updateSelfPosition (NERtcPositionInfo info) |
abstract int | enableSpatializerRoomEffects (boolean enable) |
abstract int | setSpatializerRoomProperty (NERtcSpatializerRoomProperty room_property) |
abstract int | setSpatializerRenderMode (NERtcSpatializerRenderMode mode) |
abstract int | enableSpatializer (boolean enable, boolean applyToTeam) |
abstract int | initSpatializer () |
abstract int | setRangeAudioMode (NERtcRangeAudioMode mode) |
abstract int | setRangeAudioTeamID (int teamId) |
abstract int | setSubscribeAudioBlocklist (long[] uidArray, NERtcAudioStreamType streamType) |
abstract int | setSubscribeAudioAllowlist (long[] uidArray) |
abstract boolean | isFeatureSupported (NERtcFeatureType featureType) |
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 | joinChannel (String token, String channelName, long uid, NERtcJoinChannelOptions channelOptions) |
abstract int | updatePermissionKey (String key) |
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 | setAudioProfile (int profile) |
abstract int | setAudioScenario (int scenario) |
abstract int | setLocalVideoConfig (NERtcVideoConfig videoConfig) |
abstract int | setLocalVideoConfig (NERtcVideoConfig videoConfig, NERtcVideoStreamType streamType) |
abstract int | setCameraCaptureConfig (NERtcCameraCaptureConfig captureConfig) |
abstract int | setCameraCaptureConfig (NERtcCameraCaptureConfig captureConfig, NERtcVideoStreamType streamType) |
abstract int | startVideoPreview () |
abstract int | startVideoPreview (NERtcVideoStreamType streamType) |
abstract int | stopVideoPreview () |
abstract int | stopVideoPreview (NERtcVideoStreamType streamType) |
abstract int | setupLocalVideoCanvas (IVideoRender render) |
abstract int | setupRemoteVideoCanvas (IVideoRender render, long uid) |
abstract int | enableLocalVideo (boolean enable) |
abstract int | enableLocalVideo (NERtcVideoStreamType streamType, boolean enable) |
abstract int | subscribeRemoteVideoStream (long uid, NERtcRemoteVideoStreamType streamType, boolean subscribe) |
abstract void | setParameters (NERtcParameters params) throws IllegalArgumentException |
abstract String | getParameter (String parameterKey, String extraInfo) |
静态 Public 成员函数 | |
static NERtcEx | getInstance () |
静态 Public 成员函数 继承自 com.netease.lava.nertc.sdk.NERtc | |
static NERtcVersion | version () |
static List< String > | checkPermission (Context context) |
|
abstract |
添加滤镜效果。
此接口用于加载滤镜资源,并添加对应的滤镜效果。需要更换滤镜时,重复调用此接口使用新的滤镜资源即可。
path | 滤镜资源或模型所在路径。支持 SD 卡上的绝对路径,或 asset 目录下的相对路径。
|
|
abstract |
(此接口为 beta 版本)添加美妆效果。
此接口用于加载美妆模型,添加对应的美妆效果。需要更换美妆效果时,重复调用此接口使用新的美妆模型即可。
path | 美妆模型所在路径。支持 SD 卡上的绝对路径,或 asset 目录下的相对路径。
|
|
abstract |
(此接口为 beta 版本)添加贴纸效果。
此接口用于加载贴纸资源,添加对应的贴纸效果。需要更换贴纸时,重复调用此接口使用新的贴纸资源即可。
path | 贴纸资源所在路径。支持 SD 卡上的绝对路径,或 asset 目录下的相对路径。
|
|
abstract |
添加房间内推流任务。 通过此接口可以实现增加一路旁路推流任务;若需推送多路流,则需多次调用该方法。
参数名称 | 类型 | 描述 |
---|---|---|
taskInfo | live.NERtcLiveStreamTaskInfo | 推流任务信息。 |
addLiveTaskCallback | live.AddLiveTaskCallback | 操作结果回调,方法调用成功后会触发对应的 AddLiveTaskCallback#onAddLiveStreamTask() 回调。 |
|
abstract |
调节本地播放的某个房间的所有用户的信号音量。
通过此接口可以实现在通话过程中随时调节本地播放的某个房间的所有用户的混音音量。
参数名称 | 类型 | 描述 |
---|---|---|
volume | int | 播放音量,取值范围为 [0,400]。
|
|
abstract |
调整共享音频音量。
volume | 采集信号量。该参数的取值范围为 0 ~ 100。 |
|
abstract |
调节本地播放的所有远端用户的信号音量。
通过此接口可以实现调节所有远端用户在本地播放的混音音量。
参数名称 | 类型 | 描述 |
---|---|---|
volume | int | 播放音量,取值范围为 [0,400]。
|
|
abstract |
调节采集信号音量。 通过本接口可以实现设置录制声音的信号幅度,从而达到调节采集音量的目的。
参数名称 | 类型 | 描述 |
---|---|---|
volume | int | 采集信号音量,取值范围为 0 ~ 400。
|
|
abstract |
调节本地播放的指定远端用户的信号音量。
通过此接口可以实现在通话过程中随时调节指定远端用户在本地播放的混音音量。
参数名称 | 类型 | 描述 |
---|---|---|
uid | long | 远端用户 ID。 |
volume | int | 播放音量,取值范围为 0 ~ 400。
|
|
abstract |
创建并获取一个 NERtcChannel 对象。
channelName | 房间名称,设置相同房间名称的用户会进入同一个通话房间。 |
|
abstract |
启用说话者音量提示。
通过此接口可以实现允许 SDK 定期向 App 反馈房间内发音频流的用户和瞬时音量最高的远端用户(最多 3 位,包括本端)的音量相关信息,即当前谁在说话以及说话者的音量。
参数名称 | 类型 | 描述 |
---|---|---|
enable | boolean | 是否启用说话者音量提示:
|
interval | int | 指定音量提示的时间间隔。单位为毫秒。必须设置为 100 毫秒的整数倍值,建议设置为 200 毫秒以上。 |
|
abstract |
启用说话者音量提示。
通过此接口可以实现允许 SDK 定期向 App 反馈房间内发音频流的用户和瞬时音量最高的远端用户(最多 3 位,包括本端)的音量相关信息,即当前谁在说话以及说话者的音量。
参数名称 | 类型 | 描述 |
---|---|---|
enable | boolean | 是否启用说话者音量提示:
|
interval | int | 指定音量提示的时间间隔。单位为毫秒。必须设置为 100 毫秒的整数倍值,建议设置为 200 毫秒以上。 |
enableVad | boolean | 是否启用本地采集人声监测:
|
|
abstract |
暂停或恢复美颜效果。
暂停美颜效果后,包括全局美颜、滤镜、贴纸和美妆在内的所有美颜效果都会暂时关闭,直至重新恢复美颜效果。
enable | 是否恢复美颜效果。
|
|
abstract |
设置是否开启视频大小流模式。
通过本接口可以实现设置单流或者双流模式。发送端开启双流模式后,接收端可以选择接收大流还是小流。其中,大流指高分辨率、高码率的视频流,小流指低分辨率、低码率的视频流。
参数名称 | 类型 | 描述 |
---|---|---|
enable | boolean | 是否开启双流模式:
|
|
abstract |
设置是否开启耳返功能。
volume
参数无效,请调用 NERtcEx#setEarbackVolume() 接口设置耳返音量。 参数名称 | 类型 | 描述 |
---|---|---|
enabled | boolean | 是否开启耳返功能:
|
volume | int | 设置耳返音量。取值范围为 0 ~ 100,默认值为 100。 |
|
abstract |
开启或关闭媒体流加密。
enable | 是否开启媒体流加密。
|
config | 媒体流加密方案。详细信息请参考 NERtcEncryptionConfig。 |
|
abstract |
开启或关闭本地数据通道。
[in] | enabled | 是否启用本地数据通道:
|
|
abstract |
开启或关闭音频辅流。
开启时远端会收到 NERtcCallbackEx#onUserSubStreamAudioStart(long),关闭时远端会收到NERtcCallbackEx#onUserSubStreamAudioStop(long)
enable | 是否开启音频辅流。
|
|
abstract |
开启或关闭音频共享。
enable | 是否开启音频共享。
|
mediaProjectionResultIntent | Android 的系统权限请求 Intent,在请求权限时返回。 |
callback | 音频共享状态回调,用于监听音频共享任务的结束通知。 |
|
abstract |
@if English Publishes or unpublishes the local audio stream. <br> When a user joins a room, the feature is enabled by default. <br> The method does not affect receiving or playing the remote audio stream. The enableLocalAudio(false) method is suitable for scenarios where clients only receives remote media streams and does not publish any local streams. @note - The method controls data transmitted over the main stream - The method can be called before or after a user joins a room. @since V4.6.10 @param enable specifies whether to publish the local audio stream. - true(default): publishes the local audio stream. - false: unpublishes the local audio stream. @param mediaType media type. Audio type is supported. @return - 0: success - Others: failure @endif @if Chinese 开启或关闭本地媒体流(主流)的发送。 <br>该方法用于开始或停止向网络发送本地音频或视频数据。 <br>该方法不影响接收或播放远端媒体流,也不会影响本地音频或视频的采集状态。 @since V4.6.10 @note - 该方法暂时仅支持控制音频流的发送。 - 该方法在加入房间前后均可调用。 - 停止发送媒体流的状态会在通话结束后被重置为允许发送。 - 成功调用该方法切换本地用户的发流状态后,房间内其他用户会收到 {@link AbsNERtcCallbackEx#onUserAudioStart()}开启发送音频或 {@link AbsNERtcCallbackEx#onUserAudioStop()}
停止发送音频的回调。
enable | 是否发布本地媒体流。
|
mediaType | 媒体发布类型,暂时仅支持音频。 |
|
abstract |
开启或关闭空间音效
enable | 是否打开3D音效算法功能,默认为关闭状态。
|
applyToTeam | 是否仅本小队开启3D音效。默认为 false。
|
|
abstract |
开启或关闭空间音效的房间混响效果
enable | 混响效果开关,默认为关闭 |
|
abstract |
启用或停止 AI 超分。
enable | 是否启用 AI 超分。默认为关闭状态。 |
|
abstract |
是否启用视频图像畸变矫正。
enable | 是否开启视频图像矫正。
|
|
abstract |
开启/关闭虚拟背景。
启用虚拟背景功能后,您可以使用自定义背景图片替换本地用户的原始背景图片。
替换后,频道内所有用户都可以看到自定义背景图片。
enabled | 设置是否开启虚拟背景。
|
backgroundSource | 自定义背景图片。详细信息请参考 video.NERtcVirtualBackgroundSource。 |
|
abstract |
获取音乐文件的播放进度。
该方法获取当前伴奏播放进度,单位为毫秒。请在房间内调用该方法。
|
abstract |
获取伴奏时长。
该方法获取伴奏时长,单位为毫秒。
|
abstract |
获取当前伴音文件的音调。
|
abstract |
|
abstract |
|
abstract |
|
abstract |
获取摄像头支持的最大缩放比例。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
|
abstract |
获取当前房间连接状态。
|
abstract |
查看当前摄像头配置。
|
abstract |
获取音效的播放进度。
effectId | 音效 ID。 |
|
abstract |
获取音效文件时长。
effectId | 音效 ID。 |
|
abstract |
获取指定音效文件的音调。
参数名称 | 类型 | 描述 |
---|---|---|
effectId | int | 指定音效文件的 ID。每个音效文件均对应唯一的 ID。 |
|
abstract |
获取音效文件播放音量。
请在加入房间后调用该方法。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
|
abstract |
获取指定音效文件发送音量。
请在加入房间后调用该方法。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
|
static |
|
abstract |
获取本地系统时间与服务端时间差值。
可以用于做时间对齐,通过 (System.currentTimeMillis() - offset) 可能得到当前服务端时间。
|
abstract |
初始化引擎3D音效算法
|
abstract |
检测设备是否支持手动曝光功能。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
|
abstract |
检测设备是否支持手动对焦功能。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
|
abstract |
检测设备是否支持闪光灯常亮。
|
abstract |
检测设备当前使用的摄像头是否支持缩放功能。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
|
abstract |
查询当前设备是否支持 NERtc SDK 中的某项功能。
参数名称 | 类型 | 描述 |
---|---|---|
featureType | NERtcFeatureType | RTC 功能类型 |
|
abstract |
|
abstract |
|
abstract |
检查扬声器状态启用状态。
|
abstract |
开启或关闭本地音频主流的发送。
该方法用于向网络发送或取消发送本地音频数据,不影响本地音频的采集状态,也不影响接收或播放远端音频流。
参数名称 | 类型 | 描述 |
---|---|---|
mute | boolean | 是否关闭本地音频的发送:
|
|
abstract |
静音或解除静音本地上行的音频辅流。
mute | 是否静音本地音频辅流发送。
|
|
abstract |
取消或恢复发布本端视频主流。
调用该方法取消发布本地视频主流后,SDK 不再发送本地视频主流。
参数名称 | 类型 | 描述 |
---|---|---|
mute | boolean | 是否取消发布本地视频流:
|
|
abstract |
取消或恢复发布本地视频。
调用该方法取消发布本地视频主流或辅流后,SDK 不再发送本地视频流。
参数名称 | 类型 | 描述 |
---|---|---|
streamType | video.NERtcVideoStreamType | 视频通道类型:
|
mute | boolean | 是否取消发布本地视频流:
|
|
abstract |
|
abstract |
暂停伴音。
通过此接口可以实现暂停播放伴音文件。
|
abstract |
暂停播放指定音效文件。
请在加入房间后调用该方法。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
|
abstract |
播放指定音效文件。 通过此接口可以实现播放指定的本地或在线音效文件。
参数名称 | 类型 | 描述 |
---|---|---|
effectId | int | 指定音效的 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 |
推送外部音频主流编码帧。
参数名称 | 类型 | 描述 |
---|---|---|
encodedAudioFrame | audio.NERtcAudioEncodedFrame | 编码后的音频帧数据。 |
|
abstract |
推送外部音频帧。
将外部音频数据帧推送给内部引擎。 通过 setExternalAudioSource 启用外部音频数据输入功能成功后,可以使用 pushExternalAudioFrame 接口发送音频 PCM 数据。
frame | 外部音频帧数据;数据长度不能超过 7680 字节,和调用周期时长一致。 |
|
abstract |
推送外部音频辅流编码帧。
参数名称 | 类型 | 描述 |
---|---|---|
encodedAudioFrame | audio.NERtcAudioEncodedFrame | 编码后的音频帧数据。 |
|
abstract |
推送外部音频辅流数据帧。
将外部音频辅流帧数据帧主动推送给内部引擎。通过 NERtcEx#enableLocalSubStreamAudio(boolean) 启用音频辅流后,可以调用此接口发送音频辅流 PCM 数据。
frame | 音频帧数据。 |
|
abstract |
推送外部视频编码帧。
参数名称 | 类型 | 描述 |
---|---|---|
encodedVideoFrame | video.NERtcVideoEncodedFrame | 编码后的视频帧数据。 |
streamType | video.NERtcVideoStreamType | 视频通道类型:
|
|
abstract |
推送外部视频帧。
该方法主动将视频帧数据用 NERtcVideoFrame 类封装后传递给 SDK。
frame | 外部视频帧的数据信息。详细信息请参考 video.NERtcVideoFrame。 |
|
abstract |
推送外部视频帧。
通过本接口可以实现创建外部视频输入源之后,将主流或辅流的外部视频数据帧用 NERtcVideoFrame 类封装后传递给 SDK。
参数名称 | 类型 | 描述 |
---|---|---|
streamType | video.NERtcVideoStreamType | 视频通道类型:
|
frame | video.NERtcVideoFrame | 外部视频帧的数据信息。 |
|
abstract |
|
abstract |
(此接口为 beta 版本)取消美妆效果。
|
abstract |
(此接口为 beta 版本)取消贴纸效果。
|
abstract |
删除房间内指定推流任务。
参数名称 | 类型 | 描述 |
---|---|---|
taskId | String | 推流任务 ID。 |
deleteLiveTaskCallback | live.DeleteLiveTaskCallback | 操作结果回调,方法调用成功后会触发对应的 DeleteLiveTaskCallback#onDeleteLiveStreamTask() 回调。 |
|
abstract |
用户自定义上报事件
eventName | 事件名 不能为空 |
customIdentify | 自定义标识,比如产品或业务类型,如不需要填null |
param | 参数键值对 ,参数值支持String 及java基本类型(int 、bool....) , 如不需要填null |
|
abstract |
|
abstract |
|
abstract |
恢复播放指定音效文件。
请在加入房间后调用该方法。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
|
abstract |
通过数据通道发送数据。
[in] | data | 自定义数据。 |
|
abstract |
通过主流通道发送媒体补充增强信息(SEI)。
在本端推流传输视频流数据同时,发送流媒体补充增强信息来同步一些其他附加信息。当推流方发送 SEI 后,拉流方可通过监听 onRecvSEIMsg 的回调获取 SEI 内容。
seiMsg | 自定义 SEI 数据。 |
|
abstract |
指定主流或辅流通道发送媒体增强补充信息(SEI)。
在本端推流传输视频流数据同时,发送流媒体补充增强信息来同步一些其他附加信息。当推流方发送 SEI 后,拉流方可通过监听 onRecvSEIMsg 的回调获取 SEI 内容。
seiMsg | 自定义 SEI 数据。 |
streamType | 发送 SEI 时,使用的流通道类型。详细信息请参考 video.NERtcVideoStreamType。 |
|
abstract |
预设变声效果。
通过此接口可以实现将人声原音调整为多种特殊效果,改变声音特性。
参数名称 | 类型 | 描述 |
---|---|---|
preset | int | 预设的变声音效。默认关闭变声音效。详细信息请参考 audio.NERtcVoiceChangerType。 |
|
abstract |
|
abstract |
注册语音观测器对象。
通过此接口可以设置音频采集/播放 PCM 回调,可用于声音处理等操作。
参数名称 | 类型 | 描述 |
---|---|---|
observer | audio.NERtcAudioFrameObserver | 接口对象实例。如果传入参数为 NULL,取消注册,同时会清理 audio.NERtcAudioFrameRequestFormat 的相关设置。 |
|
abstract |
设置当前伴音文件的音调。
参数名称 | 类型 | 描述 |
---|---|---|
pitch | int | 当前伴音文件的音调。默认值为 0,即不调整音调,取值范围为 -12 ~ 12,按半音音阶调整。每相邻两个值的音高距离相差半音;取值的绝对值越大,音调升高或降低得越多。 |
|
abstract |
调节伴奏播放音量。
该方法调节混音里伴奏的播放音量大小。请在房间内调用该方法。
volume | 伴奏发送音量。取值范围为 0~200。默认 100,即原始文件音量。 |
|
abstract |
设置音乐文件的播放位置。
该方法可以设置音频文件的播放位置,这样你可以根据实际情况播放文件,而非从头到尾播放整个文件。
position | 音乐文件的播放位置,单位为毫秒。 |
|
abstract |
调节伴奏发送音量。
该方法调节混音里伴奏的发送音量大小。请在房间内调用该方法。
volume | 伴奏发送音量。取值范围为 0~200。默认 100,即原始文件音量。 |
|
abstract |
注册音频处理观测器对象。
调用本方法注册音频处理观测器后,如果检测到啸叫,会发送 onAudioHasHowling 回调。
audioProcessObserver | 注册音频处理观测器对象。详细说明请参考 audio.NERtcAudioProcessObserver。 |
|
abstract |
设置空间音效的距离衰减属性和语音范围。
audibleDistance | 监听器能够听到扬声器并接收其语音的距离扬声器的最大距离。距离有效范围:[1,max int) ,无默认值。 |
conversationalDistance | 范围语音场景中,该参数设置的值不起作用,保持默认值即可。空间音效场景中,需要配置该参数。 控制音频保持其原始音量的范围,超出该范围时,语音聊天的响度在被听到时开始淡出。 默认值为 1。 |
rollOff | 范围语音场景中,该参数设置的值不起作用,保持默认值即可。空间音效场景中,需要配置该参数。 距离衰减模式,具体请参见 NERtcDistanceRolloffModel() ,默认值为 kNERtcDistanceRolloffNone。 |
|
abstract |
设置自己的音频只能被房间内指定的人订阅。
默认房间所有其他人都可以订阅自己的音频。
uidArray | 可订阅自己音频的用户uid 列表。 |
|
abstract |
设置美颜效果。 通过此接口可以实现设置磨皮、美白、大眼等多种全局美颜类型和对应的美颜强度。
参数名称 | 类型 | 描述 |
---|---|---|
beautyType | video.NERtcBeautyEffectType | 美颜类型。 |
level | float | 对应美颜类型的强度。取值范围为 [0, 1],各种美颜效果的默认值不同。 |
|
abstract |
设置滤镜强度。
取值越大,滤镜强度越大,您可以根据业务需求自定义设置滤镜强度。
level | 滤镜强度。取值范围为 [0 - 1],默认值为 0.5。 |
|
abstract |
设置驱动 NERtcCallback 事件回调队列
参数名称 | 类型 | 描述 |
---|---|---|
callbackHandler | android.os.Handler | 设置驱动 NERtcCallback 事件回调队列 |
|
abstract |
设置手动对焦位置。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
成功调用该方法后,本地会触发 onCameraFocusChanged 回调。
x | 触摸点相对于视图的横坐标。 |
y | 触摸点相对于视图的纵坐标。 |
|
abstract |
设置手动对焦位置。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
成功调用该方法后,本地会触发 onCameraFocusChanged 回调。
x | 触摸点相对于视图的横坐标。 |
y | 触摸点相对于视图的纵坐标。 |
|
abstract |
设置是否打开闪光灯。
该方法需要在相机启动后调用,例如调用 startVideoPreview 或 joinChannel 后。
on | 是否打开闪光灯。
|
|
abstract |
设置摄像头缩放比例。
zoomValue | 摄像头缩放比例。 |
|
abstract |
设置房间场景。
通过此接口可以实现设置房间场景为通话(默认)或直播场景、视频 1对1 呼叫场景、语聊房场景等。针对不同场景采取的优化策略不同,如通话场景侧重语音流畅度,直播场景侧重视频清晰度。
参数名称 | 类型 | 描述 |
---|---|---|
channelProfile | int | 设置房间场景:
|
|
abstract |
设置直播场景下的用户角色。
通过本接口可以实现将用户角色在“主播”(CLIENT_ROLE_BROADCASTER)和“观众“(CLIENT_ROLE_AUDIENCE)之间的切换,用户加入房间后默认为“主播”。
参数名称 | 类型 | 描述 |
---|---|---|
role | int | 用户角色:
|
|
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 | int | 指定音效文件的 ID。每个音效文件均对应唯一的 ID。 |
pitch | int | 指定音效文件的音调。默认值为 0,即不调整音调,取值范围为 -12 ~ 12,按半音音阶调整。每相邻两个值的音高距离相差半音;取值的绝对值越大,音调升高或降低得越多。 |
|
abstract |
设置音效文件播放音量。
请在加入房间后调用该方法。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
volume | 音效播放音量。范围为 0~200,默认为 100。 |
|
abstract |
设置指定音效文件的播放位置。
参数名称 | 类型 | 描述 |
---|---|---|
effectId | int | 指定音效文件的 ID。每个音效文件均对应唯一的 ID。 |
position | long | 指定音效文件的起始播放位置。单位为毫秒。 |
|
abstract |
设置音效文件发送音量。
请在加入房间后调用该方法。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
volume | 音效发送音量。范围为0~200,默认为100,表示原始音量。 |
|
abstract |
设置外部音频渲染。
通过此接口可以实现启用外部音频渲染,并设置音频渲染的采样率、声道数等。
enable
参数为 false 关闭该功能时,其他参数可传入任意合法值,均不会生效。 参数名称 | 类型 | 描述 |
---|---|---|
enable | boolean | 是否开启外部音频渲染:
|
sampleRate | int | 外部音频渲染的采样率,单位为赫兹(Hz),可设置为 16000,32000,44100 或 48000。 |
channels | int | 外部音频渲染的声道数,可设置为:
|
|
abstract |
开启或关闭外部音频源数据输入。
通过本接口可以实现创建自定义的外部音频源,并通过主流通道传输该外部音频源的数据。
参数名称 | 类型 | 描述 |
---|---|---|
enabled | boolean | 是否开启外部音频输入:
|
sample_rate | int | 外部音频源的数据采样率,单位为 Hz。建议设置为 8000,16000,32000,44100 或 48000。 |
channels | int | 外部音频源的数据声道数:
|
|
abstract |
开启或关闭外部音频辅流输入。
调用成功后可以使用 NERtcEx#pushExternalSubStreamAudioFrame(NERtcAudioExternalFrame) 接口发送音频辅流 PCM 数据。
enabled | 是否开启外部音频辅流数据输入。
|
sampleRate | 外部音频源的数据采样率,单位为 Hz。建议设置为 8000,16000,32000,44100 或 48000。 |
channels | 外部音频源的数据声道数。
|
|
abstract |
开启或关闭外部视频源数据输入。
通过本接口可以实现创建自定义的外部视频源,并通过主流通道传输该外部视频源的数据。
参数名称 | 类型 | 描述 |
---|---|---|
enable | boolean | 是否开启外部视频输入:
|
|
abstract |
开启或关闭外部视频源数据输入。
通过本接口可以实现创建自定义的外部视频源,您可以选择通过主流或辅流通道传输该外部视频源的数据。
参数名称 | 类型 | 描述 |
---|---|---|
streamType | video.NERtcVideoStreamType | 视频通道类型:
|
enable | boolean | 是否使用外部视频源:
|
|
abstract |
自定义本地视频渲染器。
该方法设置本地视频渲染器。只影响本地用户看到的视频画面,不影响远端。
在 App 开发中,通常在初始化后调用该方法进行本地自定义渲染器设置,然后再加入房间。
参数名称 | 类型 | 描述 |
---|---|---|
streamType | NERtcVideoStreamType | 视频通道类型:
|
renderer | NERtcExternalVideoRenderer | 自定义的本地视频渲染器。详细信息请参考 NERtcExternalVideoRenderer |
|
abstract |
设置本地用户的媒体流优先级。 如果某个用户的优先级为高,那么该用户媒体流的优先级就会高于其他用户,弱网环境下 SDK 会优先保证高优先级用户收到的媒体流的质量。
priority | 本地用户的媒体流优先级,默认为 NERtcConstants.MediaPriority#MEDIA_PRIORITY_NORMAL,详细信息请参考 NERtcConstants.MediaPriority。 |
isPreemptive | 是否开启抢占模式。
|
|
abstract |
设置弱网条件下发布的音视频流回退选项。 在网络不理想的环境下,发布的音视频质量都会下降。使用该接口并将 option 设置为 NERtcConstants.StreamFallbackOption#AUDIO_ONLY 后:
option | 本地发布流回退处理选项。 默认为不回退处理 NERtcConstants.StreamFallbackOption#DISABLED。 |
|
abstract |
设置视频水印。水印在本地预览及发送过程中均生效。
type | 水印的视频流类型。支持设置为主流或辅流。详细信息请参考 video.NERtcVideoStreamType。 |
config | 水印设置。设置为 null 表示取消之前的水印。详细信息请参考 watermark.NERtcVideoWatermarkConfig。 |
|
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 |
设置本地语音混响效果。
param | 详细信息请参考 audio.NERtcReverbParam。 |
|
abstract |
设置采集和播放声音混音后的音频数据格式。
通过本接口可以实现设置 NERtcAudioFrameObserver#onMixedAudioFrame() 回调的混音音频格式。
参数名称 | 类型 | 描述 |
---|---|---|
format | audio.NERtcAudioFrameRequestFormat | 指定 NERtcAudioFrameObserver#onMixedAudioFrame(NERtcAudioFrame) 中返回数据的采样率和数据的通道数。若您希望使用音频的原始格式,format 参数传 NULL 即可,默认为 NULL。 |
|
abstract |
设置事件通知回调。
通过本接口可以实现根据自身业务场景,监听相应的主回调。
参数名称 | 类型 | 描述 |
---|---|---|
callback | NERtcCallbackEx | SDK 主回调。设置为 null 表示清空回调。 |
|
abstract |
设置音频播放回调的声音格式。
通过此接口可以实现设置 SDK 播放音频 PCM 回调 NERtcAudioFrameObserver#onPlaybackFrame() 的采样率及声道数,同时还可以设置读写模式。在写模式下,您可以通过 NERtcAudioFrameObserver#onPlaybackFrame() 回调修改 PCM 数据,后续将播放修改后的音频数据。
参数名称 | 类型 | 描述 |
---|---|---|
format | audio.NERtcAudioFrameRequestFormat | 指定 NERtcAudioFrameObserver#onPlaybackFrame() 中返回数据的采样率和数据的通道数。允许传入 NULL,默认为 NULL,表示使用音频的原始格式。 |
|
abstract |
设置是否静音音频播放设备。
参数名称 | 类型 | 描述 |
---|---|---|
enable | boolean | 是否静音音频播放设备:
|
|
abstract |
注册解码前媒体数据观测器。
参数名称 | 类型 | 描述 |
---|---|---|
observer | predecoder.NERtcPreDecodeObserver | 接口对象实例。可以传 NULL 表示取消注册。 |
|
abstract |
设置玩家本人在房间中的范围语音模式,该设置不影响其他人。
mode | mode 范围语音模式,包括所有人和仅小队两种模式。具体请参见 NERtcRangeAudioMode 。 |
|
abstract |
设置范围语音的队伍号。
teamId | 小队ID, 有效值: >=0。若team_id = 0,则房间内所有人(不论范围语音的模式是所有人还是仅小队)都可以听到该成员的声音。 |
|
abstract |
设置是否静音音频采集设备。
参数名称 | 类型 | 描述 |
---|---|---|
enable | boolean | 是否静音音频采集设备:
|
|
abstract |
设置采集的音频格式。
通过本接口可以实现设置 NERtcAudioFrameObserver#onRecordFrame(com.netease.lava.nertc.sdk.audio.NERtcAudioFrame) 回调的录制声音格式。
参数名称 | 类型 | 描述 |
---|---|---|
format | audio.NERtcAudioFrameRequestFormat | 指定 NERtcAudioFrameObserver#onRecordFrame(com.netease.lava.nertc.sdk.audio.NERtcAudioFrame) 中返回数据的采样率和数据的通道数。 |
|
abstract |
自定义远端视频渲染器。
该方法绑定远端用户和显示视图,并设置远端用户视图在本地显示时的渲染模式和镜像模式,只影响本地用户看到的视频画面。
参数名称 | 类型 | 描述 |
---|---|---|
streamType | NERtcVideoStreamType | 视频通道类型:
|
uid | 远端用户ID | |
renderer | NERtcExternalVideoRenderer | 自定义的远端视频渲染器。详细信息请参考 NERtcExternalVideoRenderer |
|
abstract |
设置远端用户音频流的高优先级。 支持在音频自动订阅的情况下,设置某一个远端用户的音频为最高优先级,可以优先听到该用户的音频。
enabled | 是否设置音频订阅优先级。
|
uid | 用户 uid |
|
abstract |
设置弱网条件下订阅的音视频流回退选项。 弱网环境下,订阅的音视频质量会下降。调用该接口并将 option 设置为 NERtcConstants.StreamFallbackOption#VIDEO_STREAM_LOW 或者 NERtcConstants.StreamFallbackOption#AUDIO_ONLY 后:
option | 订阅音视频流的回退选项,默认为 NERtcConstants.StreamFallbackOption#VIDEO_STREAM_LOW 弱网时回退到视频小流。 |
|
abstract |
设置空间音效的渲染模式
mode | 渲染模式,具体请参见 audio.NERtcSpatializerRenderMode ,默认值 #kNERtcSpatializerRenderBinauralHighQuality |
|
abstract |
设置空间音效的房间混响属性
room_property | 房间属性,具体请参见 audio.NERtcSpatializerRoomProperty |
|
abstract |
设置是否由扬声器播放声音。
通过本接口可以实现设置是否将语音路由到扬声器,即设备外放。
参数名称 | 类型 | 描述 |
---|---|---|
enable | boolean | 是否将音频路由到扬声器:
|
|
abstract |
注册统计信息观测器,设置统计信息回调。
statsObserver | 统计信息观测器。详细信息请参考 stats.NERtcStatsObserver。 |
|
abstract |
开启精准对齐。 通过此接口可以实现精准对齐功能,对齐本地系统与服务端的时间。
参数名称 | 类型 | 描述 |
---|---|---|
enable | boolean | 是否开启精准对齐功能:
|
|
abstract |
你可以调用该方法指定只订阅的音频流。
uidArray | 只订阅此 用户uid列表 的音频。 此列表为全量列表。如果列表为空或 null,取消订阅白名单。 |
|
abstract |
你可以调用该方法指定不订阅的音频流。
uidArray | 不订阅此 用户uid列表 的音频。 此列表为全量列表。如果列表为空或 null,取消订阅黑名单。 |
|
abstract |
设置本端用户的视频辅流画布。
通过此接口可以实现设置本端用户的辅流显示视图。
参数名称 | 类型 | 描述 |
---|---|---|
render | IVideoRender | 视频画布。详细信息请参考 video.NERtcVideoView。 |
|
abstract |
设置远端用户的视频辅流画布。
通过此接口可以实现绑定远端用户和对应辅流的显示视图,即指定某个 uid 使用对应的画布显示。
参数名称 | 类型 | 描述 |
---|---|---|
render | IVideoRender | 视频画布。详细信息请参考 video.NERtcVideoView。 |
uid | long | 远端用户 ID。 |
|
abstract |
设置视频采集回调的数据格式。
通过本接口可以实现监听视频采集数据的回调 NERtcVideoCallback#onVideoCallback(),以对视频数据进行额外处理,例如美颜等操作。
参数名称 | 类型 | 描述 |
---|---|---|
videoCallback | video.NERtcVideoCallback | 视频采集数据回调。 |
textureWithI420 | boolean | 是否需要同时返回 YUV I420 和 Texture 格式的数据:
|
|
abstract |
设置视频图像矫正参数。
config | 视频图像矫正相关参数。详细说明请参考 NERtcVideoCorrectionConfiguration。 |
|
abstract |
注册视频编码 QoS 信息监听器。
参数名称 | 类型 | 描述 |
---|---|---|
encoderQosObserver | video.NERtcVideoEncoderQosObserver | 接口对象实例。可以传 NULL 表示取消注册。 |
|
abstract |
预设美声效果。 通过此接口可以实现为本地发流用户设置 SDK 预设的人声美声效果。
参数名称 | 类型 | 描述 |
---|---|---|
preset | int | 预设的美声效果模式。默认值为 VOICE_BEAUTIFIER_OFF,即关闭美声效果。详细信息请参考 audio.NERtcVoiceBeautifierType。 |
|
abstract |
|
abstract |
开始记录音频 dump。
音频 dump 可用于分析音频问题。
dumpType | dump 类型 详细信息请参考 NERtcConstants.AUDIO_DUMP_MODE。 |
dir | 音频 dump 文件存放目录,不填使用默认目录。 |
|
abstract |
开启伴音。
通过本接口可以实现指定本地或在线音频文件和录音设备采集的音频流进行混音。
参数名称 | 类型 | 描述 |
---|---|---|
option | audio.NERtcCreateAudioMixingOption | 创建伴音任务的配置选项,包括伴音任务类型、伴音文件的绝对路径或 URL 等。 |
|
abstract |
开启客户端本地录音。 通过此接口可以实现录制客户端房间内所有用户混音后的音频流,并将其保存在一个本地录音文件中。
参数名称 | 类型 | 描述 |
---|---|---|
filePath | String | 录音文件在本地保存的绝对路径,需要精确到文件名及格式,例如:sdcard/xxx/audio.aac。 |
sampleRate | int | 录音采样率。单位为赫兹(Hz),可以设置为 16000、32000(默认)、44100 或 48000。 |
quality | int | 录音音质。此参数仅在 AAC 格式下有效。详细信息请参考 NERtcConstants.AudioRecordingQuality。 |
|
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 |
开启美颜功能模块。
|
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 |
|
abstract |
停止伴音。
通过本接口可以实现停止播放本地或在线音频文件,或者录音设备采集的混音音频流。
|
abstract |
停止客户端本地录音。 本端用户离开房间时会自动停止本地录音,也可以通过此接口实现在通话过程中随时停止录音。
|
abstract |
结束美颜功能模块。
如果后续不再需要使用美颜功能,可以调用 NERtcEx#stopBeauty() 结束美颜功能模块,SDK 会自动销毁美颜引擎并释放资源。
|
abstract |
停止跨房间媒体流转发。 主播离开房间时,跨房间媒体流转发自动停止,您也可以在需要的时候随时调用 stopChannelMediaRelay 方法,此时主播会退出所有目标房间。
|
abstract |
停止播放指定音效文件。
effectId | 指定音效的 ID。每个音效均有唯一的 ID。 |
|
abstract |
|
abstract |
关闭辅流形式的屏幕共享。
如果您在加入房间后调用该方法关闭辅流,调用成功后,远端触发 onUserSubStreamVideoStop 回调。
|
abstract |
取消或恢复订阅指定远端用户数据通道流。
加入房间时,默认订阅所有远端用户的数据通道流,您可以通过此方法取消或恢复订阅指定远端用户的数据通道流。
[in] | uid | 指定用户的 ID。 |
[in] | subscribe | 是否订阅远端用户数据通道流。
|
|
abstract |
设置是否订阅指定远端用户的音频辅流。
参数名称 | 类型 | 描述 |
---|---|---|
uid | long | 远端用户 ID。 |
subscribe | boolean | 是否订阅指定音频辅流:
|
|
abstract |
订阅或取消订阅远端用户的视频辅流。
参数名称 | 类型 | 描述 |
---|---|---|
uid | long | 远端用户 ID。 |
subsribe | boolean | 是否订阅远端的视频辅流:
|
|
abstract |
切换前置或后置摄像头。
|
abstract |
指定前置/后置摄像头。
该方法需要在相机启动后调用,例如调用 NERtc#startVideoPreview(NERtcVideoStreamType streamType) 或 NERtc#joinChannel() 后。
cameraPos | 相机类型。详细信息请参考 NERtcConstants.CameraPosition。该参数为必填参数,若未赋值,SDK 会报错。 |
|
abstract |
快速切换音视频房间。 通过此接口可以实现当房间场景为直播场景时,用户从当前房间快速切换至另一个房间。
参数名称 | 类型 | 描述 |
---|---|---|
token | String | 在服务器端生成的用于鉴权的安全认证签名(Token),可设置为:
|
channelName | String | 期望切换到的目标房间名称。 |
|
abstract |
快速切换音视频房间。 房间场景为直播场景时,房间中角色为观众的成员可以调用该方法从当前房间快速切换至另一个房间。 成功调用该方切换房间后:
token | 在服务器端生成的用于鉴权的安全认证签名(Token)。可设置为:
|
channelName | 期望切换到的目标房间名称。 |
channelOptions | 加入房间时设置一些特定的房间参数,详情参考NERtcJoinChannelOptions ,默认为null |
|
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 | 操作结果回调,方法调用成功后会触发对应的 UpdateLiveTaskCallback#onUpdateLiveStreamTask() 回调。 |
|
abstract |
设置空间音效中说话者和接收者的空间位置信息。SDK 会根据该方法中的参数计算接收者和说话者之间的相对位置,进而渲染出空间音效。
参数名称 | 描述 |
---|---|
mSpeakerPosition | 说话者的位置信息,三个值依次表示X、Y、Z的坐标值。默认值{0,0,0} |
mSpeakerQuaternion | <note type="note">该参数设置的值暂时不起作用,保持默认值即可。</note>说话者的旋转信息,通过四元组来表示,数据格式为{w, x, y, z}。默认值{0,0,0,0} |
mHeadPosition | 接收者的位置信息,三个值依次表示X、Y、Z的坐标值。默认值{0,0,0} |
mHeadQuaternion | 接收者的旋转信息,通过四元组来表示,数据格式为{w, x, y, z}。默认值{0,0,0,0} |
|
abstract |
上传 SDK 信息。
只能在加入房间后调用。上传的信息包括 log 和 Audio dump 等文件。