tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
实时音视频
    文档
    Download PDF

    TUIRoomDefine

    最后更新时间：2024-12-20 16:11:45
    下载PDF
      TUIRoomDefine

      结构体类型

      函数列表
      描述
      房间信息
      用户登录信息
      房间内用户信息
      视频编码参数
      房间内座位信息
      锁定麦位操作参数
      房间内用户音量
      信令请求
      进房参数

      枚举类型

      枚举类型
      描述
      房间类型
      上麦模式
      房间内媒体设备类型
      房间内角色类型
      房间解散原因
      视频质量
      音频质量
      视频流类型
      音视频状态更改原因（分类: 自己主动修改 或者 被房主、管理员修改）
      用户被踢出房间原因（分类: 被主持人或管理员踢出、在其它设备进入房间被踢出 或者 被服务端踢出）
      分辨率模式（横屏 or 竖屏）
      请求类型
      房间内用户信息变更参数key。

      TUIRoomType

      TUIRoomType

      房间类型

      枚举
      取值
      描述
      CONFERENCE
      1
      会议类型房间，适用于会议，教育场景，该房间中可以开启自由发言，申请发言、上麦发言等不同模式。
      LIVE
      2
      直播类型房间，适用于直播场景，该房间可以开启自由发言，上麦发言模式。

      TUISeatMode

      TUISeatMode

      上麦模式

      枚举
      取值
      描述
      FREE_TO_TAKE
      1
      自由上麦模式，台下观众可以自由上麦，无需申请。
      APPLY_TO_TAKE
      2
      申请上麦模式，台下观众上麦需要房主或者管理员同意后才能上麦。

      TUIMediaDevice

      TUIMediaDevice

      房间内媒体设备类型

      枚举
      取值
      描述
      MICROPHONE
      1
      麦克风。
      CAMERA
      2
      摄像头。
      SCREEN_SHARING
      3
      屏幕共享。

      TUIRole

      TUIRole

      房间内角色类型

      枚举
      取值
      描述
      ROOM_OWNER
      0
      房主，一般指房间的创建者，房间内最高权限拥有者。
      MANAGER
      1
      房间管理员。
      GENERAL_USER
      2
      房间内普通成员。

      TUIRoomDismissedReason

      TUIRoomDismissedReason

      房间解散原因

      枚举
      取值
      描述
      BY_OWNER
      1
      被房主解散。
      BY_SERVER
      2
      被服务器解散。

      TUIVideoQuality

      TUIVideoQuality

      视频质量

      枚举
      取值
      描述
      Q_360P
      1
      低清360P。
      Q_540P
      2
      标清540P。
      Q_720P
      3
      高清720P。
      Q_1080P
      4
      超清1080P。

      TUIAudioQuality

      TUIAudioQuality

      音频质量

      枚举
      取值
      描述
      SPEECH
      0
      人声模式。
      DEFAULT
      1
      默认模式。
      MUSIC
      2
      音乐模式。

      TUIVideoStreamType

      TUIVideoStreamType

      视频流类型

      枚举
      取值
      描述
      CAMERA_STREAM
      0
      高清摄像头视频流。
      SCREEN_STREAM
      1
      屏幕分享视频流。
      CAMERA_STREAM_LOW
      2
      低清摄像头视频流。

      TUIChangeReason

      TUIChangeReason

      音视频状态更改原因（分类: 自己主动修改 或者 被房主、管理员修改）

      枚举
      取值
      描述
      BY_SELF
      0
      自己操作。
      BY_ADMIN
      1
      房主或管理员操作。

      TUIKickedOutOfRoomReason

      TUIKickedOutOfRoomReason

      用户被踢出房间原因（分类: 被主持人或管理员踢出、在其它设备进入房间被踢出 或者 被服务端踢出）

      枚举
      取值
      描述
      BY_ADMIN
      0
      被主持人或管理员踢出。
      BY_LOGGED_ON_OTHER_DEVICE
      1
      在其它设备进入房间被踢出。
      BY_SERVER
      2
      被服务端踢出。

      TUIResolutionMode

      TUIResolutionMode

      分辨率模式（横屏 or 竖屏）

      枚举
      取值
      描述
      LANDSCAPE
      0
      横屏。
      PORTRAIT
      1
      竖屏。

      TUIRequestAction

      TUIRequestAction

      请求类型

      枚举
      取值
      描述
      INVALID_ACTION
      0
      无效请求。
      REQUEST_TO_OPEN_REMOTE_CAMERA
      1
      请求远端用户打开摄像头。
      REQUEST_TO_OPEN_REMOTE_MICROPHONE
      2
      请求远端用户打开麦克风。
      REQUEST_TO_TAKE_SEAT
      4
      请求上麦。
      REQUEST_REMOTE_USER_ON_SEAT
      5
      请求远端用户上麦。
      REQUEST_APPLY_TO_ADMIN_TO_OPEN_LOCAL_CAMERA
      6
      向管理员请求打开本地摄像头。
      REQUEST_APPLY_TO_ADMIN_TO_OPEN_LOCAL_MICROPHONE
      7
      向管理员请求打开本地麦克风。
      REQUEST_APPLY_TO_ADMIN_TO_OPEN_LOCAL_SCREEN_SHARE
      8
      向管理员请求打开屏幕分享。

      TUIUserInfoModifyFlag

      TUIUserInfoModifyFlag

      房间内用户信息变更参数key。

      枚举
      取值
      描述
      USER_ROLE
      0x01
      userRole 参数发生变更。
      NAME_CARD
      0x02
      nameCard 参数发生变更。

      TUIRoomInfo

      TUIRoomInfo

      房间信息

      TUIRoomEngine 只支持字符串房间ID。
      枚举类型
      描述
      createTime
      房间创建时间（只读）。
      isCameraDisableForAllUser
      是否禁止打开摄像头（创建房间可选参数），默认值：false。
      isMessageDisableForAllUser
      是否禁止发送消息（创建房间可选参数），默认值：false。
      isMicrophoneDisableForAllUser
      是否禁止打开麦克风（创建房间可选参数），默认值：false。
      isScreenShareDisableForAllUser
      是否禁止打开屏幕分享（创建房间可选参数），默认值：false。
      isSeatEnabled
      是否开启麦位控制。
      maxSeatCount
      最大麦位数。
      memberCount
      房间内成员数量（只读）。
      name
      房间名称（创建房间可选参数，默认房间ID，最大支持100个字节）。
      ownerAvatarUrl
      房主头像URL: 默认为房间创建者头像URL（只读）。
      ownerId
      房主ID: 默认为房间创建者ID（只读）。
      ownerName
      房主昵称: 默认为房间创建者昵称（只读）。
      password
      房间密码。
      roomId
      房间ID (创建房间必填参数，最大支持48个字节)。
      roomType
      房间类型（创建房间可选参数），请参见：RoomType。
      seatMode
      上麦模式(只有开启麦位控制后生效)。

      TUILoginUserInfo

      TUILoginUserInfo

      用户登录信息

      枚举类型
      描述
      avatarUrl
      用户头像URL。
      customInfo
      自定义信息。
      userId
      用户ID。
      userName
      用户名称。

      TUIUserInfo

      TUIUserInfo

      房间内用户信息

      枚举类型
      描述
      avatarUrl
      用户头像URL。
      hasAudioStream
      是否有音频流，默认值：false。
      hasScreenStream
      是否有屏幕分享流，默认值：false。
      hasVideoStream
      是否有视频流，默认值：false。
      isMessageDisabled
      是否被禁止发送消息，默认值：false。
      nameCard
      房间内用户昵称，最大支持32个字节。
      roomCustomInfo
      房间成员自定义信息。
      userId
      用户ID。
      userName
      用户名称。
      userRole
      用户角色类型，会议类型的房间角色仅存在于房间内，退房后再进入角色为普通用户。直播可以在进房前设置，房间不解散，角色依然存在。详情参见：Role。

      TUIRoomVideoEncoderParams

      TUIRoomVideoEncoderParams

      视频编码参数

      枚举类型
      描述
      bitrate
      目标视频码率。
      fps
      视频采集帧率。
      resolutionMode
      分辨率模式, 请参见：ResolutionMode。
      videoResolution
      视频质量, 请参见：VideoQuality。

      TUISeatInfo

      TUISeatInfo

      房间内座位信息

      枚举类型
      描述
      avatarUrl
      用户头像URL
      index
      麦位序号。
      isAudioLocked
      麦位是否被禁止打开麦克风，默认值：false。
      isLocked
      麦位是否被锁定，默认值：false。
      isVideoLocked
      麦位是否被禁止打开摄像头，默认值：false。
      nameCard
      房间内用户昵称
      userId
      用户ID。
      userName
      用户昵称

      TUISeatLockParams

      TUISeatLockParams

      锁定麦位操作参数

      枚举类型
      描述
      lockAudio
      锁定麦位麦克风，默认值：false。
      lockSeat
      锁定麦位，默认值：false。
      lockVideo
      锁定麦位摄像头，默认值：false。

      TUIUserVoiceVolume

      TUIUserVoiceVolume

      房间内用户音量

      枚举类型
      描述
      userId
      用户ID。
      volume
      音量 用于承载所有正在说话的用户的音量大小，取值范围 0 - 100。

      TUIRequest

      TUIRequest

      信令请求

      枚举类型
      描述
      avatarUrl
      用户头像URL。
      content
      信令内容。
      nameCard
      房间内用户昵称。
      requestAction
      请求类型。
      requestId
      请求ID。
      timestamp
      时间戳。
      userId
      用户ID。
      userName
      用户昵称。

      TUIEnterRoomOptions

      TUIEnterRoomOptions

      进房参数

      枚举类型
      描述
      password
      房间密码。
      联系我们

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

      联系我们
      技术支持

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

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