diff options
Diffstat (limited to 'examples/multimedia/screencapture/doc/screencapture.rst')
| -rw-r--r-- | examples/multimedia/screencapture/doc/screencapture.rst | 57 |
1 files changed, 32 insertions, 25 deletions
diff --git a/examples/multimedia/screencapture/doc/screencapture.rst b/examples/multimedia/screencapture/doc/screencapture.rst index 69b1ec166..116d7773b 100644 --- a/examples/multimedia/screencapture/doc/screencapture.rst +++ b/examples/multimedia/screencapture/doc/screencapture.rst @@ -1,35 +1,42 @@ Screen Capture Example ====================== -The Screen Capture Example demonstrates how to capture a screen or window using -QScreenCapture. It shows a list of screens and and displays a live preview of -the selected item using a ``QMediaCaptureSession`` and a ``QVideoWidget``. -There is a button to start and stop the capturing. +Screen Capture demonstrates how to capture a screen or window using +``QScreenCapture`` and ``QWindowCapture``. The example shows a list of screens +and windows and displays a live preview of the selected item using a +``QMediaCaptureSession`` and a ``QVideoWidget``. Capturing can be started and +stopped with a ``QPushButton``. Application Structure +++++++++++++++++++++ -The example consists of two custom classes. The UI and all screen capture +The example consists of three custom classes. The UI and all screen capture functionality is implemented in the class ``ScreenCapturePreview``. The classes -``ScreenListModel`` serves as model behind the ``QListView``. The main function -creates a ``ScreenCapturePreview`` object, which in turn creates an instance of -``QScreenCapture``, ``QMediaCaptureSession`` and ``QVideoWidget`` in addition -to all the UI widgets. - -The list model is populated with the return values of ``QGuiApplication.screens()``. - -When a list item is selected it is connected to the ``QScreenCapture`` object -with ``QScreenCapture.setScreen()``. The ``QScreenCapture`` object is connected -to the ``QMediaCaptureSession`` object with -``QMediaCaptureSession.setScreenCapture()``, which in turn is connected to the -``QVideoWidget`` object with ``QMediaCaptureSession.setVideoOutput()`` Thus the -screen capture output is previewed in the video widget on the right hand side -of the UI. - -The start/stop button calls ``QScreenCapture.start()`` and ``QScreenCapture.stop()``. - -A ``QMessageBox`` pops up if the ``QScreenCapture.errorOccurred()`` signal is emitted. - -.. image:: screencapture.webp +``ScreenListModel`` and ``WindowListModel`` only serve as models behind the two +``QListView`` widgets. The main function creates a ``ScreenCapturePreview`` +object, which in turn creates instances of ``QScreenCapture`` and +``QWindowCapture``, and a ``QMediaCaptureSession`` and ``QVideoWidget``, in +addition to all the UI widgets. + +The screen and window models are populated with the return values of +``QGuiApplication.screens()`` and ``QWindowCapture.capturableWindows()``, +respectively. + +When a list item is selected, it is connected to the ``QScreenCapture`` object +with ``QScreenCapture.setScreen()``, or to the ``QWindowCapture`` object with +``QWindowCapture.setWindow().`` The capture object is connected to the +``QMediaCaptureSession`` object with +``QMediaCaptureSession.setScreenCapture()`` and +``QMediaCaptureSession.setWindowCapture()``, respectively. The capture session +in turn is connected to the ``QVideoWidget`` object with +``QMediaCaptureSession.setVideoOutput()``. Thus, the capture output is +previewed in the video widget on the right hand side of the UI. + +The start/stop button calls ``QScreenCapture.start()`` and ``QScreenCapture.stop()``, +or ``QWindowCapture.start()`` and ``QWindowCapture.stop()``. + +A QMessageBox pops up if an ``errorOccurred`` signal is emitted. + +.. image. screencapture.webp :width: 600 :alt: screen capture example |