tencent cloud

Tencent Real-Time Communication

お知らせ・リリースノート
製品アップデート情報
Tencent Cloudオーディオビデオ端末SDKの再生アップグレードおよび承認チェック追加に関するお知らせ
TRTCアプリケーションのサブスクリプションパッケージサービスのリリースに関する説明について
製品の説明
製品概要
基礎概念
製品の機能
製品の強み
ユースケース
性能データ
購入ガイド
Billing Overview
無料時間の説明
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
課金に関するよくあるご質問
Refund Instructions
初心者ガイド
Demo体験
Call
コンポーネントの説明(TUICallKit)
Activate the Service
Run Demo
クイック導入
オフライン通知
Conversational Chat
クラウドレコーディング(TUICallKit)
AI Noise Reduction
インターフェースのカスタマイズ
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
公開ログ
よくある質問
ライブ配信
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Demo のクイックスタート
No UI Integration
UI Customization
Live Broadcast Monitoring
Video Live Streaming
Voice Chat Room
Advanced Features
Client APIs
Server APIs
Error Codes
Release Notes
FAQs
RTC Engine
Activate Service
SDKのダウンロード
APIコードサンプル
Usage Guidelines
クライアント側 API
高度な機能
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
コンソールガイド
アプリケーション管理
使用統計
監視ダッシュボード
開発支援
Solution
Real-Time Chorus
よくあるご質問
課金関連問題
機能関連
UserSig関連
ファイアウォールの制限の対応関連
インストールパッケージの圧縮に関するご質問
AndriodおよびiOS関連
Web端末関連
Flutter関連
Electron関連
TRTCCalling Web関連
オーディオビデオ品質関連
その他のご質問
旧バージョンのドキュメント
TUIRoom(Web)の統合
TUIRoom (Android)の統合
TUIRoom (iOS)の統合
TUIRoom (Flutter)の統合
TUIRoom (Electron)の統合
TUIRoom APIのクエリー
クラウドレコーディングと再生の実現(旧)
Protocols and Policies
セキュリティコンプライアンス認証
セキュリティホワイトペーパー
情報セキュリティの説明
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC ポリシー
プライバシーポリシー
データ処理とセキュリティ契約
用語集

Type Definition

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-04-15 15:55:25

Common structures

TUIResult

The return value of calling the API.
Value
Type
Description
code
String
If the code is empty "", it means the call succeeded, if the code is not empty "", it means the call failed.
message
String?
Error message

TUIRoomId

Room ID for audio and video in a call.
Note:
(1) intRoomId and strRoomId are mutually exclusive. If you choose to use strRoomIdintRoomId needs to be filled in as 0. If both are filled in, the SDK will prioritize intRoomId.
(2) Do not mix intRoomId and strRoomId because they are not interchangeable. For example, the number 123 and the string "123" represent two completely different rooms.
Value
Type
Description
intRoomId
int
Numeric room ID.
strRoomId
String
String room number.

VideoRenderParams

Video render parameters.
Value
Type
Description
fillMode
FillMode
Video image fill mode
rotation
Rotation
Video image rotation direction

VideoEncoderParams

Video encoding parameters.
Value
Type
Description
resolution
Video resolution
resolutionMode
Video aspect ratio mode

TUICallParams

Call params.
Value
Type
Description
roomId
TUIRoomId
Room Id.
offlinePushInfo
Offline push vendor configuration information.
timeout
String
Call timeout period, default: 30s, unit: seconds.
userData
String
An additional parameter.
chatGroupId
String
Group ID.

TUIOfflinePushInfo

Offline push vendor configuration information,please refer to:Offline call push.
Value
Type
Description
title
String
offlinepush notification title
desc
String
offlinepush notification description
ignoreIOSBadge
bool
Ignore badge count for offline push (only for iOS), if set to true, the message will not increase the unread count of the app icon on the iOS receiver's side.
iOSSound
String
Offline push sound setting (only for iOS). When sound = IOS_OFFLINE_PUSH_NO_SOUND , there will be no sound played when the message is received. When sound = IOS_OFFLINE_PUSH_DEFAULT_SOUND , the system sound will be played when the message is received. If you want to customize the iOSSound, you need to link the audio file into the Xcode project first, and then set the audio file name (with extension) to the iOSSound.
androidSound
String
Offline push sound setting (only for Android, supported by IMSDK 6.1 and above). Only Huawei and Google phones support setting sound prompts. For Xiaomi phones, please refer to: Xiaomi custom ringtones . In addition, for Google phones, in order to set sound prompts for FCM push on Android 8.0 and above systems, you must call setAndroidFCMChannelID to set the channelID for it to take effect.
androidOPPOChannelID
String
Set the channel ID for OPPO phones with Android 8.0 and above systems.
androidVIVOClassification
int
Classification of VIVO push messages (deprecated interface, VIVO push service will optimize message classification rules on April 3, 2023. It is recommended to use setAndroidVIVOCategory to set the message category). 0: Operational messages, 1: System messages. The default value is 1.
androidXiaoMiChannelID
String
Set the channel ID for Xiaomi phones with Android 8.0 and above systems.
androidFCMChannelID
String
Set the channel ID for google phones with Android 8.0 and above systems.
androidHuaWeiCategory
String
Classification of Huawei push messages, please refer to: Huawei message classification standard.
isDisablePush
bool
Whether to turn off push notifications (default is on).
iOSPushType
iOS offline push type,default is APNs

