start

suspend fun start(sessionHandle: DBusPath, parentWindow: String = ""): Result<StartResponse>(source)

Start the screencast session. This will typically present a dialog for the user to confirm the selection configured via selectSources.

A screencast session may only be started after having selected sources, and an application can only attempt to start a session once.

Return

Result containing StartResponse with the selected PipeWire streams.

Parameters

sessionHandle

Object path for the session created via createSession.

parentWindow

Identifier for the application window (see Window Identifiers). Use empty string if no parent window.