Skip to main content

CompressedVideo

A single frame of a compressed video bitstream

Schema

fieldtypedescription
timestamptimeTimestamp of video frame
frame_idstringFrame of reference for the video.
databytesCompressed video frame data.
formatstringVideo format.

frame_id

The origin of the frame is the optical center of the camera. +x points to the right in the video, +y points down, and +z points into the plane of the video.

data

For packet-based video codecs this data must begin and end on packet boundaries (no partial packets), and must contain enough video packets to decode exactly one image (either a keyframe or delta frame). Note: Foxglove does not support video streams that include B frames because they require lookahead.

format

Supported values: h264 (Annex B formatted data only)

Reference implementations

Foxglove schemas are framework-agnostic, and can be implemented using any supported message encoding:

encodingschema
ROS 1foxglove_msgs/CompressedVideo
ROS 2foxglove_msgs/msg/CompressedVideo
JSONfoxglove.CompressedVideo
Protobuffoxglove.CompressedVideo
FlatBuffersfoxglove.CompressedVideo
OMG IDLfoxglove::CompressedVideo

You must use the schema names specified above for Foxglove to recognize the schema.