io.appium.java_client.android

Class AndroidStartScreenRecordingOptions

java.lang.Object

io.appium.java_client.screenrecording.BaseScreenRecordingOptions<BaseStartScreenRecordingOptions<T>>

io.appium.java_client.screenrecording.BaseStartScreenRecordingOptions<AndroidStartScreenRecordingOptions>

io.appium.java_client.android.AndroidStartScreenRecordingOptions

public class AndroidStartScreenRecordingOptions
extends BaseStartScreenRecordingOptions<AndroidStartScreenRecordingOptions>

Constructor Summary

Constructors

Constructor and Description
AndroidStartScreenRecordingOptions()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	build() Builds a map, which is ready to be passed to the subordinated Appium API.
AndroidStartScreenRecordingOptions	enableBugReport() Makes the recorder to display an additional information on the video overlay, such as a timestamp, that is helpful in videos captured to illustrate bugs.
static AndroidStartScreenRecordingOptions	startScreenRecordingOptions()
AndroidStartScreenRecordingOptions	withBitRate(int bitRate) The video bit rate for the video, in megabits per second.
AndroidStartScreenRecordingOptions	withTimeLimit(java.time.Duration timeLimit) The maximum recording time.
AndroidStartScreenRecordingOptions	withVideoSize(java.lang.String videoSize) The video size of the generated media file.

Methods inherited from class io.appium.java_client.screenrecording.BaseStartScreenRecordingOptions

enableForcedRestart, withUploadOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AndroidStartScreenRecordingOptions

public AndroidStartScreenRecordingOptions()

Method Detail

startScreenRecordingOptions

public static AndroidStartScreenRecordingOptions startScreenRecordingOptions()

withBitRate

public AndroidStartScreenRecordingOptions withBitRate(int bitRate)

The video bit rate for the video, in megabits per second. The default value is 4000000 (4 Mb/s) for Android API level below 27 and 20000000 (20 Mb/s) for API level 27 and above. You can increase the bit rate to improve video quality, but doing so results in larger movie files.

Parameters:

bitRate - The actual bit rate (Mb/s).

Returns:

self instance for chaining.

withVideoSize

public AndroidStartScreenRecordingOptions withVideoSize(java.lang.String videoSize)

The video size of the generated media file. The format is WIDTHxHEIGHT. The default value is the device's native display resolution (if supported), 1280x720 if not. For best results, use a size supported by your device's Advanced Video Coding (AVC) encoder.

Parameters:

videoSize - The actual video size: WIDTHxHEIGHT.

Returns:

self instance for chaining.

enableBugReport

public AndroidStartScreenRecordingOptions enableBugReport()

Makes the recorder to display an additional information on the video overlay, such as a timestamp, that is helpful in videos captured to illustrate bugs. This option is only supported since API level 27 (Android P).

Returns:

self instance for chaining.

withTimeLimit

public AndroidStartScreenRecordingOptions withTimeLimit(java.time.Duration timeLimit)

The maximum recording time. The default and maximum value is 180 seconds (3 minutes). Setting values greater than this or less than zero will cause an exception. The minimum time resolution unit is one second.

Overrides:

withTimeLimit in class BaseStartScreenRecordingOptions<AndroidStartScreenRecordingOptions>

Parameters:

timeLimit - The actual time limit of the recorded video.

Returns:

self instance for chaining.

build

public java.util.Map<java.lang.String,java.lang.Object> build()

Description copied from class: BaseScreenRecordingOptions

Builds a map, which is ready to be passed to the subordinated Appium API.

Overrides:

build in class BaseStartScreenRecordingOptions<AndroidStartScreenRecordingOptions>

Returns:

arguments mapping.