このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

UIKit API

API Introduction

TUILiveKit is the UI Interface of the Voice Chat Room component. Using the TUILiveKit API, you can quickly create a voice chat scenario with simple interfaces. Currently, the iOS platform supports Swift language, and the voice chat component can be invoked through simple API calls. For more detailed integration steps, see: Quickly Integrate TUILiveKit.

API Overview

Voice Chat Room Master Controller (TUIVoiceRoomViewController)
API
Description
Initialize TUIVoiceRoomViewController object

init(roomId: String, behavior: RoomBehavior, roomParams: RoomParams? = nil)

Initialize TUIVoiceRoomViewController object.
public init(roomId: String, behavior: RoomBehavior, roomParams: RoomParams? = nil)
The parameters' meanings are shown in the table below:
Parameter
Type
Meaning
roomId
String
Voice Chat Room ID
behavior
Initialize Voice Chat Room Type
roomParams
Required parameter for creating a voice chat room. It can be empty when joining a room (behavior is join)

RoomBehavior

Voice Chat Room Type
Type
Description
autoCreate
Directly Create a Voice Chat Room
prepareCreate
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
Take the Mic: Free to Join the Podium, Apply to Join the Podium (Default Application to Join the Podium)