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

Screencast

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

Методы​

HideActionsAsync​

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

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

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

await Screencast.HideActionsAsync();

Возвращает

HideOverlaysAsync​

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

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

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

await Screencast.HideOverlaysAsync();

Возвращает

ShowActionsAsync​

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

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

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

await Screencast.ShowActionsAsync(options);

Аргументы

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

    • Cursor enum ScreencastCursor { None, Pointer }? (необязательно) Добавлено в: v1.61#

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

    • Duration [float]? (необязательно)#

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

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

      Устарело

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

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

    • Position enum AnnotatePosition { TopLeft, Top, TopRight, BottomLeft, Bottom, BottomRight }? (необязательно)#

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

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

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

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

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

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

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

        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',
        },
      });

Возвращает

  • [Disposable]#

ShowChapterAsync​

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

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

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

await Screencast.ShowChapterAsync(title, options);

Аргументы

  • title string#

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

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

    • Description string? (необязательно)#

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

    • Duration [float]? (необязательно)#

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

Возвращает

ShowOverlayAsync​

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

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

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

await Screencast.ShowOverlayAsync(html, options);

Аргументы

  • html string#

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

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

    • Duration [float]? (необязательно)#

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

Возвращает

  • [Disposable]#

ShowOverlaysAsync​

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

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

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

await Screencast.ShowOverlaysAsync();

Возвращает

StartAsync​

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

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

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

Аргументы

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

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

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

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

    • OnFrame Func<[ScreencastFrame], Task> (необязательно)#

      • Data byte[]

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

      • Timestamp [float]

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

      • ViewportWidth int

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

      • ViewportHeight int

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

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

    • Path string? (необязательно)#

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

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

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

    • Size Size? (необязательно)#

      • Width int

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

      • Height int

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

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

Возвращает

  • [Disposable]#

StopAsync​

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

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

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

await Screencast.StopAsync();

Возвращает