BeholderClient reference¶
Generated from specs/beholder.yaml, cross-referenced against vars_client.generated.beholder. Regenerate with just docs-generate after just generate picks up spec changes -- do not hand-edit this file.
See also: data models.
capture¶
Frame capture from a video¶
POST /capture
Capture a frame from a video at a given elapsed time or pull it from the cache if it exists. Include imageType (either jpg or png) in the request body to select the format; defaults to "jpg".
# body: CaptureRequest
from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.beholder.capture.capture_request_builder import CaptureRequestBuilder
request_configuration = RequestConfiguration(query_parameters=CaptureRequestBuilder.CaptureRequestBuilderPostQueryParameters(accurate=..., nokey=...))
result = await client.beholder.capture.post(body, request_configuration)
Query parameters:
accurate:Optional[bool]nokey:Optional[bool]
Returns: Optional[bytes]
Errors: 401 Unauthorized · 404 NotFound
Frame capture as JPEG from a video¶
POST /capture/jpg
Capture a JPEG frame from a video at a given elapsed time or pull it from the cache if it exists
# body: CaptureRequest
from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.beholder.capture.jpg.jpg_request_builder import JpgRequestBuilder
request_configuration = RequestConfiguration(query_parameters=JpgRequestBuilder.JpgRequestBuilderPostQueryParameters(accurate=..., nokey=...))
result = await client.beholder.capture.jpg.post(body, request_configuration)
Query parameters:
accurate:Optional[bool]nokey:Optional[bool]
Returns: Optional[bytes]
Errors: 401 Unauthorized · 404 NotFound
Frame capture as PNG from a video¶
POST /capture/png
Capture a PNG frame from a video at a given elapsed time or pull it from the cache if it exists
# body: CaptureRequest
from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.beholder.capture.png.png_request_builder import PngRequestBuilder
request_configuration = RequestConfiguration(query_parameters=PngRequestBuilder.PngRequestBuilderPostQueryParameters(accurate=..., nokey=...))
result = await client.beholder.capture.png.post(body, request_configuration)
Query parameters:
accurate:Optional[bool]nokey:Optional[bool]
Returns: Optional[bytes]
Errors: 401 Unauthorized · 404 NotFound
health¶
Get the health status of the server¶
GET /health
Returns: Optional[HealthStatus]
Errors: 401 Unauthorized · 404 NotFound