livekit::TrackPublishOptions Struct Reference

Options for publishing a track to the room. More...

#include <room_event_types.h>

Collaboration diagram for livekit::TrackPublishOptions:

Public Attributes
std::optional< VideoEncodingOptions >	video_encoding
	Optional video encoding parameters.
std::optional< AudioEncodingOptions >	audio_encoding
	Optional audio encoding parameters.
std::optional< VideoCodec >	video_codec
	Optional video codec to use.
std::optional< bool >	dtx
	Enable or disable discontinuous transmission (DTX).
std::optional< bool >	red
	Enable or disable RED (redundant encoding).
std::optional< bool >	simulcast
	Enable or disable simulcast.
std::optional< TrackSource >	source
	Track source (camera, microphone, screen share, etc.).
std::optional< std::string >	stream
	Optional stream label/group for this track.
std::optional< bool >	preconnect_buffer
	Enable pre-connect buffering for lower startup latency.
std::optional< FrameMetadataFeatures >	frame_metadata_features
	Optional frame metadata features to enable for published video.
FrameMetadataFeatures	packet_trailer_features {}
std::optional< DegradationPreference >	degradation_preference
	Controls how the encoder trades off between resolution and framerate when bandwidth is constrained.
std::optional< VideoEncoderBackend >	video_encoder
	Optional video encoder backend.

Detailed Description

Options for publishing a track to the room.

Member Data Documentation

degradation_preference

std::optional<DegradationPreference> livekit::TrackPublishOptions::degradation_preference

Controls how the encoder trades off between resolution and framerate when bandwidth is constrained.

If not set, the server defaults apply.

packet_trailer_features

FrameMetadataFeatures livekit::TrackPublishOptions::packet_trailer_features {}

Deprecated:

Use frame_metadata_features instead.

video_encoder

std::optional<VideoEncoderBackend> livekit::TrackPublishOptions::video_encoder

Optional video encoder backend.

Pre-encoded sources must select VideoEncoderBackend::PreEncoded.

---

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

• include/livekit/room_event_types.h