NERtc Android SDK V5.6.10
载入中...
搜索中...
未找到
| Public 成员函数 | 静态 Public 属性 | 所有成员列表
com.netease.lava.nertc.sdk.NERtcParameters类 参考

class  Key
 

Public 成员函数

 NERtcParameters ()
 
void clear ()
 
RtcParameters getRawParameters ()
 
void setRawParameters (RtcParameters parameters)
 
final NERtcParameters setRequestKeys (Set< Key > keys)
 
final NERtcParameters setRequestKey (Key key)
 
final boolean getBoolean (Key< Boolean > key)
 
final int getInteger (Key< Integer > key)
 
final String getString (Key< String > key)
 
final void setInteger (Key< Integer > key, int value)
 
final void setBoolean (Key< Boolean > key, boolean value)
 
final void setString (Key< String > key, String value)
 
final boolean containsKey (Key key)
 
final< T > void set (Key< T > key, T value)
 
final< T > T get (Key< T > key)
 
final void setFloat (Key< Float > key, float value)
 
final float getFloat (Key< Float > key)
 
final void removeParameters (Key key)
 

静态 Public 属性

static final Key< Boolean > KEY_AUTO_SUBSCRIBE_AUDIO
 
static final Key< Boolean > KEY_AUTO_SUBSCRIBE_VIDEO
 
static final Key< Boolean > KEY_AUTO_SUBSCRIBE_DATA
 
static final Key< Boolean > KEY_AUDIO_BLUETOOTH_SCO
 
static final Key< Boolean > KEY_VIDEO_LOCAL_PREVIEW_MIRROR
 
static final Key< Boolean > KEY_DISABLE_VIDEO_DECODER
 
static final Key< Integer > KEY_VIDEO_CAMERA_TYPE
 
static final Key< String > KEY_VIDEO_ENCODE_MODE
 
static final Key< String > KEY_VIDEO_DECODE_MODE
 
static final Key< Boolean > KEY_SERVER_RECORD_AUDIO
 
static final Key< Boolean > KEY_SERVER_RECORD_VIDEO
 
static final Key< Integer > KEY_SERVER_RECORD_MODE
 
static final Key< Boolean > KEY_SERVER_RECORD_SPEAKER
 
static final Key< Boolean > KEY_PUBLISH_SELF_STREAM
 
static final Key< Integer > KEY_VIDEO_SEND_MODE
 
static final Key< Boolean > KEY_AUDIO_AI_NS_ENABLE
 
static final Key< Boolean > KEY_ENABLE_1V1_MODEL = new Key<>(RtcParameters.KEY_ENABLE_1V1_MODEL, Boolean.class)
 
static final Key< Boolean > KEY_ENABLE_NEGATIVE_UID
 
static final Key< String > KEY_CUSTOM_EXTRA_INFO
 
static final Key< Boolean > KEY_ENABLE_REPORT_VOLUME_WHEN_MUTE = new Key<>(RtcParameters.KEY_ENABLE_REPORT_VOLUME_WHEN_MUTE, Boolean.class)
 
static final Key< Boolean > KEY_START_WITH_BACK_CAMERA
 
static final Key< Boolean > KEY_DISABLE_FIRST_USER_CREATE_CHANNEL = new Key<>(RtcParameters.KEY_DISABLE_FIRST_USER_CREATE_CHANNEL, Boolean.class)
 
static final Key< String > KEY_LOGIN_CUSTOM_DATA = new Key<>(RtcParameters.KEY_GET_CHANNEL_INFO_CUSTOM_DATA, String.class)
 

详细描述

音视频通话相关的参数设置, 可以在通话前或者在通话过程中获取与设置这些参数。

构造及析构函数说明

◆ NERtcParameters()

com.netease.lava.nertc.sdk.NERtcParameters.NERtcParameters ( )

NERtcParameters

成员函数说明

◆ clear()

void com.netease.lava.nertc.sdk.NERtcParameters.clear ( )

to be added

◆ containsKey()

final boolean com.netease.lava.nertc.sdk.NERtcParameters.containsKey ( Key key)

