Service: Objects

This API is officially released and maintained.

An RPC service to request a stream of objects messages. If a pipeline is already running, it will be used to stream the data. If no pipeline is running, it will be started first and then the stream will start. NOTE: in this second case, the pipeline will also be automatically stopped once there are no more clients requesting any stream type from the module.

Table 1. Available methods
Method	Request	Response
Stream	ObjectsStreamRequest	ObjectsStreamResponseStream

Stream

A method to get a stream of objects messages from the pipeline

Request

Request message for objects stream

Table 2. Available fields in blickfeld.percept_processing.services.ObjectsStreamRequest
Field	Type	Default	Unit
untracked	optional bool	-	-
untracked	Fetch object list without tracking

Response Stream

A response for getting a stream of objects messages from the running pipeline

Table 3. Available fields in blickfeld.percept_processing.services.ObjectsStreamResponse
Field	Type	Default	Unit
objects	data.Objects	-	-
objects	The current objects detected in the scene.