Screencap API: Requirements

To run successfully, this sample demo requires the following:

Kiosk Pro Plus or Kiosk Pro Enterprise, version 7.8 or later

While the JavaScript included in this code sample is compatible with earlier versions of Kiosk Pro, those versions require a different 'kiosk_functions.js' file to access this functionality.

For live projects, we highly recommend hosting the 'kiosk_functions.js' file with your own files, whether they are placed on a server or stored locally on the iPad, and checking the app's change logs before updating. The 'kiosk_functions.js' file referenced in the sample may be updated or moved without warning - if you are referencing this file directly, this would prevent your kiosks from working correctly.

To run the demo on earlier versions of the app, generate the 'kiosk_functions.js' for that version from the settings menu under 'JavaScript API > Generate API Functions File'. Transfer the file from the device using iTunes so you can place it where you need it, then change the reference in the sample code to point at the file.

9.7-inch iPad with Retina Screen in Landscape

The capture area for this API is defined by pixel dimensions. While these dimensions can be changed for your project, our demos are specifically sized for 9.7-inch iPads with a Retina screen in landscape orientation. Trying to capture the area on a different iPad or in a different orientation will display an incorrect capture.

Specific Kiosk Pro Settings

Screen Capture Demo
Signature Capture Demo