get_image

Client.get_image(frame_type: FrameType | str = FrameType.SUMTOTAL, pixel_format: PixelFormat | str = PixelFormat.AUTO, attributes: Attributes | str = 'auto', file_name: str = None, text_size: int = 0)

Get a single image and save it to disk if a file name is provided

Parameters:

• frame_type (FrameType or str, optional) – The frame type of the image, by default FrameType.SUMTOTAL

• pixel_format (PixelFormat, optional) – The pixel format of the image, by default PixelFormat.AUTO

• file_name (str, optional) – The file name to save the image, by default None

• attributes (Attributes or "auto", optional) – The attributes of the image, by default “auto”

• text_size (int, optional) – The text size, by default 0