CloudHub 文档中心
下载中心 文档中心

RTC 实时音视频


CloudHub JSSDK

CloudHubRTC 的说明以及接口

获取 SDK 版本

CloudHub JSSDK 的版本号, VERSION: string

CloudHubRTC.VERSION

CloudHubRTC 的日志模块

日志级别:

日志模块方法

setLogLevel

方法作用: 设置 SDK 的日志输出级别。

setLogLevel(level: DEBUG | INFO | WARNING | ERROR | NONE): void
名称类型描述
levelinteger开发者设置的日志过滤级别,默认为 INFO

debug

方法作用: 打印 debug 日志。

debug(...args): void

eg:

CloudHubRTC.Logger.debug("this is debug log");

info

方法作用: 打印 info 日志。

info(...args): void

eg:

CloudHubRTC.Logger.info("this is info log");

warning

方法作用: 打印 warning 日志。

warning(...args): void

eg:

CloudHubRTC.Logger.warning("this is warning log");

error

方法作用: 打印 error 日志。

error(...args): void

eg:

CloudHubRTC.Logger.error("this is error log");

CloudHubRTC 的方法

方法汇总如下:

checkSystemRequirements

方法作用: 检查 JSSDK 对正在使用的浏览器的适配情况。 您需要在创建客户端对象 (createClient) 之前调用该方法,用以检查 JSSDK 对正在使用的浏览器的适配情况。

checkSystemRequirements(codec: string, onCallback:function): void

// example
CloudHubRTC.checkSystemRequirements('vp8', function(issupport, errinfo){
    console.info('checkSystemRequirements', issupport, errinfo);
})
名称类型描述
codecstring编码方式,编码方式有”vp8” 和”h264”,缺省为 “vp8”
onCallbackfunction回调函数,回调参数携带 issupport 和 errinfo。 **Note:**issupport 为 true 表示支持,false 表示不支持。

Note:

createClient

方法作用: 用于创建客户端,在每次会话里仅调用一次。

createClient(config: ClientConfig): Client

// example
CloudHubRTC.createClient(config)
名称类型描述
configobject定义客户端的属性 ClientConfig。
ClientConfig: 详情查看 CloudHubRTC 数据对象文档 的 ClientConfig 说明

createStream

方法作用: 创建并返回音视频流对象。 请确保创建流前将上一个相同流 ID 的流进行销毁。

createStream(spec: StreamSpec): Stream

// example
CloudHubRTC.createStream(spec);
名称类型描述
specobject定义音视频流对象的属性 StreamSpec。
StreamSpec: 详情查看 CloudHubRTC 数据对象文档 的 StreamSpec 说明
注意:StreamSpec 的 type 和 uid 是必填项,如果不填则 createStream 返回 undefined。

getDeviceManager

方法作用: 获取设备管理类。

getDeviceManager(): DeviceManager

// example
CloudHubRTC.getDeviceManager();

setSdkLogConfig

方法作用: 设置 sdk 内部日志打印的配置。

setSdkLogConfig(config:object): void

// example
CloudHubRTC.setSdkLogConfig({level: CloudHubRTC.Logger.INFO});

名称类型描述
configobjectsdk 内部日志配置如下:
level?:number 日志级别,SDK 默认的日志级别为 CloudHubRTC.Logger.INFO。