このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

Tutorial

Tencent Effect SDK enables you to quickly implement beauty filters, filters, sticker props, and background segmentation effects in live streaming or short videos. We provide UI components that include interface code, as well as a pure SDK form for UI-free integration. For the differences between the two solutions, refer to Differences between UI and UI-Free Integration Solutions.

Steps of Using Tencent Effect:

1. Experience Effect

Download the package for the corresponding platform from the Demo Experience Page, install, and try it out.
Choose the package that suits you based on the experience and the Beauty Filter feature description.

2. Apply for License Information

Since the Beauty Filter SDK requires authentication, you need to apply for License information, and only after successful authentication in the project can you use the Beauty Filter feature.

3. Run the Demo project

Demo Experience Page offers Demo projects for various scenarios. You can choose the corresponding Demo based on the instructions.

4. Download and integrate the SDK

On the SDK Download page, download the SDK corresponding to your package. If you are unsure which package to use at the start, you can directly choose S1-07 SDK for download. This SDK includes all features of Tencent Special Effects. You can replace it once you decide on the package.
Based on your business scenario, refer to the following documents for integration:
To integrate Tencent Special Effects into TRTC, see Integrating Tencent Effect into TRTC SDK
To integrate Tencent Special Effects into Tencent Live, see Integrating Tencent Effect into MLVB SDK
To integrate Tencent Special Effects into short videos, see Integrating Tencent Effect into UGSV SDK
To integrate Tencent Special Effects into other vendors' RTC or custom camera feeds, see General Integration of Tencent Effect

5. Obtain Materials

Based on your Demo experience in the first step, and in conjunction with the feature overview of your package, choose the corresponding materials (filters and stickers) included in the selected features, and send the material names to Tencent Special Effects staff. The staff will provide the corresponding materials based on your selection.
Note:
Stickers in the SDK and Demo project are for testing purposes only.

Common Issue Investigation

For integration issues, see SDK Integration Issues
For performance issues, see Performance Issues Investigation
For effectiveness issues, see Effectiveness Issues Investigation

The difference between Integration (No UI) and Integration (UI)

Integration (UI Included) provides a default beauty filter panel UI based on the original SDK, reducing UI development costs and accelerating the integration of Tencent special effects.
The beauty filter panel with UI is as follows:



Integration Solution (No UI) means using the original SDK of Tencent special effects for integration. You need to handle the beauty filter panel UI development and beauty filter property management yourself, suitable for requirements with special needs for the beauty filter panel.