Agora Java API Reference for Android
io.agora.rtc.internal.EncryptionConfig Class Reference


enum  EncryptionMode

Public Attributes

EncryptionMode encryptionMode
final byte[] encryptionKdfSalt = new byte[32]
String encryptionKey

Detailed Description

Definition of EncryptionConfig.

Member Data Documentation

◆ encryptionMode

EncryptionMode io.agora.rtc.internal.EncryptionConfig.encryptionMode

Encryption mode. The default encryption mode is AES_128_GCM2. See EncryptionMode.

◆ encryptionKdfSalt

final byte [] io.agora.rtc.internal.EncryptionConfig.encryptionKdfSalt = new byte[32]

The salt with the length of 32 bytes. Agora recommends using OpenSSL to generate the salt on your server. For details, see Media Stream Encryption.

This parameter is only valid when you set the encryption mode as AES_128_GCM2 or AES_256_GCM2. In this case, ensure that this parameter is not 0.

◆ encryptionKey

String io.agora.rtc.internal.EncryptionConfig.encryptionKey

Encryption key in string type with unlimited length. Agora recommends using a 32-byte key.

If you do not set an encryption key or set it as null, you cannot use the built-in encryption, and the SDK returns ERR_INVALID_ARGUMENT(-2).