Screencast

Интерфейс для захвата кадров записи экрана со страницы.

Методы​

hideActions​

Удаляет оформление действий.

Использование

await screencast.hideActions();

Возвращает

• Promise<void>

hideOverlays​

Скрывает наложения, не удаляя их.

Использование

await screencast.hideOverlays();

Возвращает

• Promise<void>

showActions​

Включает визуальные аннотации для элементов, с которыми взаимодействуют. Возвращает объект Disposable, который перестаёт отображать действия после вызова dispose.

Использование

await screencast.showActions();
await screencast.showActions(options);

Аргументы

• options Object (необязательно)

  • cursor "none" | "pointer" (необязательно)

    Оформление курсора, отображаемое для действий с указателем. "pointer" (значение по умолчанию) отображает указатель мыши, который анимированно перемещается от точки предыдущего действия к следующей. "none" отключает оформление курсора.

  • duration number (необязательно)

    Продолжительность отображения каждой аннотации в миллисекундах. По умолчанию 500.

  • fontSize number (необязательно)

    Размер шрифта заголовка действия в пикселях. По умолчанию 24.

  • position "top-left" | "top" | "top-right" | "bottom-left" | "bottom" | "bottom-right" (необязательно)

    Положение наложения с заголовком действия. По умолчанию "top-right".

Возвращает

• Promise<Disposable>

showChapter​

Показывает наложение главы с заголовком и необязательным описанием в центре страницы на размытом фоне. Полезно для озвучивания видеозаписей. Наложение удаляется по истечении указанной длительности или через 2000 мс.

Использование

await screencast.showChapter(title);
await screencast.showChapter(title, options);

Аргументы

• title string

  Текст заголовка, который заметно отображается в наложении.

• options Object (необязательно)

  • description string (необязательно)

    Необязательный текст описания, отображаемый под заголовком.

  • duration number (необязательно)

    Длительность в миллисекундах, по истечении которой наложение автоматически удаляется. По умолчанию 2000.

Возвращает

• Promise<void>

showOverlay​

Добавляет наложение с указанным HTML-содержимым. Наложение отображается поверх страницы, пока его не удалят. Возвращает объект Disposable, который удаляет наложение после вызова dispose.

Использование

await screencast.showOverlay(html);
await screencast.showOverlay(html, options);

Аргументы

• html string

  HTML-содержимое наложения.

• options Object (необязательно)

  • duration number (необязательно)

    Длительность в миллисекундах, по истечении которой наложение автоматически удаляется. Если значение не указано, наложение отображается, пока его не закроют.

Возвращает

• Promise<Disposable>

showOverlays​

Показывает наложения.

Использование

await screencast.showOverlays();

Возвращает

• Promise<void>

start​

Запускает запись экрана. Если указан path, видеозапись сохраняется в указанный файл. Если указан onFrame, JPEG-кадры передаются в callback. Можно использовать оба параметра одновременно.

Использование

// Record video
await page.screencast.start({ path: 'video.webm', size: { width: 1280, height: 800 } });
// ... perform actions ...
await page.screencast.stop();

// Capture frames
await page.screencast.start({
  onFrame: ({ data, timestamp, viewportWidth, viewportHeight }) => {
    console.log(`frame size: ${data.length} (${viewportWidth}x${viewportHeight}) at ${timestamp}`);
  },
  size: { width: 800, height: 600 },
});
// ... perform actions ...
await page.screencast.stop();

Аргументы

• options Object (необязательно)

  • onFrame function(Object):Promise (необязательно)

    • data Buffer

      Данные кадра в формате JPEG.

    • timestamp number

      Метка времени, когда браузер отобразил кадр, в миллисекундах с начала эпохи Unix.

    • viewportWidth number

      Ширина области просмотра страницы на момент захвата кадра.

    • viewportHeight number

      Высота области просмотра страницы на момент захвата кадра.

    Callback, получающий данные кадра в формате JPEG вместе с размером области просмотра страницы на момент захвата.

  • path string (необязательно)

    Путь, по которому следует сохранить видео после остановки записи экрана. Если указан, начинается запись видео.

  • quality number (необязательно)

    Качество изображения от 0 до 100.

  • size Object (необязательно)

    • width number

      Максимальная ширина кадра в пикселях.

    • height number

      Максимальная высота кадра в пикселях.

    Задаёт размеры кадров записи экрана. Фактический кадр масштабируется с сохранением пропорций страницы и может быть меньше указанных ограничений. Если запись экрана уже активна (например, запущена трассировкой или видеозаписью), приоритет имеет существующая конфигурация, поэтому размер кадра может превышать эти ограничения или этот параметр может быть проигнорирован. Если размер не указан, он будет соответствовать области просмотра страницы, уменьшенной до 800×800.

Возвращает

• Promise<Disposable>

stop​

Останавливает запись экрана и видеозапись, если она активна. Если велась видеозапись, она сохраняется по пути, указанному в screencast.start().

Использование

await screencast.stop();

Возвращает

• Promise<void>