This documentation is deprecated. Please refer to the README in the Appium repository or Appium 2.0 documentation.

  Edit this Doc Take Screenshot

Take a screenshot of the current viewport/window/page

Example Usage

File scrFile = ((TakesScreenshot)driver).getScreenshotAs(OutputType.FILE);

screenshotBase64 = self.driver.get_screenshot_as_base64()

// webdriver.io example
let screenshot = driver.takeScreenshot();

// wd example
let screenshot = await driver.takeScreenshot();

# ruby_lib example
driver.screenshot_as(:base64) # via core_lib

# ruby_lib_core example
@driver.screenshot_as(:base64)

Screenshot screenshot = driver.GetScreenshot();

Description

Takes a screenshot of the viewport in a native context (iOS, Android) and takes a screenshot of the window in web context

Note that some platforms may have settings that prevent screenshots from being taken, for security reason. One such feature is the Android FLAG_SECURE layout parameter

Support

Appium Server

Appium Clients

HTTP API Specifications

Endpoint

GET /session/:session_id/screenshot

URL Parameters

JSON Parameters

None

Response

The screenshot as a base64 encoded PNG (string)

See Also

• W3C Specification
• JSONWP Specification