Skip to content

Twitch

Check the Twitch chat connection and send chat messages from Flow Pro scripts.

Updated View as Markdown
For humans
Flow APIFlow Pro scriptingCommunity and Twitch

This article covers the following platforms

Use the Twitch API to check whether Flow is connected to Twitch chat and to send chat messages.

is_connected()

Check whether Flow is connected to Twitch chat.

SignatureTypeScript contract
is_connected(): boolean
ExampleJavaScript
const isConnected = this.$api.twitch.is_connected();
console.log(isConnected);

Returns

booleanWhether Flow is connected to Twitch chat.

send_message()

Send a message to the connected Twitch chat.

SignatureTypeScript contract
send_message(message: string, prefix?: string): void

Parameters

NameTypeRequiredDescription
messagestringYesMessage to send.
prefixstringNoOptional Twitch IRC prefix. For replies, use @reply-parent-msg-id=<message-id>.
ExampleJavaScript
this.$api.twitch.send_message("Thanks for watching!");

Returns

voidNo direct return value is documented.
Navigation

Type to search…

↑↓ navigate↵ selectEsc close