实现音视频通话
简要说明
- 快速创建并进入房间,开始音视频通话;代码部分均为 arkTS 代码,详细代码请参考 API-Demo 代码。
1. 初始化SDK
初始化是整个SDK的使用基础,通常在程序启动的时候进行实例的创建(create),退出后进行销毁实例(destroy)操作,整个程序的生命周期中只进行一次初始化和反初始化。
//初始化 sdkUsePath 是SDK工作目录,用于存储配置文件、临时文件等。
import { CRVideoSDKEx } from '@cloudroom/harmony_rtcsdk';
const cacheDir = getContext().getApplicationContext().cacheDir; //获取缓存目录
let sdk_engine = CRVideoSDKEx.create(cacheDir, JSON.stringify({
Timeout: 120000, //网络通信超时时间,单位是毫秒,取值范围:10000-120000, 缺省值:60000(60秒)
}));
设置回调函数
import { CRVideoSDKCallBack } from '@cloudroom/harmony_rtcsdk';
const CallbackObj: CRVideoSDKCallBack = {
//登录结果回调
loginRslt: (sdkErr) => {
//...
},
//通知掉线回调 可以弹出提示,或调用登录接口再次重试登录
notifyLineOff: (sdkErr) => {
//...
},
//创建房间成功
createMeetingSuccess: (roomID) => {
//...
},
//创建房间失败
createMeetingFail: (sdkErr) => {
//...
},
//进入房间的完成响应
enterMeetingRslt: (sdkErr) => {
//...
}
}
sdk_engine.on('loginRslt', CallbackObj.loginRslt); //订阅回调函数
sdk_engine.off('loginRslt', CallbackObj.loginRslt); //注销回调函数
说明:
调用SDK接口前,应先订阅SDK回调消息,以便接收SDK回调消息
伴随SDK销毁时,应同时销毁所有监听器
如果在多处订阅了同一个回调事件,SDK不会覆盖原有事件,各个回调函数都会进入
相关API请参考:
2. 登录连接视频服务器
设置视频服务器地址,然后使用appID和md5加密后的appSecret登录。(获取App ID及App Secret)
- 调用接口:
//如果使用云服务时填sdk.cloudroom.com,使用私有化部署的服务器时要填部署的服务器地址;
//此处以云服务为例。
import { CRVSDK_AUTHTYPE, CRVSDK_WEBPROTOCOL } from '@cloudroom/harmony_rtcsdk';
sdk_engine.login({
sdkAuthType: CRVSDK_AUTHTYPE.CRVSDK_AUTHTP_SECRET,
serverAddr: "sdk.cloudroom.com",
appID: AppID,
md5_appSecret: MD5.digestSync(AppSecret),
token: '',
userID: "userID",
nickName: "昵称",
webProtocol: CRVSDK_WEBPROTOCOL.CRVSDK_WEBPTC_HTTPS,
userAuthCode: ''
});
- 回调通知:
//登录结果
sdk_engine.on('loginRslt', (sdkErr, cookie) => {
//若失败 可以弹出错误提示,或调用登录接口再次重试登录
if (sdkErr !== CRVSDK_ERR_DEF.CRVSDKERR_NOERR) {
console.log(`登录失败(错误码: ${sdkErr})`)
return;
}
console.log('登录成功')
});
//通知掉线 可以弹出提示,或调用登录接口再次重试登录
sdk_engine.on("notifyLineOff", (sdkErr) => {
console.log(`与服务器的连接中断!(错误码: ${sdkErr})`);
})
相关API请参考:
3. 创建房间
- 调用接口:
//创建房间
sdk_engine.createMeeting();
- 回调通知:
//创建房间成功
sdk_engine.on("createMeetingSuccess", (meetID, cookie) => {
console.log(`创建房间成功,房间号:${meetID}`)
})
//创建房间失败
sdk_engine.on("createMeetingFail", (sdkErr, cookie) => {
console.log(`创建房间失败(错误码: ${sdkErr})`);
})
相关API请参考:
4. 进入房间
用创建成功的房间信息(房间ID)进入房间,其他用户也是利用此房间信息进入该房间。
- 调用接口:
//进入房间
sdk_engine.enterMeeting(meetID);
- 回调通知处理:
//进入房间的完成响应
sdk_engine.on("enterMeetingRslt", (sdkErr) => {
//若失败 可以弹出错误提示,或调用登录接口再次重试登录
if (sdkErr !== CRVSDK_ERR_DEF.CRVSDKERR_NOERR) {
console.log(`进入房间失败(错误码: ${sdkErr})`)
return;
}
console.log('进入房间成功')
})
//监控房间结束
sdk_engine.on("notifyMeetingStopped", () => {
console.log('房间已结束')
})
相关API请参考:
5. 打开麦克风/摄像头
进入房间成功后,打开自己的麦克风和摄像头,以便本地、远端显示自己的视频图像
//打开自己的麦克风
sdk_engine.openMic(myUserID);
//打开自己的摄像头
sdk_engine.openVideo(myUserID);
相关API请参考:
6. 观看自己/他人视频
成功进入房间后,根据自己/他人登录id ,设置并观看其视频图像
import { CRMeetingMember, CRVSDK_STREAM_VIEWTYPE } from '@cloudroom/harmony_rtcsdk';
import { util } from '@kit.ArkTS';
@Component
struct VideoCall {
@State memberList: CRMeetingMember[] = []
aboutToAppear(): void {
//从会议中取到所有参会者,然后按业务逻辑选取想观看他人视频;(以下代码是观看所有人的视频)
this.memberList = sdk_engine.getAllMembers();
}
build() {
Grid() {
ForEach(this.memberList, (member: CRMeetingMember) => {
GridItem() {
VideoComponent({
canvas: {
canvasId: util.generateRandomUUID(),
type: CRVSDK_STREAM_VIEWTYPE.CRVSDK_VIEWTP_VIDEO,
videoId: { userID: member.userId, videoID: -1 },
}
}).width('33.3333%')
}
}, (item: CRMeetingMember) => item.userId)
}
.layoutDirection(GridDirection.Column)
.columnsGap(10)
.rowsGap(10)
.padding(10)
}
}
VideoComponent组件是一个自行封装的组件,封装方法请参考封装视图容器
相关API请参考:
7.退出房间
//退出房间
sdk_engine.exitMeeting();
相关API请参考:
8.注销登录
//注销本次登录
sdk_engine.logout();
相关API请参考:
9.销毁实例
执行反销毁后SDK功能不再可用。
//反初始化
sdk_engine.destroy();
sdk_engine = null;
相关API请参考: