Skip to content

examples.rst

Latest commit

 

History

History
149 lines (92 loc) · 3.33 KB

examples.rst

File metadata and controls

149 lines (92 loc) · 3.33 KB

Examples

Basics

One screenshot per monitor:

for filename in sct.save():
    print(filename)

Screenshot of the monitor 1:

for filename in sct.save(mon=1):
    print(filename)

A screenshot to grab them all:

for filename in sct.save(mon=-1, output='fullscreen.png')):
    print(filename)

Callback

Screenshot of the monitor 1 with callback:

from os import rename
from os.path import isfile


def on_exists(fname):
    # type: (str) -> None
    ''' Callback example when we try to overwrite an existing screenshot. '''

    if isfile(fname):
        newfile = fname + '.old'
        print('{0} -> {1}'.format(fname, newfile))
        rename(fname, newfile)


for filename in sct.save(mon=1, callback=on_exists):
    print(filename)

Into the Python's console

Initialisation:

>>> from mss import mss
>>> sct = mss()

Retrieve monitors informations:

>>> displays = sct.enum_display_monitors()
>>> displays
[{'width': 1920, 'top': 0, 'height': 1080, 'left': 0}, {'width': 1920, 'top': 0, 'height': 1080, 'left': 0}]

You can access monitors list via monitors too:

>>> displays is sct.monitors
True

Retrieve pixels from the first monitor:

>>> pixels = sct.get_pixels(displays[1])
>>> type(pixels)
<class 'bytes'>

You can access pixels data via image too:

>>> pixels is sct.image
True

Save pixels to a PNG file, option 1:

>>> files = sct.save(mon=1)
>>> next(files)
'monitor-1.png'

Save pixels to a PNG file, option 2:

>>> sct.to_png(data=pixels, output='monitor-1.png')

GNU/Linux

On GNU/Linux, you can specify which display to use (useful for distant screenshots via SSH):

from mss.linux import MSS


display = ':0.0'
print('Screenshot of display "{0}"'.format(display))
output = 'monitor{0}-%d.png'.format(display)

with MSS(display=display) as sct:
    for filename in sct.save(output=output):
        print(filename)

Using PIL

You can use the Python Image Library (aka Pillow) to do whatever you want with raw pixels. This is an example using frombytes():

from mss import mss
from PIL import Image


with mss() as sct:
    # We retrieve monitors informations:
    monitors = sct.enum_display_monitors()

    # Get rid of the first, as it represents the "All in One" monitor:
    for num, monitor in enumerate(monitors[1:], 1):
        # Get raw pixels from the screen.
        # This method will store screen size into `width` and `height`
        # and raw pixels into `image`.
        sct.get_pixels(monitor)

        # Create an Image:
        img = Image.frombytes('RGB', (sct.width, sct.height), sct.image)

        # And save it!
        img.save('monitor-{0}.jpg'.format(num))

Part of the screen

You can capture only a part of the screen:

from mss import mss


with mss() as sct:
    # The screen part to capture
    mon = {'top': 160, 'left': 160, 'width': 222, 'height': 42}

    # Save the picture
    output = 'sct-{top}x{left}_{width}x{height}.png'.format(**mon)
    sct.to_png(sct.get_pixels(mon), output)