YouTube.js
Guide
Discord
❤️ Sponsor
GitHub
Guide
Discord
❤️ Sponsor
GitHub

youtubei.js / YT / LiveChat

Class: LiveChat

Defined in: src/parser/youtube/LiveChat.ts:58

Extends

  • EventEmitter

Constructors

Constructor

new LiveChat(video_info): LiveChat

Defined in: src/parser/youtube/LiveChat.ts:73

Parameters

video_info

VideoInfo

Returns

LiveChat

Overrides

EventEmitter.constructor

Properties

initial_info?

optional initial_info: LiveChatContinuation

Defined in: src/parser/youtube/LiveChat.ts:68


is_replay

is_replay: boolean = false

Defined in: src/parser/youtube/LiveChat.ts:71


metadata?

optional metadata: LiveMetadata

Defined in: src/parser/youtube/LiveChat.ts:69


running

running: boolean = false

Defined in: src/parser/youtube/LiveChat.ts:70


smoothed_queue

smoothed_queue: SmoothedQueue

Defined in: src/parser/youtube/LiveChat.ts:67

Methods

addEventListener()

addEventListener(type, callback, options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:11569

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

Parameters

type

string

callback

EventListenerOrEventListenerObject | null

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

EventEmitter.addEventListener


applyFilter()

applyFilter(filter): void

Defined in: src/parser/youtube/LiveChat.ts:287

Applies given filter to the live chat.

Parameters

filter

Filter to apply.

"TOP_CHAT" | "LIVE_CHAT"

Returns

void


dispatchEvent()

dispatchEvent(event): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:11575

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference

Parameters

event

Event

Returns

boolean

Inherited from

EventEmitter.dispatchEvent


emit()

emit(type, ...args): void

Defined in: src/utils/EventEmitterLike.ts:10

Parameters

type

string

args

...any[]

Returns

void

Inherited from

EventEmitter.emit


getItemMenu()

getItemMenu(item): Promise<ItemMenu>

Defined in: src/parser/youtube/LiveChat.ts:305

Retrieves given chat item's menu.

Parameters

item

ChatItemWithMenu

Returns

Promise<ItemMenu>


off()

off(type, listener): void

Defined in: src/utils/EventEmitterLike.ts:40

Parameters

type

string

listener

(...args) => void

Returns

void

Inherited from

EventEmitter.off


on()

Call Signature

on(type, listener): void

Defined in: src/parser/youtube/LiveChat.ts:108

Parameters
type

"start"

listener

(initial_data) => void

Returns

void

Overrides

EventEmitter.on

Call Signature

on(type, listener): void

Defined in: src/parser/youtube/LiveChat.ts:109

Parameters
type

"chat-update"

listener

(action) => void

Returns

void

Overrides

EventEmitter.on

Call Signature

on(type, listener): void

Defined in: src/parser/youtube/LiveChat.ts:110

Parameters
type

"metadata-update"

listener

(metadata) => void

Returns

void

Overrides

EventEmitter.on

Call Signature

on(type, listener): void

Defined in: src/parser/youtube/LiveChat.ts:111

Parameters
type

"error"

listener

(err) => void

Returns

void

Overrides

EventEmitter.on

Call Signature

on(type, listener): void

Defined in: src/parser/youtube/LiveChat.ts:112

Parameters
type

"end"

listener

() => void

Returns

void

Overrides

EventEmitter.on


once()

Call Signature

once(type, listener): void

Defined in: src/parser/youtube/LiveChat.ts:117

Parameters
type

"start"

listener

(initial_data) => void

Returns

void

Overrides

EventEmitter.once

Call Signature

once(type, listener): void

Defined in: src/parser/youtube/LiveChat.ts:118

Parameters
type

"chat-update"

listener

(action) => void

Returns

void

Overrides

EventEmitter.once

Call Signature

once(type, listener): void

Defined in: src/parser/youtube/LiveChat.ts:119

Parameters
type

"metadata-update"

listener

(metadata) => void

Returns

void

Overrides

EventEmitter.once

Call Signature

once(type, listener): void

Defined in: src/parser/youtube/LiveChat.ts:120

Parameters
type

"error"

listener

(err) => void

Returns

void

Overrides

EventEmitter.once

Call Signature

once(type, listener): void

Defined in: src/parser/youtube/LiveChat.ts:121

Parameters
type

"end"

listener

() => void

Returns

void

Overrides

EventEmitter.once


removeEventListener()

removeEventListener(type, callback, options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:11581

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference

Parameters

type

string

callback

EventListenerOrEventListenerObject | null

options?

boolean | EventListenerOptions

Returns

void

Inherited from

EventEmitter.removeEventListener


selectButton()

selectButton(button): Promise<IParsedResponse>

Defined in: src/parser/youtube/LiveChat.ts:320

Equivalent to "clicking" a button.

Parameters

button

Button

Returns

Promise<IParsedResponse>


sendMessage()

sendMessage(text): Promise<ObservedArray<RunAttestationCommand | AddChatItemAction>>

Defined in: src/parser/youtube/LiveChat.ts:255

Sends a message.

Parameters

text

string

Text to send.

Returns

Promise<ObservedArray<RunAttestationCommand | AddChatItemAction>>


start()

start(): void

Defined in: src/parser/youtube/LiveChat.ts:126

Returns

void


stop()

stop(): void

Defined in: src/parser/youtube/LiveChat.ts:134

Returns

void

Edit this page
Last Updated: 5/13/26, 3:20 AM