Skip to main content

Formatters

caution

Formatters are deprecated and planned for removal in the short future.

The original purpose of formatters was to automatically re-format the output metadata json to optimize for size and reduce bandwidth usage. However, this was not a scalable and flexible design; instead Nimble will support metadata json compression using common compression algorithms (deflate, brotli, xz).

There are different metadata formats that can be selected when subscribing to the Channel Metadata WebSocket:

  • megh: Optimized for JSON size. All keys use camelCase (lowercase first letter). Floating point numbers are rounded to reasonable precision. Tuples are preferred for common data structures (such as bounding boxes).
  • aws: Based on AWS Rekognition.
  • pass: Passes through JSON untouched.