to be added

◆ get()

final< T > T com.netease.lava.nertc.sdk.NERtcParameters.get ( Key< T > key)

to be added

◆ getBoolean()

final boolean com.netease.lava.nertc.sdk.NERtcParameters.getBoolean ( Key< Boolean > key)

to be added

◆ getFloat()

final float com.netease.lava.nertc.sdk.NERtcParameters.getFloat ( Key< Float > key)

to be added

◆ getInteger()

final int com.netease.lava.nertc.sdk.NERtcParameters.getInteger ( Key< Integer > key)

to be added

◆ getRawParameters()

RtcParameters com.netease.lava.nertc.sdk.NERtcParameters.getRawParameters ( )

to be added

◆ getString()

final String com.netease.lava.nertc.sdk.NERtcParameters.getString ( Key< String > key)

to be added

◆ removeParameters()

final void com.netease.lava.nertc.sdk.NERtcParameters.removeParameters ( Key key)

to be added

◆ set()

final< T > void com.netease.lava.nertc.sdk.NERtcParameters.set ( Key< T > key,
T value )

to be added

◆ setBoolean()

final void com.netease.lava.nertc.sdk.NERtcParameters.setBoolean ( Key< Boolean > key,
boolean value )

to be added

◆ setFloat()

final void com.netease.lava.nertc.sdk.NERtcParameters.setFloat ( Key< Float > key,
float value )

to be added

◆ setInteger()

final void com.netease.lava.nertc.sdk.NERtcParameters.setInteger ( Key< Integer > key,
int value )

to be added

◆ setRawParameters()

void com.netease.lava.nertc.sdk.NERtcParameters.setRawParameters ( RtcParameters parameters)

to be added

◆ setRequestKey()

final NERtcParameters com.netease.lava.nertc.sdk.NERtcParameters.setRequestKey ( Key key)

to be added

◆ setRequestKeys()

final NERtcParameters com.netease.lava.nertc.sdk.NERtcParameters.setRequestKeys ( Set< Key > keys)

to be added

◆ setString()

final void com.netease.lava.nertc.sdk.NERtcParameters.setString ( Key< String > key,
String value )

to be added

类成员变量说明

◆ KEY_AUDIO_AI_NS_ENABLE

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_AUDIO_AI_NS_ENABLE
static
初始值:
=
new Key<>(RtcParameters.KEY_AUDIO_AI_NS_ENABLE, Boolean.class)

AI 降噪开关。
NERTC SDK 自研 AI 降噪算法,开启 AI 降噪之后,在嘈杂的环境中可以针对背景人声、键盘声等非稳态噪声进行定向降噪,同时也会提升对于环境稳态噪声的抑制,保留更纯粹的人声。 *

◆ KEY_AUDIO_BLUETOOTH_SCO

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_AUDIO_BLUETOOTH_SCO
static
初始值:
=
new Key<>(RtcParameters.KEY_AUDIO_BLUETOOTH_SCO, Boolean.class)

是否关闭蓝牙 SCO

◆ KEY_AUTO_SUBSCRIBE_AUDIO

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_AUTO_SUBSCRIBE_AUDIO
static
初始值:
=
new Key<>(RtcParameters.KEY_AUTO_SUBSCRIBE_AUDIO, Boolean.class)

是否自动订阅音频,默认为 true,即订阅音频。

◆ KEY_AUTO_SUBSCRIBE_DATA

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_AUTO_SUBSCRIBE_DATA
static
初始值:
=
new Key<>(RtcParameters.KEY_AUTO_SUBSCRIBE_DATA, Boolean.class)

是否自动订阅数据,默认为 false 即不订阅视频

自从
4.6.0

◆ KEY_AUTO_SUBSCRIBE_VIDEO

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_AUTO_SUBSCRIBE_VIDEO
static
初始值:
=
new Key<>(RtcParameters.KEY_AUTO_SUBSCRIBE_VIDEO, Boolean.class)

是否自动订阅视频(包括主流、辅流),默认为 false, 即不订阅视频。

