Class Masterchat

Hierarchy

EventEmitter
- Masterchat

Index

Constructors

constructor

new Masterchat(videoId: string, channelId: string, __namedParameters?: MasterchatOptions): Masterchat

- Defined in src/masterchat.ts:406
Much faster than Masterchat.init

Parameters
- videoId: string
- channelId: string
- __namedParameters: MasterchatOptions = {}
Returns Masterchat

Properties

channelId

channelId: string

Optional channelName

channelName?: string

Optional isLive

isLive?: boolean

Optional title

title?: string

videoId

videoId: string

Accessors

metadata

get metadata(): { channelId: string; channelName: undefined | string; isLive: undefined | boolean; title: undefined | string; videoId: string }

- Defined in src/masterchat.ts:461
Returns { channelId: string; channelName: undefined | string; isLive: undefined | boolean; title: undefined | string; videoId: string }
- channelId: string
- channelName: undefined | string
- isLive: undefined | boolean
- title: undefined | string
- videoId: string

stopped

get stopped(): boolean

- Defined in src/masterchat.ts:582
(EventEmitter API) returns listener status

Returns boolean

Methods

addListener

addListener<U>(event: U, listener: Events[U]): Masterchat

- Defined in src/masterchat.ts:107
Type Parameters
- U extends keyof Events
Parameters
- event: U
- listener: Events[U]
Returns Masterchat

addModerator

addModerator(channelId: string): Promise<YTActionResponse>

- Defined in src/masterchat.ts:1050
Manage User API

Parameters
- channelId: string
Returns Promise<YTActionResponse>

block

block(contextMenuEndpointParams: string): Promise<undefined | YTAction[]>

- Defined in src/masterchat.ts:1031
Parameters
- contextMenuEndpointParams: string
Returns Promise<undefined | YTAction[]>

emit

emit<U>(event: U, ...args: Parameters<Events[U]>): boolean

- Defined in src/masterchat.ts:110
Type Parameters
- U extends keyof Events
Parameters
- event: U
- Rest ...args: Parameters<Events[U]>
Returns boolean

fetch

fetch(options?: FetchChatOptions): Promise<ChatResponse>
fetch(token: string, options?: FetchChatOptions): Promise<ChatResponse>

- Defined in src/masterchat.ts:646
Parameters
- Optional options: FetchChatOptions
Returns Promise<ChatResponse>
- Defined in src/masterchat.ts:647
Parameters
- token: string
- Optional options: FetchChatOptions
Returns Promise<ChatResponse>

fetchMetadataFromEmbed

fetchMetadataFromEmbed(id: string): Promise<undefined | { channelId: any; channelName: string; channelThumbnail: any; duration: number; status: any; statusText: any; thumbnail: any; title: string }>

- Defined in src/masterchat.ts:451
Parameters
- id: string
Returns Promise<undefined | { channelId: any; channelName: string; channelThumbnail: any; duration: number; status: any; statusText: any; thumbnail: any; title: string }>

fetchMetadataFromWatch

fetchMetadataFromWatch(id: string): Promise<{ channelId: string; channelName: string; isLive: boolean; title: string }>

- Defined in src/masterchat.ts:438
Parameters
- id: string
Returns Promise<{ channelId: string; channelName: string; isLive: boolean; title: string }>

getComment

getComment(commentId: string): Promise<undefined | YTCommentThreadRenderer>

- Defined in src/masterchat.ts:1082
Parameters
- commentId: string
Returns Promise<undefined | YTCommentThreadRenderer>

getComments

getComments(continuation?: string | CscOptions): Promise<{ comments: YTCommentThreadRenderer[]; continuation: undefined | string; next: undefined | (() => Promise<({ comments: YTCommentThreadRenderer[]; continuation: string | undefined; next: (() => Promise<...>) | undefined; })>) }>

- Defined in src/masterchat.ts:1093
Parameters
- continuation: string | CscOptions = {}
Returns Promise<{ comments: YTCommentThreadRenderer[]; continuation: undefined | string; next: undefined | (() => Promise<({ comments: YTCommentThreadRenderer[]; continuation: string | undefined; next: (() => Promise<...>) | undefined; })>) }>

getPlaylist

getPlaylist(browseId: string | { type: "membersOnly" }): Promise<{ description: any; title: any; videos: any }>

- Defined in src/masterchat.ts:1184
Parameters
- browseId: string | { type: "membersOnly" }
Returns Promise<{ description: any; title: any; videos: any }>

getTranscript

getTranscript(language: string): Promise<TranscriptSegment[]>

