このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。
Docs Overview/
Conference/
iOS/
インターフェースドキュメンテーション/
RoomEngine インターフェース/
タイプ定義/

タイプ定義

Enumeration Definition

TUIRoomDefine

Type
Description
Room Type
Mic Control Mode
Room Media Device Type
TUIRole
Room Role Type
Video Quality
Audio Quality
Video Stream Type
Change Reason (User audio and video status change operation reason: self-modification or modified by room owner/administrator)
Screen Sharing Capture Source Type
Request Type

TUICommonDefine

Type
Description
Network Quality

Common Structure

TUIRoomDefine

Type
Description
Room data
User Login Information
Room User Information
Room Seat Information
Lock Seat Operation Parameters
Room User Volume
Signaling Request
Screen Sharing Capture Source Information

TUICommonDefine

Type
Description
Network Quality Information
Message

TUIRoomType

Room Type
Enumeration
Value
Description
TUIRoomTypeConference
1
Conference Type Room, suitable for conference and education scenarios, this room can enable free speech, apply for speech, go live and other modes.
TUIRoomTypeLivingRoom
2
Live Type Room, suitable for live broadcast scenarios, this room can enable free speech, mic control mode, and the seats in this room are numbered.

TUISpeechMode

Mic Control Mode
Enumeration
Value
Description
TUISpeechModeFreeToSpeak
1
Free speech mode.
TUISpeechModeApplyToSpeak
2
Apply to speak mode. (Only effective in conference type room)
TUISpeechModeApplySpeakAfterTakingSeat
3
Go Live mode.

TUIMediaDevice

Room Media Device Type
Enumeration
Value
Description
TUIMediaDeviceMicrophone
1
Mic
TUIMediaDeviceCamera
2
Camera
TUIMediaDeviceApplyScreenSharing
3
Screen Sharing

TUIRole

Room Role Types
Enumeration
Value
Description
TUIRoleRoomOwner
0
Room Owner, generally refers to the creator of the room, the highest authority holder in the room
TUIRoleAdministrator
1
Room Administrator
TUIRoleGeneralUser
2
General Member in the room

TUIVideoQuality

Video Quality
Enumeration
Value
Description
TUIVideoQuality360P
1
Low-quality 360P
TUIVideoQuality540P
2
Standard Definition 540P
TUIVideoQuality720P
3
High Definition 720P
TUIVideoQuality1080P
4
Ultra-clear 1080P

TUIAudioQuality

Audio Quality
Enumeration
Value
Description
TUIAudioQualitySpeech
0
Speech Mode
TUIAudioQualityDefault
1
Default Mode
TUIAudioQualityMusic
2
Music Mode

TUIVideoStreamType

Video Stream Type
Enumeration
Value
Description
TUIVideoStreamTypeCameraStream
0
High-quality Camera Video Stream
TUIVideoStreamTypeScreenStream
1
Screen Sharing Video Stream
TUIVideoStreamTypeCameraStreamLow
2
Low-quality Camera Video Stream

TUIChangeReason

Change Reason (User audio and video status change operation reason: self-modification or modification by room owner/administrator)
Enumeration
Value
Description
TUIChangeReasonBySelf
0
Self-operation
TUIChangeReasonByAdmin
1
Room Owner or Administrator Operation

TUICaptureSourceType

Screen Sharing Capture Source Type
Enumeration
Value
Description
TUICaptureSourceTypeUnknown
-1
Undefined
TUICaptureSourceTypeWindow
0
Window
TUICaptureSourceTypeScreen
1
Screen

TUIRequestAction

Request Type
Enumeration
Value
Description
TUIRequestActionInvalidAction
0
Invalid Request
TUIRequestActionOpenRemoteCamera
1
Request Remote User to Open Camera
TUIRequestActionOpenRemoteMicrophone
2
Request Remote User to Open Microphone
TUIRequestActionConnectOtherRoom
3
Request to Connect to Other Room
TUIRequestActionTakeSeat
4
Request to Go Live
TUIRequestActionRemoteUserOnSeat
5
Request Remote User to Go Live
TUIRequestActionApplyToAdminToOpenLocalCamera
6
Request to Admin to Open Local Camera
TUIRequestActionApplyToAdminToOpenLocalMicrophone
7
Request to Admin to Open Local Microphone

TUINetworkQuality