自从
4.6.0

◆ KEY_CUSTOM_EXTRA_INFO

final Key<String> com.netease.lava.nertc.sdk.NERtcParameters.KEY_CUSTOM_EXTRA_INFO
static
初始值:
=
new Key<String>(RtcParameters.KEY_CUSTOM_EXTRA_INFO, String.class)

Login 事件中的一个自定义字段,适用于协助客户标识一些额外信息

◆ KEY_DISABLE_FIRST_USER_CREATE_CHANNEL

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_DISABLE_FIRST_USER_CREATE_CHANNEL = new Key<>(RtcParameters.KEY_DISABLE_FIRST_USER_CREATE_CHANNEL, Boolean.class)
static

是否禁止第一个加入房间的人员创建房间

◆ KEY_DISABLE_VIDEO_DECODER

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_DISABLE_VIDEO_DECODER
static
初始值:
=
new Key<>(RtcParameters.KEY_DISABLE_VIDEO_DECODER, Boolean.class)

是否关闭 sdk 视频解码(默认不关闭),关闭后 SDK 将不会解码远端视频,因此也不法渲染接收到的远端视频

注解
需要在初始化NERtc#init(Context, String, NERtcCallback, NERtcOption)前设置,释放 SDK 后失效。一般配合 NERtcEx#setPreDecodeObserver(NERtcPreDecodeObserver) 使用。
自从
4.6.130

◆ KEY_ENABLE_1V1_MODEL

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_ENABLE_1V1_MODEL = new Key<>(RtcParameters.KEY_ENABLE_1V1_MODEL, Boolean.class)
static

是否开启双人通话模式。默认为关闭状态。
适用于 1v1 通话场景。
注意

  • 开启了双人通话模式的客户端创建并加入房间时,该房间会成为一个双人通话房间,只允许同样开启了双通话模式的客户端加入。
  • 请在加入房间前设置。

◆ KEY_ENABLE_NEGATIVE_UID

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_ENABLE_NEGATIVE_UID
static
初始值:
=
new Key<>(RtcParameters.KEY_ENABLE_NEGATIVE_UID, Boolean.class)

是否支持设置负数 uid,默认为 false,即不支持设置负数 uid。
该参数需要在加入房间前设置,且不建议中途更改。
注意

  • 强烈不建议使用负数 uid,这个只是一个应急补救措施,如果超过了 32 无符整型,那么可能存在 uid 重复的问题。
  • 如果设置支持负数 uid,那么 SDK 会将通过所有 API 输入的负数 uid 进行处理(uid & 0xffffffffL)得到正数 uid,所有 SDK 回调都是相应 long 正数 uid,您需要自己强行转成 int 以能得到相应的负数。

◆ KEY_ENABLE_REPORT_VOLUME_WHEN_MUTE

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_ENABLE_REPORT_VOLUME_WHEN_MUTE = new Key<>(RtcParameters.KEY_ENABLE_REPORT_VOLUME_WHEN_MUTE, Boolean.class)
static

本地用户静音时是否返回原始音量。 布尔值,默认值为 false。

  • true:返回 NERtcCallbackEx#onLocalAudioVolumeIndication 中的原始音量。
  • false:返回 NERtcCallbackEx#onLocalAudioVolumeIndication 中的录音音量,静音时为 0。
    注解
    请在加入房间前调用此接口。

◆ KEY_LOGIN_CUSTOM_DATA

final Key<String> com.netease.lava.nertc.sdk.NERtcParameters.KEY_LOGIN_CUSTOM_DATA = new Key<>(RtcParameters.KEY_GET_CHANNEL_INFO_CUSTOM_DATA, String.class)
static

登录扩展字段,SDK 会把该字段放入 getchannelInfo 请求参数中的 customData 字段。

◆ KEY_PUBLISH_SELF_STREAM

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_PUBLISH_SELF_STREAM
static
初始值:
=
new Key<>(RtcParameters.KEY_PUBLISH_SELF_STREAM, Boolean.class)

