TRROConfig

TRROSDK 初始化配置项

包含云模式、信令地址、设备信息、事件回调、日志、自定义消息等所有顶层配置; 各字段的详细说明见下方对应字段。

Members

cloudMode :CloudMode

云模式

取值：

  • public 公有云
  • public_intl 公有云国际站
  • private 私有云
Type:
Default Value
  • "private"

serverIp :string|Array

信令调度服务器的域名或 IP 地址，可传入多个信令调度服务器地址

  • 云模式 cloudMode 设置为 public 或 public_intl 时，该字段无效；
  • 云模式 cloudMode 设置为 private 时，必须提供该字段，否则将抛出错误。
Type:
  • string | Array

port :number

信令调度服务端口。

  • 云模式 cloudMode 设置为 public 或 public_intl 时，该字段无效；
  • 云模式 cloudMode 设置为 private 时，该字段默认值为 3000 / 443（启用 https）。
Type:
  • number

targetIp :string

服务器远程访问 IP 地址，仅在多网段访问场景下需要提供该字段

  • 云模式 cloudMode 设置为 public 或 public_intl 时，该字段无效；
  • 必须为 IPv4 形式。
Type:
  • string
Deprecated
  • 2.4.1.4 及以后版本弃用该参数

targetPort :number

服务器远程访问端口，仅在多网段访问场景下需要提供该字段

注意：

  • 云模式 cloudMode 设置为 public 或 public_intl 时，该字段无效。
Type:
  • number
Deprecated
  • 2.4.1.4 及以后版本弃用该参数

https :boolean

是否启用 SSL

  • 云模式 cloudMode 设置为 public 或 public_intl 时，强制使用 SSL，该字段无效；
  • 云模式 cloudMode 设置为 private 时，该字段默认值为 false。
Type:
  • boolean

mqttOptions :object

MQTT 配置项

Type:
  • object
Properties
NameTypeAttributesDescription
urlstring | Array<optional>

MQTT 服务器的域名或 IP 地址，可传入多个 MQTT 服务器地址

  • 云模式 cloudMode 设置为 public 或 public_intl 时，一般无需配置该字段，请在专业人员指导下配置；
  • 云模式 cloudMode 设置为 private 时，该字段默认与 serverIp 一致。
portnumber<optional>

MQTT 服务器端口

  • 云模式 cloudMode 设置为 public 或 public_intl 时，一般无需配置该字段，请在专业人员指导下配置；
  • 云模式 cloudMode 设置为 private 时，该字段默认值为 2833。
forceLoginboolean<optional>

强制登录

  • 若配置为 true，则登录时会无视是否已有同名用户登录，并踢掉已登录的同名用户
enableLogboolean<optional>

打开 MQTT 底层日志

  • loggerOption.showLog 的值为 false 时，即使该字段设置为 true，也不会打印日志
  • loggerOption.reportLog 的值为 true，且该字段设置为 true，MQTT 底层日志会和其它 SDK 日志同时上报

sdkMode :SDKMode

服务模式

取值：

  • server
  • server2

注意：

  • 云模式 cloudMode 设置为 public 时，该字段默认值为 server2；
  • 云模式 cloudMode 设置为 public_intl 时，强制使用 server2 模式，该字段无效；
  • 云模式 cloudMode 设置为 private 时，该字段默认值为 server。
Type:

projectId :number|string

项目 ID

Type:
  • number | string

remoteDeviceId :string

远端设备 ID

Type:
  • string

password :string

远端设备密码

Type:
  • string

loggerOption :object

SDK 日志配置

Type:
  • object
Properties
NameTypeAttributesDescription
showLogboolean<optional>

是否打印 SDK 日志

reportLogboolean<optional>

是否上传 SDK 日志

  • 云模式 cloudMode 设置为 public 或 public_intl 时，该字段无效。
logLevel'DEBUG' | 'LOG' | 'INFO' | 'WARN' | 'ERROR'<optional>

控制台打印的最低日志级别（含）。低于该级别的日志不打印。

级别从低到高：'DEBUG' < 'LOG' < 'INFO' < 'WARN' < 'ERROR'。 例如设置为 'WARN' 时，仅打印 WARN 与 ERROR 级别日志。需 showLog 为 true 时生效。

reportLevel'DEBUG' | 'LOG' | 'INFO' | 'WARN' | 'ERROR'<optional>

上报的最低日志级别（含）。低于该级别的日志不进入上报。

级别从低到高：'DEBUG' < 'LOG' < 'INFO' < 'WARN' < 'ERROR'。 例如设置为 'INFO' 时，仅上报 INFO/WARN/ERROR 级别日志。需 reportLog 为 true 时生效。

logfunction<optional>

自定义 log 级别的日志打印函数

errorfunction<optional>

自定义 error 级别的日志打印函数

warnfunction<optional>

自定义 warn 级别的日志打印函数

infofunction<optional>

自定义 info 级别的日志打印函数

debugfunction<optional>

自定义 debug 级别的日志打印函数

customMessageOption :object

自定义消息（onControlData）相关配置

Type:
  • object
Properties
NameTypeAttributesDescription
preferArrayBufferboolean<optional>

是否将 onControlData 回调中的 data 统一为 ArrayBuffer。

  • true：dataType 均为 'arrayBuffer'，data 均为 ArrayBuffer 类型。 业务方按字节解析即可，无需再根据 dataType 分支判断。
  • false（默认）：业务方需要根据 dataType 分支判断 data 的类型。

仅影响 SCTP DataChannel 通道（channelType: 'sctp'）的 onControlData 回调； MQTT 通道（channelType: 'mqtt'）始终按内容自适应判定，不受该开关影响。