TUICallRecords

Call recording information.
Value
Type
Description
callId
String
Call recording ID.
inviter
String
Inviter ID.
inviteList
List<String>
List of invited user IDs.
scene
Call scenario.
mediaType
Media type.
groupId
String
Group ID.
role
Role.
result
Call result type.
beginTime
int
Start time.
totalTime
int
Total time.

TUICallRecentCallsFilter

Call recording filtering conditions.
Value
Type
Description
begin
double
Start time.
end
double
End time.
resultType
Call result type.

CallObserverExtraInfo

Callback extended information.
Type
Type
Description
roomId
TUIRoomId
room ID
role
Call role
userData
String
Custom extended field when initiating a call. For details, see TUICallParams.
chatGroupId
String
Group ID

enum definition

TUICallMediaType

Call media type.
Type
Description
none
Unknown
audio
Audio call
video
Video call

TUICallRole

Call role.
Type
Description
none
Unknown
caller
Caller(inviter)
called
Callee(invitee)

TUICallStatus

Call status.
Type
Description
none
Unknown
waiting
The call is currently waiting
accept
The call has been accepted

TUICallScene

Call scene.
Type
Description
groupCall
Group call
singleCall
one to one call

TUINetworkQuality

Network quality.
Type
Description
unknown
Unknown
excellent
Excellent
good
Good
poor
Poor
bad
Bad
vBad
Very bad
down
Down

FillMode

If the aspect ratio of the video display area is not equal to that of the video image, you need to specify the fill mode:
Type
Description
fill
Fill mode: the video image will be centered and scaled to fill the entire display area, where parts that exceed the area will be cropped. The displayed image may be incomplete in this mode.
fit
Fit mode: the video image will be scaled based on its long side to fit the display area, where the short side will be filled with black bars. The displayed image is complete in this mode, but there may be black bars.

Rotation

We provides rotation angle setting APIs for local and remote images. The following rotation angles are all clockwise.
Type
Description
rotation_0
No rotation
rotation_90
Clockwise rotation by 90 degrees
rotation_180
Clockwise rotation by 180 degrees
rotation_270
Clockwise rotation by 270 degrees

ResolutionMode

Video aspect ratio mode.
Type
Description
landscape
Landscape resolution, such as Resolution.Resolution_640_360 + ResolutionMode.Landscape = 640 × 360.
portrait
Portrait resolution, such as Resolution.Resolution_640_360 + ResolutionMode.Portrait = 360 × 640.

Resolution

Video resolution.
Type
Description
resolution_640_360
Aspect ratio: 16:9;resolution: 640x360;recommended bitrate: 500kbps
resolution_960_540
Aspect ratio: 16:9;resolution: 960x540;recommended bitrate: 850kbps
resolution_1280_720
Aspect ratio: 16:9;resolution: 1280x720;recommended bitrate: 1200kbps
resolution_1920_1080
Aspect ratio: 16:9;resolution: 1920x1080;recommended bitrate: 2000kbps

TUICallIOSOfflinePushType

iOS offline push type.
Type
Description
APNs
APNs
VoIP
VoIP

TUICamera

Camera type.
Type
Description
front
Front camera.
back
Rear camera.

TUIAudioPlaybackDevice

Audio playback device.
Type
Description
speakerphone
Speaker
earpiece
Earpiece

TUICallResultType

Call recording type.
Type
Description
unknown
Unknown
missed
Missed
incoming
Incoming call
outgoing
Outgoing Call

CallEndReason

Call end reason.
Type
Description
unknown
Unknown
hangup
Hang up
reject
Deny
noResponse
No response
offline
Offline
lineBusy
Busy Line
canceled
Cancel call
otherDeviceAccepted
Other device answers
otherDeviceReject
Other device denies
endByServer
Backend ends

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック