Method start

playwright/async_api/_generated.py:7803–7846

Screencast.start Starts the screencast. When `path` is provided, it saves video recording to the specified file. When `onFrame` is provided, delivers JPEG-encoded frames to the callback. Both can be used together. **Usage** Parameters ---------- on_

(
        self,
        *,
        on_frame: typing.Optional[
            typing.Callable[[ScreencastFrame], typing.Any]
        ] = None,
        path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
        quality: typing.Optional[int] = None,
        size: typing.Optional[ScreencastSize] = None,
    )

class Screencast(AsyncBase):

    async def start(
        self,
        *,
        on_frame: typing.Optional[
            typing.Callable[[ScreencastFrame], typing.Any]
        ] = None,
        path: typing.Optional[typing.Union[pathlib.Path, str]] = None,
        quality: typing.Optional[int] = None,
        size: typing.Optional[ScreencastSize] = None,
    ) -> "AsyncContextManager":
        """Screencast.start

        Starts the screencast. When `path` is provided, it saves video recording to the specified file. When `onFrame` is
        provided, delivers JPEG-encoded frames to the callback. Both can be used together.

        **Usage**

        Parameters
        ----------
        on_frame : Union[Callable[[{data: bytes, timestamp: float, viewportWidth: int, viewportHeight: int}], Any], None]
            Callback that receives JPEG-encoded frame data along with the page viewport size at the time of capture.
        path : Union[pathlib.Path, str, None]
            Path where the video should be saved when the screencast is stopped. When provided, video recording is started.
        quality : Union[int, None]
            The quality of the image, between 0-100.
        size : Union[{width: int, height: int}, None]
            Specifies the dimensions of screencast frames. The actual frame is scaled to preserve the page's aspect ratio and
            may be smaller than these bounds. If a screencast is already active (e.g. started by tracing or video recording),
            the existing configuration takes precedence and the frame size may exceed these bounds or this option may be
            ignored. If not specified the size will be equal to page viewport scaled down to fit into 800×800.

        Returns
        -------
        AsyncContextManager
        """

        return mapping.from_impl(
            await self._impl_obj.start(
                onFrame=self._wrap_handler(on_frame),
                path=path,
                quality=quality,
                size=size,
            )
        )

    async def stop(self) -> None:
        """Screencast.stop