MediaGraphParameterDeclaration Class

The declaration of a parameter in the media graph topology. A media graph topology can be authored with parameters. Then, during graph instance creation, the value for those parameters can be specified. This allows the same graph topology to be used as a blueprint for multiple graph instances with different values for the parameters.

All required parameters must be populated in order to send to Azure.

Inheritance

Model

MediaGraphParameterDeclaration

Constructor

MediaGraphParameterDeclaration(*, name: str, type: Union[str, azure.media.analyticsedge._generated.models._direct_methodsfor_live_video_analyticson_io_tedge_enums.MediaGraphParameterType], description: Optional[str] = None, default: Optional[str] = None, **kwargs)

Parameters

name

str

Required

Required. The name of the parameter.

type

str or <xref:azure.media.analyticsedge.models.MediaGraphParameterType>

Required

Required. The type of the parameter. Possible values include: "String", "SecretString", "Int", "Double", "Bool".

description

str

Required

Description of the parameter.

default

str

Required

The default value for the parameter to be used if the media graph instance does not specify a value.