WAwandelbotsgmbh
Periphery (Camera)

Capture Color Image

Changed on

Retrieves the raw RGB color image from the camera's point of view.

  • Returns the frame as PNG (lossless, the default) or as jpeg, which is a fraction of the size when the camera is polled rather than sampled once.
  • There is no json form: a colour frame as an array of pixels would be megabytes with nothing to read it.
get/periphery/cameras/capture/color

Request

Query parameters

result_type'rgb_png' | 'jpeg'

Image format the frame is returned in.

camera_prim_pathstring nullable

Path of camera prim. Leave it out to capture through the active viewport camera.

widthinteger

Image width in px

heightinteger

Image height in px

Response

Successfully fetched color image from camera

Changes

  • f4e4cbd85f5bRevision changes
    • info

      added the new optional query request parameter result_type

    • info

      the query request parameter camera_prim_path became optional

    • info

      query request parameter camera_prim_path list-of-types was widened by adding types null

    • info

      for the query request parameter camera_prim_path, the type was generalized from string to no type

    • info

      added the media type image/jpeg for the response with the status