Skip to content

API Reference

The Voxta Twitch Relay is primarily used as a standalone application, but it can also be used as a library.

voxta_twitch_relay.bot

Classes

TwitchVoxtaRelay 

TwitchVoxtaRelay(gateway_client: GatewayClient, token: str, client_id: str, client_secret: str | None, prefix: str, initial_channels: list[str], ignored_users: list[str], immediate_reply: bool = True)

Bases: Bot

Functions
gateway_health_loop async 
gateway_health_loop()

Check if the gateway is up, retry every 30s.

process_queue async 
process_queue()

Process queued messages when chat becomes active.

relay_message async 
relay_message(msg_data: dict)

Relay a message to the Voxta Gateway.

set_reply async 
set_reply(ctx, value: str)

Set immediate_reply flag (true/false).

stream_check_loop async 
stream_check_loop()

Check if the stream is live, retry every 1 minute.

voxta_status async 
voxta_status(ctx)

Check Voxta and Gateway status.

voxta_twitch_relay.webapp

Functions

create_debug_app 

create_debug_app(bot: TwitchVoxtaRelay)