Stream channel settings — read and change your own channel's title, category and language
Reads and updates a streamer's own Twitch channel settings — the title shown on the stream page, the category being played, and the language.
Reads and updates a streamer's own Twitch channel settings — the title shown on the stream page, the category being played, and the language. Needs the streamer's Twitch sign-in: the first run answers needs_user with a link to sign in, and later runs reuse it.
Also known as: stream title, change my stream title, set my stream title, update my stream title, stream category, change what i am streaming, set the game i am streaming, my channel settings, read my stream title, going live settings
Call it
bowmark.stream_channel.get(): Promise<ChannelSettings>
bowmark.stream_channel.set(options: SetChannelOptions): Promise<ChannelSettings>Functions
| Function | What it does |
|---|---|
get | Reads the signed-in streamer's own channel settings: the title shown on the stream page, the category being played, and the language. |
set | Updates the signed-in streamer's own channel settings and returns them as they now stand. |
Types
interface ChannelSettings {
platform: "twitch" // the default, and the only one today
id: string // the site's own id for these broadcast settings
title: string // the channel title shown on the stream page
language: string // ISO 639-1, e.g. "en"
gameId: string // the category; empty strings when never set
gameName: string
warnings: string[] // always present
}
interface SetChannelOptions {
platform?: "twitch" // the default, and the only one today
title?: string // the channel title shown on the stream page
language?: string // ISO 639-1, e.g. "en"
game?: string // category NAME, e.g. "Wetrix" — not a category id
}
type CallOptions = {
timeoutMs?: number // per-provider budget in ms, default 30000, clamped to 1000-55000.
// A provider slower than this is DROPPED from the results and
// NAMED in warnings — never silently absent
}Examples
// What is the channel set to right now?
const now = await bowmark.stream_channel.get();
return { title: now.title, game: now.gameName };// Retitle the stream and switch the category, leaving the language alone.
const updated = await bowmark.stream_channel.set({
title: "Wetrix N64 · going for the Classic 100k PB",
game: "Wetrix",
});
return { title: updated.title, game: updated.gameName, warnings: updated.warnings };Providers behind it
| Provider | |
|---|---|
twitch | Twitch |