Interface: ClipCreateOptions

Options accepted by TwitchService.clip.

Properties

duration?

optional duration?: number;

Length of the clip in seconds. Must be between 5 and 60 inclusive — anything else throws a RangeError before any network call. Rounded to one decimal (12.37 becomes 12.4), the precision Twitch accepts.

Default Value

30

---

has_delay?

optional has_delay?: boolean;

Deprecated

Twitch removed this parameter — it had no effect on the resulting clip. Still accepted so existing apps keep working, but it is no longer sent.

---

timeout?

optional timeout?: number;

How long to wait for publication, in milliseconds. Only used with wait.

Default Value

60000

---

title?

optional title?: string;

Title of the clip. Twitch generates one from the stream title when omitted, and an empty string is treated as omitted.

Remarks

Twitch documents no length limit here, but the title goes through AutoMod: a rejected one fails the whole call, and there is no way to predict it client-side.

---

wait?

optional wait?: boolean;

Wait until Twitch has actually published the clip, and resolve with the full ReadyClip instead of the bare { id, edit_url } receipt.