Skip to main content

"nimble" Source

Connects to and receives channel metadata from a remote Nimble instance and injects it into this Nimble instance.

This source enables the "Distributed Nimble" feature by allowing separate Nimble instances to be "stitched" together and support processing and filtering data in different physical locations.

If the source fails to connect or is disconnected from the remote Nimble instance, the source will try to reconnect indefinitely.

Along with the required source parameter type, the nimble source accepts the following additional parameters:

  • address: The hostname (and optional port, default 6344) to access a remote Nimble instance.
  • channel: The ID of the remote Channel to pull metadata from.
  • image: The method for generating the RGB image associated with the metadata. Valid options are:
    • embedded: Decode and use the embedded jpeg image. If the jpeg is missing (image-encoder omitted), then no image will be available to any pipelines that are attached to this source.
  • proxy: If the Channel has an associated Stream, then setting this to true will cause Nimble to create a local Stream and proxy the remote Stream. This should be set to true for edge deployments to avoid sending MP4 data multiple times over slow/low bandwidth edge-to-cloud connection. Optional.
  • base_path: Provide an alternative base path to access the Nimble API. Optional.

Examples​

REST API​

Create Source:

{
    "type": "nimble",
    "address": "nimble-edge:6344",
    "channel": 0,
    "image": "embedded"
}

Configuration File​

Distributed Nimble:

sources:
- type: nimble
  address: nimble-edge:6344
  channel: 0
  image: embedded