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

UIKit API

API Introduction

VideoLiveKit is a live streaming component with a UI interface, using the VideoLiveKit API, you can quickly implement an online live streaming scenario through simple interfaces. If you want to experience and debug interactive live streaming, please refer to Run Demo. If you want to integrate our feature directly into your project, please read Quick Integration (TUILiveKit).

API Overview

API
Description
Create a VideoLiveKit instance (Singleton Pattern)
startLive
Start a live room using roomId.
joinLive
Join a live room using roomId.

API Details

createInstance

Obtain a VideoLiveKit instance.
static func createInstance() -> VideoLiveKit
Returned value:VideoLiveKit

startLive

Start a live room using roomId.
func startLive(roomId: String)
Parameter:
Parameter
Type
Description
Default Value
Meaning
roomId
String
Mandatory
-
Live Streaming Room ID
Return Value:void

joinLive

Join a live room using roomId.
func joinLive(roomId: String)
Parameter:
Parameter
Type
Description
Default Value
Meaning
roomId
String
Mandatory
-
Live Streaming Room ID
Return Value:void