Service: Record

This API is officially released and maintained.

The record service allows streaming of recording data to a client. It requests and combines all the required recording data (metadata, raw, states, vtu, pcd) into one stream. A message in the stream consists of a file-path and the corresponding data. That means that one message represents one file in a recording archive.

Table 1. Available methods
Method	Request	Response
Stream	RecordStreamRequest	RecordStreamResponseStream

Stream

Get a stream of recording data.

Request

Request for getting a stream of record messages

Table 2. Available fields in blickfeld.toolkit.services.RecordStreamRequest
Field	Type	Default	Unit
point_cloud_type	optional percept_pipeline.data.PointCloudType	-	-
point_cloud_type	The type of point cloud to stream
disable_states	bool	-	-
disable_states	Reduce the amount of data by not recording states
disable_vtu_and_pcd	bool	-	-
disable_vtu_and_pcd	Reduce the amount of data by not recording vtu and pcd files

Response Stream

Response for getting a stream of record messages

Table 3. Available fields in blickfeld.toolkit.services.RecordStreamResponse
Field	Type	Default	Unit
file	data.File	-	-
file	File of a recording
data_loss	bool	-	-
data_loss	Indicates that the internal send buffer is full and drops data.