Classes
class	Key

Public Member Functions
	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)

Static Public Attributes
static final Key< Boolean >	KEY_AUTO_SUBSCRIBE_AUDIO

static final Key< Boolean >	KEY_AUTO_SUBSCRIBE_VIDEO

static final Key< Boolean >	KEY_AUDIO_BLUETOOTH_SCO

static final Key< Boolean >	KEY_VIDEO_LOCAL_PREVIEW_MIRROR

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)

Detailed Description

Obtains and sets the parameters related to audio and video calls before or during the call.

Constructor & Destructor Documentation

◆ NERtcParameters()

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

NERtcParameters

Member Function Documentation

◆ 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

Member Data Documentation

◆ KEY_AUDIO_AI_NS_ENABLE

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_AUDIO_AI_NS_ENABLE

static

Initial value:

=

new Key<>(RtcParameters.KEY_AUDIO_AI_NS_ENABLE, Boolean.class)

AI noise reduction switch.
NERTC SDK developes noise reduction algorithm. With it enabled, reduces directional noise toward non-steady noises such as background and keyboard voices in noisy environments. The algorithm also can control environmental steady noises and retain more purer voices. *

◆ KEY_AUDIO_BLUETOOTH_SCO

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_AUDIO_BLUETOOTH_SCO

static

Initial value:

=

new Key<>(RtcParameters.KEY_AUDIO_BLUETOOTH_SCO, Boolean.class)

Whether to enable bluetooth SCO.

◆ KEY_AUTO_SUBSCRIBE_AUDIO

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_AUTO_SUBSCRIBE_AUDIO

static

Initial value:

=

new Key<>(RtcParameters.KEY_AUTO_SUBSCRIBE_AUDIO, Boolean.class)

Whether to subscribe to audio automatically. true is subscription by default.

◆ KEY_AUTO_SUBSCRIBE_VIDEO

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_AUTO_SUBSCRIBE_VIDEO

static

Initial value:

=

new Key<>(RtcParameters.KEY_AUTO_SUBSCRIBE_VIDEO, Boolean.class)

Whether to subscribe to video automatically. False is subscription by default.

Since: 4.6.0

◆ KEY_CUSTOM_EXTRA_INFO

final Key<String> com.netease.lava.nertc.sdk.NERtcParameters.KEY_CUSTOM_EXTRA_INFO

static

Initial value:

=

new Key<String>(RtcParameters.KEY_CUSTOM_EXTRA_INFO, String.class)

A user-defined field in the login event is suitable for assisting clients in identifying additional information.

◆ 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

Whether to enable dual call mode. Default: Disabled.
Applicable to 1v1 call scenarios.

Note

While creating client server of the dual call mode and joining the channel. The channel is for the dual call with only client server enabling the mode permitted joining.
Sets before you join the channel.

◆ KEY_ENABLE_NEGATIVE_UID

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_ENABLE_NEGATIVE_UID

static

Initial value:

=

new Key<>(RtcParameters.KEY_ENABLE_NEGATIVE_UID, Boolean.class)

Whether to support negative uid setting. Default: false. Negative uid is not supported.
Sets the parameter before joining the channel. We don't recommend you to changed the parameter halfway.

Note

We strongly recommend you use the negative uid because it is just a contingent remedy; if it exceeds 32 unsigned integers, duplicate uid may occur.
If you set to support negative uid, the SDK will process the negative uid input from all APIs(uid & 0xffffffffL) to get the positive uid. All SDK callbacks follow with long positive uid. Therefore, you need to change the int yourself to get the corresponding negative uid.

◆ 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

Whether to return original volume when the local user is muted. Boolean value, default: false.

true：Return the original volume in NERtcCallbackEx#onLocalAudioVolumeIndication.
false：Return the recording volume(0) in NERtcCallbackEx#onLocalAudioVolumeIndication.
Note
Set the parameter before joining the channel.

◆ KEY_PUBLISH_SELF_STREAM

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_PUBLISH_SELF_STREAM

static

Initial value:

=

new Key<>(RtcParameters.KEY_PUBLISH_SELF_STREAM, Boolean.class)

Whether to push your own video streams while the channel pushes the stream to CDN. The default value is true.

Deprecated:

◆ KEY_SERVER_RECORD_AUDIO

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_SERVER_RECORD_AUDIO

static

Initial value:

=

