Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions browsers/live-view.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

<CodeGroup>

```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
)
```

</CodeGroup>

## Browser persistence

`browser_live_view_url` becomes invalid once the browser is [deleted](/browsers/termination) manually or via timeout.
6 changes: 5 additions & 1 deletion browsers/viewport.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ kernel_browser_auto = client.browsers.create(

</CodeGroup>

<Note>
The `refresh_rate` parameter only applies to live view sessions and is ignored for [headless](/browsers/headless) browsers.
</Note>

## 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:
Expand Down Expand Up @@ -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