io.appium.java_client.screenrecording

Class BaseStartScreenRecordingOptions<T extends BaseStartScreenRecordingOptions<T>>

java.lang.Object

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

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

Direct Known Subclasses:

AndroidStartScreenRecordingOptions, IOSStartScreenRecordingOptions

public abstract class BaseStartScreenRecordingOptions<T extends BaseStartScreenRecordingOptions<T>>
extends BaseScreenRecordingOptions<BaseStartScreenRecordingOptions<T>>

Constructor Summary

Constructors

Constructor and Description
BaseStartScreenRecordingOptions()

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.
T	enableForcedRestart() Whether to ignore the result of previous capture and start a new recording immediately.
T	withTimeLimit(java.time.Duration timeLimit) The maximum recording time.
T	withUploadOptions(ScreenRecordingUploadOptions uploadOptions) The remotePath upload option is the path to the remote location, where the resulting video should be uploaded.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseStartScreenRecordingOptions

public BaseStartScreenRecordingOptions()

Method Detail

withUploadOptions

public T withUploadOptions(ScreenRecordingUploadOptions uploadOptions)

The remotePath upload option is the path to the remote location, where the resulting video should be uploaded. The following protocols are supported: http/https (multipart), ftp. Missing value (the default setting) means the content of the resulting file should be encoded as Base64 and passed as the endpoint response value, but an exception will be thrown if the generated media file is too big to fit into the available process memory. This option only has an effect if there is a screen recording session in progress and forced restart is not enabled (the default setting).

Overrides:

withUploadOptions in class BaseScreenRecordingOptions<BaseStartScreenRecordingOptions<T extends BaseStartScreenRecordingOptions<T>>>

Parameters:

uploadOptions - see the documentation on ScreenRecordingUploadOptions for more details.

Returns:

self instance for chaining.

withTimeLimit

public T withTimeLimit(java.time.Duration timeLimit)

The maximum recording time.

Parameters:

timeLimit - The actual time limit of the recorded video.

Returns:

self instance for chaining.

enableForcedRestart

public T enableForcedRestart()

Whether to ignore the result of previous capture and start a new recording immediately. By default the endpoint will try to catch and return the result of the previous capture if it's still available.

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 BaseScreenRecordingOptions<BaseStartScreenRecordingOptions<T extends BaseStartScreenRecordingOptions<T>>>

Returns:

arguments mapping.