主入口（ISDPRTC）
本章节介绍了Web SDK的ISDPRTC接口详情。
|
序号 |
接口 |
描述 |
|---|---|---|
|
1 |
checkSystemRequirements |
检测浏览器是否兼容ISDPRTC Web SDK。 |
|
2 |
VERSION |
获取ISDPRTC Web SDK版本。 |
|
3 |
getDevices |
获取媒体输入输出设备列表。 |
|
4 |
createClient |
创建一个实时音视频通话的客户端对象。一个client对应于一个房间。 |
|
5 |
createStream |
创建一个本地流对象。 |
表7.3.4.1-1主入口接口
checkSystemRequirements
(static) checkSystemRequirements(): Promise<boolean>
【功能说明】
检测浏览器是否兼容ISDPRTC Web SDK。
【请求参数】
无
【返回参数】
true：浏览器兼容ISDPRTC Web SDK。
如果不兼容，则返回Error异常。
VERSION
VERSION
【功能说明】
获取ISDPRTC Web SDK版本。
【请求参数】
无
【返回参数】
字符串，SDK当前版本号。
getDevices
(static) getDevices(): Promise.<Array.<MediaDeviceInfo>>
【功能说明】
获取媒体输入输出设备列表。在用户未授权摄像头或麦克风访问权限之前，“label”及“deviceId”可能为空。因此建议在用户授权访问后，再调用此接口获取设备列表。
授权浏览器的摄像头/麦克风访问权限的方法，请参见授权浏览器摄像头/麦克风访问权限的方法。
【请求参数】
无
【返回参数】
Promise.<Array.<MediaDeviceInfo>>：媒体输入输出设备列表。MediaDeviceInfo为Web API基本接口。
createClient
(static)createClient(config: ClientConfig): Client
【功能说明】
创建一个实时音视频通话的客户端对象。一个客户端对象只能同时加入一个房间。可以创建多个客户端对象同时加入多个房间。
【请求参数】
config：必选，ClientConfig类型, 客户端对象配置信息。
ClientConfig定义为：{
appId：必选，string[128]类型，应用的APP ID。
domain：必选，string[128]类型，服务器的域名，只有App ID相同的应用程序才能进入同一个房间进行互通。
}
domain和appId请向ISDP+申请。
【返回参数】
Client：客户端对象。
createStream
(static) createStream(config: StreamConfig): Stream
【功能说明】
创建本地流对象。
【请求参数】
config: 必选，StreamConfig类型，指定创建流的参数。
StreamConfig定义为： {
video：可选，boolean类型，指定是否采集主流的视频，主流即摄像头的流。默认值为false。screen为false的时候该参数有效。
audio：可选， boolean类型，指定是否采集主流的音频。默认值为false。screen为false的时候该参数有效。
microphoneId：可选， string类型，在audio为true的时候有效，表示采集音频的源麦克风设备Id。如果不传，系统自动设置默认值。
cameraId：可选，string类型，在video为true的时候有效，表示采集视频的摄像头设备Id。如果不传系统自动设置默认值。
userId：可选，string类型，表示该流归属的userId。
}
【返回参数】
Stream：流对象。