Network Quality
Enumeration
Value
Description
TUINetworkQualityUnknown
0
Undefined
TUINetworkQualityExcellent
1
Current Network is Excellent
TUINetworkQualityGood
2
Current Network is Good
TUINetworkQualityPoor
3
Current Network is Average
TUINetworkQualityBad
4
Current Network is Poor
TUINetworkQualityVeryBad
5
Current Network is Very Poor
TUINetworkQualityDown
6
Current Network Does Not Meet TRTC's Minimum Requirements

TUIRoomInfo

Room Information
Field
Type
Description
roomId
NSString *
Room ID
roomType
Room Type
ownerId
NSString *
Host ID, default is the room creator (read-only)
name
NSString *
Room Name, default is the room ID
speechMode
Mic Control Mode
createTime
NSUInteger
Room Creation Time (read-only)
memberCount
NSInteger
Number of Members in the Room (read-only)
maxSeatCount
NSUInteger
Maximum Number of Mic Seats (only supported when entering the room and creating the room)
isCameraDisableForAllUser
BOOL
Whether to Disable Opening Camera (optional when creating a room), default value: false
isMicrophoneDisableForAllUser
BOOL
Whether to Disable Opening Microphone (optional when creating a room), default value: false
isMessageDisableForAllUser
BOOL
Whether to Disable Sending Messages (optional when creating a room), default value: false
enableCDNStreaming
BOOL
Whether to Enable CDN Live Streaming (optional when creating a room, for live streaming rooms), default value: false
cdnStreamDomain
NSString*
Live Streaming Push Domain (optional when creating a room, for live streaming rooms), default value: empty

TUILoginUserInfo

User Login Information
Field
Type
Meaning
userId
NSString *
User ID
userName
NSString *
User Name
avatarUrl
NSString *
User Avatar URL

TUIUserInfo

User Information in the Room
Field
Type
Description
userId
NSString *
User ID
userName
NSString *
User Name
avatarUrl
NSString *
User Avatar URL
userRole
TUIRole
User Role Type
hasAudioStream
BOOL
Whether There is Audio Stream, default value: false
hasVideoStream
BOOL
Whether There is Video Stream, default value: false
hasScreenStream
BOOL
Whether There is Screen Sharing Stream, default value: false

TUISeatInfo

Seat Information in the Room
Field
Type
Description
index
NSInteger
Mic Seat Number
userId
NSString *
User ID
isLocked
BOOL
Whether the Mic Seat is Locked, default false
isVideoLocked
BOOL
Whether the Mic Seat is Prohibited from Opening Camera, default false
isAudioLocked
BOOL
Whether the Mic Seat is Prohibited from Opening Microphone, default false

TUISeatLockParams

Lock Seat Operation Parameters
Field
Type
Meaning
lockSeat
BOOL
Lock Mic Seat, default false
lockVideo
BOOL
Lock Mic Seat Camera, default false
lockAudio
BOOL
Lock Mic Seat Microphone, default false

TUIUserVoiceVolume

User Voice Volume in the Room
Field
Type
Description
userId
NSString *
User ID
volume
NSUInteger
Volume Size, Value range 0 - 100

TUIRequest

Signaling Request
Field
Type
Description
requestId
NSString *
Request ID
requestAction
Request Type
userId
NSString *
User ID
content
NSString *
Signaling Content
timestamp
NSUInteger
Timestamp

TUIShareTarget

Screen Sharing Capture Source Information
Field
Type
Description
targetId
NSString *
Capturing Source ID, for windows, this field represents the window ID; for screens, this field represents the display ID
sourceType
Capturing Source Type
sourceName
NSString *
Capturing Source Name
thumbnailImage
TUIImage *
Thumbnail
iconImage
TUIImage *
Icon
extInfo
NSDictionary *
Window's Extended Information

TUINetworkInfo

Network Quality Information
Field
Type
Description
userId
NSString *
User ID
quality
Network Quality
upLoss
uint32_t
Upstream Packet Loss Rate
downLoss
uint32_t
Downstream Packet Loss Rate
delay
uint32_t
Network Delay

TUIMessage

Message
Field
Type
Description
messageId
NSString *
Message ID
message
NSString *
Message Text
timestamp
uint64_t
Message Time
userId
NSString *
Message Sender
userName
NSString *
Message Sender Nickname
avatarUrl
NSString *
Message Sender Avatar