LiveChat

LiveChat object

• fetches chat data and stores them in buffer with ThreadpoolExecutor
• responds to user inquiries of get().
• invokes callback function with processed chat data.
• can replay archived chat data (when specified video is not live broadcasting).

Usage

from pytchat import LiveChat
import time
chat = LiveChat(video_id = "uIx8l2xlYVY")

while chat.is_alive():
  try:
    data = chat.get()
    items = data.items
    for c in items:
        print(f"{c.datetime} [{c.author.name}]- {c.message}")
    time.sleep(3)
  except KeyboardInterrupt:
    chat.terminate()
    break

#constructor params

name	type	required	remarks	default value
video_id	str	*	ID of youtube video, or youtube URL that includes ID.	-
processor	ChatProcessor			DefaultProcessor
buffer	Buffer		buffer of chat data fetched background.	Buffer(maxsize=20)
interruptable	bool		Allows keyboard interrupts. Set this parameter to False if your own threading program causes the problem.	True
callback	func		function called periodically.	None
done_callback	func		function called when listener ends.	None
direct_mode	bool		If True, invoke specified callback function without using buffer.	False
seektime	int		start position of fetching chat (seconds). This option is valid for archived chat only. If negative value, it is treated as 0. This parameter is not working well. We'll deal with it as soon as possible.	0
force_replay	bool		force to fetch archived chat data, even if specified video is live.	False
topchat_only	bool		If True, get only top chat.	False
logger	logging.Logger		any Logger object	internal logger(set NullHandler)
replay_continuation	str		continuation parameter(archived chat only)	None

continuation

The continuation parameter of recent chat data.
This parameter can be used for retrieving chat data of any timing by specifying in the constructor as replay_continuation.
(This parameter is valid only archived chat data.)

Example code

from pytchat import LiveChat
import time
stream = LiveChat(video_id = "uIx8l2xlYVY")
i = 0
while stream.is_alive():
  data = stream.get()
  items = data.items
  for c in items:
      print(f"{c.datetime} [{c.author.name}]- {c.message}")
  time.sleep(3)
  i += 1
  if i == 3:
    # get the continuation parameter
    continuation = stream.continuation
    stream.terminate()
    break

# retrieve chatdata from the continuation.
stream = LiveChat(video_id = "uIx8l2xlYVY", replay_continuation=continuation)
data = stream.get()
items = data.items
for c in items:
    print(f"{c.datetime} [{c.author.name}]- {c.message}")
stream.terminate()

get()

description	return value
Get processed chat data from buffer.	processed chat data

*When callback parameter is set, get() function is not available. (Illegal function call occurs.)

is_alive()

description	return value
Check if livechat stream is alive.	bool

terminate()

description	return value
Terminate fetching livechat.	-

raise_for_status()

Raise internal exception after is_alive() becomes False. By this function, you can check the reason for the termination.