EncryptionConfig | Voice SDK v1.3.1_3.1 API Reference for Cocos Creator

Configurations of built-in encryption schemas.

Index

new EncryptionConfig(encryptionMode?: ENCRYPTION_MODE, encryptionKey: string): EncryptionConfig

- Defined in agora.ts:4740
Parameters
- Default value encryptionMode: ENCRYPTION_MODE = ENCRYPTION_MODE.AES_128_XTS
- encryptionKey: string
Returns EncryptionConfig

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 -2(ERR_INVALID_ARGUMENT).

encryptionMode: ENCRYPTION_MODE

Encryption mode. The default encryption mode is AES_128_XTS. See ENCRYPTION_MODE.