UIKit API

API Introduction

TUILiveKit is a multi-user voice chat component with a UI interface. Using the TUILiveKit API, you can quickly implement a voice chat scenario through simple interfaces. Currently, the Android platform only supports Java language, and you can invoke the voice chat component through simple API calls. For more detailed integration steps, refer to: Quick Integration with TUILiveKit.

API Overview

Voice Chat Room Main Interface (TUIVoiceRoomFragment)
API
Description
Construct the Voice Chat Room Main Interface Object

TUIVoiceRoomFragment

Construct the Voice Chat Room Main Interface Object
public TUIVoiceRoomFragment(String roomId, LiveDefine.RoomBehavior behavior, LiveDefine.RoomParams params)
The parameters' meanings are shown in the table below:
Parameter
Type
Meaning
roomId
String
Voice Chat Room ID
behavior
Initialize Voice Chat Room Type
params
Required Parameters for Creating a Voice Chat Room

RoomBehavior

Voice Chat Room Type
Type
Description
AUTO_CREATE
Directly Create a Voice Chat Room
PREPARE_CREATE
Preview Page to Create a Voice Chat Room
JOIN
Join a Voice Chat Room

RoomParams

Voice Chat Room Parameters
Type
Description
maxSeatCount
Maximum Number of Microphones in the Room, defaults to the maximum number supported by the package bundle
seatMode
Microphone Mode: Free to Join the Podium, Apply to join the microphone (default is Apply to join the microphone)