Skip to content

Skimmer

Skimmer crops a region out of a source image, or a video frame at a given millisecond offset. Unlike the other five services it has no OpenAPI spec, so SkimmerClient (vars_client.skimmer) wraps its query-parameter contract directly rather than going through Kiota. It's unauthenticated and GET-only, so there's no RequestAdapter involved — just a URL builder.

from vars_client.skimmer import SkimmerClient

skimmer = SkimmerClient("https://skimmer.example.org")

Cropping an image

url = skimmer.build_crop_url(
    "https://archive.example.org/images/4046/00_50_38_15.png",
    left=599, top=111, right=732, bottom=495,
)

Cropping a video frame

Pass ms, the millisecond offset into the video to extract the frame from before cropping:

url = skimmer.build_crop_url(
    "https://video.example.org/mezzanine/D1382_20210823T222016Z_h264.mp4",
    left=1255, top=30, right=1351, bottom=136,
    ms=490023,
)

build_crop_url returns a plain URL string — fetch it with whatever HTTP client suits your use case; SkimmerClient doesn't perform the request itself.

Via VARSClient

If your ConfigProvider returns an endpoint named "skimmer", VARSClient.connect() populates client.skimmer automatically.