tencent cloud

示例：

rtcClient.startQuestionTime(classId)

raiseHand()

学生举手，学生发送举手通知，老师端收到学生举手通知。
参数：无
示例：

rtcClient.raiseHand()

inviteToPlatform(userID: string)

老师邀请学生上台回答，老师端选择举手列表里的学生 userID ，发送邀请通知，学生端收到邀请上台回答事件，受邀请的学生开麦。如果没有学生举手，老师直接点名回答，学生端收到邀请上台回答事件，被点名的学生开麦。
参数：

示例：

rtcClient.inviteToPlatform(userID).then(() => {
})

finishAnswering(userID: string)

结束回答，老师端结束学生端回答，学生收到结束回答的通知，指定的学生停止连麦。
参数：

示例：

rtcClient.finishAnswering(userID).then(() => {
})

stopQuestionTime(classId: number)

停止问答时间，老师端停止问答时间，学生端收到停止回答时间的通知，已连麦的学生要停止连麦，关闭举手功能。
参数：

示例：

rtcClient.stopQuestionTime(classId)

推拉流操作相关函数

getScreenShareList()

获取屏幕分享窗口列表。
参数：无
示例：

rtcClient.getScreenShareList();

startScreenCapture(source: SourceParam)

选择分享屏幕，开始推流。
参数：

示例：

interface SourceParam {
 type: number; // 采集源类型
 sourceId: string; // 采集源 ID
 sourceName: string; // 采集源名称，UTF8 编码
}
rtcClient.startScreenCapture({
  type,
  sourceId,
  sourceName
})

startRemoteView(params: RemoteParams)

开始显示远端视频画面或屏幕分享画面。
参数：

示例：

interface RemoteParams {
 userID: string; // 用户 ID
 streamType: number; // 画面类型,1-大画面，2-小画面，3-屏幕分享
 view: HTMLElement; //承载显示画面的 DOM
}
const view = document.getElementById('localVideo');
rtcClient.startRemoteView({
 userID: userID,
 streamType: 1,//1-大画面，2-小画面，3-屏幕分享
 view: view
});

stopRemoteView(params: StopRemoteParams)

停止显示远端视频画面或屏幕分享画面，同时不再拉取该远端用户的数据流。
参数：

示例：

interface StopRemoteParams {
 userID: string; // 用户 ID
 streamType: number; // 画面类型,1-大画面，2-小画面，3-屏幕分享
}
rtcClient.stopRemoteView({
  userID: userID,
  streamType: 1 //1-大画面，2-小画面，3-屏幕分享
});

消息收发相关函数

sendTextMessage(params: MessageParams)

发送聊天室消息。
参数：

示例：

interface MessageParams {
 classId: number; // 教室 ID
 message: string; // 消息文本
}
rtcClient.sendTextMessage(params).then(() => {
})

sendCustomMessage(userID: string, data: string)

发送自定义 C2C 消息。
参数：

示例：

rtcClient.sendCustomMessage(userID, JSON.stringify(params)

sendGroupCustomMessage(classId: number, data: string)

发送自定义群组消息。
参数：

示例：

rtcClient.sendGroupCustomMessage(classId, JSON.stringify(params))

设备操作相关函数

openCamera(view: HTMLElement)

打开摄像头。
参数：

示例：

const domEle = document.getElementById('localVideo');
rtcClient.openCamera(domEle);

closeCamera()

关闭摄像头。
参数：无
示例：

rtcClient.closeCamera();

getCameraList()

获取摄像头列表。
参数：无
示例：

rtcClient.getCameraList()

setCurrentCamera(deviceId:string)

设置摄像头，参数是从 getCameraDevicesList 中得到的设备 ID。
参数：

示例：

rtcClient.setCurrentCamera(deviceId)

openMicrophone()

打开麦克风。
参数：无
示例：

rtcClient.openMicrophone();

closeMicrophone()

关闭麦克风。
参数：无
示例：

rtcClient.closeMicrophone();

getMicrophoneList()

获取麦克风设备列表。
参数：无
示例：

rtcClient.getMicrophoneList()

setCurrentMicDevice(micId:string)

设置麦克风，参数是从 getMicDevicesList 中得到的设备 ID。
参数：

示例：

rtcClient.setCurrentMicDevice(micId)

setBeautyStyle(params: BeautyParams)

设置美颜、美白、红润效果级别。
参数：

示例：

interface BeautyParams {
 beautyStyle: number;//光滑、自然
 beauty: number; //美颜级别
 white: number; //美白级别
 ruddiness: number; //红润级
}
rtcClient.setBeautyStyle({
beautyStyle: 1,
beauty: 5,
white: 5,
ruddiness: 5
})

组件事件

示例

const EVENT = rtcClient.EVENT
rtcClient.on(EVENT.STUDENT_RAISE_HAND, () => {
  //学生举手
})

详细事件