Package io.appium.java_client.screenrecording

Interface CanRecordScreen

All Superinterfaces:
ExecutesMethod
All Known Implementing Classes:
AndroidDriver, FlutterAndroidDriver, FlutterIOSDriver, IOSDriver, Mac2Driver, WindowsDriver
public interface CanRecordScreen extends ExecutesMethod

  • Method Details

    • startRecordingScreen

      default <T extends BaseStartScreenRecordingOptions> String startRecordingScreen(T options)
      Start asynchronous screen recording process.
      Type Parameters:
      T - The platform-specific BaseStartScreenRecordingOptions
      Parameters:
      options - see the documentation on the BaseStartScreenRecordingOptions descendant for the particular platform.
      Returns:
      `not used`.

    • startRecordingScreen

      default String startRecordingScreen()
      Start asynchronous screen recording process with default options.
      Returns:
      `not used`.

    • stopRecordingScreen

      default <T extends BaseStopScreenRecordingOptions> String stopRecordingScreen(T options)
      Gather the output from the previously started screen recording to a media file.
      Type Parameters:
      T - The platform-specific BaseStopScreenRecordingOptions
      Parameters:
      options - see the documentation on the BaseStopScreenRecordingOptions descendant for the particular platform.
      Returns:
      Base-64 encoded content of the recorded media file or an empty string if the file has been successfully uploaded to a remote location (depends on the actual options).

    • stopRecordingScreen

      default String stopRecordingScreen()
      Gather the output from the previously started screen recording to a media file with default options.
      Returns:
      Base-64 encoded content of the recorded media file.