YouTube.js

mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-19 20:41:17 +00:00

Files

LuanRT 4f994c338b refactor: rewrite Live Chat logic (#85 )

* dev: start LiveChat refactor

* dev: implement simple module system to separate classes

+ add a few Live Chat actions

* dev: add fundamental Live Chat classes

* chore: update type declarations

* feat: finalize Live Chat

Now supporting almost all kinds of messages! Next up: add a ability to send messages.

* chore: update type declarations

* chore: update contributors list

* feat(livechat): add `sendMessage()` method

* chore: remove unneeded files

* style: format code

* chore: remove outdated examples

* chore: update tests

* chore: remove trailing spaces

* chore: remove trailing spaces x2

2022-06-29 16:51:51 -03:00

index.js

refactor: rewrite Live Chat logic (#85 )

2022-06-29 16:51:51 -03:00

README.md

refactor: rewrite Live Chat logic (#85 )

2022-06-29 16:51:51 -03:00

README.md

Live Chat

The library's Live Chat parser and poller were highly 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 session.getInfo('video_id');

Then you may request a Live Chat instance:

const livechat = await info.getLiveChat();

API

LiveChat
- .ev ⇒ EventEmitter
- .start ⇒ function
- .stop ⇒ function
- .sendMessage ⇒ function

ev

Live Chat's EventEmitter.

Events:

start

Arguments:

Type Description

object Initial chat data, actions, info, etc.
chat-update

Arguments:

Type Description

object Chat Action
metadata-update

Arguments:

Type Description

object LiveStream Metadata

Type	Description
`object`	Initial chat data, actions, info, etc.

Type	Description
`object`	Chat Action

Type	Description
`object`	LiveStream Metadata

start()

Starts the Live Chat.

stop()

Stops the Live Chat.

sendMessage(text)

Sends a message.

Param	Type	Description
text	`string`	Message content

Returns: Promise.<object>

Example

See index.js.