twitch

Documentation

Index

• Constants
• func GetAuthorizationURL(params *helix.AuthorizationURLParams, clientID string, redirectURI string) string
• func InitConfig(cfg streamctl.Config)
• type ChatClient
• type ChatHandler
  • func NewChatHandler(ctx context.Context, channelID string) (*ChatHandler, error)
  • func (h *ChatHandler) Close() error
  • func (h *ChatHandler) MessagesChan() <-chan streamcontrol.ChatMessage
• type Config
• type OAuthHandler
• type PlatformSpecificConfig
• type SaveProfileHandler
• type StreamProfile
• type Twitch
  • func New(ctx context.Context, cfg Config, saveCfgFn func(Config) error) (*Twitch, error)
  • func (t *Twitch) ApplyProfile(ctx context.Context, profile StreamProfile, customArgs ...any) error
  • func (t *Twitch) BanUser(ctx context.Context, userID streamcontrol.ChatUserID, reason string, ...) (_err error)
  • func (t *Twitch) Close() error
  • func (t *Twitch) EndStream(ctx context.Context) error
  • func (t *Twitch) Flush(ctx context.Context) error
  • func (t *Twitch) GetAllCategories(ctx context.Context) ([]helix.Game, error)
  • func (t *Twitch) GetChatMessagesChan(ctx context.Context) (<-chan streamcontrol.ChatMessage, error)
  • func (t *Twitch) GetStreamStatus(ctx context.Context) (*streamcontrol.StreamStatus, error)
  • func (t *Twitch) InsertAdsCuePoint(ctx context.Context, ts time.Time, duration time.Duration) error
  • func (t *Twitch) IsCapable(ctx context.Context, cap streamcontrol.Capability) bool
  • func (t *Twitch) RemoveChatMessage(ctx context.Context, messageID streamcontrol.ChatMessageID) (_ret error)
  • func (t *Twitch) SendChatMessage(ctx context.Context, message string) (_ret error)
  • func (t *Twitch) SetDescription(ctx context.Context, description string) error
  • func (t *Twitch) SetTitle(ctx context.Context, title string) error
  • func (t *Twitch) StartStream(ctx context.Context, title string, description string, profile StreamProfile, ...) (_err error)

Constants

const ID = twitch.ID

Functions

func GetAuthorizationURL

func GetAuthorizationURL(
	params *helix.AuthorizationURLParams,
	clientID string,
	redirectURI string,
) string

func InitConfig

func InitConfig(cfg streamctl.Config)

Types

type ChatClient

type ChatClient interface {
	Join(channelIDs ...string) error
	OnShardMessage(func(shard int, msg irc.ChatMessage))
	Close()
}

type ChatHandler

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

func NewChatHandler

func NewChatHandler(
	ctx context.Context,
	channelID string,
) (*ChatHandler, error)

func (*ChatHandler) Close

func (h *ChatHandler) Close() error

func (*ChatHandler) MessagesChan

func (h *ChatHandler) MessagesChan() <-chan streamcontrol.ChatMessage

type Config

type Config = twitch.Config

type OAuthHandler

type OAuthHandler = twitch.OAuthHandler

type PlatformSpecificConfig

type PlatformSpecificConfig = twitch.PlatformSpecificConfig

type SaveProfileHandler

type SaveProfileHandler interface {
	SaveProfile(context.Context, StreamProfile) error
}

type StreamProfile

type StreamProfile = twitch.StreamProfile

type Twitch

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

func New

func New(
	ctx context.Context,
	cfg Config,
	saveCfgFn func(Config) error,
) (*Twitch, error)

func (*Twitch) ApplyProfile

func (t *Twitch) ApplyProfile(
	ctx context.Context,
	profile StreamProfile,
	customArgs ...any,
) error

func (*Twitch) BanUser

func (t *Twitch) BanUser(
	ctx context.Context,
	userID streamcontrol.ChatUserID,
	reason string,
	deadline time.Time,
) (_err error)

func (*Twitch) Close

func (t *Twitch) Close() error

func (*Twitch) EndStream

func (t *Twitch) EndStream(
	ctx context.Context,
) error

func (*Twitch) Flush

func (t *Twitch) Flush(
	ctx context.Context,
) error

func (*Twitch) GetAllCategories

func (t *Twitch) GetAllCategories(
	ctx context.Context,
) ([]helix.Game, error)

func (*Twitch) GetChatMessagesChan

func (t *Twitch) GetChatMessagesChan(
	ctx context.Context,
) (<-chan streamcontrol.ChatMessage, error)

func (*Twitch) GetStreamStatus

func (t *Twitch) GetStreamStatus(
	ctx context.Context,
) (*streamcontrol.StreamStatus, error)

func (*Twitch) InsertAdsCuePoint

func (t *Twitch) InsertAdsCuePoint(
	ctx context.Context,
	ts time.Time,
	duration time.Duration,
) error

func (*Twitch) IsCapable

func (t *Twitch) IsCapable(
	ctx context.Context,
	cap streamcontrol.Capability,
) bool

func (*Twitch) RemoveChatMessage

func (t *Twitch) RemoveChatMessage(
	ctx context.Context,
	messageID streamcontrol.ChatMessageID,
) (_ret error)

func (*Twitch) SendChatMessage

func (t *Twitch) SendChatMessage(ctx context.Context, message string) (_ret error)

func (*Twitch) SetDescription

func (t *Twitch) SetDescription(
	ctx context.Context,
	description string,
) error

func (*Twitch) SetTitle

func (t *Twitch) SetTitle(
	ctx context.Context,
	title string,
) error

func (*Twitch) StartStream

func (t *Twitch) StartStream(
	ctx context.Context,
	title string,
	description string,
	profile StreamProfile,
	customArgs ...any,
) (_err error)