即时通信 IM 开播方式

一、核心功能

LiveCoreView 是一个专为直播场景设计的轻量级 View 组件，是你构建直播场景的核心，它封装了所有复杂的底层直播技术（例如推拉流、连麦、音视频渲染）。你可以将 LiveCoreView 作为直播画面的"画布"，专注于上层 UI 与交互的开发。

通过下方的视图层级示意图，你可以直观了解 LiveCoreView 在直播界面中的位置和作用：

二、步骤1：开通服务

请参见 开通服务，获取体验版或付费版 SDK。

三、步骤2：在当前项目中导入 AtomicXCore

安装组件：请在你的 build.gradle 文件中添加 implementation 'com.tencent.atomicx:atomicxcore:latest' 依赖，然后执行 Gradle Sync。

build.gradle.ktsbuild.gradleimplementation("io.trtc.uikit:atomicx-core:latest.release")api("com.tencent.imsdk:imsdk-plus:8.9.7511")implementation 'io.trtc.uikit:atomicx-core:latest.release'api "com.tencent.imsdk:imsdk-plus:8.9.7511"

四、步骤3：实现登录逻辑

在你的项目中调用 LoginStore.shared.login 完成登录，这是使用 AtomicXCore 所有功能的关键前提。

注意：重要：

注意：推荐在你 App 自身的用户账户登录成功后，再调用 LoginStore.shared.login，以确保登录业务逻辑的清晰和一致。

