tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
实时音视频
    文档
    Download PDF

    TUIRoomEngine Defines

    最后更新时间：2024-09-11 16:37:31
    下载PDF
      本文介绍 TUIRoomEnigne Electron 端类型定义。

      枚举值

      TUIRole

      用户角色，TUIRoomEngine 共提供三种用户角色，分别是主持人，管理员，普通用户。
      枚举项
      类型
      说明
      kRoomOwner
      number
      主持人角色
      kAdministrator
      number
      管理员角色
      kGeneralUser
      number
      普通用户角色

      TUIVideoQuality

      视频分辨率。
      枚举项
      类型
      说明
      kVideoQuality_360p
      number
      低清，分辨率为 640 * 360
      kVideoQuality_540p
      number
      标清，分辨率为 960 * 540
      kVideoQuality_720p
      number
      高清，分辨率为 1280 * 720
      kVideoQuality_1080p
      number
      超清，分辨率为 1920 * 1080

      TUIResolutionMode

      分辨率模式（横屏分辨率｜竖屏分辨率）。
      枚举项
      类型
      说明
      kResolutionMode_Landscape
      number
      横屏模式
      kResolutionMode_Portrait
      number
      竖屏模式

      TUIAudioQuality

      音频分辨率。
      枚举项
      类型
      说明
      kAudioProfileSpeech
      number
      语音模式
      kAudioProfileDefault
      number
      标准模式（默认模式）
      kAudioProfileMusic
      number
      音乐模式

      TUIVideoStreamType

      视频流类型。
      枚举项
      类型
      说明
      kCameraStream
      number
      摄像头视频流
      kScreenStream
      number
      屏幕分享视频流
      kCameraStreamLow
      number
      低清摄像头视频流

      TUINetworkQuality

      网络状态。
      枚举项
      类型
      说明
      kQualityUnknown
      number
      网络状况未知
      kQualityExcellent
      number
      网络状况极佳
      kQualityGood
      number
      网络状况较好
      kQualityPoor
      number
      网络状况一般
      kQualityBad
      number
      网络状况差
      kQualityVeryBad
      number
      网络状况极差
      kQualityDown
      number
      网络连接已断开

      TUIRoomType

      房间类型。
      枚举项
      类型
      说明
      kConference
      number
      kConference 类型房间，适用于会议、教育场景
      kLive
      number
      kLive 类型房间，适用于直播场景

      TUISeatMode

      上麦模式
      枚举项
      类型
      说明
      kFreeToTake
      number
      自由上麦模式，台下观众可以自由上麦，无需申请
      kApplyToTake
      number
      申请上麦模式，台下观众上麦需要房主或者管理员同意后才能上麦

      TUICaptureSourceType

      屏幕分享类型。
      枚举项
      类型
      说明
      kWindow
      number
      该分享目标是某一个 Windows 或 Mac 窗口
      kScreen
      number
      该分享目标是整个 Windows 桌面或 Mac 桌面

      TUIChangeReason

      更改原因（用户音视频状态变更操作原因：自己主动修改 或者 被房主、管理员修改）。
      枚举项
      类型
      说明
      kChangedBySelf
      number
      自己操作
      kChangedByAdmin
      number
      房主或管理员操作

      TUIMediaDeviceState

      枚举项
      类型
      说明
      kMediaDeviceStateAdd
      number
      新增设备
      kMediaDeviceStateRemove
      number
      移除设备
      kMediaDeviceStateActive
      number
      设备已启用
      kMediaDefaultDeviceChanged
      number
      系统默认设备变化

      TUICameraCaptureMode

      摄像头采集模式
      枚举项
      类型
      说明
      kCameraResolutionStrategyAuto
      number
      自动调整采集参数。SDK 根据实际的采集设备性能及网络情况，选择合适的摄像头输出参数，在设备性能及视频预览质量之间，维持平衡。
      kCameraResolutionStrategyPerformance
      number
      优先保证设备性能。SDK 根据用户设置编码器的分辨率和帧率，选择最接近的摄像头输出参数，从而保证设备性能。
      kCameraResolutionStrategyHighQuality
      number
      优先保证视频预览质量。SDK选择较高的摄像头输出参数，从而提高预览视频的质量。在这种情况下，会消耗更多的 CPU 及内存做视频前处理。
      kCameraCaptureManual
      number
      允许用户设置本地摄像头采集的视频宽高。

      TUIRequestAction

      请求操作的类型。
      枚举项
      类型
      说明
      kInvalidAction
      number
      无效操作
      kRequestToOpenRemoteCamera
      number
      请求远端打开摄像头
      kRequestToOpenRemoteMicrophone
      number
      请求远端打开麦克风
      kRequestToConnectOtherRoom
      number
      请求远端夸房连麦
      kRequestToTakeSeat
      number
      请求上麦
      kRequestRemoteUserOnSeat
      number
      请求远端上麦

      TUIRequestCallbackType

      请求类型。
      枚举项
      类型
      说明
      kRequestAccepted
      number
      对端已接受
      kRequestRejected
      number
      对端已拒绝
      kRequestCancelled
      number
      请求已取消
      kRequestTimeout
      number
      请求超时
      kRequestError
      number
      请求错误

      TUIKickedOutOfRoomReason

      用户被移出房间原因。
      枚举项
      类型
      说明
      kKickedByAdmin
      number
      被主持人或管理员移出
      kKickedByLoggedOnOtherDevice
      number
      相同 userId 用户进入同一房间被移出
      kKickedByServer
      number
      被服务端移出

      TUIConferenceStatus

      会议状态。
      枚举项
      类型
      说明
      kConferenceStatusNone
      number
      未知状态
      kConferenceStatusNotStarted
      number
      会议未开始
      kConferenceStatusRunning
      number
      会议进行中

      TUIConferenceCancelReason

      会议取消原因。
      枚举项
      类型
      说明
      kConferenceCancelReasonCancelledByAdmin
      number
      房主取消
      kConferenceCancelReasonRemovedFromAttendees
      number
      当前用户被移出参会人员列表

      TUIMediaDeviceEventType

      音视频设备事件类型
      枚举项
      类型
      说明
      onDeviceChanged
      string
      设备状态变更

      TUIVoiceReverbType

      混响特效
      枚举项
      类型
      说明
      kVoiceReverbType_0
      number
      关闭特效
      kVoiceReverbType_1
      number
      KTV
      kVoiceReverbType_2
      number
      小房间
      kVoiceReverbType_3
      number
      大会堂
      kVoiceReverbType_4
      number
      低沉
      kVoiceReverbType_5
      number
      洪亮
      kVoiceReverbType_6
      number
      金属声
      kVoiceReverbType_7
      number
      磁性
      kVoiceReverbType_8
      number
      空灵
      kVoiceReverbType_9
      number
      录音棚
      kVoiceReverbType_10
      number
      悠扬
      kVoiceReverbType_11
      number
      录音棚2

      TUIVoiceChangerType

      变声特效
      枚举项
      类型
      说明
      kVoiceChangerType_0
      number
      关闭
      kVoiceChangerType_1
      number
      熊孩子
      kVoiceChangerType_2
      number
      萝莉
      kVoiceChangerType_3
      number
      大叔
      kVoiceChangerType_4
      number
      重金属
      kVoiceChangerType_5
      number
      感冒
      kVoiceChangerType_6
      number
      外语腔
      kVoiceChangerType_7
      number
      困兽
      kVoiceChangerType_8
      number
      肥宅
      kVoiceChangerType_9
      number
      强电流
      kVoiceChangerType_10
      number
      重机械
      kVoiceChangerType_11
      number
      空灵

      TUIMediaRotation

      旋转角度
      枚举项
      类型
      说明
      kMediaRotation0
      number
      旋转 0 度
      kMediaRotation90
      number
      旋转 90 度
      kMediaRotation180
      number
      旋转 180 度
      kMediaRotation270
      number
      旋转 270 度

      TUIMediaFillMode

      填充模式
      枚举项
      类型
      说明
      kMediaFillMode_Fill
      number
      图像铺满显示区域，超出显示视窗的视频部分将被截掉，画面内容可能显示不完整
      kMediaFillMode_Fit
      number
      图像长边填满显示区域，短边区域会被填充黑色，画面内容显示完整

      TUIMediaMirrorType

      镜像模式
      枚举项
      类型
      说明
      kMediaMirrorType_Auto
      number
      自动模式，本地预览时，前置摄像头镜像，后置摄像头不镜像
      kMediaMirrorType_Enable
      number
      开启镜像
      kMediaMirrorType_Disable
      number
      关闭镜像

      TUIVideoResolution

      视频分辨率。此处仅定义了横屏分辨率，如果要使用360 × 640这样的竖屏分辨率，需要同时指定 TUIResolutionMode 为 Portrait。
      枚举项
      类型
      说明
      kVideoResolution_120_120
      number
      建议码率（VideoCall）80kbps; 建议码率（LIVE）120kbps
      kVideoResolution_160_160
      number
      建议码率（VideoCall）100kbps; 建议码率（LIVE）150kbps
      kVideoResolution_270_270
      number
      建议码率（VideoCall）200kbps; 建议码率（LIVE）300kbps
      kVideoResolution_480_480
      number
      建议码率（VideoCall）350kbps; 建议码率（LIVE）500kbps
      kVideoResolution_160_120
      number
      建议码率（VideoCall）100kbps; 建议码率（LIVE）150kbps
      kVideoResolution_240_180
      number
      建议码率（VideoCall）150kbps; 建议码率（LIVE）250kbps
      kVideoResolution_280_210
      number
      建议码率（VideoCall）200kbps; 建议码率（LIVE）300kbps
      kVideoResolution_320_240
      number
      建议码率（VideoCall）250kbps; 建议码率（LIVE）375kbps
      kVideoResolution_400_300
      number
      建议码率（VideoCall）300kbps; 建议码率（LIVE）450kbps
      kVideoResolution_480_360
      number
      建议码率（VideoCall）400kbps; 建议码率（LIVE）600kbps
      kVideoResolution_640_480
      number
      建议码率（VideoCall）600kbps; 建议码率（LIVE）900kbps
      kVideoResolution_960_720
      number
      建议码率（VideoCall）1000kbps; 建议码率（LIVE）1500kbps
      kVideoResolution_160_90
      number
      建议码率（VideoCall）150kbps; 建议码率（LIVE）250kbps
      kVideoResolution_256_144
      number
      建议码率（VideoCall）200kbps; 建议码率（LIVE）300kbps
      kVideoResolution_320_180
      number
      建议码率（VideoCall）250kbps; 建议码率（LIVE）400kbps
      kVideoResolution_480_270
      number
      建议码率（VideoCall）350kbps; 建议码率（LIVE）550kbps
      kVideoResolution_640_360
      number
      建议码率（VideoCall）500kbps; 建议码率（LIVE）900kbps
      kVideoResolution_960_540
      number
      建议码率（VideoCall）850kbps; 建议码率（LIVE）1300kbps
      kVideoResolution_1280_720
      number
      建议码率（VideoCall）1200kbps; 建议码率（LIVE）1800kbps
      kVideoResolution_1920_1080
      number
      建议码率（VideoCall）2000kbps; 建议码率（LIVE）3000kbps

      TUIMediaSourceType

      媒体源类型
      枚举项
      类型
      说明
      kCamera
      number
      摄像头
      kScreen
      number
      屏幕/窗口
      kImage
      number
      图片

      TUIVideoPixelFormat

      视频数据格式
      枚举项
      类型
      描述
      TUIVideoPixelFormat_I420
      number
      I420
      TUIVideoPixelFormat_BGRA32
      number
      BGRA32
      TUIVideoPixelFormat_RGBA32
      number
      RGBA32

      类型定义

      TUILoginUserInfo

      当前登录用户信息。
      字段
      类型
      说明
      userId
      string
      登录用户的 ID
      userName
      string
      登录用户的名称
      avatarUrl
      string
      登录用户的头像

      TUIRoomInfo

      房间信息，用户可使用 roomEngine.fetchRoomInfo 获取房间信息。
      字段
      类型
      说明
      roomId
      string
      房间号，字符串类型房间号
      roomName
      string
      房间名称
      roomType
      房间类型
      isSeatEnabled
      boolean
      是否开启麦位控制（创建房间可选参数，默认值为 false）
      seatMode
      房间内上麦模式 (开启麦位控制后生效，默认值为 TUISeatMode.kFreeToTake )
      isMicrophoneDisableForAllUser
      boolean
      是否开启全员禁音（创建房间可选参数，默认值为 false）
      isCameraDisableForAllUser
      boolean
      是否开启全员禁画（创建房间可选参数， 默认值为 false）
      isMessageDisableForAllUser
      boolean
      是否允许所有用户发消息（创建房间可选参数，默认值为 false）
      isScreenShareDisableForAllUser
      boolean
      是否开启禁止屏幕分享（创建房间可选参数，默认值为 false）
      maxSeatCount
      number
      最大麦位数量，默认为 6
      roomOwner
      string
      房间主持人，只读
      createTime
      number
      房间创建时间，只读，精确到秒
      roomMemberCount
      number
      房间成员数量，只读

      TUIUserInfo

      用户信息。
      字段
      类型
      说明
      userId
      string
      用户 ID
      userName
      string
      用户名称
      avatarUrl
      string
      用户头像地址
      userRole
      TUIRole
      用户角色
      hasAudioStream
      boolean
      是否有音频流
      hasVideoStream
      boolean
      是否有视频流
      hasScreenStream
      boolean
      是否有屏幕分享流

      TUIMessage

      消息信息。
      字段
      类型
      说明
      messageId
      string
      消息 ID
      message
      string
      消息
      timestamp
      number
      时间戳信息, 精确到秒
      userId
      string
      用户 ID
      userName
      string
      用户名称
      avatarUrl
      string
      用户头像地址

      TUIRequest

      请求信息。
      字段
      类型
      说明
      requestAction
      请求类型
      timestamp
      number
      请求发起时间
      requestId
      string
      请求 ID
      userId
      string
      发起请求的用户 ID
      content
      string
      其他内容

      TUIRequestCallback

      请求回调信息。
      字段
      类型
      说明
      requestCallbackType
      请求回调类型，接受/拒绝/取消/超时/错误
      requestId
      string
      请求 ID
      userId
      string
      用户 ID
      code
      number
      请求响应码
      message
      string
      请求状态补充说明

      TUISeatInfo

      麦位信息。
      字段
      类型
      说明
      index
      number
      麦位序号
      userId
      string
      麦位对应的用户 ID
      locked
      boolean
      当前麦位是否被锁
      videoMuted
      boolean
      当前麦位是否禁止视频
      audioMuted
      boolean
      当前麦位是否禁止音频

      TUISeatLockParams

      麦位锁定状态。
      字段
      类型
      说明
      lockSeat
      boolean
      锁定麦位
      lockVideo
      boolean
      锁定麦位视频
      lockAudio
      boolean
      锁定麦位音频

      TUINetwork

      网络信息。
      字段
      类型
      说明
      userId
      string
      用户 ID
      quality
      TUINetworkQuality
      网络质量
      upLoss
      number
      上行丢包率，单位 (%) 该数值越小越好，目前仅本地用户有该信息
      downLoss
      number
      下行丢包率，单位 (%) 该数值越小越好，目前仅本地用户有该信息
      delay
      number
      网络延迟，单位 ms，目前仅本地用户有该信息

      TUIVideoEncoderParams

      视频编码参数。
      字段
      类型
      说明
      videoResolution
      视频分辨率, 该字段在 v1.6.0 版本由 quality 修改为 videoResolution
      fps
      number
      视频帧率
      bitrate
      number
      视频码率
      resolutionMode
      横竖屏模式

      TUIRect

      矩形坐标区域
      字段
      类型
      说明
      left
      number
      左边线坐标
      top
      number
      顶边线坐标
      right
      number
      右边线坐标
      bottom
      number
      底边线坐标

      TUICameraCaptureParam

      摄像头采集参数
      字段
      类型
      说明
      mode
      摄像头采集模式
      width
      number
      采集图像宽度
      height
      number
      采集图像高度

      TUIAudioMusicParam

      背景音乐的播放控制信息
      字段
      类型
      说明
      id
      number
      音乐 ID。允许播放多路音乐，因此需要使用 ID 进行标记，用于控制音乐的开始、停止、音量等。
      path
      string
      音效文件的完整路径或 URL 地址。支持的音频格式包括 MP3、AAC、M4A、WAV。
      loopCount
      number
      音乐循环播放的次数。取值范围为0 - 任意正整数，默认值：0。0 表示播放音乐一次；1 表示播放音乐两次；以此类推。
      publish
      boolean
      是否将音乐传到远端。true：音乐在本地播放的同时，远端用户也能听到该音乐；false：主播只能在本地听到该音乐，远端观众听不到。默认值：false。
      isShortFile
      boolean
      播放的是否为短音乐文件。true：需要重复播放的短音乐文件；false：正常的音乐文件。默认值：false。
      startTimeMS
      number
      音乐开始播放时间点，单位：毫秒。
      endTimeMS
      number
      音乐结束播放时间点，单位毫秒，0表示播放至文件结尾。

      TUIMusicPlayObserver

      背景音乐播放事件监听器类型定义
      字段
      类型
      说明
      onStart
      Function | null
      背景音乐开始播放事件
      onPlayProgress
      Function | null
      背景音乐的播放进度事件
      onComplete
      Function | null
      背景音乐播放完毕事件

      TUIScreenCaptureSourceInfo

      屏幕/窗口数据
      字段
      类型
      说明
      type
      媒体源类型：屏幕/窗口
      sourceId
      number
      唯一 ID
      sourceName
      string
      名称
      isMinimizeWindow
      boolean
      是否最小化窗口
      isMainScreen
      boolean
      是否主屏幕
      rect
      TUIRect
      相对显示屏幕的坐标位置

      TUIMediaSource

      媒体源数据
      字段
      类型
      说明
      sourceType
      媒体源类型
      sourceId
      string
      媒体源唯一 ID
      rect
      TUIRect
      相对于本地混流布局的坐标位置
      zOrder
      number
      显示层级。显示层级高的媒体源会遮挡显示层级底的媒体源，多个媒体源不能拥有相同层级。
      rotation
      可选项，旋转角度
      fillMode
      可选项，填充模式
      mirrorType
      可选项，镜像模式
      isSelected
      boolean
      可选项，默认：false，是否选中媒体源

      TUIVideoEncParam

      混流视频编码参数
      字段
      类型
      说明
      videoResolution
      视频分辨率
      resMode
      视频横竖屏模式
      videoFps
      number
      帧率
      videoBitrate
      number
      码率
      minVideoBitrate
      number
      最小码率
      enableAdjustRes
      boolean
      是否自适应调整码率，默认：true

      TUILocalMediaTranscodingParams

      本地混流配置参数
      字段
      类型
      说明
      inputSourceList
      媒体源列表
      videoEncoderParams
      混流视频编码参数
      canvasColor
      number
      混流视频背景色，格式 RGB，默认：0x0
      
      联系我们

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

      联系我们
      技术支持

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

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