TUICallEngine

最近更新时间:2024-01-17 10:47:12

我的收藏

TUICallEngine API 简介

TUICallEngine API 是音视频通话组件的无 UI 接口,如果 TUICallKit 的交互并不满足您的需求,您可以使用这套接口实现交互。目前仅提供如下接口,如有需求可到这里 反馈
注意:
需要结合 腾讯云音视频通话插件 TencentCloud-TUICallKit 插件使用,不能单独使用。下述接口也是结合客户有自动挂断、设置渲染模式的需求下,才支持的。

API 概览

API
描述
hangup
结束通话
accept
接听通话
设置用户视频画面的渲染模式
设置视频编码的编码参数

API 详情

hangup

挂断当前通话,当您处于通话中,可以调用该函数结束通话。
const TUICallEngine = uni.requireNativePlugin('TencentCloud-TUICallKit-TUICallEngine');
TUICallEngine.hangup();

accept

接受当前通话,当您作为被叫收到 onCallReceived() 的回调时,可以调用该函数接听来电。
const TUICallEngine = uni.requireNativePlugin('TencentCloud-TUICallKit-TUICallEngine');
TUICallEngine.accept();

setVideoRenderParams

设置用户视频画面的渲染模式。
const TUICallEngine = uni.requireNativePlugin('TencentCloud-TUICallKit-TUICallEngine');
const params = {
userID: '234',
fillMode: 0, // 0-填充模式,1一适应模式
rotation: 1, // 0~3分别对应值:Rotation_0, Rotation_90, Rotation_180, Rotation_270;
};
TUICallEngine.setVideoRenderParams(params, (res) => {
console.warn('res = ', JSON.stringify(res));
});
参数如下表所示:
参数
类型
含义
userID
String
目标用户的 userID
params
Object
视频画面渲染参数,例如:画面旋转角度、填充模式

setVideoEncoderParams

设置视频编码的编码参数。
该设置能够决定远端用户看到的画面质量,同时也能决定云端录制出的视频文件的画面质量。
const TUICallEngine = uni.requireNativePlugin('TencentCloud-TUICallKit-TUICallEngine');
const params = {
resolution: 108,
resolutionMode: 0, // 0--横屏,1--竖屏
};
TUICallEngine.setVideoEncoderParams(params, (res) => {
console.warn('res = ', JSON.stringify(res));
});
参数如下表所示:
参数
类型
含义
resolution
Number
视频分辨率
62 -- 宽高比 16:9;分辨率 640x360;
64 -- 宽高比 4:3;分辨率 960x720;
108 -- 宽高比 16:9;分辨率 640x360;
110 -- 宽高比 16:9;分辨率 960x540;
112 -- 宽高比 16:9;分辨率 1280x720;
114 -- 宽高比 16:9;分辨率 1920x1080;
resolutionMode
Number
分辨率模式(横屏分辨率 or 竖屏分辨率)
0-Landscape(横屏)
1-Portrait(竖屏)