dev.flutter.scenariosui.ScreenshotUtil Class Reference

Static Public Member Functions
static synchronized void	onCreate ()
static synchronized void	finish ()
static synchronized void	writeFile ( @NonNull String filename, @NonNull CountDownLatch latch)
static void	capture (@NonNull TestableFlutterActivity activity, @NonNull String captureName) throws Exception

Detailed Description

Allows to capture screenshots, and transfers the screenshots to the host where they can be further proccessed. On a LUCI environment, the screenshots are sent to Skia Gold.

Definition at line 22 of file ScreenshotUtil.java.

Member Function Documentation

capture()

static void dev.flutter.scenariosui.ScreenshotUtil.capture ( @NonNull TestableFlutterActivity  activity, @NonNull String  captureName  ) throws Exception

inlinestatic

Captures a screenshot of the activity, and sends the screenshot bytes to the host where it is further processed.

The activity must be already launched.

Parameters

activity	The target activity.
fileName	The name of the file.

Definition at line 125 of file ScreenshotUtil.java.

                       {
    CountDownLatch latch = new CountDownLatch(1);
    activity.waitUntilFlutterRendered();
    ScreenshotUtil.writeFile(captureName, latch);
    latch.await();
  }

finish()

static synchronized void dev.flutter.scenariosui.ScreenshotUtil.finish ( )

inlinestatic

Closes the connection with the host.

Definition at line 80 of file ScreenshotUtil.java.

                                           {
    if (executor != null && conn != null) {
      executor.execute(
          () -> {
            try {
              conn.close();
              conn = null;
            } catch (IOException e) {
              throw new RuntimeException(e);
            }
          });
    }
  }

onCreate()

static synchronized void dev.flutter.scenariosui.ScreenshotUtil.onCreate ( )

inlinestatic

Starts the connection with the host.

Definition at line 62 of file ScreenshotUtil.java.

                                             {
    if (executor == null) {
      executor = Executors.newSingleThreadExecutor();
    }
    if (conn == null) {
      executor.execute(
          () -> {
            try {
              final Socket socket = new Socket(HOST, PORT);
              conn = new Connection(socket);
            } catch (IOException e) {
              throw new RuntimeException(e);
            }
          });
    }
  }

writeFile()

static synchronized void dev.flutter.scenariosui.ScreenshotUtil.writeFile ( @NonNull String  filename, @NonNull CountDownLatch  latch  )

inlinestatic

Sends the file to the host.

Parameters

filename	The file name.
fileContent	The file content.

Definition at line 100 of file ScreenshotUtil.java.

                                                               {
    if (executor != null && conn != null) {
      executor.execute(
          () -> {
            try {
              conn.writeFile(filename);
            } catch (IOException e) {
              throw new RuntimeException(e);
            } finally {
              latch.countDown();
            }
          });
    }
  }

---

The documentation for this class was generated from the following file:

• testing/scenario_app/android/app/src/androidTest/java/dev/flutter/scenariosui/ScreenshotUtil.java