Stop Recording Screen
Stop recording screen
//: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/device/recording-screen/stop-recording-screen.yml)
Example Usage
// Java
driver.stopRecordingScreen();
driver.stopRecordingScreen(new BaseStopScreenRecordingOptions(....));
# Python
self.driver.stop_recording_screen()
// Javascript
// webdriver.io example
driver.stopRecordingScreen();
// wd example
await driver.stopRecordingScreen();
# Ruby
# ruby_lib example
stop_recording_screen
stop_recording_screen remote_path: 'https://example.com', user: 'example', pass: 'pass', method: 'POST'
# ruby_lib_core example
@driver.stop_recording_screen
@driver.stop_recording_screen remote_path: 'https://example.com', user: 'example', pass: 'pass', method: 'POST'
# PHP
// TODO PHP sample
// C#
driver.StopRecordingScreen();
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.3+ | All | All | |
| Mac | Mac | None | None | None |
| Windows | Windows | None | None | None |
Appium Clients
| Language | Support | Documentation |
|---|---|---|
| Java | All | static.javadoc.io |
| Python | All | appium.github.io |
| Javascript (WebdriverIO) | All | |
| Javascript (WD) | All | github.com |
| Ruby | All | www.rubydoc.info |
| PHP | None | github.com |
| C# | None | github.com |
HTTP API Specifications
Endpoint
POST /session/:session_id/appium/stop_recording_screen
URL Parameters
| name | description |
|---|---|
| remotePath | 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. |
| username | The name of the user for the remote authentication. |
| password | The password for the remote authentication. |
| method | The http multipart upload method name. The ‘PUT’ one is used by default. |
JSON Parameters
None
Response
Base64 encoded string. If remote_path is set, the response is empty string. (string)