tencent cloud

Sample code:

rtcClient.startQuestionTime(classId)

raiseHand()

This API is used by the student to raise hand. The student sends a raise hand notification, which will be received by the teacher.
Parameters: none
Sample code:

rtcClient.raiseHand()

inviteToPlatform(userID: string)

This API is used by the teacher to invite a student to answer a question. The teacher selects the userID of a student in the "raise hand" list and sends an invitation notification. The invited student will receive the invitation event and mic on. If no student raises hand, the teacher can directly select a student. The selected student will receive the answering invitation event and mic on.
Parameters:

Sample code:

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

finishAnswering(userID: string)

This API is used to end answering. The teacher ends answering by the student. The student receives the answering end notification and exits co-anchoring.
Parameters:

Sample code:

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

stopQuestionTime(classId: number)

This API is used to stop Q&A. The teacher stops Q&A, and students receive the Q&A stop notification. The co-anchoring student needs to stop co-anchoring and disable the "raise hand" feature.
Parameters:

Sample code:

rtcClient.stopQuestionTime(classId)

Push/Pull APIs

getScreenShareList()

This API is used to get the list of windows for screen sharing.
Parameters: none
Sample code:

rtcClient.getScreenShareList();

startScreenCapture(source: SourceParam)

This API is used to select the shared screen and start push.
Parameters:

Sample code:

interface SourceParam {
 type: number; // Capturing source type
 sourceId: string; // Capturing source ID
 sourceName: string; // Capturing source name encoded in UTF-8
}
rtcClient.startScreenCapture({
  type,
  sourceId,
  sourceName
})

startRemoteView(params: RemoteParams)

This API is used to start displaying the remote video image or screen sharing image.
Parameters:

Sample code:

interface RemoteParams {
 userID: string; // User ID
 streamType: number; // Image type. 1: big image; 2: small image; 3: screen sharing
 view: HTMLElement; // DOM that carries the displayed image
}
const view = document.getElementById('localVideo');
rtcClient.startRemoteView({
 userID: userID,
 streamType: 1,// 1: big image; 2: small image; 3: screen sharing
 view: view
});

stopRemoteView(params: StopRemoteParams)

This API is used to stop displaying the remote video image or screen sharing image and pulling the data stream from the remote user.
Parameters:

Sample code:

interface StopRemoteParams {
 userID: string; // User ID
 streamType: number; // Image type. 1: big image; 2: small image; 3: screen sharing
}
rtcClient.stopRemoteView({
  userID: userID,
  streamType: 1 // 1: big image; 2: small image; 3: screen sharing
});

Message sending/receiving APIs

sendTextMessage(params: MessageParams)

This API is used to send a message in the chat room.
Parameters:

Sample code:

interface MessageParams {
 classId: number; // Classroom ID
 message: string; // Message text
}
rtcClient.sendTextMessage(params).then(() => {
})

sendCustomMessage(userID: string, data: string)

This API is used to send a custom C2C message.
Parameters:

Sample code:

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

sendGroupCustomMessage(classId: number, data: string)

This API is used to send a custom group message.
Parameters:

Sample code:

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

Device operation APIs

openCamera(view: HTMLElement)

This API is used to enable the camera.
Parameters:

Sample code:

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

closeCamera()

This API is used to disable the camera.
Parameters: none
Sample code:

rtcClient.closeCamera();

getCameraList()

This API is used to get the list of cameras.
Parameters: none
Sample code:

rtcClient.getCameraList()

setCurrentCamera(deviceId:string)

This API is used to set the camera. The parameter is a device ID obtained from getCameraDevicesList.
Parameters:

Sample code:

rtcClient.setCurrentCamera(deviceId)

openMicrophone()

This API is used to enable the mic.
Parameters: none
Sample code:

rtcClient.openMicrophone();

closeMicrophone()

This API is used to disable the mic.
Parameters: none
Sample code:

rtcClient.closeMicrophone();

getMicrophoneList()

This API is used to get the list of mics.
Parameters: none
Sample code:

rtcClient.getMicrophoneList()

setCurrentMicDevice(micId:string)

This API is used to set the mic. The parameter is a device ID obtained from getMicDevicesList.
Parameters:

Sample code:

rtcClient.setCurrentMicDevice(micId)

setBeautyStyle(params: BeautyParams)

This API is used to set the effect levels of beauty, brightening, and rosy skin filters.
Parameters:

Sample code:

interface BeautyParams {
 beautyStyle: number;// Smooth or natural
 beauty: number; // Effect level of beauty filter
 white: number; // Effect level of brightening filter
 ruddiness: number; // Effect level of rosy skin filter
}
rtcClient.setBeautyStyle({
beautyStyle: 1,
beauty: 5,
white: 5,
ruddiness: 5
})

Component Events

Sample code

const EVENT = rtcClient.EVENT
rtcClient.on(EVENT.STUDENT_RAISE_HAND, () => {
  // A student raises hand
})

Detailed events