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

Class GrpcExtension

java.lang.Object

com.azure.media.videoanalyzer.edge.models.ProcessorNodeBase

com.azure.media.videoanalyzer.edge.models.ExtensionProcessorBase

com.azure.media.videoanalyzer.edge.models.GrpcExtension

public final class GrpcExtension
extends ExtensionProcessorBase

GRPC extension processor allows pipeline extension plugins to be connected to the pipeline through over a gRPC channel. Extension plugins must act as an gRPC server. Please see https://aka.ms/ava-extension-grpc for details.

Constructor Summary

Constructors

Constructor	Description
GrpcExtension(String name, List<NodeInput> inputs, EndpointBase endpoint, ImageProperties image, GrpcExtensionDataTransfer dataTransfer)	Creates an instance of GrpcExtension class.

Method Summary

Modifier and Type	Method	Description
GrpcExtensionDataTransfer	getDataTransfer()	Get the dataTransfer property: Specifies how media is transferred to the extension plugin.
String	getExtensionConfiguration()	Get the extensionConfiguration property: An optional configuration string that is sent to the extension plugin.
GrpcExtension	setExtensionConfiguration(String extensionConfiguration)	Set the extensionConfiguration property: An optional configuration string that is sent to the extension plugin.
GrpcExtension	setSamplingOptions(SamplingOptions samplingOptions)	Set the samplingOptions property: Media sampling parameters that define how often media is submitted to the extension plugin.

Methods inherited from class com.azure.media.videoanalyzer.edge.models.ExtensionProcessorBase

getEndpoint, getImage, getSamplingOptions

Methods inherited from class com.azure.media.videoanalyzer.edge.models.ProcessorNodeBase

getInputs, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

GrpcExtension

public GrpcExtension(String name,
                     List<NodeInput> inputs,
                     EndpointBase endpoint,
                     ImageProperties image,
                     GrpcExtensionDataTransfer dataTransfer)

Creates an instance of GrpcExtension class.

Parameters:

name - the name value to set.

inputs - the inputs value to set.

endpoint - the endpoint value to set.

image - the image value to set.

dataTransfer - the dataTransfer value to set.

Method Detail

getDataTransfer

public GrpcExtensionDataTransfer getDataTransfer()

Get the dataTransfer property: Specifies how media is transferred to the extension plugin.

Returns:

the dataTransfer value.

getExtensionConfiguration

public String getExtensionConfiguration()

Get the extensionConfiguration property: An optional configuration string that is sent to the extension plugin. The configuration string is specific to each custom extension and it not understood neither validated by Video Analyzer. Please see https://aka.ms/ava-extension-grpc for details.

Returns:

the extensionConfiguration value.

setExtensionConfiguration

public GrpcExtension setExtensionConfiguration(String extensionConfiguration)

Set the extensionConfiguration property: An optional configuration string that is sent to the extension plugin. The configuration string is specific to each custom extension and it not understood neither validated by Video Analyzer. Please see https://aka.ms/ava-extension-grpc for details.

Parameters:

extensionConfiguration - the extensionConfiguration value to set.

Returns:

the GrpcExtension object itself.

setSamplingOptions

public GrpcExtension setSamplingOptions(SamplingOptions samplingOptions)

Set the samplingOptions property: Media sampling parameters that define how often media is submitted to the extension plugin.

Overrides:

setSamplingOptions in class ExtensionProcessorBase

Parameters:

samplingOptions - the samplingOptions value to set.

Returns:

the ExtensionProcessorBase object itself.