Skip to main content


Sink elements take data from the pipeline and push it out, they contain two mandatory and one optional fields: address, filter and type

type: "file"         # string: "file", "embedding", "zmq"
address: "video.mp4" # string: url or path, depending on 'type' property
filter: "*" # string, integer, or array of integers: source(s) to filter on (by zero-based index) (optional: default "*")
  • address is a url to either a zmq socket, video file or directory.
  • filter filtering can be performed on the input source, it can either be * to denote no filtering, an integer or a list of integers of the source you want to filter on. In configuration files sources are implicitly indexed top-to-bottom starting from index 0.
  • type is source type, there are 3 different types:
    • file : stream out to file.
    • zmq : publish output stream on a ZMQ socket.
    • embedding : creates and embedding database for further annotation by the user.

The WebSocket endpoint is always enabled for all channels and does not need to be explicitly specified as a sink. The WebSocket is the recommended way to consume metadata from Nimble.