Skip to main content

Remote Screenshot API

  • Description

    GET /snapshot?ext=[extension]&compress=[ratio]&orient=[orientation]&zoom=[scale]&left=[left]&top=[top]&right=[right]&bottom=[bottom] HTTP/1.1
  • Possible Responses

    Image bytes

  • Notes

    • [extension] can be png or jpg
    • [ratio] range 0~1; if less than 1, jpg format is used automatically
    • [orientation] range 0~3:
      • 0 portrait, home at bottom
      • 1 landscape, home at right
      • 2 landscape, home at left
      • 3 portrait, home at top
    • [scale] range 0~3; default 1; available since 1.0.7-1
    • [left], [top], [right], [bottom] define a capture region; invalid region means full screen; available since 1.0.7-1