# Tencent RTC Beauty AR — Android

> Beauty AR documentation for Android platform.

## Core SDK

### Integration

- [SDK Download](https://pre.trtc.io/document/74071.md): Tencent RTC SDK download page offers multiple editions including Basic, Advanced, and X Series Atomic Capabilities for mobile and cross-platform applications. It supports iOS and Android platforms with detailed package options and integration guides, enabling developers to select and integrate the appropriate SDK version for beautification and algorithmic features.
- [Install the SDK](https://pre.trtc.io/document/60195.md): The BeautyAR Core SDK for Android provides developers with tools to integrate beauty effects into their applications. This quickstart guide covers environment setup, SDK integration via Maven or manual methods, resource management, and essential steps including authentication, initialization, and obfuscation configuration. It is designed for Android Studio 3.5 or later and supports Android 7.0 and above on armeabi-v7a and arm64-v8a architectures.
- [Use with TEBeautyKit](https://pre.trtc.io/document/60196.md): TEBeautyKit is an Android beauty effect UI component SDK designed to simplify the integration of beauty effects and UI panels for developers. This guide provides step-by-step instructions including adding dependency libraries, configuring panel JSON files, initializing the SDK, using beauty effects, managing lifecycle events, and exporting or importing effect parameters. It supports Tencent Effect SDK version 3.5.0 and above and references the TEBeautyDemo project for practical implementation.
- [Use with TRTC SDK](https://pre.trtc.io/document/73768.md): This guide explains how to integrate the TRTC SDK on Android, focusing on adding beauty effects using BeautyAR SDK and TEBeautyKit. It is intended for developers who want to implement beauty features in their TRTC-powered apps. The document details step-by-step procedures including dependency setup, panel configuration, authentication, adapter initialization, and audio management to enable smooth integration and usage of beauty effects.
- [Use with MLVB SDK](https://pre.trtc.io/document/73767.md): The MLVB SDK for Android is a beauty effect SDK designed for developers to integrate advanced beauty features into their applications. This guide provides step-by-step instructions including SDK integration, authentication, resource management, adapter and panel initialization, and handling beauty effects to help developers quickly implement beauty functionalities using Tencent RTC technology.
- [Use with UGSV SDK](https://pre.trtc.io/document/73769.md): UGSV SDK for Android is a beauty effects SDK designed for developers to integrate advanced beauty features into their video recording applications. This guide provides step-by-step instructions including demo setup, SDK integration, resource configuration, authentication, beauty object creation, video processing, and lifecycle management such as pausing and resuming sound. It enables developers to quickly implement and customize beauty effects in their Android apps.
- [Use with Other RTC](https://pre.trtc.io/document/80471.md): Tencent Effect SDK is an SDK designed for Android that enables seamless integration with Tencent Cloud RTC and other RTC platforms. This guide provides step-by-step instructions for integrating the SDK with platforms such as Agora, ZEGO, BytePlus, IVS, and Qiniu, helping developers implement effect features across multiple RTC environments.

### Advanced Features

- [Gesture Recognition](https://pre.trtc.io/document/60309.md): The Gesture Recognition SDK for Android processes camera OpenGL textures to provide real-time gesture detection data. This guide helps Android developers integrate the Beauty AR SDK, enabling gesture detection by activating feature switches and handling JSON callback data. It supports multiple gesture types such as HEART, PAPER, SCISSOR, and more for interactive applications.
- [Face Detection](https://pre.trtc.io/document/60310.md): The Face Recognition SDK for Android provides capabilities to detect partially captured or concealed faces and recognize 256 facial keypoints. This integration guide is designed for Android developers to implement facial recognition features by registering Xmagic listeners that handle callbacks with detailed facial data. Key steps include setting up the appropriate listener interface based on SDK version and processing JSON data containing facial keypoints and visibility metrics.
- [Virtual Background](https://pre.trtc.io/document/60311.md): The Virtual Background Android SDK guide provides detailed steps to accurately remove backgrounds in real time and apply customizable virtual backgrounds. It is designed for Android developers integrating Tencent RTC SDK to enhance video call experiences by setting virtual or custom backgrounds using the setEffect method with specific parameters and configurations.
- [Body Tracking](https://pre.trtc.io/document/74184.md): The Body Keypoints capability of Tencent RTC processes OpenGL camera textures to output 3D body data for Android. It provides APIs to enable the feature and receive JSON-formatted body keypoints including 2D/3D coordinates, bone rotations, and projection matrices. This enables developers to integrate realistic body motion data into applications such as Unity models or other features.

### Best Practices

- [Asset Integration](https://pre.trtc.io/document/73782.md): This guide details the Android usage of filters and animation stickers within the BeautyAR SDK. It targets developers integrating beauty effects, providing step-by-step instructions for using TEBeautyKit UI panel or directly integrating the BeautyAR SDK. The document covers adding filter images and animation folders, configuring icons and resource paths, and invoking SDK methods to apply these effects.
- [Asset Layering](https://pre.trtc.io/document/73783.md): The Material Overlay feature in Tencent RTC allows simultaneous activation of multiple simple animation materials such as makeup or motion effects. This guide helps developers configure overlay settings on Android and iOS platforms by using the mergeWithCurrentMotion parameter to manage effect compatibility and layering. It includes key steps for setting up overlays, managing complex and simple effects, and ensuring smooth transitions between effects.
- [Recommended Beauty Parameters](https://pre.trtc.io/document/73784.md): This document presents the recommended parameter settings for implementing one-click beauty effects using the Tencent RTC beautification SDK. It provides detailed parameter values for both iOS and Android platforms across various beautification presets such as Natural, Goddess, Vitality, Classic Live Stream, and more. These configurations help developers quickly apply consistent and optimized beauty effects in their applications.
- [Enhanced Mode](https://pre.trtc.io/document/73785.md): The Enhanced Mode User Guide for the Beauty SDK explains how to enable and use Enhanced Mode to achieve stronger beauty effects by adjusting parameter values beyond the normal range. It provides step-by-step instructions for Android, iOS, Flutter, and uniapp platforms, including usage with TEBeautyKit UI components and direct API calls. The guide also includes recommended enhancement multipliers for different beauty items to ensure optimal results without degrading effect quality.
- [EffectMode (High Performance)](https://pre.trtc.io/document/73786.md): EffectMode is a key SDK configuration parameter introduced in Tencent RTC SDK version 3.9.0 that controls performance modes. This guide provides step-by-step instructions for developers on Android, iOS, Flutter, and uniapp platforms to set EffectMode_Normal or EffectMode_Pro when creating SDK instances. It also explains how to enable high performance mode in earlier SDK versions using appropriate API calls, ensuring optimal performance for real-time audio and video processing.
- [Reduce SDK Size](https://pre.trtc.io/document/60206.md): This guide details the Android SDK size reduction process for Tencent RTC by downloading essential so libraries and model resources online prior to SDK initialization. It is intended for developers aiming to optimize app package size by dynamically downloading filters and animation resources on demand. Key steps include using the TEBeauty_Download_Example demo project, verifying downloaded files, managing downloads with resume support, and integrating resources with the SDK.
- [Green Screen Keying v2](https://pre.trtc.io/document/73789.md): Green Screen Keying V2 is a video processing SDK that enables users to fine-tune five key parameters—similarity, smoothness, edge elimination strength, grayscale ratio, and shadow removal—to improve green screen matting quality. This guide helps users understand how to adjust these parameters to solve common issues such as incomplete removal of green screen areas, incorrect foreground matting, edge detail loss, color spill, and jagged edges, providing practical steps to achieve cleaner and more natural compositing results.
- [Effect Parameters](https://pre.trtc.io/document/60207.md): The Effect Parameters document for the Beautification SDK provides detailed reference information on effect names, intensity ranges, and resource paths used to configure beautification and body beautification features. It is intended for developers integrating Tencent RTC's beautification capabilities on Android and iOS platforms, enabling precise control over various cosmetic and filter effects through defined constants and parameters.

### Asset Authoring

- [Beauty AR Studio (Desktop)](https://pre.trtc.io/document/60296.md): Beauty AR Studio is a material creation tool designed for customizing 2D and 3D stickers, enabling personalized material production for integration into SDKs. Available on Windows and Mac, it offers AI modular editing, 3D model design, rich process control, and dynamic effect preview. The tool supports creating various special effects including beauty enhancements and interactive 3D effects, catering to designers aiming to produce advanced AR materials.
- [Gift AR Conversion Tool](https://pre.trtc.io/document/70541.md): The Gift AR Conversion Tool is a specialized SDK for Tencent Gift AR that enables users to convert various animation formats including PNG sequences, SVGA, WebP, PAG, and Lottie into mp4 or tcmp4 files compatible with the effect player. Designed for macOS 14 and above, this guide provides detailed steps for downloading, installing, authorizing, configuring, and using the tool to generate secure effect files with Tencent Cloud credentials.
- [Gift AR Preview Tool](https://pre.trtc.io/document/70542.md): Tencent Gift AR Preview Tool is a MacOS application designed for previewing animation materials in Gift AR. It enables users to quickly preview animations by entering a license key and dragging animation files into the preview area. Key operations include starting, pausing animations, and viewing detailed animation information such as duration, frame rate, width, height, and frame count. This guide provides step-by-step instructions for downloading, installing, and using the tool effectively.

### API Reference

- [API Reference](https://pre.trtc.io/document/60201.md): XmagicApi is the core interface class of the Beauty AR SDK for Android, offering SDK initialization, beauty effect updates, animated effect invocation, and device level detection. This API documentation details static and public methods such as setLibPathAndLoad for library loading, addAiModeFilesFromAssets for model resource management, getDeviceLevel for device capability assessment, and process for rendering image or video data.

### Release Notes

- [Release Notes](https://pre.trtc.io/document/60203.md): This document presents the release notes for the Android SDK of the Tencent RTC product, covering multiple versions from 2.4.2 to 4.3.0.31. It is intended for developers integrating or updating the Android SDK, providing detailed information on new features, bug fixes, performance improvements, and enhancements such as skin smoothing algorithms, virtual makeup trials, chroma key segmentation, and AI optimizations.

### FAQ

- [FAQ](https://pre.trtc.io/document/60312.md): Tencent RTC Android SDK FAQ provides solutions for common integration and runtime issues such as missing methods during release packaging, gson library conflicts, .so library loading failures on Android targetSdkVersion 31 or above, and handling horizontal or OES textures in beauty filters. This guide helps developers troubleshoot and resolve these problems effectively.

### Gift AR

- [Introduction](https://pre.trtc.io/document/70595.md): Gift AR is a high-performance animation effects playback SDK designed for Android, iOS, and Flutter platforms. It addresses industry challenges such as playback lag, crashes, and high power consumption by supporting multiple animation formats and ensuring smooth playback even on low-end devices. The SDK also provides secure resource encryption, interactive animation capabilities, and comprehensive playback controls to enhance user experience in interactive gift-giving scenarios.
- [Quickstart](https://pre.trtc.io/document/70530.md): Tencent Gift AR SDK Demo for Android is a development guide that helps developers quickly run the Android version of the Gift AR SDK demo. It targets Android developers using Android Studio 2.0+ and devices with API Level 19 or higher. The guide covers downloading the demo project, importing it into Android Studio, modifying dependencies and license configurations, setting up animation resources, and compiling and running the demo on real devices to experience animation playback.
- [Integration Guide](https://pre.trtc.io/document/70531.md): Tencent Gift AR SDK is an Android SDK designed to enable augmented reality gift effects in applications. This guide is intended for Android developers aiming to quickly integrate the SDK into their projects. It provides step-by-step instructions covering environment requirements, manual and Gradle integration methods, obfuscation rule configuration, soft decoding capacity integration, and license application to ensure optimal playback performance.
- [Usage Guide](https://pre.trtc.io/document/70532.md): Tencent Gift AR SDK is an augmented reality effect SDK designed for developers to integrate AR gift animations into their projects. This guide provides step-by-step instructions on license initialization, log management, player usage, playback configuration, and troubleshooting common issues to help developers quickly set up and use the SDK effectively.
- [API Reference](https://pre.trtc.io/document/70533.md): Tencent Gift AR SDK Android API documentation provides detailed information on classes and methods for integrating and using the SDK on Android platforms. It is designed for developers to configure licenses, enable logs, control video playback, and manage effect player settings. This documentation includes key API methods such as TCMediaXBase getInstance, setLicense, setLogEnable, and TCEffectAnimView startPlay, along with parameter details and common error codes for license verification.
- [Skills](https://pre.trtc.io/document/79350.md): Gift AR SDK Skills is a structured guide for integrating the Gift AR SDK playback features on Android, iOS, and Flutter platforms. It helps AI Agents convert natural language requests into executable steps, enabling developers to implement gift animation effects such as MP4 playback, blended animations, multi-animation scenarios, and animation format conversions. This guide covers prerequisites, installation methods, usage examples, and key trigger keywords for efficient integration.
- [Release Notes](https://pre.trtc.io/document/70543.md): Gift AR SDK is a cross-platform SDK for Android and iOS that enables playback of MP4 animations, fusion animations, and special effect resources. This release notes page details version updates from 3.0 to 3.5, including new features like playback progress callbacks, dynamic resource replacement, and enhanced stability optimizations. It also covers bug fixes addressing playback issues and crashes. The page includes information on related tools such as the Gift AR Conversion Tool and Gift AR Preview Tool for animation resource management and preview.
- [FAQ](https://pre.trtc.io/document/70544.md): Tencent RTC Special Effects Player FAQ provides detailed explanations and solutions for common playback failures, including license verification errors indicated by error code -10009. This guide helps developers and users on Android and iOS platforms to diagnose issues, understand error codes, and follow recommended troubleshooting steps to ensure stable playback performance.