在旁路推流场景中,是否允许推送本地媒体流到 CDN。默认值 true。

弃用
该参数已废弃。

◆ KEY_SERVER_RECORD_AUDIO

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_SERVER_RECORD_AUDIO
static
初始值:
=
new Key<>(RtcParameters.KEY_SERVER_RECORD_AUDIO, Boolean.class)

是否开启云端音频录制。默认为 false,即关闭音频录制。

◆ KEY_SERVER_RECORD_MODE

final Key<Integer> com.netease.lava.nertc.sdk.NERtcParameters.KEY_SERVER_RECORD_MODE
static
初始值:
=
new Key<>(RtcParameters.KEY_SERVER_RECORD_MODE, Integer.class)

云端录制模式。

参见
ServerRecordMode::MIX_AND_SINGLE
ServerRecordMode::MIX
ServerRecordMode::SINGLE

◆ KEY_SERVER_RECORD_SPEAKER

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_SERVER_RECORD_SPEAKER
static
初始值:
=
new Key<>(RtcParameters.KEY_SERVER_RECORD_SPEAKER, Boolean.class)

本端是否为云端录制的主讲人。

◆ KEY_SERVER_RECORD_VIDEO

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_SERVER_RECORD_VIDEO
static
初始值:
=
new Key<>(RtcParameters.KEY_SERVER_RECORD_VIDEO, Boolean.class)

是否开启云端视频录制。默认为 false,即关闭视频录制。

◆ KEY_START_WITH_BACK_CAMERA

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_START_WITH_BACK_CAMERA
static
初始值:
=
new Key<>(RtcParameters.KEY_START_WITH_BACK_CAMERA, Boolean.class)

是否用后置相机加入房间

◆ KEY_VIDEO_CAMERA_TYPE

final Key<Integer> com.netease.lava.nertc.sdk.NERtcParameters.KEY_VIDEO_CAMERA_TYPE
static
初始值:
=
new Key<>(RtcParameters.KEY_VIDEO_CAMERA_TYPE, Integer.class)

摄像头类型。

◆ KEY_VIDEO_DECODE_MODE

final Key<String> com.netease.lava.nertc.sdk.NERtcParameters.KEY_VIDEO_DECODE_MODE
static
初始值:
=
new Key<>(RtcParameters.KEY_VIDEO_DECODE_MODE, String.class)

视频解码模式。

参见
MediaCodecMode::MEDIA_CODEC_DEFAULT
MediaCodecMode::MEDIA_CODEC_HARDWARE
MediaCodecMode::MEDIA_CODEC_SOFTWARE

◆ KEY_VIDEO_ENCODE_MODE

final Key<String> com.netease.lava.nertc.sdk.NERtcParameters.KEY_VIDEO_ENCODE_MODE
static
初始值:
=
new Key<>(RtcParameters.KEY_VIDEO_ENCODE_MODE, String.class)

视频编码模式。

参见
MediaCodecMode::MEDIA_CODEC_DEFAULT
MediaCodecMode::MEDIA_CODEC_HARDWARE
MediaCodecMode::MEDIA_CODEC_SOFTWARE

◆ KEY_VIDEO_LOCAL_PREVIEW_MIRROR

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_VIDEO_LOCAL_PREVIEW_MIRROR
static
初始值:
=
new Key<>(RtcParameters.KEY_VIDEO_LOCAL_PREVIEW_MIRROR, Boolean.class)

前置摄像头预览是否采用镜像模式。默认为 true,开启镜像模式。

◆ KEY_VIDEO_SEND_MODE

final Key<Integer> com.netease.lava.nertc.sdk.NERtcParameters.KEY_VIDEO_SEND_MODE
static
初始值:
=
new Key<>(RtcParameters.KEY_VIDEO_SEND_MODE, Integer.class)

视频发布模式

参见
VideoSendMode::SEND_ON_PUB_NONE
VideoSendMode::SEND_ON_PUB_HIGH
VideoSendMode::SEND_ON_PUB_LOW
VideoSendMode::SEND_ON_PUB_ALL

该类的文档由以下文件生成: