Edit this Doc Stop Recording Screen

Stop recording screen

Example Usage

driver.stopRecordingScreen(new BaseStopScreenRecordingOptions(....));


// Not supported

// wd example
await driver.stopRecordingScreen();

@driver.stop_recording_screen remote_path: 'https://example.com', user: 'example', pass: 'pass', method: 'POST'

// TODO C# sample

// TODO PHP sample


Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest 9.3+ 1.6.0+ All
UIAutomation None None None
Android 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 www.rubydoc.info
PHP None github.com
C# None github.com

HTTP API Specifications


POST /session/:session_id/appium/stop_recording_screen

URL Parameters

name description
remote_path 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



Base64 encoded string. If remote_path is set, the response is empty string. (string)

See Also