Skip to main content

Metadata

Episode-level session metadata is published on a single topic. The message carries capture devices and equipment types, global time range, task/scene identifiers, parent/child episode identifiers, operator information, and the conversion batch version when available.

Topic & Message Type​

  • Topic: /session/metadata
  • Message type: session.SessionMetadata
  • Encoding: protobuf

Defined in session/metadata.proto; SessionMetadata includes common.header.Header.

Message definition (metadata, one message per session):

syntax = "proto3";

package session;

import "common/header.proto";

message Resolution {
uint32 height = 1;
uint32 width = 2;
}

message CaptureDevice {
string device_type = 1;
string firmware_version = 2;
string fps = 3;
string modality = 4;
Resolution resolution = 5;
int64 unix_start_time = 6;
int64 unix_end_time = 7;
}

message GlobalTime {
string start_time_iso = 1;
string end_time_iso = 2;
string timezone = 3;
}

message TaskInfo {
string task_id = 1;
string task_name = 2;
string task_description = 3;
string episode_uuid = 4;
string environment_id = 5;
string scene_id = 6;
string parent_episode_uuid = 7;
int32 child_episode_index = 8;
}

message OperatorInfo {
double arm_span = 1;
double height = 2;
double leg_length = 3;
string unit = 4;
}

message Operator {
string operator_id = 1;
OperatorInfo operator_info = 2;
}

// Equipment used for capture, keyed by body position.
message CaptureEquipmentTypes {
string head = 1;
string wrist = 2;
string hand = 3;
}

// Main message for topic /session/metadata
message SessionMetadata {
common.header.Header header = 1;
string batch_version = 2;
repeated CaptureDevice devices = 3;
CaptureEquipmentTypes capture_equipment_types = 4;
GlobalTime global_time = 5;
TaskInfo task_info = 6;
Operator operator = 7;
}