kick

Documentation

Overview

Package kick reads a Kick channel's chat over the Pusher WebSocket that kick.com's own web client uses.

This is unofficial: Kick publishes no chat API, so the app key and event names below are lifted from the public web client and can change without notice.

Index

• type Source
  • func New(slug string) *Source
  • func (s *Source) Label() string
  • func (s *Source) Platform() string
  • func (s *Source) Run(ctx context.Context, sink chat.Sink) error

Types

type Source

type Source struct {
	// contains filtered or unexported fields
}

Source is one Kick channel's chat. It implements chat.Source.

func New

func New(slug string) *Source

New returns a Source for the given channel slug, with or without a leading "@".

func (*Source) Label

func (s *Source) Label() string

Label returns the "kick:<slug>" identifier for this source.

func (*Source) Platform

func (s *Source) Platform() string

Platform returns "kick".

func (*Source) Run

func (s *Source) Run(ctx context.Context, sink chat.Sink) error

Run subscribes to the channel's chatroom and streams messages into sink until the connection drops or ctx is done. Reconnecting is the caller's job; see chat.Supervise.