tencent cloud

实时音视频

动态与公告
产品动态
产品近期公告
关于 TRTC Live 正式上线的公告
关于TRTC Conference 正式版上线的公告
Conference 商业化版本即将推出
关于多人音视频 Conference 开启内测公告
关于音视频通话 Call 正式版上线的公告
关于腾讯云音视频终端 SDK 播放升级及新增授权校验的公告
关于 TRTC 应用订阅套餐服务上线的相关说明
产品简介
产品概述
基本概念
产品功能
产品优势
应用场景
性能数据
购买指南
计费概述
免费时长说明
月订阅
现收现付
TRTC 逾期与暂停政策
常见问题解答
退款说明
新手指引
Demo 体验
视频通话 SDK
组件介绍
开通服务
跑通 Demo
快速接入
离线唤醒
会话聊天
云端录制
AI 降噪
界面定制
Chat 集成通话能力
更多特性
无 UI 集成
服务端 API
客户端 API
解决方案
错误码表
发布日志
常见问题
视频会议 SDK
组件介绍(TUIRoomKit)
开通服务(TUIRoomKit)
跑通 Demo(TUIRoomKit)
快速接入(TUIRoomKit)
屏幕共享(TUIRoomKit)
预定会议(TUIRoomKit)
会中呼叫(TUIRoomKit)
界面定制(TUIRoomKit)
虚拟背景(TUIRoomKit)
会议控制(TUIRoomKit)
云端录制(TUIRoomKit)
AI 降噪(TUIRoomKit)
会中聊天(TUIRoomKit)
机器人推流(TUIRoomKit)
更多特性(TUIRoomKit)
客户端 API(TUIRoomKit)
服务端 API(TUIRoomKit)
常见问题(TUIRoomKit)
错误码 (TUIRoomKit)
SDK更新日志(TUIRoomKit)
直播与语聊 SDK
Live 视频直播计费说明
组件介绍
开通服务(TUILiveKit)
跑通 Demo
无 UI 集成
UI 自定义
直播监播
视频直播
语聊房
高级功能
客户端 API
服务端 API
错误码
发布日志
常见问题
RTC Engine
开通服务
SDK 下载
API-Example
接入指引
API-参考手册
高级功能
AI 集成
概述
MCP 配置
Skills 配置
集成指南
常见问题
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
控制台指南
应用管理
套餐包管理
用量统计
监控仪表盘
开发辅助
解决方案
实时合唱
常见问题
迁移指南
计费相关
功能相关
UserSig 相关
应对防火墙限制相关
缩减安装包体积相关
Andriod 与 iOS 相关
Web 端相关
Flutter 相关
Electron 相关
TRTCCalling Web 相关
音视频质量相关
其他问题
旧版文档
RTC RoomEngine SDK(旧)
集成 TUIRoom (Web)
集成 TUIRoom (Android)
集成 TUIRoom (iOS)
集成 TUIRoom (Flutter)
集成 TUIRoom (Electron)
TUIRoom API 查询
实现云端录制与回放(旧)
监控仪表盘计费(旧)
协议与策略
安全合规认证
安全白皮书
信息安全说明
服务等级协议
苹果隐私策略:PrivacyInfo.xcprivacy
TRTC 政策
隐私协议
数据处理和安全协议
词汇表

TUICallEngine

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-02-26 14:17:51

TUICallEngine API 简介

TUICallEngine API 是音视频通话组件的无 UI 接口,如果 TUICallKit 的交互并不满足您的需求,您可以使用这套接口自己封装交互。

Overview

API
含义
创建 TUICallEngine 实例(单例模式)
销毁 TUICallEngine 实例(单例模式)
login
完成音视频通话基础能力的鉴权。
on
增加事件回调
off
移除回调接口
call
发起 1v1 通话
accept
接听通话
reject
拒绝通话
ignore
忽略通话
hangup
结束通话
切换通话媒体类型,比如视频通话切音频通话
开始订阅远端用户视频流
停止订阅远端用户视频流
开启摄像头
切换前后摄像头
关闭摄像头
打开麦克风
关闭麦克风
选择音频播放设备(听筒/扬声器)
设置用户视频画面的渲染模式
设置视频编码的编码参数
设置美颜级别,支持关闭默认美颜
设置用户的昵称、头像
开启/关闭 TUICallEngine 的多设备登录模式 (群组通话版套餐 支持)

API 详情

CreateInstance

创建 TUICallEngine 的单例。
TUICallKit.CreateInstance();

destroyInstance

销毁 TUICallEngine 的单例。
TUICallKit.destroyInstance();

login

初始化函数,请在使用所有功能之前先调用该函数,以便完成包含通话服务鉴权在内初始化动作。
login(
sdkAppId: number;
userId: string;
userSig: string;
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}
参数
类型
含义
sdkAppId
Number
您可以在实时音视频控制台 > 应用管理 > 应用信息中查看 SDKAppID
userId
String
当前用户的 ID,字符串类型,只允许包含英文字母(a-z 和 A-Z)、数字(0-9)、连词符(-)和下划线(_)
userSig
String
腾讯云设计的一种安全保护签名,获取方式请参见 如何计算及使用 UserSig

on

