开启或关闭媒体流私有加密

说明

在安全要求较高的场景下，TRTC 建议您在加入房间前，调用 enablePayloadPrivateEncryption 方法开启媒体流私有加密。
用户退出房间后，SDK 会自动关闭私有加密。如需重新开启私有加密，您需要在用户再次加入房间前调用该方法。

方法名

enablePayloadPrivateEncryption

用法

• 用法如下：

uniapp

module.enablePayloadPrivateEncryption({
  params:{
  },
  //成功执行的函数
  success: (res) => {
    let data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数，不管成功还是失败都会返回
  complete: (res) => {
    // console.log(res)
  }
})

uniappx

module.enablePayloadPrivateEncryption({
  params:{
  },
  //成功执行的函数
  success: (res) => {
    const data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数，不管成功还是失败都会返回
  // complete: (res) => {
  //   console.log(res)
  // }
} as LevenOptions)

• 参数说明

  参数名	参数类型	是否必填	默认值	参数描述
  params	Object	是	无	参数配置
  params.enabled	String	是	无	是否开启媒体流私有加密
  params.config	Object	是	无	配置媒体流私有加密的算法和密钥
  params.config.encryptionAlgorithm	String	否	TRTC_EncryptionAlgorithm_Aes_128_Gcm	加密算法，可选值请参考【加密算法类型】
  params.config.encryptionKey	String	否	无	加密用密钥，字符串类型 若加密算法为 TRTC_EncryptionAlgorithm_Aes_128_Gcm，密匙长度需为 16 字节，若加密算法为 TRTC_EncryptionAlgorithm_Aes_256_Gcm，密匙长度需为 32 字节
  success	Function	否	无	执行成功的函数
  fail	Function	否	无	执行失败的函数
  complete	Function	否	无	执行完成的函数，不管成功还是失败都会执行

加密算法类型

名称	描述
TRTC_EncryptionAlgorithm_Aes_128_Gcm	AES GCM 128
TRTC_EncryptionAlgorithm_Aes_256_Gcm	AES GCM 256

回调

• 示例

{
"data": {
  "result": 0
},
"message": "",
"code": 0
}

• 回调说明：

  参数名	参数类型	参数描述
  message	String	消息提示
  data	Object	数据对象
  data.result	Integer	接口调用结果，0: 方法调用成功， -1: 传入参数无效， -2: 功能已过期。若需解锁：请前往购买 TRTC 旗舰版（国内站）/ 专业版（国际站）套餐，并联系我们审核后使用
  code	Integer	返回类型，0.成功，其他：失败