Release Notes and Announcements
User Tutorial
Product Introduction
Purchase Guide
Free Demo
SDK Download
Integration (UI Included)
- TUIKit Overview
- Audio/Video Call
  - Overview (TUICallKit)
  - Integration (TUICallKit)
  - UI Customization (TUICallKit)
  - Offline Call Push (TUICallKit)
    - Android
    - iOS
      - VoIP
      - APNs
    - Flutter
  - On-Cloud Recording (TUICallKit)
  - API Documentation (TUICallKit)
  - Release Notes (TUICallKit)
  - FAQs
    - All Platform
    - Flutter
- Audio/Video Conference
  - Overview (TUIRoomKit)
  - Integration (TUIRoomKit)
  - UI Customization (TUIRoomKit)
  - API Documentation(TUIRoomKit)
    - iOS&Mac
    - Android
    - Windows
    - Web
    - Electron
    - Flutter
  - FAQs
  - Error Code
- Interactive Live Audio Streaming
  - Integrating TUIVoiceRoom (Android)
  - Integrating TUIVoiceRoom (iOS)
  - TUIVoiceRoom APIs
    - TRTCVoiceRoom (iOS)
    - TRTCVoiceRoom (Android)
- Interactive Video Streaming
- Online Karaoke
  - Quick Integration (TUIKaraoke)
    - iOS
    - Android
  - Solution Overview (TUIKaraoke)
    - Implementation Steps
    - Song Synchronization
      - iOS
      - Android
    - Lyric Synchronization
      - iOS
      - Android
    - Vocal Synchronization
      - iOS
      - Android
    - Mixing Stream Solution
      - iOS
      - Android
  - TUIKaraoke APIs
    - TRTCKaraoke (iOS)
    - TRTCKaraoke (Android)
  - FAQs
    - iOS
    - Android
Integration (No UI)
- 0. API Examples
- 1. Importing the SDK
- 2. Entering a Room
- 3. Subscribing to Audio/Video Streams
- 4. Publishing Audio/Video Streams
- 5. Exiting a Room
- 6. Sensing Network Quality
- 7. Enabling Screen Sharing
- 8. Sharing Computer Audio
- 9. Setting Video Quality
- 10. Rotating Videos
- 11.FAQs
  - FAQs for Beginners
Advanced Features
- Relay to CDN
- Enabling Advanced Permission Control
- RTMP Streaming with TRTC
- Testing Hardware Devices
  - Android&iOS&Windows&Mac
  - Web
- Testing Network Quality
  - Android&iOS&Windows&Mac
  - Web
- On-Cloud Recording
- Custom Capturing and Rendering
  - Android, iOS, Windows, and macOS
  - Web
- Custom Audio Capturing and Playback
  - Android, iOS, Windows, and macOS
  - Web
- Sending and Receiving Messages
- Event Callbacks
- Content Moderation
  - Specified-Room Moderation
- Access Management
- How to push stream to TRTC room with OBS WHIP
Sample Code
Client APIs
- iOS and macOS
- Android
- All Platforms (C++)
- Web
  - Overview
  - Error Codes
- Electron
  - Overview
  - Error Codes
- Flutter
  - Overview
  - Error Codes
- Unity
  - Overview
  - Error Codes
Server APIs
- History
- Introduction
- API Category
- Making API Requests
- Room Management APIs
- Call Quality Monitoring APIs
- Pull stream Relay Related interface
- Stream mixing and relay APIs
- On-cloud recording APIs
- Usage Statistics APIs
- Data Types
- Error Codes
- Appendix
  - Event ID Mapping Table
Console Guide
- Selection of Service region
- Application Management
- Package Management
- Usage Statistics
- Monitoring Dashboard
  - Call Data
  - Real-Time Monitoring
- Development Assistance
  - UserSig Generation and Verification
FAQs
Legacy Documentation
Service Level Agreement
TRTC Policy
- Privacy Policy
- Data Processing And Security Agreement
Glossary

TUICallEngine

Last updated: 2023-09-19 16:08:49Download PDF

TUICallEngine APIs
TUICallEngine is an audio/video call component that does not include UI elements.
API Overview
API
Description
﻿createInstance﻿
Creates a TUICallEngine instance (singleton mode).
﻿destroyInstance﻿
Terminates a TUICallEngine instance (singleton mode).
﻿on﻿
Listens for an event.
﻿off﻿
Stops listening for an event.
﻿login﻿
Logs in.
﻿logout﻿
Logs out.
﻿setSelfInfo﻿
Sets the alias and profile photo.
﻿call﻿
Makes a one-to-one call.
﻿groupCall﻿
Makes a group call.
﻿accept﻿
Accepts a call.
﻿reject﻿
Rejects a call.
﻿hangup﻿
Ends a call.
﻿inviteUser﻿
Invites users to the current group call.
﻿joinInGroupCall﻿
Joins the current group call.
﻿switchCallMediaType﻿
Changes the call type.
﻿startRemoteView﻿
Starts rendering a remote video.
﻿stopRemoteView﻿
Stops rendering a remote video.
﻿startLocalView﻿
Starts rendering the local video.
﻿stopLocalView﻿
Stops rendering the local video.
﻿openCamera﻿
Turns the camera on.
﻿closeCamara﻿
Turns the camera off.
﻿openMicrophone﻿
Turns the mic on.
﻿closeMicrophone﻿
Turns the mic off.
﻿setVideoQuality﻿
Sets the video quality.
﻿getDeviceList﻿
Gets the device list.
﻿switchDevice﻿
Changes to a different camera/mic.
﻿enableAIVoice﻿
Enables/Disables AI noise canceling.
﻿

API	Description
createInstance	Creates a `TUICallEngine` instance (singleton mode).
destroyInstance	Terminates a `TUICallEngine` instance (singleton mode).
on	Listens for an event.
off	Stops listening for an event.
login	Logs in.
logout	Logs out.
setSelfInfo	Sets the alias and profile photo.
call	Makes a one-to-one call.
groupCall	Makes a group call.
accept	Accepts a call.
reject	Rejects a call.
hangup	Ends a call.
inviteUser	Invites users to the current group call.
joinInGroupCall	Joins the current group call.
switchCallMediaType	Changes the call type.
startRemoteView	Starts rendering a remote video.
stopRemoteView	Stops rendering a remote video.
startLocalView	Starts rendering the local video.
stopLocalView	Stops rendering the local video.
openCamera	Turns the camera on.
closeCamara	Turns the camera off.
openMicrophone	Turns the mic on.
closeMicrophone	Turns the mic off.
setVideoQuality	Sets the video quality.
getDeviceList	Gets the device list.
switchDevice	Changes to a different camera/mic.
enableAIVoice	Enables/Disables AI noise canceling.