tencent cloud

Tencent Real-Time Communication

Release Notes and Announcements
Release Notes
Recent Product Announcement
TRTC Live (TUILiveKit) Product Launch Announcement
TRTC Conference Official Editions Launched
The commercial version of Conference is coming soon
Terms and Conditions Applicable to $9.9 Starter Package
Rules for the "First Subscription $100 Discount" Promotion
Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
TRTC Call Official Editions Launched
License Required for Video Playback in New Version of LiteAV SDK
TRTC to Offer Monthly Packages
Product Introduction
Overview
Concepts
Features
Strengths
Use Cases
Performance Statistics
Tencent RTC Quickplay: Experience Ultimate Real-Time Audio and Video Interaction!
Purchase Guide
Billing Overview
Free Minutes
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
FAQs
Refund Instructions
User Tutorial
Free Demo
Call
Overview
Activate the Service
Run Demo
Integration
Offline Call Push
Conversational Chat
On-Cloud Recording
AI Noise Reduction
UI Customization
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
Release Notes
FAQs
Conference
Overview(TUIRoomKit)
Activate the Service (TUIRoomKit)
Run Demo(TUIRoomKit)
Integration(TUIRoomKit)
Screen Sharing (TUIRoomKit)
Schedule a meeting (TUIRoomKit)
In-meeting Call (TUIRoomKit)
UI Customization(TUIRoomKit)
Virtual Background (TUIRoomKit)
Conference Control (TUIRoomKit)
Cloud Recording (TUIRoomKit)
AI Noise Reduction (TUIRoomKit)
In-Conference Chat (TUIRoomKit)
Robot Streaming (TUIRoomKit)
Enhanced Features (TUIRoomKit)
Client APIs (TUIRoomKit)
Server APIs (TUIRoomKit)
FAQs (TUIRoomKit)
Error Code (TUIRoomKit)
SDK Update Log (TUIRoomKit)
Live
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Run 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 Download
API Examples
Usage Guidelines
API Reference Manual
Advanced Features
AI Integration
Overview
Configure MCP Server
Install Skills
Integration Guide
FAQ
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
Console Guide
Application Management
Package Management
Usage Statistics
Monitoring Dashboard
Development Assistance
Solution
Real-Time Chorus
FAQs
Migration Guide
Billing
Features
UserSig
Firewall Restrictions
How to Downsize Installation Package
Android and iOS
Web
Flutter
Electron
TRTCCalling for Web
Audio and Video Quality
Others
Legacy Documentation
RTC RoomEngine SDK(Old)
Integrating TUIRoom (Web)
Integrating TUIRoom (Android)
Integrating TUIRoom (iOS)
Integrating TUIRoom (Flutter)
Integrating TUIRoom (Electron)
TUIRoom APIs
On-Cloud Recording and Playback (Old)
RTC Analytics Monthly Packages (Previous Version)
Protocols and Policies
Compliance
Security White Paper
Notes on Information Security
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC Policy
Privacy Policy
Data Processing And Security Agreement
Glossary

Cloud Recording (TUIRoomKit)

PDF
Focus Mode
Font Size
Last updated: 2024-04-17 18:02:37
This article introduces how to quickly use TUIRoomKit's cloud recording feature to help developers achieve diversified needs such as archiving and reviewing important content in video conferencing, online education, live interactive, and other scenarios. We provide two solutions for you to choose from: Automatic Recording and RESTful API-Based Recording.

Scheme 1. Automatic Recording (Recommended)

We recommend using the automatic recording solution, which does not require the business side to start and stop the recording. The Tencent Cloud Real-Time Audio and Video backend manages the recording tasks, and it automatically records when there is audio and video stream uploading during the call. The access process is fast and simple. You can complete it in the following steps:
1. Find the application of the target SDKAppId in Application Management in the TRTC console and enter the Advanced Feature page.
2. In the Advanced Function configuration page, you can see the option for On-cloud recording configuration. Click on Global Auto-Recording to enter the configuration popup window.



3. In the configuration popup window,You can customize the recording template as needed. 。



Note:
Global automatic recording only supports single-stream recording (i.e., each host records a single file). Once enabled, it only applies to newly created rooms and does not take effect for rooms created before the automatic recording feature is enabled. If you need to record the screen after mixing multiple streams, please use the RESTful API-Based recording.
Global automatic recording supports recording up to 25 hosts in a room. If there are more than 25 hosts, they will be sorted by the time they enter the room, and the first 25 hosts will be recorded (if you need to record more than 25 hosts in a single stream, please refer to the RESTful API-Based recording).
After enabling the global automatic recording feature, the automatic start recording task will be triggered after the conference starts and there is audio and video uploading. After the conference ends, the recording will automatically stop. If you leave the room abnormally due to network or other situations, our recording backend will automatically stop the recording task according to the MaxIdleTime value you set (idle waiting time, default 5s) to avoid causing additional billing losses.

Scheme 2. RESTful API-Based Recording

If the automatic recording scheme doesn't meet your needs, you can also use the more flexible RESTful API-based recording scheme. In this scheme, you can record and subscribe to a specified anchor in the room, customize the layout of mixed streams, and update the layout and subscription during recording. However, using its features requires using it together with the business backend service and performing complex integration operations:
1. Find the application of the target SDKAppId in Application Management in the TRTC console and enter the Advanced Feature page.
2. On the Advanced Features configuration page, you can see the options for cloud recording configuration. Enable the cloud recording feature. Here, it is recommended to turn off Global Automatic Recording, which defaults to Manual Custom Recording, that is, RESTful API-based recording mode.



3. Afterward, you can call the REST API (CreateCloudRecording) to start the cloud recording. Here, it is recommended that you can listen to the notification events of TUIRoomObserver and start recording when the meeting starts.
Note:
Under manual recording, you can go to the console to configure the callback address to receive recording callback events, please see Recording Callback Description.




FAQs

1. Can the two recording solutions be used simultaneously?

The Automatic Recording Solution and REST API Recording Solution do not conflict and can be used simultaneously. However, two recording files and fees will be generated.

2. How do I view recorded files?

Log in to the VOD console, select Video/Audio Management on the left sidebar, click Search by prefix above the list, select Search by prefix, and enter the keyword in the search box. The recording filenames are in the following formats:
The filename format of an MP4 single-stream recording file: <SdkAppId>_<RoomId>_UserId_s_<UserId>_UserId_e_<MediaId>_<Index>.mp4
The filename format of an MP4 mixed-stream recording file: <SdkAppId>_<RoomId>_<Index>.mp4

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback