HomeGuidesAPI Reference
HubBlogChangelogSupport ForumLog In
API Reference

Web SDK - InboundStream.requestFullscreen()

Home > @rainway/web > InboundStream > requestFullscreen

InboundStream.requestFullscreen() method

Ask the browser to fullscreen the Rainway container. The default behavior is to additionally lock the keyboard and mouse pointer, but this can be overridden by providing options.

For example:

requestFullScreen();
requestFullScreen({ lockKeyboard: false, lockPointer: false });

Signature:

requestFullscreen(options?: FullscreenOptions): void;

Parameters

ParameterTypeDescription
optionsFullscreenOptions(Optional) See

Returns:

void