Video Live 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).
Note:
If you have your own UI design and want to develop with LiveKit business, we also provide the more flexible and comprehensive RTC Room Engine SDK. You can learn more about its features by checking our RTC Room Engine SDK API documentation.
API Overview
API | Description |
Create a VideoLiveKit instance (Singleton Pattern) | |
Start a live room using roomId. | |
End the live stream. | |
Join a live room using roomId. | |
Leave the live stream. |
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 | Meaning |
roomId | String | Mandatory | Live Streaming Room ID |
stopLive
Join a live streaming room by roomId.
func stopLive(onSuccess: TUISuccessBlock?, onError: TUIErrorBlock?)
Parameters:
Parameter | Type | Description | Meaning |
onSuccess | TUISuccessBlock? | Optional | Success callback. Specific type: () -> Void? |
onError | TUIErrorBlock? | Optional | Callback failure. Specific type: (TUIError, String)? |
joinLive
Join a live room using roomId.
func joinLive(roomId: String)
Parameter:
Parameter | Type | Description | Meaning |
roomId | String | Mandatory | Live Streaming Room ID |
leaveLive
Join a live streaming room through roomId.
func leaveLive(onSuccess: TUISuccessBlock?, onError: TUIErrorBlock?)
Parameter:
Parameter | Type | Description | Meaning |
onSuccess | TUISuccessBlock? | Optional | Success callback. Specific type: () -> Void? |
onError | TUIErrorBlock? | Optional | Callback failure. Specific type: (TUIError, String)? |
