Перейти к основному содержимому

Screencast

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

Методы​

hide_actions​

Добавлено в: v1.59 screencast.hide_actions

Удаляет визуальные обозначения действий.

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

screencast.hide_actions()

Возвращает

hide_overlays​

Добавлено в: v1.59 screencast.hide_overlays

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

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

screencast.hide_overlays()

Возвращает

show_actions​

Добавлено в: v1.59 screencast.show_actions

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

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

screencast.show_actions()
screencast.show_actions(**kwargs)

Аргументы

  • cursor "none" | "pointer" (необязательно) Добавлено в: v1.61#

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

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

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

  • font_size int (необязательно)#

    Устарело

    Вместо этого используйте title в style, например style: { title: 'font-size: 32px' }.

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

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

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

  • style Dict (необязательно) Добавлено в: v1.64#

    • point str (необязательно)

      CSS-объявления для маркера в точке действия. Маркер располагается в точке действия, имеет нулевой размер и центрируется относительно этой точки, поэтому его размер и внешний вид задаются этим стилем. Если параметр не указан, маркер не отображается.

    • highlight str (необязательно)

      CSS-объявления для прямоугольника, покрывающего целевой элемент. Положение и размеры прямоугольника соответствуют границам элемента. Если параметр не указан, прямоугольник не отображается.

    • title str (необязательно)

      CSS-объявления для заголовка действия, например 'font-size: 32px; background: #333'. Заголовок размещается в соответствии с position.

    Стили визуальных обозначений действий. Все обозначения постепенно исчезают в течение duration.

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

    await page.screencast.showActions({
      style: {
        point: 'width: 20px; height: 20px; border-radius: 50%; background: red',
        highlight: 'outline: 2px solid #333; background: rgba(0, 128, 255, .15)',
        title: 'font-size: 16px',
      },
    });

Возвращает

show_chapter​

Добавлено в: v1.59 screencast.show_chapter

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

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

screencast.show_chapter(title)
screencast.show_chapter(title, **kwargs)

Аргументы

  • title str#

    Текст заголовка, выделенный на наложении.

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

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

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

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

Возвращает

show_overlay​

Добавлено в: v1.59 screencast.show_overlay

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

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

screencast.show_overlay(html)
screencast.show_overlay(html, **kwargs)

Аргументы

  • html str#

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

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

    Время в миллисекундах, по истечении которого наложение автоматически удаляется. Если параметр не указан, наложение остаётся до явного удаления.

Возвращает

show_overlays​

Добавлено в: v1.59 screencast.show_overlays

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

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

screencast.show_overlays()

Возвращает

start​

Добавлено в: v1.59 screencast.start

Запускает скринкаст. Если указан path, сохраняет видеозапись в заданный файл. Если указан on_frame, передаёт кадры в формате JPEG в функцию обратного вызова. Оба параметра можно использовать одновременно.

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

Аргументы

  • fps int (необязательно) Добавлено в: v1.64#

    Частота кадров видеозаписи в кадрах в секунду. Используется только вместе с path. По умолчанию — 25.

    Более высокая частота кадров делает анимации и прокрутку плавнее, но увеличивает нагрузку на процессор при кодировании. Используйте вместе с size для записи видео высокого разрешения. Видео может содержать лишь столько различных кадров, сколько создаёт браузер; Firefox и WebKit в настоящее время захватывают до 25 кадров в секунду.

  • on_frame Callable[Dict]:Promise (необязательно)#

    • data bytes

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

    • timestamp float

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

    • viewportWidth int

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

    • viewportHeight int

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

    Функция обратного вызова, которая получает данные кадра в формате JPEG вместе с размерами области просмотра страницы на момент захвата.

  • path Union[str, pathlib.Path] (необязательно)#

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

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

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

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

    • width int

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

    • height int

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

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

Возвращает

stop​

Добавлено в: v1.59 screencast.stop

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

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

screencast.stop()

Возвращает