tencent cloud

实时音视频

动态与公告
产品动态
产品近期公告
关于 TRTC Live 正式上线的公告
关于TRTC Conference 正式版上线的公告
Conference 商业化版本即将推出
关于多人音视频 Conference 开启内测公告
关于音视频通话 Call 正式版上线的公告
关于腾讯云音视频终端 SDK 播放升级及新增授权校验的公告
关于 TRTC 应用订阅套餐服务上线的相关说明
产品简介
产品概述
基本概念
产品功能
产品优势
应用场景
性能数据
购买指南
计费概述
免费时长说明
月订阅
现收现付
TRTC 逾期与暂停政策
常见问题解答
退款说明
新手指引
Demo 体验
视频通话 SDK
组件介绍
开通服务
跑通 Demo
快速接入
离线唤醒
会话聊天
云端录制
AI 降噪
界面定制
Chat 集成通话能力
更多特性
无 UI 集成
服务端 API
客户端 API
解决方案
错误码表
发布日志
常见问题
视频会议 SDK
组件介绍(TUIRoomKit)
开通服务(TUIRoomKit)
跑通 Demo(TUIRoomKit)
快速接入(TUIRoomKit)
屏幕共享(TUIRoomKit)
预定会议(TUIRoomKit)
会中呼叫(TUIRoomKit)
界面定制(TUIRoomKit)
虚拟背景(TUIRoomKit)
会议控制(TUIRoomKit)
云端录制(TUIRoomKit)
AI 降噪(TUIRoomKit)
会中聊天(TUIRoomKit)
机器人推流(TUIRoomKit)
更多特性(TUIRoomKit)
客户端 API(TUIRoomKit)
服务端 API(TUIRoomKit)
常见问题(TUIRoomKit)
错误码 (TUIRoomKit)
SDK更新日志(TUIRoomKit)
直播与语聊 SDK
Live 视频直播计费说明
组件介绍
开通服务(TUILiveKit)
跑通 Demo
无 UI 集成
UI 自定义
直播监播
视频直播
语聊房
高级功能
客户端 API
服务端 API
错误码
发布日志
常见问题
RTC Engine
开通服务
SDK 下载
API-Example
接入指引
API-参考手册
高级功能
AI 集成
概述
MCP 配置
Skills 配置
集成指南
常见问题
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
控制台指南
应用管理
套餐包管理
用量统计
监控仪表盘
开发辅助
解决方案
实时合唱
常见问题
迁移指南
计费相关
功能相关
UserSig 相关
应对防火墙限制相关
缩减安装包体积相关
Andriod 与 iOS 相关
Web 端相关
Flutter 相关
Electron 相关
TRTCCalling Web 相关
音视频质量相关
其他问题
旧版文档
RTC RoomEngine SDK(旧)
集成 TUIRoom (Web)
集成 TUIRoom (Android)
集成 TUIRoom (iOS)
集成 TUIRoom (Flutter)
集成 TUIRoom (Electron)
TUIRoom API 查询
实现云端录制与回放(旧)
监控仪表盘计费(旧)
协议与策略
安全合规认证
安全白皮书
信息安全说明
服务等级协议
苹果隐私策略:PrivacyInfo.xcprivacy
TRTC 政策
隐私协议
数据处理和安全协议
词汇表

BarrageStore

PDF
聚焦模式
字号
最后更新时间: 2026-03-05 16:32:08

简介

BarrageStore 提供了一套完整的弹幕管理 API,包括发送文本弹幕、发送自定义弹幕和添加本地提示消息。
通过该类,可以在直播间内实现弹幕互动功能。
重要:
使用 create 工厂方法创建 BarrageStore 实例,需要传入有效的直播间 ID。
说明:
弹幕状态更新通过 barrageState 发布者传递。订阅它以接收房间内弹幕数据的实时更新。

功能特性

文本弹幕:支持发送纯文本弹幕消息。
自定义弹幕:支持发送自定义格式的弹幕(如带特效的弹幕)。
本地提示:支持添加仅本地可见的提示消息。

可订阅数据

BarrageState 的字段描述如下:
属性名
类型
描述
messageList
ValueListenable<List<Barrage>>
当前房间的弹幕消息列表,支持实时更新并可被订阅监听。

API 列表

函数名
描述
创建弹幕管理实例。
发送文本弹幕。
发送自定义弹幕。
添加本地提示消息。

创建实例

create

弹幕管理核心类,用于处理直播间/语音聊天房内的弹幕相关业务逻辑。
static BarrageStore create(String liveID) {
return StoreFactory.shared.getStore<BarrageStore>(liveID: liveID);
}
版本信息
从 3.5 版本开始支持。
参数说明
参数名
类型
是否必填
描述
liveID
String
必填
直播间ID。

发送弹幕

sendTextMessage

发送文本类型弹幕。
Future<CompletionHandler> sendTextMessage({
required String text,
Map<String, String>? extensionInfo,
});
版本信息
从 3.5 版本开始支持。
参数说明
参数名
类型
是否必填
描述
text
String
必填
文本弹幕内容。
extensionInfo
Map<String, String>?
必填
扩展信息,可包含自定义字段(如指定弹幕颜色、字体大小等)。

sendCustomMessage

发送自定义类型弹幕。
Future<CompletionHandler> sendCustomMessage({
required String businessID,
required String data,
});
版本信息
从 3.5 版本开始支持。
参数说明
参数名
类型
是否必填
描述
businessID
String
必填
业务标识ID,用于区分不同业务场景的自定义弹幕。
data
String
必填
自定义数据内容,通常为JSON格式字符串,用于传递业务自定义的数据。

本地消息

appendLocalTip

添加本地提示消息(在本地添加提示或操作反馈消息,仅当前客户端可见)。
void appendLocalTip(Barrage message);
版本信息
从 3.5 版本开始支持。
注意事项
说明:
该消息仅在本地显示,不会通过网络发送给其他用户。
参数说明
参数名
类型
是否必填
描述
message
必填
本地弹幕消息(如系统提示、操作反馈等,仅当前用户可见)。

数据结构

BarrageType

弹幕类型枚举,用于区分不同的弹幕消息种类。
枚举值
说明
text
0
文本类型弹幕,包含纯文字内容。
custom
1
自定义类型弹幕,支持业务自定义数据格式(如带特效的弹幕、互动消息等)。

Barrage

弹幕数据模型,包含单条弹幕的完整属性信息。
属性
类型
说明
liveID
String
弹幕所属直播间/语音聊天房的唯一标识ID。
sender
弹幕发送者的用户信息(如用户ID、昵称、头像等)。
sequence
int
弹幕消息的唯一序列ID,用于消息排序和去重。
timestampInSecond
int
弹幕发送时间戳(单位:秒),用于展示发送时间顺序。
messageType
弹幕消息类型(文本或自定义)。
textContent
String
文本类型弹幕的消息内容,即弹幕的文本内容。
extensionInfo
Map<String, String>
弹幕扩展信息,可自定义字段(如显示样式、优先级等)。当 messageType 为 TEXT 时有效。
businessID
String
自定义类型弹幕的业务标识ID,用于区分不同业务场景的自定义弹幕。
data
String
自定义类型弹幕的具体数据内容(通常为JSON格式字符串),当 messageType 为 CUSTOM 时有效。

BarrageState

弹幕状态,管理当前房间的弹幕数据状态。
属性
类型
说明
messageList
ValueListenable<List<Barrage>>
当前房间的弹幕消息列表,支持实时更新并可被订阅监听。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