AtomicX Core API/io.trtc.tuikit.atomicxcore.api.barrage/Barrage

Barrage

data class Barrage(var liveID: String = "", var sender: LiveUserInfo = LiveUserInfo(), var sequence: Long = 0, var timestampInSecond: Long = 0, var messageType: BarrageType = BarrageType.TEXT, var textContent: String = "", var extensionInfo: Map<String, String> = emptyMap(), var businessID: String = "", var data: String = "")

Barrage data model, containing complete attribute information of a single barrage.

Overview

Contains complete information about the barrage sender, content, type, etc.

Property Overview


Property	Type	Description
liveID	`String`	Unique identifier ID of the live room/voice chat room the barrage belongs to
sender	`LiveUserInfo`	User information of the barrage sender
sequence	`Long`	Unique sequence ID of the barrage message
timestampInSecond	`Long`	Barrage sending timestamp (unit: seconds)
messageType	`BarrageType`	Barrage message type (text or custom)
textContent	`String`	Message content of text type barrage
extensionInfo	`Map<String, String>`	Barrage extension information
businessID	`String`	Business identifier ID of custom type barrage
data	`String`	Specific data content of custom type barrage

Constructors

Barrage

constructor(liveID: String = "", sender: LiveUserInfo = LiveUserInfo(), sequence: Long = 0, timestampInSecond: Long = 0, messageType: BarrageType = BarrageType.TEXT, textContent: String = "", extensionInfo: Map<String, String> = emptyMap(), businessID: String = "", data: String = "")

Properties

businessID

var businessID: String

Business identifier ID of custom type barrage, used to distinguish custom barrages from different business scenarios.

data

var data: String

Specific data content of custom type barrage (usually JSON format string), valid when messageType is CUSTOM.

extensionInfo

var extensionInfo: Map<String, String>

Barrage extension information, customizable fields (such as display style, priority, etc.). Valid when messageType is TEXT.

liveID

var liveID: String

Unique identifier ID of the live room/voice chat room the barrage belongs to.

messageType

var messageType: BarrageType

Barrage message type (text or custom).

sender

var sender: LiveUserInfo

User information of the barrage sender (such as user ID, nickname, avatar, etc.).

sequence

var sequence: Long

Unique sequence ID of the barrage message, used for message sorting and deduplication.

textContent

var textContent: String

Message content of text type barrage, i.e., the text content of the barrage.

timestampInSecond

var timestampInSecond: Long

Barrage sending timestamp (unit: seconds), used to display sending time order.