io.appium.java_client.ios

Class IOSStartScreenRecordingOptions

java.lang.Object

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

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

io.appium.java_client.ios.IOSStartScreenRecordingOptions

public class IOSStartScreenRecordingOptions
extends BaseStartScreenRecordingOptions<IOSStartScreenRecordingOptions>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IOSStartScreenRecordingOptions.VideoQuality
static class	IOSStartScreenRecordingOptions.VideoType

Constructor Summary

Constructors

Constructor and Description
IOSStartScreenRecordingOptions()

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.
static IOSStartScreenRecordingOptions	startScreenRecordingOptions()
IOSStartScreenRecordingOptions	withTimeLimit(java.time.Duration timeLimit) The maximum recording time.
IOSStartScreenRecordingOptions	withVideoQuality(IOSStartScreenRecordingOptions.VideoQuality videoQuality) The video encoding quality (low, medium, high, photo - defaults to medium).
IOSStartScreenRecordingOptions	withVideoType(IOSStartScreenRecordingOptions.VideoType videoType) The format of the screen capture to be recorded.

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

IOSStartScreenRecordingOptions

public IOSStartScreenRecordingOptions()

Method Detail

startScreenRecordingOptions

public static IOSStartScreenRecordingOptions startScreenRecordingOptions()

withVideoType

public IOSStartScreenRecordingOptions withVideoType(IOSStartScreenRecordingOptions.VideoType videoType)

The format of the screen capture to be recorded. Available formats: "h264", "mp4" or "fmp4". Default is "mp4". Only works for Simulator.

Parameters:

videoType - one of available format names.

Returns:

self instance for chaining.

withVideoQuality

public IOSStartScreenRecordingOptions withVideoQuality(IOSStartScreenRecordingOptions.VideoQuality videoQuality)

The video encoding quality (low, medium, high, photo - defaults to medium). Only works for real devices.

Parameters:

videoQuality - one of possible quality preset names.

Returns:

self instance for chaining.

withTimeLimit

public IOSStartScreenRecordingOptions withTimeLimit(java.time.Duration timeLimit)

The maximum recording time. The default value is 180 seconds (3 minutes). The maximum value is 10 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<IOSStartScreenRecordingOptions>

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<IOSStartScreenRecordingOptions>

Returns:

arguments mapping.