Method: Appium::Core::Android::Device#start_recording_screen

Defined in:

lib/appium_lib_core/android/device.rb

#start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', file_field_name: nil, form_fields: nil, headers: nil, force_restart: nil, video_size: nil, time_limit: '180', bit_rate: '4000000', bug_report: nil) ⇒ String

Returns Base64 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).

Examples:

@driver.start_recording_screen
@driver.start_recording_screen video_size: '1280x720', time_limit: '180', bit_rate: '5000000'

Parameters:

• remote_path (String) (defaults to: nil) —

  The path to the remote location, where the resulting video should be uploaded. The following protocols are supported: http/https, ftp. Null or empty string value (the default setting) means the content of resulting file should be encoded as Base64 and passed as the endpoint response value. 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 screen recording process in progress and forceRestart parameter is not set to true.

• user (String) (defaults to: nil) —

  The name of the user for the remote authentication.

• pass (String) (defaults to: nil) —

  The password for the remote authentication.

• method (String) (defaults to: 'PUT') —

  The http multipart upload method name. The ‘PUT’ one is used by default.

• file_field_name (String) (defaults to: nil) —

  The name of the form field containing the binary payload in multipart/form-data requests since Appium 1.18.0. Defaults to ‘file’.

• form_fields (Array<Hash, Array<String>>) (defaults to: nil) —

  The form fields mapping in multipart/form-data requests since Appium 1.18.0. If any entry has the same key in this mapping, then it is going to be ignored.

• headers (Hash) (defaults to: nil) —

  The additional headers in multipart/form-data requests since Appium 1.18.0.

• force_restart (Boolean) (defaults to: nil) —

  Whether to try to catch and upload/return the currently running screen recording (false, the default setting on server) or ignore the result of it and start a new recording immediately (true).

• video_size (String) (defaults to: nil) —

  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. For example, “1280x720”

• time_limit (String) (defaults to: '180') —

  Recording time. 180 seconds is by default. 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.

• bit_rate (String) (defaults to: '4000000') —

  The video bit rate for the video, in megabits per second. 4 Mbp/s(4000000) is by default for Android API level below 27. 20 Mb/s(20000000) for API level 27 and above.

• bug_report (Boolean) (defaults to: nil) —

  Set it to true in order to display 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:

• (String) —

  Base64 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)

# File 'lib/appium_lib_core/android/device.rb', line 149