添加回调接口,您可以通过这个接口,监听TUICallObserver相关的事件回调。
on(type: TUICallEvent, listener: (params: any) => void): void {}
参数
类型
含义
type
监听 TUICallkit 的某个事件

off

移除回调接口。
off(type: TUICallEvent): void {}
参数
类型
含义
type
注销 TUICallkit 的某个事件

call

发起 1v1 或 多人通话。
call(
userId: string;
mediaType: MediaType;
callParams?: CallParams;
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}
参数
类型
含义
userId
string
目标用户的 userId
mediaType
MediaType
通话的媒体类型,例如:视频通话、语音通话
callParams
通话参数扩展字段,例如:房间号、通话邀请超时时间,离线推送自定义内容等

accept

接受当前通话,当您作为被叫收到 onCallReceived() 的回调时,可以调用该函数接听来电。
accept(
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}

reject

拒绝当前通话,当您作为被叫收到 onCallReceived() 的回调时,可以调用该函数拒绝来电。
reject(
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}

ignore

忽略当前通话,当您作为被叫收到 onCallReceived() 的回调时,可以调用该函数忽略来电,此时主叫会收到 onUserLineBusy 的回调。
备注:如果您的业务中存在直播、会议等场景,在直播/会议中的情况时,也可以调用这个函数来忽略此次来电。
ignore(
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}

hangup

挂断当前通话,当您处于通话中,可以调用该函数结束通话。
hangup(
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}

switchCallMediaType

切换视频通话到语音通话。
switchCallMediaType(mediaType: MediaType): void {}
参数
类型
含义
mediaType
MediaType
通话的媒体类型,比如视频通话、语音通话

startRemoteView

开始订阅远端用户的视频数据。
startRemoteView(
userId: string;
viewId: string;
onPlaying: (params: any) => void;
onLoading: (params: any) => void;
): void {}
参数
类型
含义
userId
string
目标用户的 userId
viewId
string
需要渲染的 view ID.

stopRemoteView

停止订阅远端用户的视频数据。
stopRemoteView(userId: string;): void {}
参数
类型
含义
userId
string
目标用户的 userId

openCamera

开启摄像头。
openCamera(
camera?: Camera;
viewId: string;
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;): void {}
参数
类型
含义
camera
Camera
前置/后置 摄像头
Camera.Front: 前置摄像头
Camera.Back: 后置摄像头
viewId
string
需要渲染画面的 view ID

switchCamera

切换前后摄像头。
switchCamera(camera: Camera): void {}
参数
类型
含义
camera
Camera
前置/后置 摄像头
Camera.Front: 前置摄像头
Camera.Back: 后置摄像头

closeCamera

关闭摄像头。
closeCamera(): void {}

openMicrophone

打开麦克风。
openMicrophone(
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}

closeMicrophone

关闭麦克风。
closeMicrophone(
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}

selectAudioPlaybackDevice

选择音频播放设备。
目前支持听筒、扬声器,在通话场景中,可以使用这个接口来开启/关闭免提模式。
selectAudioPlaybackDevice(
device: AudioPlaybackDevice;
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}
参数
类型
含义
device
听筒/扬声器
AudioPlaybackDevice.Earpiece:听筒
AudioPlaybackDevice.Speakerphone:扬声器

setVideoRenderParams

设置用户视频画面的渲染模式。
setVideoRenderParams(
userId: string;
videoRender?: {
fillMode?: FillMode;
rotation?: Rotation;
};
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}
参数
类型
含义
userId
string
目标用户的 userId
fillMode
FillMode
视频画面渲染参数,填充模式。详情请参考:FillMode
rotation
Rotation
视频画面渲染参数,画面旋转角度。
Rotation.Rotation_0:不旋转
Rotation.Rotation_90:顺时针旋转90度
Rotation.Rotation_180:顺时针旋转180度
Rotation.Rotation_270:顺时针旋转270度

setVideoEncoderParams

设置视频编码的编码参数。
该设置能够决定远端用户看到的画面质量,同时也能决定云端录制出的视频文件的画面质量。
setVideoEncoderParams(
videoEncoder?: {
resolution?: Resolution;
resolutionMode?: ResolutionMode;
};
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}
参数
类型
含义
resolution
视频编码的参数,分辨率。详情请参见 Resolution
resolutionMode
视频编码的参数,视频宽高比。详情请参见 ResolutionMode

setBeautyLevel

设置美颜级别,支持关闭默认美颜。
setBeautyLevel(
level: number;
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}
参数
类型
含义
level
number
美颜级别,取值范围 0 - 9; 0 表示关闭,9 表示效果最明显

setSelfInfo

设置用户昵称、头像。
用户昵称不能超过500字节,用户头像必须是 URL 格式。
setSelfInfo(
nickname: string;
avatar?: string;
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}
参数
类型
含义
nickname
string
用户昵称
avatar
string
用户头像(格式为 URL)

enableMultiDeviceAbility

开启/关闭 TUICallEngine 的多设备登录模式 (群组通话版套餐支持)。
enableMultiDeviceAbility(
enable: boolean;
onSuccess?: (data: String) => void;
onError?: (errCode: number, errMsg: string) => void;
): void {}
参数
类型
含义
enable
boolean
设置 TUICallEngine 是否开启多设备登录。

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백