Filestack\FilestackClient::screenshot

Take a screenshot of a URL

Signature

public function screenshot(string
        $url,
            [array
        $store_options = ,
            [string
        $agent = 'desktop',
            [string
        $mode = 'all',
            [integer
        $width = 1024,
            [integer
        $height = 768,
            [integer
        $delay = 0]]]]]] )

Parameters

$url — string: URL to screenshot
$store_options — array: optional store values
$agent — string: desktop or mobile
$mode — string: all or window
$width — integer: Designate the width of the browser window. The
width is 1024 by default, but can be set to
anywhere between 1 to 1920.
$height — integer: Designate the height of the browser window.
The height is 768 by default, but can be set
to anywhere between 1 to 1080.
$delay — integer: Tell URL Screenshot to wait x milliseconds before
capturing the webpage. Sometimes pages take
longer to load, so you may need to delay the
capture in order to make sure the page is
rendered before the screenshot is taken. The
delay must be an integer between 0 and 10000.

Returns

Filestack/Filelink

Errors/Exceptions

FilestackException: if API call fails, e.g 404 file not found

Test Coverage

Information

Coverage: / Lines (%)
Tests: 0
Passed: 0 (0%)