Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EncryptionConfig

Configurations of built-in encryption schemas.

Hierarchy

  • EncryptionConfig

Index

Properties

Properties

encryptionKdfSalt

encryptionKdfSalt: Uint8ArrayBuffer
since

v3.4.5

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.

note

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

encryptionKey: string

Encryption key in string type.

note

If you do not set an encryption key or set it as NULL, you cannot use the built-in encryption, and the SDK returns the error code -2.

encryptionMode

encryptionMode: ENCRYPTION_MODE

Encryption mode. The default encryption mode is AES_128_GCM2.