Class BackgroundSegmentationMetrics

Metrics collection for background segmentation processing. Collects one-time processor creation metrics and periodic CDN processor metrics.

Index

Constructors

Methods

emitInitializationMetrics reportAssetLoadingResult reportCompatibilityCheck reportProcessorError reportProcessorMetrics setMetricsCollector

Constructors

constructor

new BackgroundSegmentationMetrics(
logger: Logger,
metricsCollector?: BackgroundSegmentationMetricsObserver,
): BackgroundSegmentationMetrics
Parameters
- logger: Logger
- OptionalmetricsCollector: BackgroundSegmentationMetricsObserver
Returns BackgroundSegmentationMetrics
- Defined in src/backgroundsegmentation/BackgroundSegmentationMetrics.ts:61

Methods

emitInitializationMetrics

emitInitializationMetrics(): void
Returns void
- Defined in src/backgroundsegmentation/BackgroundSegmentationMetrics.ts:113

reportAssetLoadingResult

reportAssetLoadingResult(error?: string, loadTimeMs?: number): void
Parameters
- Optionalerror: string
- OptionalloadTimeMs: number
Returns void
- Defined in src/backgroundsegmentation/BackgroundSegmentationMetrics.ts:96

reportCompatibilityCheck

reportCompatibilityCheck(isCompatible: boolean): void
Parameters
- isCompatible: boolean
Returns void
- Defined in src/backgroundsegmentation/BackgroundSegmentationMetrics.ts:90

reportProcessorError

reportProcessorError(): void
Returns void
- Defined in src/backgroundsegmentation/BackgroundSegmentationMetrics.ts:106

reportProcessorMetrics

reportProcessorMetrics(metric: BackgroundSegmentationProcessorMetrics): void
Parameters
- metric: BackgroundSegmentationProcessorMetrics
Returns void
- Defined in src/backgroundsegmentation/BackgroundSegmentationMetrics.ts:122

setMetricsCollector

setMetricsCollector(
metricsCollector: BackgroundSegmentationMetricsObserver,
): void
Update the metrics collector and flush any buffered metrics
Parameters
- metricsCollector: BackgroundSegmentationMetricsObserver
Returns void
- Defined in src/backgroundsegmentation/BackgroundSegmentationMetrics.ts:71