Documentation

WellKnownSchemaEncoding
in package

Well-known encoding for schema definition.

Mirrors the well-known schema encodings from the MCAP spec: https://mcap.dev/spec/registry#schema-encodings

Protobuf type livekit.DataTrackSchemaEncoding.WellKnownSchemaEncoding

Table of Contents

Constants

WELL_KNOWN_SCHEMA_ENCODING_FLATBUFFER  : mixed = 2
FlatBuffer IDL: describes `FLATBUFFER` frame encoding.
WELL_KNOWN_SCHEMA_ENCODING_JSON_SCHEMA  : mixed = 7
JSON Schema: describes `JSON` frame encoding.
WELL_KNOWN_SCHEMA_ENCODING_OMG_IDL  : mixed = 6
OMG IDL: describes `CDR` frame encoding.
WELL_KNOWN_SCHEMA_ENCODING_PROTOBUF  : mixed = 1
Protocol Buffer IDL: describes `PROTOBUF` frame encoding.
WELL_KNOWN_SCHEMA_ENCODING_ROS1_MSG  : mixed = 3
ROS 1 Message: describes `ROS1` frame encoding.
WELL_KNOWN_SCHEMA_ENCODING_ROS2_IDL  : mixed = 5
ROS 2 IDL: describes `CDR` frame encoding.
WELL_KNOWN_SCHEMA_ENCODING_ROS2_MSG  : mixed = 4
ROS 2 Message: describes `CDR` frame encoding.
WELL_KNOWN_SCHEMA_ENCODING_UNSPECIFIED  : mixed = 0
Generated from protobuf enum <code>WELL_KNOWN_SCHEMA_ENCODING_UNSPECIFIED = 0;</code>

Properties

$valueToName  : mixed

Methods

name()  : mixed
value()  : mixed

Constants

WELL_KNOWN_SCHEMA_ENCODING_FLATBUFFER

FlatBuffer IDL: describes `FLATBUFFER` frame encoding.

public mixed WELL_KNOWN_SCHEMA_ENCODING_FLATBUFFER = 2

Generated from protobuf enum WELL_KNOWN_SCHEMA_ENCODING_FLATBUFFER = 2;

WELL_KNOWN_SCHEMA_ENCODING_JSON_SCHEMA

JSON Schema: describes `JSON` frame encoding.

public mixed WELL_KNOWN_SCHEMA_ENCODING_JSON_SCHEMA = 7

Generated from protobuf enum WELL_KNOWN_SCHEMA_ENCODING_JSON_SCHEMA = 7;

WELL_KNOWN_SCHEMA_ENCODING_OMG_IDL

OMG IDL: describes `CDR` frame encoding.

public mixed WELL_KNOWN_SCHEMA_ENCODING_OMG_IDL = 6

Generated from protobuf enum WELL_KNOWN_SCHEMA_ENCODING_OMG_IDL = 6;

WELL_KNOWN_SCHEMA_ENCODING_PROTOBUF

Protocol Buffer IDL: describes `PROTOBUF` frame encoding.

public mixed WELL_KNOWN_SCHEMA_ENCODING_PROTOBUF = 1

Generated from protobuf enum WELL_KNOWN_SCHEMA_ENCODING_PROTOBUF = 1;

WELL_KNOWN_SCHEMA_ENCODING_ROS1_MSG

ROS 1 Message: describes `ROS1` frame encoding.

public mixed WELL_KNOWN_SCHEMA_ENCODING_ROS1_MSG = 3

Generated from protobuf enum WELL_KNOWN_SCHEMA_ENCODING_ROS1_MSG = 3;

WELL_KNOWN_SCHEMA_ENCODING_ROS2_IDL

ROS 2 IDL: describes `CDR` frame encoding.

public mixed WELL_KNOWN_SCHEMA_ENCODING_ROS2_IDL = 5

Generated from protobuf enum WELL_KNOWN_SCHEMA_ENCODING_ROS2_IDL = 5;

WELL_KNOWN_SCHEMA_ENCODING_ROS2_MSG

ROS 2 Message: describes `CDR` frame encoding.

public mixed WELL_KNOWN_SCHEMA_ENCODING_ROS2_MSG = 4

Generated from protobuf enum WELL_KNOWN_SCHEMA_ENCODING_ROS2_MSG = 4;

WELL_KNOWN_SCHEMA_ENCODING_UNSPECIFIED

Generated from protobuf enum <code>WELL_KNOWN_SCHEMA_ENCODING_UNSPECIFIED = 0;</code>

public mixed WELL_KNOWN_SCHEMA_ENCODING_UNSPECIFIED = 0

Properties

$valueToName

private static mixed $valueToName = [self::WELL_KNOWN_SCHEMA_ENCODING_UNSPECIFIED => 'WELL_KNOWN_SCHEMA_ENCODING_UNSPECIFIED', self::WELL_KNOWN_SCHEMA_ENCODING_PROTOBUF => 'WELL_KNOWN_SCHEMA_ENCODING_PROTOBUF', self::WELL_KNOWN_SCHEMA_ENCODING_FLATBUFFER => 'WELL_KNOWN_SCHEMA_ENCODING_FLATBUFFER', self::WELL_KNOWN_SCHEMA_ENCODING_ROS1_MSG => 'WELL_KNOWN_SCHEMA_ENCODING_ROS1_MSG', self::WELL_KNOWN_SCHEMA_ENCODING_ROS2_MSG => 'WELL_KNOWN_SCHEMA_ENCODING_ROS2_MSG', self::WELL_KNOWN_SCHEMA_ENCODING_ROS2_IDL => 'WELL_KNOWN_SCHEMA_ENCODING_ROS2_IDL', self::WELL_KNOWN_SCHEMA_ENCODING_OMG_IDL => 'WELL_KNOWN_SCHEMA_ENCODING_OMG_IDL', self::WELL_KNOWN_SCHEMA_ENCODING_JSON_SCHEMA => 'WELL_KNOWN_SCHEMA_ENCODING_JSON_SCHEMA']

Methods

On this page

Search results