Class: AnnounceOptions

Display options for an on-screen announcement shown via k.overlay.announce.

Extends

• ScreenDisplayOptions

Constructors

Constructor

new AnnounceOptions(): AnnounceOptions;

Returns

AnnounceOptions

Inherited from

ScreenDisplayOptions.constructor

Properties

duration?

optional duration?: number;

On-screen display duration, in seconds.

Remarks

Values outside the allowed range are clamped rather than rejected (1 to 180 seconds for an announcement, 1 to 60 for a notification).

Default Value

the duration configured by the streamer.

Inherited from

ScreenDisplayOptions.duration

---

html?

optional html?: boolean;

If true, the message is interpreted as HTML rather than plain text. Sanitized before display.

Inherited from

ScreenDisplayOptions.html

---

target?

optional target?: ScreenTarget;

Overlay the screen is played in.

Default Value

main

Inherited from

ScreenDisplayOptions.target

---

title?

optional title?: string;

Title displayed above the message.

Inherited from

ScreenDisplayOptions.title

---

title_html?

optional title_html?: boolean;

If true, the title is interpreted as HTML. Sanitized before display.

Inherited from

ScreenDisplayOptions.title_html

---

visual?

optional visual?: ScreenVisual;

Image or profile picture attached to the event.

Inherited from

ScreenDisplayOptions.visual