Documentation

WellKnownFrameEncoding
in package

Well-known encoding for frame payloads.

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

Protobuf type livekit.DataTrackFrameEncoding.WellKnownFrameEncoding

Table of Contents

Constants

WELL_KNOWN_FRAME_ENCODING_CBOR  : mixed = 5
CBOR: self-describing.
WELL_KNOWN_FRAME_ENCODING_CDR  : mixed = 2
CDR: must be described by `ROS2_MSG`, `ROS2_IDL`, or `OMG_IDL` schema encoding.
WELL_KNOWN_FRAME_ENCODING_FLATBUFFER  : mixed = 4
FlatBuffer: must be described by `FLATBUFFER` schema encoding.
WELL_KNOWN_FRAME_ENCODING_JSON  : mixed = 7
JSON: self-describing or described by `JSON_SCHEMA` schema encoding.
WELL_KNOWN_FRAME_ENCODING_MSGPACK  : mixed = 6
MessagePack: self-describing.
WELL_KNOWN_FRAME_ENCODING_PROTOBUF  : mixed = 3
Protocol Buffer: must be described by `PROTOBUF` schema encoding.
WELL_KNOWN_FRAME_ENCODING_ROS1  : mixed = 1
ROS 1: must be described by `ROS1_MSG` schema encoding.
WELL_KNOWN_FRAME_ENCODING_UNSPECIFIED  : mixed = 0
Generated from protobuf enum <code>WELL_KNOWN_FRAME_ENCODING_UNSPECIFIED = 0;</code>

Properties

$valueToName  : mixed

Methods

name()  : mixed
value()  : mixed

Constants

WELL_KNOWN_FRAME_ENCODING_CBOR

CBOR: self-describing.

public mixed WELL_KNOWN_FRAME_ENCODING_CBOR = 5

Generated from protobuf enum WELL_KNOWN_FRAME_ENCODING_CBOR = 5;

WELL_KNOWN_FRAME_ENCODING_CDR

CDR: must be described by `ROS2_MSG`, `ROS2_IDL`, or `OMG_IDL` schema encoding.

public mixed WELL_KNOWN_FRAME_ENCODING_CDR = 2

Generated from protobuf enum WELL_KNOWN_FRAME_ENCODING_CDR = 2;

WELL_KNOWN_FRAME_ENCODING_FLATBUFFER

FlatBuffer: must be described by `FLATBUFFER` schema encoding.

public mixed WELL_KNOWN_FRAME_ENCODING_FLATBUFFER = 4

Generated from protobuf enum WELL_KNOWN_FRAME_ENCODING_FLATBUFFER = 4;

WELL_KNOWN_FRAME_ENCODING_JSON

JSON: self-describing or described by `JSON_SCHEMA` schema encoding.

public mixed WELL_KNOWN_FRAME_ENCODING_JSON = 7

Generated from protobuf enum WELL_KNOWN_FRAME_ENCODING_JSON = 7;

WELL_KNOWN_FRAME_ENCODING_MSGPACK

MessagePack: self-describing.

public mixed WELL_KNOWN_FRAME_ENCODING_MSGPACK = 6

Generated from protobuf enum WELL_KNOWN_FRAME_ENCODING_MSGPACK = 6;

WELL_KNOWN_FRAME_ENCODING_PROTOBUF

Protocol Buffer: must be described by `PROTOBUF` schema encoding.

public mixed WELL_KNOWN_FRAME_ENCODING_PROTOBUF = 3

Generated from protobuf enum WELL_KNOWN_FRAME_ENCODING_PROTOBUF = 3;

WELL_KNOWN_FRAME_ENCODING_ROS1

ROS 1: must be described by `ROS1_MSG` schema encoding.

public mixed WELL_KNOWN_FRAME_ENCODING_ROS1 = 1

Generated from protobuf enum WELL_KNOWN_FRAME_ENCODING_ROS1 = 1;

WELL_KNOWN_FRAME_ENCODING_UNSPECIFIED

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

public mixed WELL_KNOWN_FRAME_ENCODING_UNSPECIFIED = 0

Properties

$valueToName

private static mixed $valueToName = [self::WELL_KNOWN_FRAME_ENCODING_UNSPECIFIED => 'WELL_KNOWN_FRAME_ENCODING_UNSPECIFIED', self::WELL_KNOWN_FRAME_ENCODING_ROS1 => 'WELL_KNOWN_FRAME_ENCODING_ROS1', self::WELL_KNOWN_FRAME_ENCODING_CDR => 'WELL_KNOWN_FRAME_ENCODING_CDR', self::WELL_KNOWN_FRAME_ENCODING_PROTOBUF => 'WELL_KNOWN_FRAME_ENCODING_PROTOBUF', self::WELL_KNOWN_FRAME_ENCODING_FLATBUFFER => 'WELL_KNOWN_FRAME_ENCODING_FLATBUFFER', self::WELL_KNOWN_FRAME_ENCODING_CBOR => 'WELL_KNOWN_FRAME_ENCODING_CBOR', self::WELL_KNOWN_FRAME_ENCODING_MSGPACK => 'WELL_KNOWN_FRAME_ENCODING_MSGPACK', self::WELL_KNOWN_FRAME_ENCODING_JSON => 'WELL_KNOWN_FRAME_ENCODING_JSON']

Methods

On this page

Search results