new Key<>(RtcParameters.KEY_SERVER_RECORD_AUDIO, Boolean.class)

Whether to enable cloud audio recording. Default: false. Disables audio recording.

◆ KEY_SERVER_RECORD_MODE

final Key<Integer> com.netease.lava.nertc.sdk.NERtcParameters.KEY_SERVER_RECORD_MODE

static

Initial value:

=

new Key<>(RtcParameters.KEY_SERVER_RECORD_MODE, Integer.class)

Cloud recording mode.

See also: 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

Initial value:

=

new Key<>(RtcParameters.KEY_SERVER_RECORD_SPEAKER, Boolean.class)

Whether to set the local server as the speaker of the cloud server recording.

◆ KEY_SERVER_RECORD_VIDEO

final Key<Boolean> com.netease.lava.nertc.sdk.NERtcParameters.KEY_SERVER_RECORD_VIDEO

static

Initial value:

=

new Key<>(RtcParameters.KEY_SERVER_RECORD_VIDEO, Boolean.class)

Whether to enable cloud video recording. Default: false. Disables video recording.

◆ KEY_VIDEO_CAMERA_TYPE

final Key<Integer> com.netease.lava.nertc.sdk.NERtcParameters.KEY_VIDEO_CAMERA_TYPE

static

Initial value:

=

new Key<>(RtcParameters.KEY_VIDEO_CAMERA_TYPE, Integer.class)

Video camera type.

◆ KEY_VIDEO_DECODE_MODE

final Key<String> com.netease.lava.nertc.sdk.NERtcParameters.KEY_VIDEO_DECODE_MODE

static

Initial value:

=

new Key<>(RtcParameters.KEY_VIDEO_DECODE_MODE, String.class)

Video decoding mode.

See also: 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

Initial value:

=

new Key<>(RtcParameters.KEY_VIDEO_ENCODE_MODE, String.class)

Video encoding mode.

See also: 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

Initial value:

=

new Key<>(RtcParameters.KEY_VIDEO_LOCAL_PREVIEW_MIRROR, Boolean.class)

Whether to preview the front camera with mirror mode. Default: true. The setting enables the mirror mode.

◆ KEY_VIDEO_SEND_MODE

final Key<Integer> com.netease.lava.nertc.sdk.NERtcParameters.KEY_VIDEO_SEND_MODE

static

Initial value:

=

new Key<>(RtcParameters.KEY_VIDEO_SEND_MODE, Integer.class)

Video publish mode.

See also: VideoSendMode::SEND_ON_PUB_NONE; VideoSendMode::SEND_ON_PUB_HIGH; VideoSendMode::SEND_ON_PUB_LOW; VideoSendMode::SEND_ON_PUB_ALL

The documentation for this class was generated from the following file:

sdk/NERtcParameters.java

Classes

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NERtcParameters()

Member Function Documentation

◆ clear()

◆ containsKey()

◆ get()

◆ getBoolean()

◆ getFloat()

◆ getInteger()

◆ getRawParameters()

◆ getString()

◆ removeParameters()

◆ set()

◆ setBoolean()

◆ setFloat()

◆ setInteger()

◆ setRawParameters()

◆ setRequestKey()

◆ setRequestKeys()

◆ setString()

Member Data Documentation

◆ KEY_AUDIO_AI_NS_ENABLE

◆ KEY_AUDIO_BLUETOOTH_SCO

◆ KEY_AUTO_SUBSCRIBE_AUDIO

◆ KEY_AUTO_SUBSCRIBE_VIDEO

◆ KEY_CUSTOM_EXTRA_INFO

◆ KEY_ENABLE_1V1_MODEL

◆ KEY_ENABLE_NEGATIVE_UID

◆ KEY_ENABLE_REPORT_VOLUME_WHEN_MUTE

◆ KEY_PUBLISH_SELF_STREAM

◆ KEY_SERVER_RECORD_AUDIO

◆ KEY_SERVER_RECORD_MODE

◆ KEY_SERVER_RECORD_SPEAKER

◆ KEY_SERVER_RECORD_VIDEO

◆ KEY_VIDEO_CAMERA_TYPE

◆ KEY_VIDEO_DECODE_MODE

◆ KEY_VIDEO_ENCODE_MODE

◆ KEY_VIDEO_LOCAL_PREVIEW_MIRROR

◆ KEY_VIDEO_SEND_MODE