帮你快速理解、总结文档立即下载

关键类型

最近更新时间:2025-06-25 15:45:22
我的收藏

CallParams

在 Tencent RTC 控制台通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等。
参数
类型
是否必填
含义
roomId
RoomId
否
房间 ID,详情请参考 RoomId。
timeout
Number
否
通话超时时间,默认:40s,单位:秒。timeout = 0,设置为不超时。
userData
String
否
发起通话时自定义扩展字段。
offlinePushInfo
否
自定义离线消息推送参数。
chatGroupId
String
否
与 chat 结合使用时, chat 群组的群 ID。

RoomId

房间 ID,分为 String 类型和 Number 类型。
参数
类型
是否必填
含义
strRoomId
String
否
房间 ID,String 类型。
intRoomId
Number
否
房间 ID,Number 类型。

OfflinePushInfo

厂商离线推送配置信息。
参数
类型
是否必填
含义
title
String
否
离线推送展示通知栏标题。
desc
String
否
离线推送展示通知栏内容。
ignoreIOSBadge
boolean
否
离线推送忽略 badge 计数(仅对 iOS 生效), 如果设置为 true,在 iOS 接收端,这条消息不会使 App 的应用图标未读计数增加。
iOSSound
String
否
离线推送声音设置(仅对 iOS 生效)。
当 sound = IOS_OFFLINE_PUSH_NO_SOUND,表示接收时不会播放声音。
当 sound = IOS_OFFLINE_PUSH_DEFAULT_SOUND,表示接收时播放系统声音。 如果要自定义 iOSSound,需要先把语音文件链接进 Xcode 工程,然后把语音文件名(带后缀)设置给 iOSSound。
androidSound
String
否
离线推送声音设置(仅对 Android 生效,IMSDK 6.1 及以上版本支持)。 只有华为和谷歌手机支持设置声音提示,小米手机设置声音提示,请您参见 小米自定义铃声。 另外,谷歌手机 FCM 推送在 Android 8.0 及以上系统设置声音提示,必须调用 setAndroidFCMChannelID 设置好 channelID,才能生效。
androidOPPOChannelID
String
否
离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID。
androidVIVOClassification
Number
否
VIVO 推送消息分类 (待废弃接口,vivo 推送服务于 2023 年 4 月 3 日优化消息分类规则,推荐使用 setAndroidVIVOCategory 设置消息类别)。
0:运营消息。
1:系统消息,默认取值为 1。
androidXiaoMiChannelID
String
否
小米手机 8.0 系统及以上的渠道 ID。
androidFCMChannelID
String
否
FCM 通道手机 8.0 系统及以上的渠道 ID。
androidHuaWeiCategory
String
否
华为推送消息分类,详细参见:华为消息分类标准。
isDisablePush
boolean
否
是否关闭推送(默认开启推送)。
iOSPushType
否
iOS 离线推送类型,默认:APNs。

IOSOfflinePushType

iOS 离线推送类型。
类型
含义
APNs
普通推送。
VoIP
VoIP 推送。

MediaType

通话类型。
类型
含义
Audio
语音通话。
Video
视频通话。

Camera

前置/后置 摄像头
类型
含义
Front
前置摄像头。
Back
后置摄像头。

AudioPlaybackDevice

音频设备
类型
含义
Earpiece
听筒。
Speakerphone
扬声器。

FillMode

视频画面的渲染参数
类型
含义
Fill
填充模式:即将画面内容居中等比缩放以充满整个显示区域,超出显示区域的部分将会被裁剪掉,此模式下画面可能不完整。
Fit
适应模式:即按画面长边进行缩放以适应显示区域,短边部分会被填充为黑色,此模式下图像完整但可能留有黑边。

Rotation

视频画面旋转方向
类型
含义
Rotation_0
不旋转。
Rotation_90
顺时针旋转90度。
Rotation_180
顺时针旋转180度。
Rotation_270
顺时针旋转270度。

Resolution

视频分辨率
类型
含义
Resolution_640_360
宽高比 16:9;分辨率 640x360;建议码率(VideoCall)500kbps。
Resolution_640_480
宽高比 4:3;分辨率 640x480;建议码率(VideoCall)600kbps。
Resolution_960_540
宽高比 16:9;分辨率 960x540;建议码率(VideoCall)850kbps。
Resolution_960_720
宽高比 4:3;分辨率 960x720;建议码率(VideoCall)1000kbps。
Resolution_1280_720
宽高比 16:9;分辨率 1280x720;建议码率(VideoCall)1200kbps。
Resolution_1920_1080
宽高比 16:9;分辨率 1920x1080;建议码率(VideoCall)2000kbps。

ResolutionMode

视频宽高比模式
类型
含义
Landscape
横屏分辨率,例如:Resolution.Resolution_640_360 + ResolutionMode.Landscape = 640 × 360。
Portrait
竖屏分辨率,例如:Resolution.Resolution_640_360 + ResolutionMode.Portrait = 360 × 640。