YouTube.js/examples/livechat

Live Chat

The library's Live Chat parser and poller were heavily based on YouTube's original compiled code, this makes it behave in a similar if not identical way to YouTube's Live Chat. Here you can do all sorts of funny things, ex; track messages, donations, polls, and much more.

Usage

Before fetching a Live Chat, you have to retrieve the target livestream's info:

const info = await yt.getInfo('video_id');

Then you may request a Live Chat instance:

const livechat = await info.getLiveChat();

API

• LiveChat
  • .ev ⇒ EventEmitter
  • .start ⇒ function
  • .stop ⇒ function
  • .getItemMenu ⇒ function
  • .sendMessage ⇒ function

ev

Live Chat's EventEmitter.

Events:

• start

  Arguments:

  Type	Description
  LiveChatContinuation	Initial chat data, actions, info, etc.

• chat-update

  Arguments:

  Type	Description
  ChatAction	Chat Action

• metadata-update

  Arguments:

  Type	Description
  LiveMetadata	LiveStream Metadata

start()

Starts the Live Chat.

stop()

Stops the Live Chat.

getItemMenu(item)

Retrieves given chat item's menu.

Param	Type	Description
item	object	Chat item

Returns: Promise<ItemMenu>

sendMessage(text)

Sends a message.

Param	Type	Description
text	string	Message content

Returns: Promise<ObservedArray<AddChatItemAction>>

Example

See index.ts.