diff --git a/browsers/live-view.mdx b/browsers/live-view.mdx index 970825d..337bf8d 100644 --- a/browsers/live-view.mdx +++ b/browsers/live-view.mdx @@ -15,6 +15,34 @@ To access the live view, visit the `browser_live_view_url` provided when you cre The `browser_live_view_url` supports additional query parameters to customize the live view: - `readOnly` (bool): when set to `true`, the view will be non-interactive. +## Kiosk mode + +Kiosk mode provides a fullscreen live view experience without browser UI elements like the address bar and tabs. You can enable kiosk mode when creating a browser by setting the `kiosk_mode` parameter to `true`. + + + +```typescript Typescript/Javascript +const kernelBrowser = await kernel.browsers.create({ + viewport: { + width: 1920, + height: 1080 + }, + kiosk_mode: true +}); +``` + +```python Python +kernel_browser = client.browsers.create( + viewport={ + "width": 1920, + "height": 1080 + }, + kiosk_mode=True +) +``` + + + ## Browser persistence `browser_live_view_url` becomes invalid once the browser is [deleted](/browsers/termination) manually or via timeout. diff --git a/browsers/viewport.mdx b/browsers/viewport.mdx index 88d8765..44eda62 100644 --- a/browsers/viewport.mdx +++ b/browsers/viewport.mdx @@ -51,6 +51,10 @@ kernel_browser_auto = client.browsers.create( + +The `refresh_rate` parameter only applies to live view sessions and is ignored for [headless](/browsers/headless) browsers. + + ## Supported viewport configurations Kernel supports specific viewport configurations. The server will reject unsupported combinations. When you provide width and height without specifying refresh_rate, it will be automatically determined if the dimensions match one of the supported resolutions exactly. The following resolutions are supported: @@ -204,4 +208,4 @@ The server will reject any viewport configuration that doesn't exactly match one - Higher resolutions (like 2560x1440) may impact the performance and responsiveness of live view sessions - The viewport size affects how websites render, especially those with responsive designs - Screenshots taken from the browser will match the configured viewport dimensions -- In [headless mode](/browsers/headless), the viewport configuration still applies for rendering and screenshots +- In [headless mode](/browsers/headless), the viewport width and height still apply for rendering and screenshots, but the `refresh_rate` parameter is ignored