SamplingOptions Class

Defines how often media is submitted to the extension plugin.

Inheritance

Model

SamplingOptions

Constructor

SamplingOptions(*, skip_samples_without_annotation: Optional[str] = None, maximum_samples_per_second: Optional[str] = None, **kwargs)

Variables

skip_samples_without_annotation

str

When set to 'true', prevents frames without upstream inference data to be sent to the extension plugin. This is useful to limit the frames sent to the extension to pre-analyzed frames only. For example, when used downstream from a motion detector, this can enable for only frames in which motion has been detected to be further analyzed.

maximum_samples_per_second

str

Maximum rate of samples submitted to the extension. This prevents an extension plugin to be overloaded with data.