livekit::DataTrackFrame Struct Reference

A single frame of data published or received on a data track. More...

#include <data_track_frame.h>

Public Member Functions
	DataTrackFrame (const DataTrackFrame &)=default
	DataTrackFrame (DataTrackFrame &&) noexcept=default
DataTrackFrame &	operator= (const DataTrackFrame &)=default
DataTrackFrame &	operator= (DataTrackFrame &&) noexcept=default
	DataTrackFrame (std::vector< std::uint8_t > &&p, std::optional< std::uint64_t > ts=std::nullopt) noexcept

Static Public Member Functions
static LIVEKIT_API DataTrackFrame	fromOwnedInfo (const proto::DataTrackFrame &owned)
	This is a private method used by the SDK to create a DataTrackFrame from a proto::DataTrackFrame.

Public Attributes
std::vector< std::uint8_t >	payload
	Arbitrary binary payload (the frame contents).
std::optional< std::uint64_t >	user_timestamp
	Optional application-defined timestamp.

Detailed Description

A single frame of data published or received on a data track.

Carries an arbitrary binary payload and an optional user-specified timestamp. The unit is application-defined; the SDK examples use microseconds since the Unix epoch (system_clock).

Member Function Documentation

fromOwnedInfo()

static LIVEKIT_API DataTrackFrame livekit::DataTrackFrame::fromOwnedInfo ( const proto::DataTrackFrame &  owned )

static

This is a private method used by the SDK to create a DataTrackFrame from a proto::DataTrackFrame.

Parameters

owned

The proto::DataTrackFrame to create a DataTrackFrame from.

Returns

The created DataTrackFrame.

Member Data Documentation

user_timestamp

std::optional<std::uint64_t> livekit::DataTrackFrame::user_timestamp

Optional application-defined timestamp.

The proto field is a bare uint64 with no prescribed unit. By convention the SDK examples use microseconds since the Unix epoch.

---

The documentation for this struct was generated from the following file:

• include/livekit/data_track_frame.h