Skip to content

Watermark & Marquee API

Watermark and marquee (scrolling text) overlay management.

API Reference

getMarqueeConfig()

Get the current marquee (scrolling text) configuration.

Returns: MarqueeConfig | null


getWatermarkConfig()

Get the current watermark configuration.

Returns: WatermarkConfig | null


setMarqueeConfig()

Override the marquee (scrolling text) configuration.

Writes to state.marqueeConfig$ and emits marqueeUpdate event. Once set, the server-side school marquee config will not override this custom config on room join.

ParameterTypeDescription
configMarqueeConfigMarquee configuration

Returns: void


setWatermarkConfig()

Override the watermark configuration.

Writes to state.watermarkConfig$ and emits watermarkUpdate event. Once set, the server-side school watermark will not override this custom config on room join.

ParameterTypeDescription
configWatermarkConfigWatermark configuration

Returns: void