livekit::capture Namespace Reference

Capture sources and their configuration types. More...

Classes
struct	CaptureError
	Structured terminal pump failure reported by the Rust FFI. More...
struct	CaptureResolution
	Video resolution in pixels. More...
struct	CaptureResult
	Successful terminal statistics of a started capture. More...
class	CaptureSource
	A server-side capture source (livekit-capture) that produces video without per-frame FFI traffic. More...
struct	ClockVideoSourceConfig
	Wall clock with millisecond precision, rendered on the GPU. More...
struct	GstreamerRateControl
	Binding from WebRTC rate-control targets to a GStreamer encoder property. More...
struct	GstreamerVideoSourceConfig
	Configuration for encoded ingest from a GStreamer pipeline. More...
struct	PatternVideoSourceConfig
	Configuration for the built-in test source rendering a Pattern. More...

Enumerations
enum class	CaptureSourceKind { Pixel = 0 , Encoded = 1 }
	Kind of media a capture source produces. More...
enum class	GstreamerBitrateUnit { Bps = 0 , Kbps = 1 }
	Bitrate unit expected by a GStreamer encoder property. More...
enum class	Pattern { Gradient = 0 , Logo = 1 }
	Test pattern rendered by the built-in pattern source. More...
enum class	CaptureExit { Stopped = 0 , EndOfStream = 1 }
	Why a capture ended without error. More...
enum class	CaptureErrorKind { Source = 0 , Rtc = 1 , Panicked = 2 }
	Terminal pump failure category; matches the FFI CaptureErrorKind enum. More...

Detailed Description

Capture sources and their configuration types.

Enumeration Type Documentation

CaptureErrorKind

enum class livekit::capture::CaptureErrorKind

strong

Terminal pump failure category; matches the FFI CaptureErrorKind enum.

Enumerator
Source	The capture source failed or violated its contract.
Rtc	The RTC video source rejected a frame.
Panicked	The pump thread panicked.

CaptureExit

enum class livekit::capture::CaptureExit

strong

Why a capture ended without error.

Enumerator
Stopped	Stopped via CaptureSource::stop (or source destruction).
EndOfStream	The producer reached the end of its stream.

CaptureSourceKind

enum class livekit::capture::CaptureSourceKind

strong

Kind of media a capture source produces.

Enumerator
Pixel	Pixel frames, published through the WebRTC encoder.
Encoded	Pre-encoded access units, published as passthrough.

GstreamerBitrateUnit

enum class livekit::capture::GstreamerBitrateUnit

strong

Bitrate unit expected by a GStreamer encoder property.

Enumerator
Bps	Bits per second.
Kbps	Kilobits per second.

Pattern

enum class livekit::capture::Pattern

strong

Test pattern rendered by the built-in pattern source.

Enumerator
Gradient	Animated color gradient.
Logo	Bouncing LiveKit logo.