# Tencent RTC RTC Engine — Android

> RTC Engine documentation for Android platform.

## Core SDK

### Get Started

- [Activate Service](https://pre.trtc.io/document/73281.md): Tencent RTC-Engine is a real-time communication SDK offering audio and video call capabilities, cloud recording, mixed-stream transcoding, and live streaming relay. This guide helps users activate the trial service, create applications, run demos, purchase official subscriptions, renew or upgrade editions, and enable automatic renewal. Follow step-by-step instructions to quickly start using Tencent RTC-Engine for your audio and video communication needs.
- [Run the Demo](https://pre.trtc.io/document/35084.md): The TRTC Android SDK quickstart guide helps developers set up and run the TRTC sample project on Android devices running version 4.4 or later. It covers prerequisites, project download, configuration with SDKAppID and SDKSecretKey, running the project in Android Studio, and exploring TRTC features. The guide also emphasizes secure UserSig generation on the server side for production environments.
- [Integration](https://pre.trtc.io/document/62045.md): The TRTC SDK Android Quickstart guide explains how to implement basic audio and video call features on Android devices. It is designed for developers using Android Studio 4.0 or later and Android 4.4 or above. This guide walks through essential steps including SDK integration, project configuration, requesting permissions, creating TRTC instances, entering rooms, and controlling camera and microphone to enable seamless real-time communication.

### Basic Features

- [UserSig Authentication](https://pre.trtc.io/document/35166.md): This guide explains how to calculate UserSig, a security signature for Tencent-RTC services, during the debugging phase. It covers obtaining SDKAppID and SDKSecretKey from the Tencent-RTC console and generating UserSig using client sample code on multiple platforms including Android, iOS, Web, Windows, Flutter, and Mac. The steps ensure secure authentication for developers testing Tencent-RTC SDKs before official deployment.
- [Network Quality Probing](https://pre.trtc.io/document/48272.md): Tencent RTC SDKs for Android, iOS, Windows, and macOS enable developers to detect network quality before and during video calls. This guide explains how to perform speed testing using the startSpeedTest API, interpret key parameters such as packet loss, latency, and bandwidth, and use the results to optimize server selection and enhance call experience. Step-by-step instructions and sample code snippets are provided to help you integrate network quality detection into your applications.
- [Video Quality & Encoding Profiles](https://pre.trtc.io/document/35153.md): TRTCCloud SDK provides video quality configuration options for multiple platforms including iOS, Android, macOS, Windows, Web, Electron, and Flutter. It supports scenario-based settings through TRTCAppScene, encoding parameters via TRTCVideoEncParam, and network policies using TRTCNetworkQosParam to optimize video call and live streaming experiences. This overview details recommended configurations for resolution, frame rate, and bitrate tailored to scenarios such as video calls, conferencing, and online education to meet diverse project needs.
- [Video Rotation](https://pre.trtc.io/document/35154.md): Tencent RTC TRTC SDK quickstart guide for Android, iOS, Windows, and macOS explains how to implement portrait and landscape video modes. It covers setting app orientation, configuring video encoder parameters, and customizing local and remote image rotation and rendering. This guide helps developers deliver video call and live streaming experiences with correct page orientation and image adaptation.
- [Live Streaming Mode](https://pre.trtc.io/document/64695.md): Tencent Real-Time Communication (TRTC) provides a live streaming SDK supporting iOS, Android, Mac OS, Windows, Web, Electron, and Flutter platforms. This guide explains how to implement live streaming in the TRTC_APP_SCENE_LIVE scenario by managing user roles as Host or Audience. Key steps include entering the room with appropriate roles, publishing streams as a Host, and subscribing as an Audience, enabling scalable live broadcasting with up to 100,000 audience members.
- [Device Management](https://pre.trtc.io/document/64696.md): Tencent Real-Time Communication (TRTC) Live Streaming SDK provides developers with comprehensive media device control capabilities. This guide explains how to turn on/off the microphone and camera, control the camera preview, toggle the flash, enable or disable face focus, and detect speaking status after mute, enabling flexible media management during live streaming on Android, iOS, Mac, and Windows platforms.
- [Volume Control](https://pre.trtc.io/document/64697.md): The TRTC SDK quickstart guide demonstrates how to detect and adjust the volume levels of local and remote microphones across Android, iOS, Mac, and Windows platforms. It provides step-by-step instructions to enable audio volume evaluation, receive real-time volume feedback through callbacks, and configure volume parameters to manage audio input effectively for interactive audio and video communication scenarios.
- [Screen Sharing](https://pre.trtc.io/document/37337.md): Tencent RTC Android SDK provides a detailed quickstart guide for enabling screen sharing in TRTC rooms. This guide is designed for developers integrating screen sharing into their Android applications, explaining how to start screen sharing using the startScreenCapture() API, configure encoding parameters for different scenarios, and optionally create a floating window to keep the app active during background sharing. It also covers how to watch shared screens from various platforms by handling primary and substreams appropriately.

### Advanced Features

- [Custom Video Capture & Rendering](https://pre.trtc.io/document/35158.md): The TRTC SDK provides custom video capturing and rendering capabilities for Android, iOS, Windows, and macOS platforms. This guide explains how to enable custom video capturing, send custom video frames, and set up local and remote video rendering callbacks. It includes platform-specific API examples and details on video data formats to help developers implement customized video processing and rendering workflows.
- [Custom Audio Processing](https://pre.trtc.io/document/47635.md): The TRTC SDK guide for Android, iOS, Windows, and macOS demonstrates how to enable custom audio capturing, send custom audio frames, and set audio callbacks. This quickstart helps developers integrate custom audio capturing features across multiple platforms, providing step-by-step API usage examples to capture and render audio data effectively.
- [Basic Beauty Effects](https://pre.trtc.io/document/64698.md): This tutorial explains how to enable and configure beauty effects in TRTC live broadcast SDK. It guides users through setting up skin smoothing, whitening, ruddy, and facial special effects such as enlarging eyes and slimming face. The guide covers applying beauty algorithms, adjusting whitening and ruddy levels, adding color filters, and using animated effects across Android, iOS, Mac, and Windows platforms. Prerequisites include having an SDKAppID and ensuring RTC service availability.
- [AI Noise Suppression](https://pre.trtc.io/document/66038.md): The AI Noise Suppression feature in Tencent RTC Android SDK leverages AI algorithms from Tencent Tianlai Laboratory to intelligently detect and remove noise interference from transmitted audio signals. This guide helps developers activate AI Noise Suppression to enhance voice clarity and sound quality in various environments such as offices, internet cafes, malls, and outdoors. Key steps include trying the feature online via the Tencent RTC Demo and enabling it by default with TRTCAudioQualitySpeech for seamless integration.
- [Background Music & Audio Mixing](https://pre.trtc.io/document/64699.md): Tencent RTC Engine provides a background music SDK that enables developers to play, pause, resume, and stop background music during live streaming sessions. This guide covers the essential steps to integrate background music playback on Android, iOS, Mac, and Windows platforms, including setting playback parameters, handling playback events, adjusting volume and pitch, and controlling playback speed.
- [Custom Messages / SEI Messages](https://pre.trtc.io/document/47866.md): The TRTC SDK is a real-time communication SDK that enables anchors in a video room to send custom messages to other participants. This guide covers the steps to send custom messages on supported platforms including iOS, Android, Web, macOS, Windows, Electron, and Flutter. It explains how to use the sendCustomCmdMsg API with required parameters such as message ID, data content, and reliability options to ensure ordered and reliable message delivery.
- [Media Stream Encryption](https://pre.trtc.io/document/61828.md): Tencent Real-Time Communication (TRTC) SDK offers media stream private encryption to secure user data transmission in sensitive industries like finance. This guide explains how developers on iOS, Android, Windows, and macOS can enable private encryption by generating keys and salts on the server, configuring the SDK, and ensuring all users in a room use consistent encryption settings. It covers prerequisites, implementation steps, and example code to integrate this enhanced security feature.
- [Video Snapshot Upload](https://pre.trtc.io/document/64802.md): The TRTC Video Screenshot Upload SDK feature enables automatic capture and upload of video screenshots for use cases such as third-party content review and cover image setting. Available on Android, iOS/Mac, and Windows with the Pro Edition package, it requires enabling the feature in the TRTC Console and configuring storage on Tencent Cloud COS or AWS S3. Developers can control screenshot intervals and stream types via an experimental SDK API and receive server-side event callbacks through configurable HTTP/HTTPS endpoints with retry mechanisms to ensure reliable notification delivery.

### Client APIs

- [Overview](https://pre.trtc.io/document/35125.md): The TRTCCloud API overview provides a comprehensive reference for Tencent RTC's real-time communication SDK. It includes detailed descriptions of instance management, room operations, CDN streaming, video and audio controls, device management, and event callback functions. This documentation is intended for developers integrating TRTCCloud SDK to build interactive audio and video applications with features such as multi-room support, custom rendering, and network quality control.
- [TRTCCloud](https://pre.trtc.io/document/50762.md): TRTCCloud is the primary API class in Tencent Cloud's TRTC SDK, offering comprehensive real-time communication capabilities including room entry and exit, media stream publishing, audio and video control, and network quality management. This reference is intended for developers integrating TRTC services to implement interactive audio and video features across supported platforms. It details method functionalities such as event listener management, stream subscription, 3D spatial audio effects, and device management.
- [TRTCCloudListener](https://pre.trtc.io/document/50763.md): TRTCCloudListener is an event callback interface in the TRTC Android SDK that provides comprehensive callback methods for handling video call events. It supports video rendering, audio frame processing, network status updates, user stream changes, and publishing control, enabling developers to manage real-time communication scenarios effectively.
- [TRTCStatistics](https://pre.trtc.io/document/50764.md): TRTCStatistics is a read-only API in the TRTC SDK that reports current real-time audio and video metrics every two seconds. It provides detailed local and remote audio/video statistics including bitrate, frame rate, packet loss, playback lag, and network delays. This API helps developers monitor and analyze the performance of audio/video streams in real-time communication scenarios on supported platforms.
- [TXAudioEffectManager](https://pre.trtc.io/document/50765.md): TXAudioEffectManager is an audio effect management SDK module that enables developers to control background music, short audio effects, and voice effects in real-time communication scenarios. It supports playback control, volume adjustment, pitch and speed modification, in-ear monitoring, and voice effect settings. The API also provides event callbacks for music preload and playback progress, facilitating effective audio management in applications.
- [TXBeautyManager](https://pre.trtc.io/document/50766.md): TXBeautyManager is a beauty filter and image processing configuration SDK that enables developers to adjust beautification, color filters, and green screen effects. It provides APIs to set parameters like skin smoothing styles, filter strengths, facial feature adjustments, and AI animated effects. This reference helps developers integrate and customize beauty effects in applications using Tencent RTC technology.
- [TXDeviceManager](https://pre.trtc.io/document/50767.md): TXDeviceManager is an audio/video device management module that provides APIs for controlling cameras, microphones, and speakers on mobile operating systems. It enables developers to switch cameras, adjust zoom and focus, enable auto focus and torch mode, set exposure compensation, and manage audio routes and system volume types. This API reference details the functions and parameters available for precise device control in real-time communication scenarios.
- [Type Definition](https://pre.trtc.io/document/50768.md): The TRTC key class definition document provides detailed struct and enumeration types used in the Tencent Real-Time Communication SDK. It defines parameters for video resolution, encoding, network quality, rendering, audio and video frames, and other configuration settings essential for developers implementing TRTC features. This reference is intended for developers working with TRTC on supported platforms such as Android, enabling precise control over media stream encoding, transmission, and rendering.
- [Deprecated Interface](https://pre.trtc.io/document/50769.md): The Deprecated TRTCCloud API reference documents legacy interfaces of the TRTCCloud SDK, a real-time audio and video communication SDK by Tencent RTC. It is intended for developers maintaining or migrating from older versions of the SDK and details functions for beauty effects, audio controls, camera operations, video rendering, and other multimedia features that are no longer recommended for use.
- [Error Codes](https://pre.trtc.io/document/35130.md): The TRTC SDK error codes document lists detailed error and warning codes encountered during the use of Tencent Real-Time Communication SDK. It helps developers identify and resolve issues related to camera, microphone, speaker, screen capture, video encoding, and audio plugin across mobile, Windows, and macOS platforms. The guide provides error code definitions and suggested solutions to improve debugging efficiency.

### Solution

- [Quick Integration](https://pre.trtc.io/document/41941.md): TUIKaraoke is an open-source audio/video UI component SDK designed for Android to enable online karaoke, seat management, gift giving, and text chat features. This quickstart guide walks you through downloading and importing the component, configuring necessary permissions and obfuscation rules, initializing and logging in, and implementing the online karaoke scenario with optional chat and gift features.
- [Implementation Steps](https://pre.trtc.io/document/57023.md): This guide explains the implementation steps for building a complete online Karaoke scenario using Tencent RTC. It covers essential modules including room management, seat management, song selection management, and Karaoke management. The document details how to create and manage Karaoke rooms, control seat interactions, and handle song selection and queue management, providing a comprehensive approach for developers to build interactive Karaoke experiences.
- [Song Synchronization](https://pre.trtc.io/document/57026.md): Tencent Cloud's Android real-time synchronization SDK enables accurate song progress alignment during chorus performances by leveraging NTP time calibration and custom signaling. This guide walks through key steps including NTP calibration, sending and receiving chorus signaling, and playback progress correction to ensure synchronized music playback across multiple devices with minimal delay.
- [Lyric Synchronization](https://pre.trtc.io/document/57029.md): This guide details the Android lyrics synchronization implementation process for Tencent RTC, focusing on karaoke scenarios. It explains how to calibrate NTP time, enable black frame compensation, send song progress through SEI messages, and synchronize lyrics locally and remotely. The guide includes key code examples for developers to integrate real-time lyrics synchronization effectively in their applications.
- [Vocal Synchronization](https://pre.trtc.io/document/57033.md): Tencent RTC Android SDK guide for vocal and song synchronization demonstrates how to reduce audio delay by enabling chorus mode and low-latency mode. This guide targets developers integrating real-time audio features to improve synchronization between vocals and background music using specific experimental API calls. Key steps include enabling chorus mode for vocal and accompaniment instances and activating high-performance audio AAudio for low latency.
- [Mixing Stream Solution](https://pre.trtc.io/document/57036.md): The TRTCCloud SDK for Android enables developers to implement real-time audio streaming with separate main and sub-instances for vocal and accompaniment. This quickstart guide walks through creating instances, entering rooms, pushing audio streams, and initiating mixed stream transcoding to support synchronized multi-stream audio scenarios.
- [TRTCKaraoke APIs](https://pre.trtc.io/document/41943.md): TRTCKaraokeRoom is an Android SDK that integrates Tencent Real-Time Communication (TRTC) and Tencent Cloud Chat to enable karaoke room creation, speaker and listener roles, seat management, music playback, audio control, messaging, and invitation signaling. This API reference details the methods for managing rooms, controlling audio and music playback, handling seat operations, sending messages, and processing event callbacks to build interactive karaoke applications.
- [FAQs](https://pre.trtc.io/document/57039.md): This FAQ document for the TRTC SDK on Android addresses common ear monitoring issues in Karaoke scenarios, including enabling the ear monitoring function, troubleshooting no effect or high latency problems, and hardware considerations. It also covers NTP time synchronization and DNS resolution errors, along with recommendations for network speed testing to ensure a stable real-time chorus experience. Detailed code examples and best practices are provided to help developers optimize audio performance and network reliability.

### FAQ

- [FAQs for Beginners](https://pre.trtc.io/document/38104.md): Tencent Real-Time Communication (TRTC) FAQs provide essential information for beginners about the TRTC SDK, including UserSig security, supported platforms, room capacity, live streaming roles, screen sharing, and troubleshooting common issues. This guide helps developers understand how to use TRTC features effectively and resolve typical problems encountered during integration and usage.
- [Billing](https://pre.trtc.io/document/42298.md): Tencent Real-Time Communication (TRTC) Billing FAQ provides detailed answers on billing methods, discounts for high-demand customers, usage tracking, and cost estimation. It explains how TRTC services are billed, how to view bills and usage details, and clarifies billing for audio and video durations. The FAQ also covers how free minutes and Monthly Active Users (MAU) are calculated across multiple subscription packages with the same SDKAppID, helping users manage and estimate their TRTC service expenses effectively.
- [Features](https://pre.trtc.io/document/36057.md): Tencent Real-Time Communication (TRTC) SDK offers a comprehensive platform for developing interactive audio and video communication applications. Designed for developers needing group audio/video calls and low-latency live streaming, TRTC supports diverse scenarios such as video calls, live streaming, and voice chat rooms. Key features include flexible role management, manual stream subscription, support for large concurrent audiences, and multi-platform demos for rapid deployment.
- [Firewall Restrictions](https://pre.trtc.io/document/35164.md): Tencent TRTC SDK firewall restriction FAQ provides detailed guidance on the ports and domain names to add to firewall allowlists for native SDK and WebRTC clients. It also explains how to configure proxies using Nginx and Coturn to enable client access to the TRTC SDK from private networks, ensuring smooth connectivity and compliance with network security requirements.
- [How to Downsize Installation Package](https://pre.trtc.io/document/35165.md): This FAQ document addresses how to reduce the installation package size after integrating the TRTC SDK for iOS and Android platforms. It explains the file size increments caused by the SDK and provides detailed methods such as packaging only specific architectures for iOS, enabling Bitcode, and selectively packaging or downloading .so files for Android. These solutions help developers optimize app size while maintaining TRTC SDK functionalities.
- [TRTCCalling for Web](https://pre.trtc.io/document/43096.md): TRTCCalling for Web is a real-time communication SDK based on TRTC and TIM that enables one-to-one and group audio/video calls. This FAQ page helps developers and users resolve common issues such as browser compatibility, network quality testing, device permission errors, and integration challenges. It provides detailed explanations and solutions for errors encountered during audio/video calls and SDK operations to ensure smooth communication experiences.
- [Audio and Video Quality](https://pre.trtc.io/document/43094.md): Tencent Real-Time Communication (TRTC) SDK offers comprehensive troubleshooting guidance for audio and video quality issues. This FAQ helps developers and users resolve common problems such as black bars in video images, video stutter, low-quality or blurry videos, audio volume and echo issues, and device status errors. It also explains how to monitor network status and adjust video orientation and mirroring settings to optimize call and streaming experiences.
- [Others](https://pre.trtc.io/document/36058.md): Tencent Real-Time Communication (TRTC) FAQ provides solutions to common issues and questions related to live streaming, interactive live streaming, relayed live streaming, and TRTC usage. It covers topics such as differences between streaming types, user ID conflicts, playback stuttering, room entry errors, log viewing, error codes, and cross-room calls. This guide helps developers and users troubleshoot and optimize their TRTC and live streaming experience across multiple platforms including iOS, Android, Windows, and Web.
- [Android FAQs](https://pre.trtc.io/document/37341.md): Tencent Real-Time Communication (TRTC) SDK FAQ for Android and iOS addresses common questions about system volume types, screen sharing, cross-platform communication, architecture support, Swift integration, background running, event listening, co-anchoring, multi-room login, and SDK version management. This guide helps developers understand how to configure and use TRTC features effectively on mobile devices.