Skip to main content

ClikaRT::processor::VideoProcessorConfig

class

Header: ClikaRT/processor/config.h

Settable configuration for a VideoProcessor: the per-frame ImageProcessorConfig plus temporal sampling (num_frames / fps). Move-only.

Static member functions​

from_json()​

static VideoProcessorConfig from_json(std::string_view text)

Parse from preprocessor_config.json text, with the schema semantics of ImageProcessorConfig::from_json.

Throws

  • ClikaRT::Error: on malformed text.

Declared in ClikaRT/processor/config.h, line 330

Member functions​

VideoProcessorConfig()​

VideoProcessorConfig()

defaults: default per-frame image config, keep-all sampling

Declared in ClikaRT/processor/config.h, line 320

VideoProcessorConfig(VideoProcessorConfig)​

VideoProcessorConfig(VideoProcessorConfig&&) noexcept

move-construct (the source becomes an empty shell)

Declared in ClikaRT/processor/config.h, line 321

operator=(VideoProcessorConfig)​

VideoProcessorConfig& operator=(VideoProcessorConfig&&) noexcept

move-assign

Declared in ClikaRT/processor/config.h, line 322

VideoProcessorConfig(VideoProcessorConfig)​

VideoProcessorConfig(const VideoProcessorConfig&)

copy-construct: a deep copy

Declared in ClikaRT/processor/config.h, line 323

operator=(VideoProcessorConfig)​

VideoProcessorConfig& operator=(const VideoProcessorConfig&)

copy-assign: a deep copy

Declared in ClikaRT/processor/config.h, line 324

~VideoProcessorConfig()​

~VideoProcessorConfig()

destructor

Declared in ClikaRT/processor/config.h, line 325

to_json()​

std::string to_json(int indent = 2) const

canonical json text (indent < 0 compact); round-trips through from_json; infallible

Declared in ClikaRT/processor/config.h, line 333

image()​

ImageProcessorConfig image() const

The per-frame image pipeline config (a copy; set it back with set_image).

Declared in ClikaRT/processor/config.h, line 336

set_image()​

VideoProcessorConfig& set_image(const ImageProcessorConfig& image)

replace the per-frame image pipeline config

Declared in ClikaRT/processor/config.h, line 337

set_num_frames()​

VideoProcessorConfig& set_num_frames(std::int64_t n)

Uniformly sample this many frames (0 = keep all / use fps).

Declared in ClikaRT/processor/config.h, line 339

set_fps()​

VideoProcessorConfig& set_fps(double fps)

Resample to this fps (0 = use num_frames; needs clip metadata).

Declared in ClikaRT/processor/config.h, line 341

num_frames()​

std::int64_t num_frames() const

frames sampled uniformly (default 0 = keep all / use fps)

Declared in ClikaRT/processor/config.h, line 343

fps()​

double fps() const

target fps (default 0 = use num_frames)

Declared in ClikaRT/processor/config.h, line 344