Package com.azure.media.videoanalyzer.edge.models

Class SamplingOptions

java.lang.Object

com.azure.media.videoanalyzer.edge.models.SamplingOptions

public final class SamplingOptions
extends Object

Defines how often media is submitted to the extension plugin.

Constructor Summary

Constructors

Constructor	Description
SamplingOptions()

Method Summary

Modifier and Type	Method	Description
String	getMaximumSamplesPerSecond()	Get the maximumSamplesPerSecond property: Maximum rate of samples submitted to the extension.
String	getSkipSamplesWithoutAnnotation()	Get the skipSamplesWithoutAnnotation property: When set to 'true', prevents frames without upstream inference data to be sent to the extension plugin.
SamplingOptions	setMaximumSamplesPerSecond(String maximumSamplesPerSecond)	Set the maximumSamplesPerSecond property: Maximum rate of samples submitted to the extension.
SamplingOptions	setSkipSamplesWithoutAnnotation(String skipSamplesWithoutAnnotation)	Set the skipSamplesWithoutAnnotation property: When set to 'true', prevents frames without upstream inference data to be sent to the extension plugin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SamplingOptions

public SamplingOptions()

Method Detail

getSkipSamplesWithoutAnnotation

public String getSkipSamplesWithoutAnnotation()

Get the skipSamplesWithoutAnnotation property: 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.

Returns:

the skipSamplesWithoutAnnotation value.

setSkipSamplesWithoutAnnotation

public SamplingOptions setSkipSamplesWithoutAnnotation(String skipSamplesWithoutAnnotation)

Set the skipSamplesWithoutAnnotation property: 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.

Parameters:

skipSamplesWithoutAnnotation - the skipSamplesWithoutAnnotation value to set.

Returns:

the SamplingOptions object itself.

getMaximumSamplesPerSecond

public String getMaximumSamplesPerSecond()

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

Returns:

the maximumSamplesPerSecond value.

setMaximumSamplesPerSecond

public SamplingOptions setMaximumSamplesPerSecond(String maximumSamplesPerSecond)

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

Parameters:

maximumSamplesPerSecond - the maximumSamplesPerSecond value to set.

Returns:

the SamplingOptions object itself.