Download the PHP package actengage/capture without Composer
On this page you can find all versions of the php package actengage/capture. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download actengage/capture
More information about actengage/capture
Files in actengage/capture
Informations about the package capture
Capture SDK
This package provides fluent SDK for the Capture server. Capture is a Node server on AWS that takes screenshots with a variety of options. This package requires access to a Capture server endpoint before it be used.
Requirements
- Laravel ^9.1
- PHP ^8.1
- Guzzle ^7.0
- Capture Server Endpoint
Capture Server
Why is the Capture server endpoint not included in the package? Capture is a private Node server that runs Puppeteer with a specific set of features that are used for our internal products. We do not publish the URL, as its not intended for public consumption. You may however deploy your own Capture server and endpoint.
Installation
Install via Composer
Publish the config file
Set the endpoint URL in your ENV file.
Basic Usage
Calls
Call allow you to execute methods on the Puppeteer page
instance before the screenshot has been taken. This is a convenient way to execute a sequence of actions that are explicitly built into the server options (mainly for edge cases). The first argument is the method name, and all other arguments are passed to the method in Puppeteer.
Clipping
Clip a portion of an image using width
, height
, x
, and y
coordinates. There is no clipping by default.
Encoding
Encoding changes how the response is composed, either using binary
or base64
. Defaults to binary
.
Full Page
Take full page screenshots. Defaults to false
.
Headers
Pass a custom headers that are included by Puppeteer in its HTTP request. Defaults to {"Accept-Language": "en-US"}
.
Omit Background
This omits the black background for transparent PNG images. Defaults to true
.
Quality
The quality of image that is returned. Must be 1-100
. Defaults to 100
.
Timeout
The timeout of the Puppeteer request (in milliseconds). Defaults to 25000
.
Type
The type of image that is returned, jpeg
or png
. Defaults to jpeg
.
Viewport
The viewport dimensions. Defaults to {"width": 1200, "height": 800}
.
Wait Until
How long should Puppeteer wait before returning a response. Defaults to ['load', 'networkidle2']
.