tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
即时通信 IM
    文档
    Download PDF

    类型定义

    最后更新时间：2023-07-04 14:51:04
    下载PDF

      常用结构

      TUICallDefine

      类型
      描述
      通话参数
      离线推送厂商配置信息

      TUICommonDefine

      类型
      描述
      TUIRoomId
      通话中音视频房间 ID
      网络质量
      视频画面的渲染参数
      视频编码参数

      枚举定义

      TUICallDefine

      类型
      说明
      通话类型
      通话角色
      通话状态
      通话场景
      iOS 离线推送类型

      TUICommonDefine

      类型
      说明
      音频设备
      TUICamera
      摄像头类型
      网络质量
      视频画面填充模式
      视频画面旋转方向
      视频宽高比模式
      视频分辨率

      TUICallParams

      通话参数
      参数
      类型
      描述
      roomId
      TUIRoomId
      通话中音视频房间ID
      offlinePushInfo
      厂商离线推送配置信息
      timeout
      int
      通话超时时间，默认：30s，单位：秒
      userData
      NSString
      发起通话时自定义扩展字段，被叫端在 onCallReceived 中回调

      TUIOfflinePushInfo

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

      TUIRoomId

      通话中音视频房间ID
      (1) intRoomId 与 strRoomId 是互斥的，若您选用 strRoomId，则 intRoomId 需要填写为 0。若两者都填，SDK 将优先选用 intRoomId。
      (2) 不要混用 intRoomId 和 strRoomId，因为它们之间是不互通的，比如数字123和字符串123是两个完全不同的房间。
      参数
      类型
      描述
      intRoomId
      UInt32
      数字房间号 取值范围 1 - 2147483647(2^31-1)
      strRoomId
      NSString
      字符串房间号 推荐取值 限制长度为 64 字节。以下为支持的字符集范围（共 89 个字符）: 大小写英文字母（a-zA-Z）； 数字（0-9）；
      空格、!、#、$、%、&、(、)、+、-、:、;、<、=、.、>、?、@、[、]、^、_、{、}、|、~、,。
      注意：
      字符串房间号目前只支持 Android 和 iOS 平台，Web、小程序、Flutter、Uniapp 等其他平台后续支持，敬请期待！

      TUINetworkQualityInfo

      用户网络质量
      类型
      类型
      描述
      userId
      NSString
      用户 ID
      quality
      网络质量

      TUIVideoRenderParams

      视频画面的渲染参数
      参数
      类型
      描述
      fillMode
      视频画面填充模式
      rotation
      视频画面旋转方向

      TUIVideoEncoderParams

      视频编码参数
      参数
      类型
      描述
      resolution
      视频分辨率
      resolutionMode
      视频宽高比

      TUICallMediaType

      通话类型
      类型
      取值
      描述
      TUICallMediaTypeUnknown
      0
      未知类型
      TUICallMediaTypeAudio
      1
      语音通话
      TUICallMediaTypeVideo
      2
      视频通话

      TUICallRole

      通话角色
      类型
      取值
      描述
      TUICallRoleNone
      0
      未知类型
      TUICallRoleCall
      1
      主叫（邀请方）
      TUICallRoleCalled
      2
      被叫（被邀请方）

      TUICallStatus

      通话状态
      类型
      取值
      描述
      TUICallStatusNone
      0
      未定义
      TUICallStatusWaiting
      1
      通话等待中
      TUICallStatusAccept
      2
      通话已接听

      TUICallScene

      通话场景
      类型
      取值
      描述
      TUICallSceneGroup
      0
      群组通话
      TUICallSceneMulti
      1
      匿名群组通话（暂不支持，敬请期待）
      TUICallSceneSingle
      2
      单人通话

      TUICallIOSOfflinePushType

      iOS离线推送类型
      类型
      取值
      描述
      TUICallIOSOfflinePushTypeAPNs
      0
      普通推送
      TUICallIOSOfflinePushTypeVoIP
      1
      VoIP 推送

      TUIAudioPlaybackDevice

      音频设备
      类型
      取值
      描述
      TUIAudioPlaybackDeviceSpeakerphone
      0
      扬声器
      TUIAudioPlaybackDeviceEarpiece
      1
      听筒

      TUICamera

      前置/后置 摄像头
      类型
      取值
      描述
      TUICameraFront
      0
      前置摄像头
      TUICameraBack
      1
      后置摄像头

      TUINetworkQuality

      网络质量
      类型
      取值
      描述
      TUINetworkQualityUnknown
      0
      未定义
      TUINetworkQualityExcellent
      1
      当前网络非常好
      TUINetworkQualityGood
      2
      当前网络比较好
      TUINetworkQualityPoor
      3
      当前网络一般
      TUINetworkQualityBad
      4
      当前网络较差
      TUINetworkQualityVbad
      5
      当前网络很差
      TUINetworkQualityDown
      6
      当前网络不满足通话的最低要求

      TUIVideoRenderParamsFillMode

      视频画面填充模式
      类型
      取值
      描述
      TUIVideoRenderParamsFillModeFill
      0
      填充模式：即将画面内容居中等比缩放以充满整个显示区域，超出显示区域的部分将会被裁剪掉，此模式下画面可能不完整
      TUIVideoRenderParamsFillModeFit
      1
      适应模式：即按画面长边进行缩放以适应显示区域，短边部分会被填充为黑色，此模式下图像完整但可能留有黑边

      TUIVideoRenderParamsRotation

      视频画面旋转方向
      类型
      取值
      描述
      TUIVideoRenderParamsRotation_0
      0
      不旋转
      TUIVideoRenderParamsRotation_90
      1
      顺时针旋转90度
      TUIVideoRenderParamsRotation_180
      2
      顺时针旋转180度
      TUIVideoRenderParamsRotation_270
      3
      顺时针旋转270度

      TUIVideoEncoderParamsResolutionMode

      视频宽高比模式
      类型
      取值
      描述
      TUIVideoEncoderParamsResolutionModeLandscape
      0
      横屏分辨率，例如：TUIVideoEncoderParamsResolution_640_360 + TUIVideoEncoderParamsResolutionModeLandscape = 640 × 360
      TUIVideoEncoderParamsResolutionModePortrait
      1
      竖屏分辨率，例如：TUIVideoEncoderParamsResolution_640_360 + TUIVideoEncoderParamsResolutionModePortrait = 360 × 640

      TUIVideoEncoderParamsResolution

      视频分辨率
      类型
      取值
      描述
      TUIVideoEncoderParamsResolution_640_360
      108
      宽高比 16:9；分辨率 640x360；建议码率（VideoCall）500kbps
      TUIVideoEncoderParamsResolution_640_480
      62
      宽高比 4:3；分辨率 640x480；建议码率（VideoCall）600kbps
      TUIVideoEncoderParamsResolution_960_540
      110
      宽高比 16:9；分辨率 960x540；建议码率（VideoCall）850kbps
      TUIVideoEncoderParamsResolution_960_720
      64
      宽高比 4:3；分辨率 960x720；建议码率（VideoCall）1000kbps
      TUIVideoEncoderParamsResolution_1280_720
      112
      宽高比 16:9；分辨率 1280x720；建议码率（VideoCall）1200kbps
      TUIVideoEncoderParamsResolution_1920_1080
      114
      宽高比 16:9；分辨率 1920x1080；建议码率（VideoCall）2000kbps
      
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款