youtubei.js / YT / LiveChat
Class: LiveChat
Defined in: src/parser/youtube/LiveChat.ts:66
Extends
EventEmitter<LiveChatEvents>
Constructors
Constructor
new LiveChat(
video_info):LiveChat
Defined in: src/parser/youtube/LiveChat.ts:81
Parameters
video_info
Returns
LiveChat
Overrides
Properties
initial_info?
optionalinitial_info?:LiveChatContinuation
Defined in: src/parser/youtube/LiveChat.ts:76
is_replay
is_replay:
boolean=false
Defined in: src/parser/youtube/LiveChat.ts:79
metadata?
optionalmetadata?:LiveMetadata
Defined in: src/parser/youtube/LiveChat.ts:77
running
running:
boolean=false
Defined in: src/parser/youtube/LiveChat.ts:78
smoothed_queue
smoothed_queue:
SmoothedQueue
Defined in: src/parser/youtube/LiveChat.ts:75
Methods
applyFilter()
applyFilter(
filter):void
Defined in: src/parser/youtube/LiveChat.ts:277
Applies given filter to the live chat.
Parameters
filter
"TOP_CHAT" | "LIVE_CHAT"
Filter to apply.
Returns
void
emit()
emit<
K>(type, ...args):void
Defined in: src/utils/EventEmitterLike.ts:7
Type Parameters
K
K extends keyof LiveChatEvents
Parameters
type
K
args
...Parameters<LiveChatEvents[K]>
Returns
void
Inherited from
getItemMenu()
getItemMenu(
item):Promise<ItemMenu>
Defined in: src/parser/youtube/LiveChat.ts:295
Retrieves given chat item's menu.
Parameters
item
ChatItemWithMenu
Returns
Promise<ItemMenu>
off()
off<
K>(type,listener):void
Defined in: src/utils/EventEmitterLike.ts:45
Type Parameters
K
K extends keyof LiveChatEvents
Parameters
type
K
listener
LiveChatEvents[K]
Returns
void
Inherited from
on()
on<
K>(type,listener):void
Defined in: src/utils/EventEmitterLike.ts:17
Type Parameters
K
K extends keyof LiveChatEvents
Parameters
type
K
listener
LiveChatEvents[K]
Returns
void
Inherited from
once()
once<
K>(type,listener):void
Defined in: src/utils/EventEmitterLike.ts:28
Type Parameters
K
K extends keyof LiveChatEvents
Parameters
type
K
listener
LiveChatEvents[K]
Returns
void
Inherited from
removeAllListeners()
removeAllListeners(
type?):void
Defined in: src/utils/EventEmitterLike.ts:70
Parameters
type?
keyof LiveChatEvents
Returns
void
Inherited from
EventEmitter.removeAllListeners
selectButton()
selectButton(
button):Promise<IParsedResponse>
Defined in: src/parser/youtube/LiveChat.ts:310
Equivalent to "clicking" a button.
Parameters
button
Returns
Promise<IParsedResponse>
sendMessage()
sendMessage(
text):Promise<ObservedArray<RunAttestationCommand|AddChatItemAction>>
Defined in: src/parser/youtube/LiveChat.ts:245
Sends a message.
Parameters
text
string
Text to send.
Returns
Promise<ObservedArray<RunAttestationCommand | AddChatItemAction>>
start()
start():
void
Defined in: src/parser/youtube/LiveChat.ts:116
Returns
void
stop()
stop():
void
Defined in: src/parser/youtube/LiveChat.ts:124
Returns
void