puppeteer-core/lib/esm/puppeteer/node/ScreenRecorder.d.ts

A high-level API to control headless Chrome over the DevTools Protocol

/**
 * Copyright 2023 Google Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/// <reference types="node" />
import { PassThrough } from 'stream';
import type { BoundingBox } from '../api/ElementHandle.js';
import type { Page } from '../api/Page.js';
import { asyncDisposeSymbol } from '../util/disposable.js';
/**
 * @internal
 */
export interface ScreenRecorderOptions {
    speed?: number;
    crop?: BoundingBox;
    format?: 'gif' | 'webm';
    scale?: number;
    path?: string;
}
/**
 * @public
 */
export declare class ScreenRecorder extends PassThrough {
    #private;
    /**
     * @internal
     */
    constructor(page: Page, width: number, height: number, { speed, scale, crop, format, path }?: ScreenRecorderOptions);
    /**
     * Stops the recorder.
     *
     * @public
     */
    stop(): Promise<void>;
    /**
     * @internal
     */
    [asyncDisposeSymbol](): Promise<void>;
}
//# sourceMappingURL=ScreenRecorder.d.ts.map