Class SignalGateProcessor
java.lang.Object
com.azure.media.videoanalyzer.edge.models.ProcessorNodeBase
com.azure.media.videoanalyzer.edge.models.SignalGateProcessor
A signal gate determines when to block (gate) incoming media, and when to allow it through. It gathers input events
over the activationEvaluationWindow, and determines whether to open or close the gate. See
https://aka.ms/ava-signalgate for more information.
-
Constructor Summary
ConstructorDescriptionSignalGateProcessor
(String name, List<NodeInput> inputs) Creates an instance of SignalGateProcessor class. -
Method Summary
Modifier and TypeMethodDescriptionGet the activationEvaluationWindow property: The period of time over which the gate gathers input events before evaluating them.Get the activationSignalOffset property: Signal offset once the gate is activated (can be negative).Get the maximumActivationTime property: The maximum period for which the gate remains open in the presence of subsequent triggers (events).Get the minimumActivationTime property: The minimum period for which the gate remains open in the absence of subsequent triggers (events).setActivationEvaluationWindow
(String activationEvaluationWindow) Set the activationEvaluationWindow property: The period of time over which the gate gathers input events before evaluating them.setActivationSignalOffset
(String activationSignalOffset) Set the activationSignalOffset property: Signal offset once the gate is activated (can be negative).setMaximumActivationTime
(String maximumActivationTime) Set the maximumActivationTime property: The maximum period for which the gate remains open in the presence of subsequent triggers (events).setMinimumActivationTime
(String minimumActivationTime) Set the minimumActivationTime property: The minimum period for which the gate remains open in the absence of subsequent triggers (events).Methods inherited from class com.azure.media.videoanalyzer.edge.models.ProcessorNodeBase
getInputs, getName
-
Constructor Details
-
SignalGateProcessor
Creates an instance of SignalGateProcessor class.- Parameters:
name
- the name value to set.inputs
- the inputs value to set.
-
-
Method Details
-
getActivationEvaluationWindow
Get the activationEvaluationWindow property: The period of time over which the gate gathers input events before evaluating them.- Returns:
- the activationEvaluationWindow value.
-
setActivationEvaluationWindow
Set the activationEvaluationWindow property: The period of time over which the gate gathers input events before evaluating them.- Parameters:
activationEvaluationWindow
- the activationEvaluationWindow value to set.- Returns:
- the SignalGateProcessor object itself.
-
getActivationSignalOffset
Get the activationSignalOffset property: Signal offset once the gate is activated (can be negative). It determines the how much farther behind of after the signal will be let through based on the activation time. A negative offset indicates that data prior the activation time must be included on the signal that is let through, once the gate is activated. When used upstream of a file or video sink, this allows for scenarios such as recording buffered media prior an event, such as: record video 5 seconds prior motions is detected.- Returns:
- the activationSignalOffset value.
-
setActivationSignalOffset
Set the activationSignalOffset property: Signal offset once the gate is activated (can be negative). It determines the how much farther behind of after the signal will be let through based on the activation time. A negative offset indicates that data prior the activation time must be included on the signal that is let through, once the gate is activated. When used upstream of a file or video sink, this allows for scenarios such as recording buffered media prior an event, such as: record video 5 seconds prior motions is detected.- Parameters:
activationSignalOffset
- the activationSignalOffset value to set.- Returns:
- the SignalGateProcessor object itself.
-
getMinimumActivationTime
Get the minimumActivationTime property: The minimum period for which the gate remains open in the absence of subsequent triggers (events). When used upstream of a file or video sink, it determines the minimum length of the recorded video clip.- Returns:
- the minimumActivationTime value.
-
setMinimumActivationTime
Set the minimumActivationTime property: The minimum period for which the gate remains open in the absence of subsequent triggers (events). When used upstream of a file or video sink, it determines the minimum length of the recorded video clip.- Parameters:
minimumActivationTime
- the minimumActivationTime value to set.- Returns:
- the SignalGateProcessor object itself.
-
getMaximumActivationTime
Get the maximumActivationTime property: The maximum period for which the gate remains open in the presence of subsequent triggers (events). When used upstream of a file or video sink, it determines the maximum length of the recorded video clip.- Returns:
- the maximumActivationTime value.
-
setMaximumActivationTime
Set the maximumActivationTime property: The maximum period for which the gate remains open in the presence of subsequent triggers (events). When used upstream of a file or video sink, it determines the maximum length of the recorded video clip.- Parameters:
maximumActivationTime
- the maximumActivationTime value to set.- Returns:
- the SignalGateProcessor object itself.
-