public class AndroidStartScreenRecordingOptions extends BaseStartScreenRecordingOptions<AndroidStartScreenRecordingOptions>
Constructor and Description |
---|
AndroidStartScreenRecordingOptions() |
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 |
withUploadOptions(ScreenRecordingUploadOptions uploadOptions)
Upload options set for the recorded screen capture.
|
AndroidStartScreenRecordingOptions |
withVideoSize(java.lang.String videoSize)
The video size of the generated media file.
|
disableForcedRestart, enableForcedRestart
public static AndroidStartScreenRecordingOptions startScreenRecordingOptions()
public AndroidStartScreenRecordingOptions withBitRate(int bitRate)
bitRate
- The actual bit rate (Mb/s).public AndroidStartScreenRecordingOptions withUploadOptions(ScreenRecordingUploadOptions uploadOptions)
withUploadOptions
in class BaseScreenRecordingOptions<BaseStartScreenRecordingOptions<AndroidStartScreenRecordingOptions>>
uploadOptions
- see the documentation on ScreenRecordingUploadOptions
for more details.public AndroidStartScreenRecordingOptions withVideoSize(java.lang.String videoSize)
videoSize
- The actual video size: WIDTHxHEIGHT.public AndroidStartScreenRecordingOptions enableBugReport()
public AndroidStartScreenRecordingOptions withTimeLimit(java.time.Duration timeLimit)
Since Appium 1.8.2 the time limit can be up to 1800 seconds (30 minutes). Appium will automatically try to merge the 3-minutes chunks recorded by the screenrecord utility, however, this requires FFMPEG utility to be installed and available in PATH on the server machine. If the utility is not present then the most recent screen recording chunk is going to be returned as the result.
withTimeLimit
in class BaseStartScreenRecordingOptions<AndroidStartScreenRecordingOptions>
timeLimit
- The actual time limit of the recorded video.public java.util.Map<java.lang.String,java.lang.Object> build()
BaseScreenRecordingOptions
build
in class BaseStartScreenRecordingOptions<AndroidStartScreenRecordingOptions>