UIKit API

API 简介

VideoLiveKit 是在线直播组件的 UI 使用相关的接口,使用 VideoLiveKit API,您可以通过简单接口快速实现一个在线直播场景,如果您想要体验并调试互动直播效果,请阅读 Demo 快速跑通。如果您想把我们的功能直接集成到您的项目中,请阅读 快速接入(TUILiveKit)

API 概览

API
描述
创建 VideoLiveKit 实例(单例模式)
startLive
通过 roomId 开启一个直播间。
joinLive
通过 roomId 加入一个直播间。

API 详情

createInstance

获取一个 VideoLiveKit 对象实例。
static func createInstance() -> VideoLiveKit

返回值:VideoLiveKit

startLive

通过 roomId 开启一个直播间。
func startLive(roomId: String)
参数:
参数
类型
说明
默认值
含义
roomId
String
必填
-
直播间 ID
返回值:void

joinLive

通过 roomId 加入一个直播间。
func joinLive(roomId: String)
参数:
参数
类型
说明
默认值
含义
roomId
String
必填
-
直播间 ID
返回值:void