Class EncryptionConfig

Built-in encryption configurations.

Hierarchy

  • EncryptionConfig

Constructors

constructor

Properties

datastreamEncryptionEnabled? encryptionKdfSalt? encryptionKey? encryptionMode?

Constructors

constructor

Properties

Optional datastreamEncryptionEnabled

datastreamEncryptionEnabled?: boolean

Whether to enable data stream encryption: true : Enable data stream encryption. false : (Default) Disable data stream encryption.

Optional encryptionKdfSalt

encryptionKdfSalt?: number[]

Salt, 32 bytes in length. Agora recommends that you use OpenSSL to generate salt on the server side. See Media Stream Encryption for details. This parameter takes effect only in Aes128Gcm2 or Aes256Gcm2 encrypted mode. In this case, ensure that this parameter is not 0.

Optional encryptionKey

encryptionKey?: string

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 -2.

Optional encryptionMode

encryptionMode?: EncryptionMode

The built-in encryption mode. See EncryptionMode. Agora recommends using Aes128Gcm2 or Aes256Gcm2 encrypted mode. These two modes support the use of salt for higher security.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc