screenshot.js 1.44 KB
/*
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2017 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 */
/* istanbul ignore next */
/* globals Promise */

define('screens/player/firmware/screenshot/spi/screenshot', [], function() {
    'use strict';

    /**
     * Defines the screenshot SPI.
     *
     * @interface ScreenshotSPI
     */
    return Object.freeze({

        /**
         * The service name
         * @property serviceName
         * @memberof ScreenshotSPI
         * @constant
         */
        serviceName: 'com.adobe.cq.screens.player.screenshot.spi.screenshot',

        /**
         * Gets a Base64 encoded screenshot of the entire screen
         * @function Screenshot#captureScreenshotAsURI
         * @returns {Promise<String|Error>} A promise resolving with the screenshot as a Base64 encoded URI string
         */
        captureScreenshotAsURI: function() { return Promise.reject(new Error('Not implemented')); }
    });

});