Start Recording Screen
Start recording screen
Example Usage
// Java
driver.startRecordingScreen();
driver.startRecordingScreen(new BaseStartScreenRecordingOptions(....));
# Python
self.driver.start_recording_screen()
// Not supported
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
// wd example
await driver.startRecordingScreen();
# Ruby
# ruby_lib example
start_recording_screen
start_recording_screen video_size: '1280x720', time_limit: '180', bit_rate: '5000000' # Android
start_recording_screen video_type: 'h264', time_limit: '260' # iOS
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/start-recording-screen.yml)
# ruby_lib_core example
@driver.start_recording_screen
@driver.start_recording_screen video_size: '1280x720', time_limit: '180', bit_rate: '5000000' # Android
@driver.start_recording_screen video_type: 'h264', time_limit: '260' # iOS
# PHP
// TODO PHP sample
// C#
// TODO C# sample
Support
Appium Server
Platform | Driver | Platform Versions | Appium Version | Driver Version |
---|---|---|---|---|
iOS | XCUITest | 9.3+ | 1.6.0+ | All |
UIAutomation | None | None | None | |
Android | Espresso | ?+ | 1.9.0+ | All |
UiAutomator2 | ?+ | 1.6.0+ | All | |
UiAutomator | 4.2+ | All | All | |
Mac | Mac | None | None | None |
Windows | Windows | None | None | None |
Appium Clients
Language | Support | Documentation |
---|---|---|
Java | All | static.javadoc.io |
Python | All | |
Javascript (WebdriverIO) | All | |
Javascript (WD) | All | github.com |
Ruby | All | Android iOS |
PHP | None | github.com |
C# | None | github.com |
HTTP API Specifications
Endpoint
POST /session/:session_id/appium/start_recording_screen
URL Parameters
name | description |
---|---|
session_id | ID of the session to route the command to |
JSON Parameters
name | type | description |
---|---|---|
remotePath | string |
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 endpount 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 progreess and forceRestart parameter is not set to true . |
username | string |
The name of the user for the remote authentication. |
password | string |
The password for the remote authentication. |
method | string |
The http multipart upload method name. The 'PUT' one is used by default. |
forceRestart | boolean |
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 ). |
timeLimit | string |
Recording time. 180 seconds is by default. |
videoType | string |
(iOS Only) The format of the screen capture to be recorded. Available formats "h264", "mp4" or "fmp4". Default is "mp4". Only works for Simulator. |
videoQuality | string |
(iOS Only) The video encoding quality (low, medium, high, photo - defaults to medium). |
videoFps | string |
(iOS Only) The Frames Per Second rate of the recorded video. Change this value if the resulting video is too slow or too fast. Defaults to 10. This can decrease the resulting file size. |
bitRate | string |
(iOS Only) 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. |
videoSize | string |
(Android Only) 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" |
bugReport | string |
(Android Only) 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 O). |
Response
null