- Defined in src/masterchat.ts:1135
Fetch transcript

Parameters
- language: string
Returns Promise<TranscriptSegment[]>

hide

hide(targetChannelId: string): Promise<void>

- Defined in src/masterchat.ts:998
Hide user on the channel

Parameters
- targetChannelId: string
Returns Promise<void>

iter

iter(options?: IterateChatOptions): AsyncIterator<Action, any, undefined>

- Defined in src/masterchat.ts:589
AsyncIterator API

Parameters
- Optional options: IterateChatOptions
Returns AsyncIterator<Action, any, undefined>

iterate

iterate(__namedParameters?: IterateChatOptions): AsyncGenerator<ChatResponse, any, unknown>

- Defined in src/masterchat.ts:599
(AsyncGenerator API) Iterate until live stream ends

Parameters
- __namedParameters: IterateChatOptions = {}
Returns AsyncGenerator<ChatResponse, any, unknown>

listen

listen(iterateOptions?: IterateChatOptions): ChatListener

- Defined in src/masterchat.ts:488
(EventEmitter API) start listening live stream

Parameters
- Optional iterateOptions: IterateChatOptions
Returns ChatListener

off

off<U>(event: U, listener: Events[U]): Masterchat

- Defined in src/masterchat.ts:108
Type Parameters
- U extends keyof Events
Parameters
- event: U
- listener: Events[U]
Returns Masterchat

on

on<U>(event: U, listener: Events[U]): Masterchat

- Defined in src/masterchat.ts:105
Type Parameters
- U extends keyof Events
Parameters
- event: U
- listener: Events[U]
Returns Masterchat

once

once<U>(event: U, listener: Events[U]): Masterchat

- Defined in src/masterchat.ts:106
Type Parameters
- U extends keyof Events
Parameters
- event: U
- listener: Events[U]
Returns Masterchat

pin

pin(chatId: string): Promise<YTActionResponse>

- Defined in src/masterchat.ts:916
Live Chat Action API

Parameters
- chatId: string
Returns Promise<YTActionResponse>

populateMetadata

populateMetadata(): Promise<void>

- Defined in src/masterchat.ts:429
Context API

Returns Promise<void>

remove

remove(chatId: string): Promise<MarkChatItemAsDeletedAction>

- Defined in src/masterchat.ts:951
Moderate API

Parameters
- chatId: string
Returns Promise<MarkChatItemAsDeletedAction>

removeListener

removeListener<U>(event: U, listener: Events[U]): Masterchat

- Defined in src/masterchat.ts:109
Type Parameters
- U extends keyof Events
Parameters
- event: U
- listener: Events[U]
Returns Masterchat

removeModerator

removeModerator(channelId: string): Promise<YTActionResponse>

- Defined in src/masterchat.ts:1064
Parameters
- channelId: string
Returns Promise<YTActionResponse>

sendMessage

sendMessage(message: string): Promise<YTLiveChatTextMessageRenderer>

- Defined in src/masterchat.ts:876
Send Message API

Parameters
- message: string
Returns Promise<YTLiveChatTextMessageRenderer>

setCredentials

setCredentials(credentials?: string | Credentials): void

- Defined in src/masterchat.ts:474
Set credentials. This will take effect on the subsequent requests.

Parameters
- Optional credentials: string | Credentials
Returns void

stop

stop(): void

- Defined in src/masterchat.ts:572
(EventEmitter API) stop listening live stream

Returns void

timeout

timeout(channelId: string): Promise<void>

- Defined in src/masterchat.ts:980
Put user in timeout for 300 seconds

Parameters
- channelId: string
Returns Promise<void>

unblock

unblock(contextMenuEndpointParams: string): Promise<undefined | YTAction[]>

- Defined in src/masterchat.ts:1039
Parameters
- contextMenuEndpointParams: string
Returns Promise<undefined | YTAction[]>

unhide

unhide(channelId: string): Promise<void>

- Defined in src/masterchat.ts:1015
Parameters
- channelId: string
Returns Promise<void>

unpin

unpin(actionId: string): Promise<YTActionResponse>

- Defined in src/masterchat.ts:930
Parameters
- actionId: string
Returns Promise<YTActionResponse>

Static init

init(videoIdOrUrl: string, options?: MasterchatOptions): Promise<Masterchat>

- Defined in src/masterchat.ts:387
Useful when you don't know channelId or isLive status

Parameters
- videoIdOrUrl: string
- options: MasterchatOptions = {}
Returns Promise<Masterchat>

Generated using TypeDoc