import android.os.Bundleimport androidx.appcompat.app.AppCompatActivityimport io.trtc.tuikit.atomicxcore.api.login.LoginStoreimport io.trtc.tuikit.atomicxcore.api.CompletionHandlerimport android.util.Logclass MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) LoginStore.shared.login( this, // context 1400000001, // 替换为你的 SDKAppID "test_001", // 替换为你的 UserID "xxxxxxxxxxx", // 替换为你的 UserSig object : CompletionHandler { override fun onSuccess() { // 登录成功处理 Log.d("Login", "login success"); } override fun onFailure(code: Int, desc: String) { // 登录失败处理 Log.e("Login", "login failed, code: $code, error: $desc"); } } ) }}

登录接口参数说明：

五、步骤1：实现主播视频开播

主播开播流程如下，你只需执行以下几步操作，即可快速搭建主播视频直播。

注意：提示：

注意：主播开播推流的业务代码，你也可以参考 TUILiveKit 开源项目中的 VideoLiveAnchorActivity.kt 文件来了解完整的实现逻辑。

1. 初始化主播推流的视图

在你的主播 Activity 中，创建一个 LiveCoreView 实例，并将 viewType 指定为 PUSH_VIEW（推流视图）。

import io.trtc.tuikit.atomicxcore.api.view.CoreViewTypeimport io.trtc.tuikit.atomicxcore.api.view.LiveCoreViewimport android.os.Bundleimport androidx.appcompat.app.AppCompatActivityimport androidx.constraintlayout.widget.ConstraintLayout// YourAnchorActivity 代表你的主播开播Activityclass YourAnchorActivity : AppCompatActivity() { // 1. 将 LiveCoreView 作为你Activity的一个属性 private lateinit var coreView: LiveCoreView override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) // 2. 初始化视图 coreView = LiveCoreView(this, viewType = CoreViewType.PUSH_VIEW) coreView.setLiveID("test_live_001") // 布局 UI setupUI() } private fun setupUI() { setContentView(R.layout.activity_anchor) // 3. 将主播推流页面加载到你的视图上 val container = findViewById<ConstraintLayout>(R.id.container) container.addView(coreView) // 设置布局参数 val params = ConstraintLayout.LayoutParams( ConstraintLayout.LayoutParams.MATCH_PARENT, ConstraintLayout.LayoutParams.MATCH_PARENT ) params.topMargin = 36 params.bottomMargin = 96 coreView.layoutParams = params }}

2. 打开摄像头和麦克风

通过调用 DeviceStore 的 openLocalCamera、openLocalMicrophone 接口打开摄像头和麦克风，你无需做额外操作，LiveCoreView 会自动预览当前摄像头的视频流，示例代码如下：

import androidx.appcompat.app.AppCompatActivityimport android.os.Bundleimport io.trtc.tuikit.atomicxcore.api.device.DeviceStoreclass YourAnchorActivity : AppCompatActivity() { // … 其他代码 … override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) // 布局 UI setupUI() // 打开设备 openDevices() } private fun openDevices() { // 1. 打开前置摄像头 DeviceStore.shared().openLocalCamera(true, completion = null) // 2. 打开麦克风 DeviceStore.shared().openLocalMicrophone(completion = null) }}

3. 开始直播

通过调用 LiveListStore 的 createLive 接口开始视频直播，完整示例代码如下：

import android.util.Logimport androidx.appcompat.app.AppCompatActivityimport io.trtc.tuikit.atomicxcore.api.live.LiveInfoimport io.trtc.tuikit.atomicxcore.api.live.LiveInfoCompletionHandlerimport io.trtc.tuikit.atomicxcore.api.live.LiveListStoreclass YourAnchorActivity : AppCompatActivity() { // … 其他代码 … // 调用开播接口开始直播 private fun startLive() { val liveInfo = LiveInfo().apply { // 1. 设置直播的房间 id liveID = "test_live_001" // 2. 设置直播的房间名称 liveName = "test 直播" // 3. 配置布局模板，VideoDynamicGrid9Seats 为九宫格布局 seatTemplate = SeatLayoutTemplate.VideoDynamicGrid9Seats } // 5. 调用 LiveListStore.shared().createLive 开始直播 LiveListStore.shared().createLive(liveInfo, object: LiveInfoCompletionHandler { override fun onFailure(code: Int, desc: String) { Log.e("Live", "Response startLive onError: $desc") } override fun onSuccess(liveInfo: LiveInfo) { Log.d("Live", "Response startLive onSuccess") } }) }}

LiveInfo 参数说明

4. 结束直播

直播结束后，主播可以调用 LiveListStore 的 endLive 接口结束直播。SDK 会处理停止推流和销毁房间的逻辑。

import android.util.Logimport androidx.appcompat.app.AppCompatActivityimport com.tencent.cloud.tuikit.engine.extension.TUILiveListManagerimport io.trtc.tuikit.atomicxcore.api.device.DeviceStoreimport io.trtc.tuikit.atomicxcore.api.live.LiveListStoreimport io.trtc.tuikit.atomicxcore.api.live.StopLiveCompletionHandlerclass YourAnchorActivity : AppCompatActivity() { // … 其他代码 … // 结束直播 private fun stopLive() { LiveListStore.shared().endLive(object : StopLiveCompletionHandler { override fun onSuccess(statisticsData: TUILiveListManager.LiveStatisticsData) { Log.d("Live", "endLive success, duration: ${statisticsData.liveDuration}, totalViewers: ${statisticsData.totalViewers}") } override fun onFailure(code: Int, desc: String) { Log.e("Live", "endLive error: $desc") } }) } // 确保在 Activity 销毁时也调用结束直播 override fun onDestroy() { super.onDestroy() stopLive() // 关闭本地设备 DeviceStore.shared().closeLocalCamera() DeviceStore.shared().closeLocalMicrophone() Log.d("Live", "YourAnchorActivity onDestroy") }}

六、步骤2：实现观众进房观看

观众观看流程如下，通过简单几步操作，即可实现观众观看直播。

注意：提示：

注意：观众进房拉流的业务代码，你也可以参考 TUILiveKit 开源项目中的 VideoLiveAudienceActivity.kt 文件来了解完整的实现逻辑。

1. 添加观众拉流页面

在你的观众 Activity 中，创建 LiveCoreView 实例，并将 viewType 指定为 PLAY_VIEW（拉流视图）。

import io.trtc.tuikit.atomicxcore.api.view.CoreViewTypeimport io.trtc.tuikit.atomicxcore.api.view.LiveCoreViewimport android.os.Bundleimport androidx.appcompat.app.AppCompatActivityimport androidx.constraintlayout.widget.ConstraintLayout// YourAudienceActivity 代表你的观众观看Activityclass YourAudienceActivity : AppCompatActivity() { // 1. 初始化观众拉流页面 private lateinit var coreView: LiveCoreView override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) // 2. 初始化视图 coreView = LiveCoreView(this, viewType = CoreViewType.PLAY_VIEW) coreView.setLiveId("test_live_001") // UI 布局 setupUI() } private fun setupUI() { setContentView(R.layout.activity_audience) // 3. 将观众拉流页面加载到你的视图上 val container = findViewById<ConstraintLayout>(R.id.container) container.addView(coreView) // 设置布局参数 val params = ConstraintLayout.LayoutParams( ConstraintLayout.LayoutParams.MATCH_PARENT, ConstraintLayout.LayoutParams.MATCH_PARENT ) params.topMargin = 36 params.bottomMargin = 96 coreView.layoutParams = params }}

2. 进入直播间观看

通过调用 LiveListStore 的 joinLive 接口加入直播，你无需做额外操作，LiveCoreView 会自动播放当前房间的视频流，完整示例代码如下：

import io.trtc.tuikit.atomicxcore.api.live.LiveInfoimport io.trtc.tuikit.atomicxcore.api.live.LiveInfoCompletionHandlerimport io.trtc.tuikit.atomicxcore.api.live.LiveListStoreimport android.os.Bundleimport androidx.appcompat.app.AppCompatActivityimport android.util.Log// YourAudienceActivity 代表你的观众观看Activityclass YourAudienceActivity : AppCompatActivity() { // … 其他代码 … override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setupUI() // 1. 调用 LiveListStore.shared().joinLive 进入直播间 // – liveID: 与主播开播同样的 liveID LiveListStore.shared().joinLive(liveID, object : LiveInfoCompletionHandler { override fun onFailure(code: Int, desc: String) { Log.e("Live", "joinLive error: $desc") } override fun onSuccess(liveInfo: LiveInfo) { Log.d("Live", "joinLive success") } }) }}

3. 退出直播

观众退出直播间时，需要调用 LiveListStore 的 leaveLive 接口退出直播。SDK 会自动停止拉流并退出房间。

import io.trtc.tuikit.atomicxcore.api.live.LiveListStoreimport io.trtc.tuikit.atomicxcore.api.CompletionHandlerimport androidx.appcompat.app.AppCompatActivityimport android.util.Log// YourAudienceActivity 代表你的观众观看Activityclass YourAudienceActivity : AppCompatActivity() { // … 其他代码 … // 退出直播 private fun leaveLive() { LiveListStore.shared().leaveLive(object : CompletionHandler { override fun onSuccess() { Log.d("Live", "leaveLive success") } override fun onFailure(code: Int, desc: String) { Log.e("Live", "leaveLive error: $desc") } }) } // 确保在 Activity 销毁时也调用退出直播 override fun onDestroy() { super.onDestroy() leaveLive() Log.d("Live", "YourAudienceActivity onDestroy") }}

七、步骤3：监听直播事件

在观众加入直播间后，你还需要处理一些房间内的“被动”事件。例如主播主动结束了直播，或者观众因为违规等原因被踢出房间。如果不监听这些事件，观众端 UI 可能会停留在黑屏页面，影响用户体验。

你可以通过实现 LiveListListener 监听器，并将其注册到 LiveListStore 来实现事件监听。

import io.trtc.tuikit.atomicxcore.api.live.LiveEndedReasonimport io.trtc.tuikit.atomicxcore.api.live.LiveKickedOutReasonimport io.trtc.tuikit.atomicxcore.api.live.LiveListListenerimport io.trtc.tuikit.atomicxcore.api.live.LiveListStoreimport android.os.Bundleimport androidx.appcompat.app.AppCompatActivityimport android.util.Log// YourAudienceActivity 代表你的观众观看Activityclass YourAudienceActivity : AppCompatActivity() { // … (coreView, liveId, setupUI, joinLive, leaveLive 等代码) … // 2. 定义一个 LiveListListener 实例 private val liveListListener = object : LiveListListener() { override fun onLiveEnded(liveID: String, reason: LiveEndedReason, message: String) { // 监听到直播结束 Log.d("Live", "Live ended. liveID: $liveID, reason: $reason, message: $message") // 在此处处理退出直播间的逻辑，例如关闭当前 Activity // finish() } override fun onKickedOutOfLive(liveID: String, reason: LiveKickedOutReason, message: String) { // 监听到被踢出直播 Log.d("Live", "Kicked out of live. liveID: $liveID, reason: $reason, message: $message") // 在此处处理退出直播间的逻辑 // finish() } } override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setupUI() // 3. 注册监听器 LiveListStore.shared().addLiveListListener(liveListListener) // 4. 进入直播间 joinLive() } // … joinLive() 和 leaveLive() 方法 … override fun onDestroy() { super.onDestroy() // 5. 确保在 Activity 销毁时移除监听器，防止内存泄漏 LiveListStore.shared().removeLiveListListener(liveListListener) leaveLive() Log.d("Live", "YourAudienceActivity onDestroy") }}

八、运行效果

集成 LiveCoreView 后，你将得到一个纯净的视频渲染视图，它已具备完整的直播业务能力，但没有任何交互 UI。你可以参考下一章节 丰富直播场景 来完善直播场景。

九、丰富直播场景

当你完成了基础的直播功能后，你可以参考以下功能指南来为直播添加丰富的互动玩法。

十、API 文档

十一、主播调用 createLive 或 观众调用 joinLive 后为什么画面是黑的，没有视频画面？

·检查 setLiveID：请确保在调用开播或观看接口前，已经为 LiveCoreView 实例设置了正确的 liveID。

·检查设备权限：请确保 App 已获得摄像头和麦克风的系统使用权限。

·检查主播端：主播端是否正常调用 DeviceStore.shared().openLocalCamera(true) 打开了摄像头。

·检查网络：请检查设备网络连接是否正常。

十二、主播端打开摄像头后，开播后可以看到本地视频预览画面，开播前视频预览是黑屏？

·检查主播端：请检查主播推流视图 LiveCoreView 的 viewType 是否配置为 PUSH_VIEW。

·检查观众端：请检查观众拉流视图 LiveCoreView 的 viewType 是否配置为 PLAY_VIEW。