Web SDK - RainwayStream.requestFullscreen()

Home > rainway-sdk > RainwayStream > requestFullscreen

RainwayStream.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?: RainwayFullscreenOptions): void;

Parameters

ParameterTypeDescription
optionsRainwayFullscreenOptionsSee RainwayFullscreenOptions.

Returns:

void