Skip to content

TypeScript SDK Reference / RealtimeEstimationConfig

Interface: RealtimeEstimationConfig

Configuration options for realtime estimation.

Properties

debug?

optional debug: boolean

Whether to enable debug logging for realtime estimation.


estimatorType?

optional estimatorType: RealtimeEstimatorType

Type of estimator to use.


hrPath?

optional hrPath: string

ME-rPPG specific: Path to HR extraction model (only used if estimatorType is MeRppg)


lambda?

optional lambda: number

ME-rPPG specific: Lambda parameter for temporal normalization (only used if estimatorType is MeRppg)


minSamples?

optional minSamples: number

Minimum number of RGB samples required before producing an HR estimate. Default: 30.


modelPath?

optional modelPath: string

ME-rPPG specific: Path to main model (only used if estimatorType is MeRppg)


scanDuration?

optional scanDuration: number

Total configured scan duration in seconds. Default: 25.


signalQualityDelay?

optional signalQualityDelay: number

Minimum seconds of signal before computing quality metrics. Panoptic default: 5, MeRppg default: 3.


statePath?

optional statePath: string

ME-rPPG specific: Path to initial state (only used if estimatorType is MeRppg)


visualSignalType?

optional visualSignalType: VisualSignalType

Type of visual signal for the visualization pipeline. Panoptic estimator only. Use Raw for unfiltered PPG or Normalized for bandpass-filtered signal. Default: Normalized.


welchPath?

optional welchPath: string

ME-rPPG specific: Path to Welch PSD model (only used if estimatorType is MeRppg)