jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-13 09:32:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update live chat examples

Browse Source
This commit is contained in:
LuanRT
2022-08-01 15:55:27 -03:00
parent daaba3745e
commit 3cdaab8b7a
3 changed files with 86 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
examples/livechat/README.md
View File

@@ -34,21 +34,21 @@ Live Chat's EventEmitter.
Arguments:
| Type | Description |
| --- | --- |
| `object` | Initial chat data, actions, info, etc. |
| `LiveChatContinuation` | Initial chat data, actions, info, etc. |
- `chat-update`
Arguments:
| Type | Description |
| --- | --- |
| `object` | Chat Action |
| `ChatAction` | Chat Action |
- `metadata-update`
Arguments:
| Type | Description |
| --- | --- |
| `object` | LiveStream Metadata |
| `LiveMetadata` | LiveStream Metadata |
<a name="start"></a>
### start()
@@ -66,7 +66,7 @@ Sends a message.
| --- | --- | --- |
| text | `string` | Message content |
**Returns:** `Promise.<object>`
**Returns:** `Promise<ObservedArray<AddChatItemAction>>`
## Example
See [`index.js`]('./index.js').

62
examples/livechat/index.js
View File

@@ -1,62 +0,0 @@
import Innertube from 'youtubei.js';
const session = await new Innertube();
const info = await session.getInfo('video_id');
const livechat = await info.getLiveChat();
livechat.ev.on('start', (initial_data) => {
/**
* Initial info is what you see when you first open a Live Chat — this is; inital actions, account's info and so on.
*/
console.info(`Hey ${initial_data.viewer_name}, welcome to ${info.basic_info.channel.name}\'s Live Chat!`);
});
livechat.ev.on('chat-update', (action) => {
/**
* An action represents what is being added to
* the live chat. All actions have a `type` property,
* including their item (if the action has an item).
*
* Below are a few examples of how this can be used.
*/
if (action.type === 'AddChatItemAction') {
const hours = new Date(action.item.timestamp).toLocaleTimeString('en-US', {
hour: '2-digit',
minute: '2-digit'
});
switch (action.item.type) {
case 'LiveChatTextMessage':
console.info(
`${hours} - ${action.item.author.name.toString()}:\n` +
`${action.item.message.toString()}\n`
);
break;
case 'LiveChatPaidMessage':
console.info(`
${hours} - ${action.item.author.name.toString()}
${action.item.purchase_amount}
`);
break;
default:
console.debug(action);
}
}
if (action.type === 'MarkChatItemAsDeletedAction') {
console.warn(`Message ${action.target_item_id} just got deleted and should be replaced with ${action.delete_state_message.toString()}!`);
}
});
livechat.ev.on('metadata-update', (metadata) => {
console.info(`
VIEWS: ${metadata.views.view_count.toString()}
LIKES: ${metadata.likes.default_text}
DATE: ${metadata.date.date_text}
`);
});
livechat.start();

82
examples/livechat/index.ts Normal file
View File

@@ -0,0 +1,82 @@
import { Innertube, UniversalCache } from 'youtubei.js';
import { LiveChatContinuation } from 'youtubei.js/dist/src/parser';
import LiveChat, { ChatAction, LiveMetadata } from 'youtubei.js/dist/src/parser/youtube/LiveChat';
import Video from 'youtubei.js/dist/src/parser/classes/Video';
import AddChatItemAction from 'youtubei.js/dist/src/parser/classes/livechat/AddChatItemAction';
import MarkChatItemAsDeletedAction from 'youtubei.js/dist/src/parser/classes/livechat/MarkChatItemAsDeletedAction';
import LiveChatTextMessage from 'youtubei.js/dist/src/parser/classes/livechat/items/LiveChatTextMessage';
import LiveChatPaidMessage from 'youtubei.js/dist/src/parser/classes/livechat/items/LiveChatPaidMessage';
(async () => {
const yt = await Innertube.create({ cache: new UniversalCache() });
const search = await yt.search('Lofi girl live');
const info = await yt.getInfo(search.videos[0].as(Video).id);
const livechat = await info.getLiveChat();
livechat.on('start', (initial_data: LiveChatContinuation) => {
/**
* Initial info is what you see when you first open a Live Chat — this is; inital actions (pinned messages, top donations..), account's info and so on.
*/
console.info(`Hey ${initial_data.viewer_name}, welcome to ${info.basic_info.channel.name}\'s Live Chat!`);
});
livechat.on('chat-update', (action: ChatAction) => {
/**
* An action represents what is being added to
* the live chat. All actions have a `type` property,
* including their item (if the action has an item).
*
* Below are a few examples of how this can be used.
*/
if (action.is(AddChatItemAction)) {
const item = action.as(AddChatItemAction).item;
if (!item)
return console.info('Action did not have an item.', action);
const hours = new Date(item.hasKey('timestamp') ? item.timestamp : Date.now()).toLocaleTimeString('en-US', {
hour: '2-digit',
minute: '2-digit'
});
switch (item.type) {
case 'LiveChatTextMessage':
console.info(
`${hours} - ${item.as(LiveChatTextMessage).author.name.toString()}:\n` +
`${item.as(LiveChatTextMessage).message.toString()}\n`
);
break;
case 'LiveChatPaidMessage':
console.info(
`${hours} - ${item.as(LiveChatPaidMessage).author.name.toString()}:\n` +
`${item.as(LiveChatPaidMessage).purchase_amount}\n`
);
break;
default:
console.debug(action);
break;
}
}
if (action.is(MarkChatItemAsDeletedAction)) {
console.warn(`Message ${action.target_item_id} just got deleted and should be replaced with ${action.deleted_state_message.toString()}!`, '\n');
}
});
livechat.on('metadata-update', (metadata: LiveMetadata) => {
console.info(`
VIEWS: ${metadata.views?.view_count.toString()}
LIKES: ${metadata.likes?.default_text}
DATE: ${metadata.date?.date_text}
`);
});
livechat.start();
})();