Skip to content

Latest commit

 

History

History
121 lines (86 loc) · 6.02 KB

README.md

File metadata and controls

121 lines (86 loc) · 6.02 KB
Raw

简体中文 | English

This document shows how to integrate the TRTC SDK in Unity to enable audio/video calls in games.

The demo includes the following features:

  • Room entry/exit
  • Custom video rendering
  • Device management and music/voice effects

For details about API features and parameters, please see Client APIs > Unity > Overview.

Environmental description

  • Unity 2020.2.1f1 is recommended.
  • Supported platforms: Android, iOS, Windows, macOS
  • Modules required: Android Build Support, iOS Build Support, Windows Build Support, MacOS Build Support
  • If you are developing for iOS, you also need:
    • Xcode 11.0 or above
    • A valid developer signature for your project

Directions

Step 1. Create an application

  1. Log in to the TRTC console and select Application Management > Create application.
  2. Click Create Application and enter the application name such as APIExample. If you have already created an application, click Select Existing Application. #900px
  3. Add or edit tags according to your actual business needs and click Create.

An application name can contain up to 15 characters. Only digits, letters, Chinese characters, and underscores are allowed.

Tags are used to identify and organize your Tencent Cloud resources. For example, an enterprise may have multiple business units, each of which has one or more TRTC applications. In this case, the enterprise can tag TRTC applications to mark out the unit information. Tags are optional and can be added or edited according to your actual business needs.

Step 2. Download the SDK and source code

  1. Download the SDK and demo source code for your platform.
  2. Click Next. #900px

Step 3. Configure demo project files

  1. In the Modify Configuration step, select the development platform in line with the source package downloaded. #900px
  2. Find and open TRTC-Simple-Demo/Assets/TRTCSDK/Demo/Tools/GenerateTestUserSig.cs.
  3. Set parameters in GenerateTestUserSig.cs as follows:
    • SDKAPPID: a placeholder by default. Set it to the actual SDKAppID.
    • SECRETKEY: a placeholder by default. Set it to the actual key. #900px
  4. Click Next to complete the creation.
  5. After compilation, click Return to Overview Page.

Step 4. Compile and run

Android

  1. Open Unity Editor, go to File > Build Settings, and select Android for Platform.
  2. Connect to a real Android device and click Build And Run to run the demo.
  3. Call enterRoom first and go on to test other APIs. The data display window shows whether the call is successful, and the other window displays the callback information.

iOS

  1. Open TRTC Build Configuration（You can find it in the navigation bar at the top of the unity editor）
  2. Click IOS，Wait for project generation to complete
  3. Use Xcode to open the generated 'Unity-iPhone.xcodeproj' project
  4. Download TRTC SDK.You need to manually add the dynamic libraries. Click General, expand Frameworks, Libraries, and Embedded Content, and click the + icon at the bottom to add the dynamic libraries required in turn: FFmpeg.xcframework, and SoundTouch.xcframework. Click Embed & Sign.
  5. Connects IOS device for debugging

Windows

  1. Open Unity Editor, go to File > Build Settings, and select PC, Mac & Linux Standalone for Platform and Windows for Target Platform.
  2. Click Build And Run to run the demo.

macOS

  1. Open Unity Editor, go to File > Build Settings, and select PC, Mac & Linux Standalone for Platform, and macOS for Target Platform.
  2. Open Player Setting , change Scripting Backend to IL2CPP
  3. Click Build And Run to run the demo.

Demo

The demo integrates most of the APIs launched so far, which can be used for testing and as reference for API calls. For more information about APIs, see Client APIs > Unity > Overview.

The UI of the latest version of the demo may look different.

Directory Structure

├─Assets
├── Editor                        // Unity Editor script
│   ├── BuildScript.cs            // Unity Editor build menu
│   ├── IosPostProcess.cs         // Script for building iOS application in Unity Editor
├── Plugins
│   ├── Android
│   │   ├── AndroidManifest.xml   //Android configuration file
├── StreamingAssets               // Audio/video stream files for the Unity demo
├── TRTCSDK
    ├── Demo                      // Unity demo
    ├── SDK                       // TRTC SDK for Unity
        ├── Implement             // Implementation of TRTC SDK for Unity
        ├── Include               // Header files of TRTC SDK for Unity
        └── Plugins               // Underlying implementation of TRTC SDK for Unity for different platforms