Package io.appium.java_client.screenrecording

Interface CanRecordScreen

All Superinterfaces:

ExecutesMethod

All Known Implementing Classes:

AndroidDriver, IOSDriver, Mac2Driver, WindowsDriver

public interface CanRecordScreen
extends ExecutesMethod

Method Summary

Modifier and Type	Method	Description
default java.lang.String	startRecordingScreen()	Start asynchronous screen recording process with default options.
default <T extends BaseStartScreenRecordingOptions> java.lang.String	startRecordingScreen(T options)	Start asynchronous screen recording process.
default java.lang.String	stopRecordingScreen()	Gather the output from the previously started screen recording to a media file with default options.
default <T extends BaseStopScreenRecordingOptions> java.lang.String	stopRecordingScreen(T options)	Gather the output from the previously started screen recording to a media file.

Methods inherited from interface io.appium.java_client.ExecutesMethod

execute, execute

Method Detail

startRecordingScreen

default <T extends BaseStartScreenRecordingOptions> java.lang.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 java.lang.String startRecordingScreen()

Start asynchronous screen recording process with default options.

Returns:

`not used`.

stopRecordingScreen

default <T extends BaseStopScreenRecordingOptions> java.lang.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 java.lang.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.