session_capture_config_t Struct Reference

Configuration for session capture context. More...

#include <src/common/session/capture.h>

Data Fields
media_source_type_t	type
	Media source type (WEBCAM, FILE, STDIN, TEST)
const char *	path
	Device index (for webcam) or file path (for file sources)
uint32_t	target_fps
	Target frame rate in FPS (e.g., 60 for display, 144 for network)
bool	loop
	Enable loop playback for file sources.
bool	resize_for_network
	Resize frames to network-optimal dimensions (MAX_FRAME_WIDTH x MAX_FRAME_HEIGHT)
bool	enable_audio
	Enable audio capture from media source.
bool	audio_fallback_to_mic
	Fall back to microphone if file audio is not available.
void *	mic_audio_ctx
	Microphone audio context for fallback (borrowed, not owned)
double	initial_seek_timestamp
	Seek to this timestamp after opening media (0.0 = no seek)
session_capture_should_exit_fn	should_exit_callback
	Optional: callback to check if initialization should be cancelled (e.g., shutdown signal)
void *	callback_data
	Opaque data passed to should_exit_callback.

Detailed Description

Configuration for session capture context.

Specifies the media source type, path, and capture parameters.

Definition at line 80 of file common/session/capture.h.

Field Documentation

audio_fallback_to_mic

bool session_capture_config_t::audio_fallback_to_mic

Fall back to microphone if file audio is not available.

Definition at line 100 of file common/session/capture.h.

Referenced by capture_init(), and session_capture_create().

callback_data

void* session_capture_config_t::callback_data

Opaque data passed to should_exit_callback.

Definition at line 112 of file common/session/capture.h.

Referenced by display_init(), session_capture_create(), and session_client_like_run().

enable_audio

bool session_capture_config_t::enable_audio

Enable audio capture from media source.

Definition at line 97 of file common/session/capture.h.

Referenced by capture_init(), session_capture_create(), and session_client_like_run().

initial_seek_timestamp

double session_capture_config_t::initial_seek_timestamp

Seek to this timestamp after opening media (0.0 = no seek)

Definition at line 106 of file common/session/capture.h.

Referenced by capture_init(), display_init(), session_capture_create(), and session_client_like_run().

loop

bool session_capture_config_t::loop

Enable loop playback for file sources.

Definition at line 91 of file common/session/capture.h.

Referenced by capture_init(), display_init(), session_capture_create(), session_client_like_run(), and session_participant_start_video_capture().

mic_audio_ctx

void* session_capture_config_t::mic_audio_ctx

Microphone audio context for fallback (borrowed, not owned)

Definition at line 103 of file common/session/capture.h.

Referenced by capture_init(), and session_capture_create().

path

const char* session_capture_config_t::path

Device index (for webcam) or file path (for file sources)

Definition at line 85 of file common/session/capture.h.

Referenced by capture_init(), display_init(), session_capture_create(), session_client_like_run(), and session_participant_start_video_capture().

resize_for_network

bool session_capture_config_t::resize_for_network

Resize frames to network-optimal dimensions (MAX_FRAME_WIDTH x MAX_FRAME_HEIGHT)

Definition at line 94 of file common/session/capture.h.

Referenced by capture_init(), display_init(), session_capture_create(), and session_client_like_run().

should_exit_callback

session_capture_should_exit_fn session_capture_config_t::should_exit_callback

Optional: callback to check if initialization should be cancelled (e.g., shutdown signal)

Definition at line 109 of file common/session/capture.h.

Referenced by display_init(), session_capture_create(), and session_client_like_run().

target_fps

uint32_t session_capture_config_t::target_fps

Target frame rate in FPS (e.g., 60 for display, 144 for network)

Definition at line 88 of file common/session/capture.h.

Referenced by capture_init(), display_init(), session_capture_create(), and session_client_like_run().

type

media_source_type_t session_capture_config_t::type

Media source type (WEBCAM, FILE, STDIN, TEST)

Definition at line 82 of file common/session/capture.h.

Referenced by capture_init(), display_init(), session_capture_create(), session_client_like_run(), and session_participant_start_video_capture().

---

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

• common/session/capture.h