azure.media.videoanalyzeredge package¶
-
class
azure.media.videoanalyzeredge.CertificateSource(**kwargs)[source]¶ Base class for certificate sources.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: PemCertificateList.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor(*, name: str, inputs: List[azure.media.videoanalyzeredge._generated.models._models_py3.NodeInput], endpoint: azure.media.videoanalyzeredge._generated.models._models_py3.EndpointBase, operation: azure.media.videoanalyzeredge._generated.models._models_py3.SpatialAnalysisOperationBase, image: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.ImageProperties] = None, sampling_options: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.SamplingOptions] = None, **kwargs)[source]¶ A processor that allows the pipeline topology to send video frames to a Cognitive Services Vision extension. Inference results are relayed to downstream nodes.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
endpoint (EndpointBase) – Required. Endpoint to which this processor should connect.
image (ImageProperties) – Describes the parameters of the image that is sent as input to the endpoint.
sampling_options (SamplingOptions) – Describes the sampling options to be applied when forwarding samples to the extension.
operation (SpatialAnalysisOperationBase) – Required. Describes the Spatial Analysis operation to be used in the Cognitive Services Vision processor.
- Keyword Arguments
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
endpoint (EndpointBase) – Required. Endpoint to which this processor should connect.
image (ImageProperties) – Describes the parameters of the image that is sent as input to the endpoint.
sampling_options (SamplingOptions) – Describes the sampling options to be applied when forwarding samples to the extension.
operation (SpatialAnalysisOperationBase) – Required. Describes the Spatial Analysis operation to be used in the Cognitive Services Vision processor.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.CredentialsBase(**kwargs)[source]¶ Base class for credential objects.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: HttpHeaderCredentials, SymmetricKeyCredentials, UsernamePasswordCredentials.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.DiscoveredOnvifDevice(*, service_identifier: Optional[str] = None, remote_ip_address: Optional[str] = None, scopes: Optional[List[str]] = None, endpoints: Optional[List[str]] = None, **kwargs)[source]¶ The discovered properties of the ONVIF device that are returned during the discovery.
- Variables
service_identifier (str) – The unique identifier of the ONVIF device that was discovered in the same subnet as the IoT Edge device.
remote_ip_address (str) – The IP address of the ONVIF device that was discovered in the same subnet as the IoT Edge device.
scopes (list[str]) – An array of hostnames for the ONVIF discovered devices that are in the same subnet as the IoT Edge device.
endpoints (list[str]) – An array of media profile endpoints that the ONVIF discovered device supports.
- Keyword Arguments
service_identifier (str) – The unique identifier of the ONVIF device that was discovered in the same subnet as the IoT Edge device.
remote_ip_address (str) – The IP address of the ONVIF device that was discovered in the same subnet as the IoT Edge device.
scopes (list[str]) – An array of hostnames for the ONVIF discovered devices that are in the same subnet as the IoT Edge device.
endpoints (list[str]) – An array of media profile endpoints that the ONVIF discovered device supports.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection(*, value: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.DiscoveredOnvifDevice]] = None, **kwargs)[source]¶ A list of ONVIF devices that were discovered in the same subnet as the IoT Edge device.
- Variables
value (list[DiscoveredOnvifDevice]) – An array of ONVIF devices that have been discovered in the same subnet as the IoT Edge device.
- Keyword Arguments
value (list[DiscoveredOnvifDevice]) – An array of ONVIF devices that have been discovered in the same subnet as the IoT Edge device.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.EndpointBase(*, url: str, credentials: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.CredentialsBase] = None, **kwargs)[source]¶ Base class for endpoints.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: TlsEndpoint, UnsecuredEndpoint.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
credentials (CredentialsBase) – Credentials to be presented to the endpoint.
url (str) – Required. The endpoint URL for Video Analyzer to connect to.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.ExtensionProcessorBase(*, name: str, inputs: List[azure.media.videoanalyzeredge._generated.models._models_py3.NodeInput], endpoint: azure.media.videoanalyzeredge._generated.models._models_py3.EndpointBase, image: azure.media.videoanalyzeredge._generated.models._models_py3.ImageProperties, sampling_options: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.SamplingOptions] = None, **kwargs)[source]¶ Base class for pipeline extension processors. Pipeline extensions allow for custom media analysis and processing to be plugged into the Video Analyzer pipeline.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: GrpcExtension, HttpExtension.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
endpoint (EndpointBase) – Required. Endpoint details of the pipeline extension plugin.
image (ImageProperties) – Required. Image transformations and formatting options to be applied to the video frame(s) prior submission to the pipeline extension plugin.
sampling_options (SamplingOptions) – Media sampling parameters that define how often media is submitted to the extension plugin.
- Keyword Arguments
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
endpoint (EndpointBase) – Required. Endpoint details of the pipeline extension plugin.
image (ImageProperties) – Required. Image transformations and formatting options to be applied to the video frame(s) prior submission to the pipeline extension plugin.
sampling_options (SamplingOptions) – Media sampling parameters that define how often media is submitted to the extension plugin.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.FileSink(*, name: str, inputs: List[azure.media.videoanalyzeredge._generated.models._models_py3.NodeInput], base_directory_path: str, file_name_pattern: str, maximum_size_mi_b: str, **kwargs)[source]¶ File sink allows for video and audio content to be recorded on the file system on the edge device.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
base_directory_path (str) – Required. Absolute directory path where media files will be stored.
file_name_pattern (str) – Required. File name pattern for creating new files when performing event based recording. The pattern must include at least one system variable.
maximum_size_mi_b (str) – Required. Maximum amount of disk space that can be used for storing files from this sink. Once this limit is reached, the oldest files from this sink will be automatically deleted.
- Keyword Arguments
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
base_directory_path (str) – Required. Absolute directory path where media files will be stored.
file_name_pattern (str) – Required. File name pattern for creating new files when performing event based recording. The pattern must include at least one system variable.
maximum_size_mi_b (str) – Required. Maximum amount of disk space that can be used for storing files from this sink. Once this limit is reached, the oldest files from this sink will be automatically deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.GrpcExtension(*, name: str, inputs: List[azure.media.videoanalyzeredge._generated.models._models_py3.NodeInput], endpoint: azure.media.videoanalyzeredge._generated.models._models_py3.EndpointBase, image: azure.media.videoanalyzeredge._generated.models._models_py3.ImageProperties, data_transfer: azure.media.videoanalyzeredge._generated.models._models_py3.GrpcExtensionDataTransfer, sampling_options: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.SamplingOptions] = None, extension_configuration: Optional[str] = None, **kwargs)[source]¶ 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.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
endpoint (EndpointBase) – Required. Endpoint details of the pipeline extension plugin.
image (ImageProperties) – Required. Image transformations and formatting options to be applied to the video frame(s) prior submission to the pipeline extension plugin.
sampling_options (SamplingOptions) – Media sampling parameters that define how often media is submitted to the extension plugin.
data_transfer (GrpcExtensionDataTransfer) – Required. Specifies how media is transferred to the extension plugin.
extension_configuration (str) – 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.
- Keyword Arguments
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
endpoint (EndpointBase) – Required. Endpoint details of the pipeline extension plugin.
image (ImageProperties) – Required. Image transformations and formatting options to be applied to the video frame(s) prior submission to the pipeline extension plugin.
sampling_options (SamplingOptions) – Media sampling parameters that define how often media is submitted to the extension plugin.
data_transfer (GrpcExtensionDataTransfer) – Required. Specifies how media is transferred to the extension plugin.
extension_configuration (str) – 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.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.GrpcExtensionDataTransfer(*, mode: Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.GrpcExtensionDataTransferMode], shared_memory_size_mi_b: Optional[str] = None, **kwargs)[source]¶ Describes how media is transferred to the extension plugin.
All required parameters must be populated in order to send to Azure.
- Variables
shared_memory_size_mi_b (str) – The share memory buffer for sample transfers, in mebibytes. It can only be used with the ‘SharedMemory’ transfer mode.
mode (str or GrpcExtensionDataTransferMode) – Required. Data transfer mode: embedded or sharedMemory. Possible values include: “embedded”, “sharedMemory”.
- Keyword Arguments
shared_memory_size_mi_b (str) – The share memory buffer for sample transfers, in mebibytes. It can only be used with the ‘SharedMemory’ transfer mode.
mode (str or GrpcExtensionDataTransferMode) – Required. Data transfer mode: embedded or sharedMemory. Possible values include: “embedded”, “sharedMemory”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.GrpcExtensionDataTransferMode(value)[source]¶ Data transfer mode: embedded or sharedMemory.
-
EMBEDDED= 'embedded'¶ Media samples are embedded into the gRPC messages. This mode is less efficient but it requires a simpler implementations and can be used with plugins which are not on the same node as the Video Analyzer module.
-
SHARED_MEMORY= 'sharedMemory'¶ Media samples are made available through shared memory. This mode enables efficient data transfers but it requires that the extension plugin to be co-located on the same node and sharing the same shared memory space.
-
-
class
azure.media.videoanalyzeredge.H264Configuration(*, gov_length: Optional[float] = None, profile: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.H264Profile]] = None, **kwargs)[source]¶ Class representing the H264 Configuration.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.H264Profile(value)[source]¶ The H264 Profile
-
BASELINE= 'Baseline'¶
-
EXTENDED= 'Extended'¶
-
HIGH= 'High'¶
-
MAIN= 'Main'¶
-
-
class
azure.media.videoanalyzeredge.HttpExtension(*, name: str, inputs: List[azure.media.videoanalyzeredge._generated.models._models_py3.NodeInput], endpoint: azure.media.videoanalyzeredge._generated.models._models_py3.EndpointBase, image: azure.media.videoanalyzeredge._generated.models._models_py3.ImageProperties, sampling_options: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.SamplingOptions] = None, **kwargs)[source]¶ HTTP extension processor allows pipeline extension plugins to be connected to the pipeline through over the HTTP protocol. Extension plugins must act as an HTTP server. Please see https://aka.ms/ava-extension-http for details.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
endpoint (EndpointBase) – Required. Endpoint details of the pipeline extension plugin.
image (ImageProperties) – Required. Image transformations and formatting options to be applied to the video frame(s) prior submission to the pipeline extension plugin.
sampling_options (SamplingOptions) – Media sampling parameters that define how often media is submitted to the extension plugin.
- Keyword Arguments
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
endpoint (EndpointBase) – Required. Endpoint details of the pipeline extension plugin.
image (ImageProperties) – Required. Image transformations and formatting options to be applied to the video frame(s) prior submission to the pipeline extension plugin.
sampling_options (SamplingOptions) – Media sampling parameters that define how often media is submitted to the extension plugin.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.HttpHeaderCredentials(*, header_name: str, header_value: str, **kwargs)[source]¶ HTTP header credentials.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
header_name (str) – Required. HTTP header name.
header_value (str) – Required. HTTP header value. It is recommended that this value is parameterized as a secret string in order to prevent this value to be returned as part of the resource on API requests.
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.ImageFormatBmp(**kwargs)[source]¶ BMP image encoding.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.ImageFormatJpeg(*, quality: Optional[str] = None, **kwargs)[source]¶ JPEG image encoding.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
quality (str) – Image quality value between 0 to 100 (best quality).
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.ImageFormatPng(**kwargs)[source]¶ PNG image encoding.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.ImageFormatProperties(**kwargs)[source]¶ Base class for image formatting properties.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageFormatBmp, ImageFormatJpeg, ImageFormatPng, ImageFormatRaw.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.ImageFormatRaw(*, pixel_format: Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.ImageFormatRawPixelFormat], **kwargs)[source]¶ Raw image formatting.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
pixel_format (str or ImageFormatRawPixelFormat) – Required. Pixel format to be applied to the raw image. Possible values include: “yuv420p”, “rgb565be”, “rgb565le”, “rgb555be”, “rgb555le”, “rgb24”, “bgr24”, “argb”, “rgba”, “abgr”, “bgra”.
- Keyword Arguments
pixel_format (str or ImageFormatRawPixelFormat) – Required. Pixel format to be applied to the raw image. Possible values include: “yuv420p”, “rgb565be”, “rgb565le”, “rgb555be”, “rgb555le”, “rgb24”, “bgr24”, “argb”, “rgba”, “abgr”, “bgra”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.ImageFormatRawPixelFormat(value)[source]¶ Pixel format to be applied to the raw image.
-
ABGR= 'abgr'¶ 8:8, 32bpp, ABGRABGR.
- Type
Packed ABGR 8
- Type
8
-
ARGB= 'argb'¶ 8:8, 32bpp, ARGBARGB.
- Type
Packed ARGB 8
- Type
8
-
BGR24= 'bgr24'¶ 8, 24bpp, BGRBGR.
- Type
Packed RGB 8
- Type
8
-
BGRA= 'bgra'¶ 8:8, 32bpp, BGRABGRA.
- Type
Packed BGRA 8
- Type
8
-
RGB24= 'rgb24'¶ 8, 24bpp, RGBRGB.
- Type
Packed RGB 8
- Type
8
-
RGB555_BE= 'rgb555be'¶ 5, 16bpp, (msb)1X 5R 5G 5B(lsb), big-endian , X=unused/undefined.
- Type
Packed RGB 5
- Type
5
-
RGB555_LE= 'rgb555le'¶ 5, 16bpp, (msb)1X 5R 5G 5B(lsb), little-endian, X=unused/undefined.
- Type
Packed RGB 5
- Type
5
-
RGB565_BE= 'rgb565be'¶ 5, 16bpp, (msb) 5R 6G 5B(lsb), big-endian.
- Type
Packed RGB 5
- Type
6
-
RGB565_LE= 'rgb565le'¶ 5, 16bpp, (msb) 5R 6G 5B(lsb), little-endian.
- Type
Packed RGB 5
- Type
6
-
RGBA= 'rgba'¶ 8:8, 32bpp, RGBARGBA.
- Type
Packed RGBA 8
- Type
8
-
YUV420_P= 'yuv420p'¶ 0, 12bpp, (1 Cr and Cb sample per 2x2 Y samples).
- Type
Planar YUV 4
- Type
2
-
-
class
azure.media.videoanalyzeredge.ImageProperties(*, scale: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.ImageScale] = None, format: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.ImageFormatProperties] = None, **kwargs)[source]¶ Image transformations and formatting options to be applied to the video frame(s).
- Variables
scale (ImageScale) – Image scaling mode.
format (ImageFormatProperties) – Base class for image formatting properties.
- Keyword Arguments
scale (ImageScale) – Image scaling mode.
format (ImageFormatProperties) – Base class for image formatting properties.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.ImageScale(*, mode: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.ImageScaleMode]] = None, width: Optional[str] = None, height: Optional[str] = None, **kwargs)[source]¶ Image scaling mode.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.ImageScaleMode(value)[source]¶ Describes the image scaling mode to be applied. Default mode is ‘pad’.
-
PAD= 'pad'¶ Pads the image with black horizontal stripes (letterbox) or black vertical stripes (pillar-box) so the image is resized to the specified dimensions while not altering the content aspect ratio.
-
PRESERVE_ASPECT_RATIO= 'preserveAspectRatio'¶ Preserves the same aspect ratio as the input image. If only one image dimension is provided, the second dimension is calculated based on the input image aspect ratio. When 2 dimensions are provided, the image is resized to fit the most constraining dimension, considering the input image size and aspect ratio.
-
STRETCH= 'stretch'¶ Stretches the original image so it resized to the specified dimensions.
-
-
class
azure.media.videoanalyzeredge.IotHubDeviceConnection(*, device_id: str, credentials: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.CredentialsBase] = None, **kwargs)[source]¶ Information that enables communication between the IoT Hub and the IoT device - allowing this edge module to act as a transparent gateway between the two.
All required parameters must be populated in order to send to Azure.
- Variables
device_id (str) – Required. The name of the IoT device configured and managed in IoT Hub. (case-sensitive).
credentials (CredentialsBase) – IoT device connection credentials. Currently IoT device symmetric key credentials are supported.
- Keyword Arguments
device_id (str) – Required. The name of the IoT device configured and managed in IoT Hub. (case-sensitive).
credentials (CredentialsBase) – IoT device connection credentials. Currently IoT device symmetric key credentials are supported.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.IotHubMessageSink(*, name: str, inputs: List[azure.media.videoanalyzeredge._generated.models._models_py3.NodeInput], hub_output_name: str, **kwargs)[source]¶ IoT Hub Message sink allows for pipeline messages to published into the IoT Edge Hub. Published messages can then be delivered to the cloud and other modules via routes declared in the IoT Edge deployment manifest.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
hub_output_name (str) – Required. Name of the Iot Edge Hub output to which the messages will be published.
- Keyword Arguments
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
hub_output_name (str) – Required. Name of the Iot Edge Hub output to which the messages will be published.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.IotHubMessageSource(*, name: str, hub_input_name: Optional[str] = None, **kwargs)[source]¶ IoT Hub Message source allows for the pipeline to consume messages from the IoT Edge Hub. Messages can be routed from other IoT modules via routes declared in the IoT Edge deployment manifest.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.LineCrossingProcessor(*, name: str, inputs: List[azure.media.videoanalyzeredge._generated.models._models_py3.NodeInput], lines: List[azure.media.videoanalyzeredge._generated.models._models_py3.NamedLineBase], **kwargs)[source]¶ Line crossing processor allows for the detection of tracked objects moving across one or more predefined lines. It must be downstream of an object tracker of downstream on an AI extension node that generates sequenceId for objects which are tracked across different frames of the video. Inference events are generated every time objects crosses from one side of the line to another.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
lines (list[NamedLineBase]) – Required. An array of lines used to compute line crossing events.
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.LivePipeline(*, name: str, system_data: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.SystemData] = None, properties: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.LivePipelineProperties] = None, **kwargs)[source]¶ Live Pipeline represents an unique instance of a pipeline topology which is used for real-time content ingestion and analysis.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – Required. Live pipeline unique identifier.
system_data (SystemData) – Read-only system metadata associated with this object.
properties (LivePipelineProperties) – Live pipeline properties.
- Keyword Arguments
name (str) – Required. Live pipeline unique identifier.
system_data (SystemData) – Read-only system metadata associated with this object.
properties (LivePipelineProperties) – Live pipeline properties.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.LivePipelineActivateRequest(*, name: str, api_version: Optional[str] = '1.1', **kwargs)[source]¶ Activates an existing live pipeline.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.LivePipelineCollection(*, value: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.LivePipeline]] = None, continuation_token: Optional[str] = None, **kwargs)[source]¶ A collection of live pipelines.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.LivePipelineDeactivateRequest(*, name: str, api_version: Optional[str] = '1.1', **kwargs)[source]¶ Deactivates an existing live pipeline.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.LivePipelineDeleteRequest(*, name: str, api_version: Optional[str] = '1.1', **kwargs)[source]¶ Deletes an existing live pipeline.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.LivePipelineGetRequest(*, name: str, api_version: Optional[str] = '1.1', **kwargs)[source]¶ Retrieves an existing live pipeline.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.LivePipelineListRequest(*, api_version: Optional[str] = '1.1', **kwargs)[source]¶ List all existing live pipelines.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.LivePipelineProperties(*, description: Optional[str] = None, topology_name: Optional[str] = None, parameters: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.ParameterDefinition]] = None, state: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.LivePipelineState]] = None, **kwargs)[source]¶ Live pipeline properties.
- Variables
description (str) – An optional description of the live pipeline.
topology_name (str) – The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.
parameters (list[ParameterDefinition]) – List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
state (str or LivePipelineState) – Current pipeline state (read-only). Possible values include: “inactive”, “activating”, “active”, “deactivating”.
- Keyword Arguments
description (str) – An optional description of the live pipeline.
topology_name (str) – The reference to an existing pipeline topology defined for real-time content processing. When activated, this live pipeline will process content according to the pipeline topology definition.
parameters (list[ParameterDefinition]) – List of the instance level parameter values for the user-defined topology parameters. A pipeline can only define or override parameters values for parameters which have been declared in the referenced topology. Topology parameters without a default value must be defined. Topology parameters with a default value can be optionally be overridden.
state (str or LivePipelineState) – Current pipeline state (read-only). Possible values include: “inactive”, “activating”, “active”, “deactivating”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.LivePipelineSetRequest(*, live_pipeline: azure.media.videoanalyzeredge._generated.models._models_py3.LivePipeline, api_version: Optional[str] = '1.1', **kwargs)[source]¶ Creates a new live pipeline or updates an existing one.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
method_name (str) – Required. Direct method method name.Constant filled by server.
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
live_pipeline (LivePipeline) – Required. Live Pipeline represents an unique instance of a pipeline topology which is used for real-time content ingestion and analysis.
- Keyword Arguments
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
live_pipeline (LivePipeline) – Required. Live Pipeline represents an unique instance of a pipeline topology which is used for real-time content ingestion and analysis.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize()¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.LivePipelineSetRequestBody(*, name: str, api_version: Optional[str] = '1.1', system_data: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.SystemData] = None, properties: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.LivePipelineProperties] = None, **kwargs)[source]¶ Live Pipeline represents an unique instance of a pipeline topology which is used for real-time content ingestion and analysis.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
method_name (str) – Required. Direct method method name.Constant filled by server.
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
name (str) – Required. Live pipeline unique identifier.
system_data (SystemData) – Read-only system metadata associated with this object.
properties (LivePipelineProperties) – Live pipeline properties.
- Keyword Arguments
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
name (str) – Required. Live pipeline unique identifier.
system_data (SystemData) – Read-only system metadata associated with this object.
properties (LivePipelineProperties) – Live pipeline properties.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.LivePipelineState(value)[source]¶ Current pipeline state (read-only).
-
ACTIVATING= 'activating'¶ The live pipeline is transitioning into the active state.
-
ACTIVE= 'active'¶ The live pipeline is active and able to process media. If your data source is not available, for instance, if your RTSP camera is powered off or unreachable, the pipeline will still be active and periodically retrying the connection. Your Azure subscription will be billed for the duration in which the live pipeline is in the active state.
-
DEACTIVATING= 'deactivating'¶ The live pipeline is transitioning into the inactive state.
-
INACTIVE= 'inactive'¶ The live pipeline is idle and not processing media.
-
-
class
azure.media.videoanalyzeredge.MPEG4Configuration(*, gov_length: Optional[float] = None, profile: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.MPEG4Profile]] = None, **kwargs)[source]¶ Class representing the MPEG4 Configuration.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.MPEG4Profile(value)[source]¶ The MPEG4 Profile
-
ASP= 'ASP'¶ Advanced Simple Profile.
-
SP= 'SP'¶ Simple Profile.
-
-
class
azure.media.videoanalyzeredge.MediaProfile(*, name: Optional[str] = None, media_uri: Optional[Any] = None, video_encoder_configuration: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.VideoEncoderConfiguration] = None, **kwargs)[source]¶ Class representing the ONVIF MediaProfiles.
- Variables
name (str) – The name of the Media Profile.
media_uri (any) – Object representing the URI that will be used to request for media streaming.
video_encoder_configuration (VideoEncoderConfiguration) – The Video encoder configuration.
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.MediaUri(*, uri: Optional[str] = None, **kwargs)[source]¶ Object representing the URI that will be used to request for media streaming.
- Variables
uri (str) – URI that can be used for media streaming.
- Keyword Arguments
uri (str) – URI that can be used for media streaming.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.MethodRequest(*, api_version: Optional[str] = '1.1', **kwargs)[source]¶ Base class for direct method calls.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: LivePipelineSetRequestBody, MethodRequestEmptyBodyBase, PipelineTopologySetRequestBody, RemoteDeviceAdapterSetRequestBody, LivePipelineListRequest, LivePipelineSetRequest, OnvifDeviceDiscoverRequest, OnvifDeviceGetRequest, PipelineTopologyListRequest, PipelineTopologySetRequest, RemoteDeviceAdapterListRequest, RemoteDeviceAdapterSetRequest.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase(*, name: str, api_version: Optional[str] = '1.1', **kwargs)[source]¶ MethodRequestEmptyBodyBase.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: LivePipelineActivateRequest, LivePipelineDeactivateRequest, LivePipelineDeleteRequest, LivePipelineGetRequest, PipelineTopologyDeleteRequest, PipelineTopologyGetRequest, RemoteDeviceAdapterDeleteRequest, RemoteDeviceAdapterGetRequest.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.MotionDetectionProcessor(*, name: str, inputs: List[azure.media.videoanalyzeredge._generated.models._models_py3.NodeInput], sensitivity: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.MotionDetectionSensitivity]] = None, output_motion_region: Optional[bool] = None, event_aggregation_window: Optional[str] = None, **kwargs)[source]¶ Motion detection processor allows for motion detection on the video stream. It generates motion events whenever motion is present on the video.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
sensitivity (str or MotionDetectionSensitivity) – Motion detection sensitivity: low, medium, high. Possible values include: “low”, “medium”, “high”.
output_motion_region (bool) – Indicates whether the processor should detect and output the regions within the video frame where motion was detected. Default is true.
event_aggregation_window (str) – Time window duration on which events are aggregated before being emitted. Value must be specified in ISO8601 duration format (i.e. “PT2S” equals 2 seconds). Use 0 seconds for no aggregation. Default is 1 second.
- Keyword Arguments
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
sensitivity (str or MotionDetectionSensitivity) – Motion detection sensitivity: low, medium, high. Possible values include: “low”, “medium”, “high”.
output_motion_region (bool) – Indicates whether the processor should detect and output the regions within the video frame where motion was detected. Default is true.
event_aggregation_window (str) – Time window duration on which events are aggregated before being emitted. Value must be specified in ISO8601 duration format (i.e. “PT2S” equals 2 seconds). Use 0 seconds for no aggregation. Default is 1 second.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.MotionDetectionSensitivity(value)[source]¶ Motion detection sensitivity: low, medium, high.
-
HIGH= 'high'¶ High sensitivity.
-
LOW= 'low'¶ Low sensitivity.
-
MEDIUM= 'medium'¶ Medium sensitivity.
-
-
class
azure.media.videoanalyzeredge.NamedLineBase(*, name: str, **kwargs)[source]¶ Base class for named lines.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: NamedLineString.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
name (str) – Required. Line name. Must be unique within the node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.NamedLineString(*, name: str, line: str, **kwargs)[source]¶ Describes a line configuration.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. The Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Line name. Must be unique within the node.
line (str) – Required. Point coordinates for the line start and end, respectively. Example: ‘[[0.3, 0.2],[0.9, 0.8]]’. Each point is expressed as [LEFT, TOP] coordinate ratios ranging from 0.0 to 1.0, where [0,0] is the upper-left frame corner and [1, 1] is the bottom-right frame corner.
- Keyword Arguments
name (str) – Required. Line name. Must be unique within the node.
line (str) – Required. Point coordinates for the line start and end, respectively. Example: ‘[[0.3, 0.2],[0.9, 0.8]]’. Each point is expressed as [LEFT, TOP] coordinate ratios ranging from 0.0 to 1.0, where [0,0] is the upper-left frame corner and [1, 1] is the bottom-right frame corner.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.NamedPolygonBase(*, name: str, **kwargs)[source]¶ Describes the named polygon.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: NamedPolygonString.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
name (str) – Required. Polygon name. Must be unique within the node.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.NamedPolygonString(*, name: str, polygon: str, **kwargs)[source]¶ Describes a closed polygon configuration.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. The Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Polygon name. Must be unique within the node.
polygon (str) – Required. Point coordinates for the polygon. Example: ‘[[0.3, 0.2],[0.9, 0.8],[0.7, 0.6]]’. Each point is expressed as [LEFT, TOP] coordinate ratios ranging from 0.0 to 1.0, where [0,0] is the upper-left frame corner and [1, 1] is the bottom-right frame corner.
- Keyword Arguments
name (str) – Required. Polygon name. Must be unique within the node.
polygon (str) – Required. Point coordinates for the polygon. Example: ‘[[0.3, 0.2],[0.9, 0.8],[0.7, 0.6]]’. Each point is expressed as [LEFT, TOP] coordinate ratios ranging from 0.0 to 1.0, where [0,0] is the upper-left frame corner and [1, 1] is the bottom-right frame corner.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.NodeInput(*, node_name: str, output_selectors: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.OutputSelector]] = None, **kwargs)[source]¶ Describes an input signal to be used on a pipeline node.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.ObjectTrackingAccuracy(value)[source]¶ Object tracker accuracy: low, medium, high. Higher accuracy leads to higher CPU consumption in average.
-
HIGH= 'high'¶ High accuracy.
-
LOW= 'low'¶ Low accuracy.
-
MEDIUM= 'medium'¶ Medium accuracy.
-
-
class
azure.media.videoanalyzeredge.ObjectTrackingProcessor(*, name: str, inputs: List[azure.media.videoanalyzeredge._generated.models._models_py3.NodeInput], accuracy: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.ObjectTrackingAccuracy]] = None, **kwargs)[source]¶ Object tracker processor allows for continuous tracking of one of more objects over a finite sequence of video frames. It must be used downstream of an object detector extension node, thus allowing for the extension to be configured to to perform inferences on sparse frames through the use of the ‘maximumSamplesPerSecond’ sampling property. The object tracker node will then track the detected objects over the frames in which the detector is not invoked resulting on a smother tracking of detected objects across the continuum of video frames. The tracker will stop tracking objects which are not subsequently detected by the upstream detector on the subsequent detections.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
accuracy (str or ObjectTrackingAccuracy) – Object tracker accuracy: low, medium, high. Higher accuracy leads to higher CPU consumption in average. Possible values include: “low”, “medium”, “high”.
- Keyword Arguments
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
accuracy (str or ObjectTrackingAccuracy) – Object tracker accuracy: low, medium, high. Higher accuracy leads to higher CPU consumption in average. Possible values include: “low”, “medium”, “high”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.OnvifDevice(*, hostname: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.OnvifHostName] = None, system_date_time: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.OnvifSystemDateTime] = None, dns: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.OnvifDns] = None, media_profiles: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.MediaProfile]] = None, **kwargs)[source]¶ The ONVIF device properties.
- Variables
hostname (OnvifHostName) – The hostname of the ONVIF device.
system_date_time (OnvifSystemDateTime) – The system date and time of the ONVIF device.
dns (OnvifDns) – The ONVIF device DNS properties.
media_profiles (list[MediaProfile]) – An array of of ONVIF media profiles supported by the ONVIF device.
- Keyword Arguments
hostname (OnvifHostName) – The hostname of the ONVIF device.
system_date_time (OnvifSystemDateTime) – The system date and time of the ONVIF device.
dns (OnvifDns) – The ONVIF device DNS properties.
media_profiles (list[MediaProfile]) – An array of of ONVIF media profiles supported by the ONVIF device.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest(*, api_version: Optional[str] = '1.1', discovery_duration: Optional[str] = None, **kwargs)[source]¶ Lists all the discoverable ONVIF devices on the same subnet as the Edge Module.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
method_name (str) – Required. Direct method method name.Constant filled by server.
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
discovery_duration (str) – The amount of time that the ONVIF device discovery will wait for supported device responses.
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.OnvifDeviceGetRequest(*, endpoint: azure.media.videoanalyzeredge._generated.models._models_py3.EndpointBase, api_version: Optional[str] = '1.1', **kwargs)[source]¶ Retrieves properties and media profiles of an ONVIF device.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
endpoint (EndpointBase) – Required. Base class for endpoints.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.OnvifDns(*, from_dhcp: Optional[bool] = None, ipv4_address: Optional[List[str]] = None, ipv6_address: Optional[List[str]] = None, **kwargs)[source]¶ The ONVIF device DNS properties.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.OnvifHostName(*, from_dhcp: Optional[bool] = None, hostname: Optional[str] = None, **kwargs)[source]¶ The ONVIF device DNS properties.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.OnvifSystemDateTime(*, type: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.OnvifSystemDateTimeType]] = None, time: Optional[str] = None, time_zone: Optional[str] = None, **kwargs)[source]¶ The ONVIF device DNS properties.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.OnvifSystemDateTimeType(value)[source]¶ An enum value determining whether the date time was configured using NTP or manual.
-
MANUAL= 'Manual'¶
-
NTP= 'Ntp'¶
-
-
class
azure.media.videoanalyzeredge.OutputSelector(*, property: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.OutputSelectorProperty]] = None, operator: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.OutputSelectorOperator]] = None, value: Optional[str] = None, **kwargs)[source]¶ Allows for the selection of particular streams from another node.
- Variables
property (str or OutputSelectorProperty) – The property of the data stream to be used as the selection criteria. Possible values include: “mediaType”.
operator (str or OutputSelectorOperator) – The operator to compare properties by. Possible values include: “is”, “isNot”.
value (str) – Value to compare against.
- Keyword Arguments
property (str or OutputSelectorProperty) – The property of the data stream to be used as the selection criteria. Possible values include: “mediaType”.
operator (str or OutputSelectorOperator) – The operator to compare properties by. Possible values include: “is”, “isNot”.
value (str) – Value to compare against.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.OutputSelectorOperator(value)[source]¶ The operator to compare properties by.
-
IS_ENUM= 'is'¶ The property is of the type defined by value.
-
IS_NOT= 'isNot'¶ The property is not of the type defined by value.
-
-
class
azure.media.videoanalyzeredge.OutputSelectorProperty(value)[source]¶ The property of the data stream to be used as the selection criteria.
-
MEDIA_TYPE= 'mediaType'¶ audio, video or application.
- Type
The stream’s MIME type or subtype
-
-
class
azure.media.videoanalyzeredge.ParameterDeclaration(*, name: str, type: Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.ParameterType], description: Optional[str] = None, default: Optional[str] = None, **kwargs)[source]¶ Single topology parameter declaration. Declared parameters can and must be referenced throughout the topology and can optionally have default values to be used when they are not defined in the pipeline instances.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – Required. Name of the parameter.
type (str or ParameterType) – Required. Type of the parameter. Possible values include: “string”, “secretString”, “int”, “double”, “bool”.
description (str) – Description of the parameter.
default (str) – The default value for the parameter to be used if the live pipeline does not specify a value.
- Keyword Arguments
name (str) – Required. Name of the parameter.
type (str or ParameterType) – Required. Type of the parameter. Possible values include: “string”, “secretString”, “int”, “double”, “bool”.
description (str) – Description of the parameter.
default (str) – The default value for the parameter to be used if the live pipeline does not specify a value.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.ParameterDefinition(*, name: str, value: Optional[str] = None, **kwargs)[source]¶ Defines the parameter value of an specific pipeline topology parameter. See pipeline topology parameters for more information.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.ParameterType(value)[source]¶ Type of the parameter.
-
BOOL= 'bool'¶ The parameter’s value is a boolean value that is either true or false.
-
DOUBLE= 'double'¶ The parameter’s value is a 64-bit double-precision floating point.
-
INT= 'int'¶ The parameter’s value is a 32-bit signed integer.
-
SECRET_STRING= 'secretString'¶ The parameter’s value is a string that holds sensitive information.
-
STRING= 'string'¶ The parameter’s value is a string.
-
-
class
azure.media.videoanalyzeredge.PemCertificateList(*, certificates: List[str], **kwargs)[source]¶ A list of PEM formatted certificates.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
certificates (list[str]) – Required. PEM formatted public certificates. One certificate per entry.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.PipelineTopology(*, name: str, system_data: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.SystemData] = None, properties: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.PipelineTopologyProperties] = None, **kwargs)[source]¶ Pipeline topology describes the processing steps to be applied when processing media for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. For instance, a pipeline topology which acquires data from a RTSP camera, process it with an specific AI model and stored the data on the cloud can be reused across many different cameras, as long as the same processing should be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized, thus allowing individual pipelines to refer to different values, such as individual cameras RTSP endpoints and credentials. Overall a topology is composed of the following:
Parameters: list of user defined parameters that can be references across the topology nodes.
Sources: list of one or more data sources nodes such as an RTSP source which allows for media to be ingested from cameras.
Processors: list of nodes which perform data analysis or transformations. -Sinks: list of one or more data sinks which allow for data to be stored or exported to other destinations.
All required parameters must be populated in order to send to Azure.
- ivar name
Required. Pipeline topology unique identifier.
- vartype name
str
- ivar system_data
Read-only system metadata associated with this object.
- vartype system_data
~azure.media.videoanalyzer.edge.models.SystemData
- ivar properties
Pipeline topology properties.
- vartype properties
~azure.media.videoanalyzer.edge.models.PipelineTopologyProperties
- Keyword Arguments
name (str) – Required. Pipeline topology unique identifier.
system_data (SystemData) – Read-only system metadata associated with this object.
properties (PipelineTopologyProperties) – Pipeline topology properties.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.PipelineTopologyCollection(*, value: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.PipelineTopology]] = None, continuation_token: Optional[str] = None, **kwargs)[source]¶ A collection of pipeline topologies.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest(*, name: str, api_version: Optional[str] = '1.1', **kwargs)[source]¶ Deletes an existing pipeline topology.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.PipelineTopologyGetRequest(*, name: str, api_version: Optional[str] = '1.1', **kwargs)[source]¶ Retrieves an existing pipeline topology.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.PipelineTopologyListRequest(*, api_version: Optional[str] = '1.1', **kwargs)[source]¶ List all existing pipeline topologies.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.PipelineTopologyProperties(*, description: Optional[str] = None, parameters: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.ParameterDeclaration]] = None, sources: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.SourceNodeBase]] = None, processors: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.ProcessorNodeBase]] = None, sinks: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.SinkNodeBase]] = None, **kwargs)[source]¶ Pipeline topology properties.
- Variables
description (str) – An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here.
parameters (list[ParameterDeclaration]) – List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of “${PARAMETER_NAME}” string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline.
sources (list[SourceNodeBase]) – List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline.
processors (list[ProcessorNodeBase]) – List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed.
sinks (list[SinkNodeBase]) – List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported.
- Keyword Arguments
description (str) – An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here.
parameters (list[ParameterDeclaration]) – List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of “${PARAMETER_NAME}” string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline.
sources (list[SourceNodeBase]) – List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline.
processors (list[ProcessorNodeBase]) – List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed.
sinks (list[SinkNodeBase]) – List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.PipelineTopologySetRequest(*, pipeline_topology: azure.media.videoanalyzeredge._generated.models._models_py3.PipelineTopology, api_version: Optional[str] = '1.1', **kwargs)[source]¶ Creates a new pipeline topology or updates an existing one.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
method_name (str) – Required. Direct method method name.Constant filled by server.
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
pipeline_topology (PipelineTopology) –
Required. Pipeline topology describes the processing steps to be applied when processing media for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. For instance, a pipeline topology which acquires data from a RTSP camera, process it with an specific AI model and stored the data on the cloud can be reused across many different cameras, as long as the same processing should be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized, thus allowing individual pipelines to refer to different values, such as individual cameras RTSP endpoints and credentials. Overall a topology is composed of the following:
Parameters: list of user defined parameters that can be references across the topology
nodes. * Sources: list of one or more data sources nodes such as an RTSP source which allows for media to be ingested from cameras. * Processors: list of nodes which perform data analysis or transformations.
-Sinks: list of one or more data sinks which allow for data to be stored or exported to
other destinations.
- Keyword Arguments
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
pipeline_topology (PipelineTopology) –
Required. Pipeline topology describes the processing steps to be applied when processing media for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. For instance, a pipeline topology which acquires data from a RTSP camera, process it with an specific AI model and stored the data on the cloud can be reused across many different cameras, as long as the same processing should be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized, thus allowing individual pipelines to refer to different values, such as individual cameras RTSP endpoints and credentials. Overall a topology is composed of the following:
Parameters: list of user defined parameters that can be references across the topology
nodes. * Sources: list of one or more data sources nodes such as an RTSP source which allows for media to be ingested from cameras. * Processors: list of nodes which perform data analysis or transformations.
-Sinks: list of one or more data sinks which allow for data to be stored or exported to
other destinations.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize()¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.PipelineTopologySetRequestBody(*, name: str, api_version: Optional[str] = '1.1', system_data: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.SystemData] = None, properties: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.PipelineTopologyProperties] = None, **kwargs)[source]¶ Pipeline topology describes the processing steps to be applied when processing media for a particular outcome. The topology should be defined according to the scenario to be achieved and can be reused across many pipeline instances which share the same processing characteristics. For instance, a pipeline topology which acquires data from a RTSP camera, process it with an specific AI model and stored the data on the cloud can be reused across many different cameras, as long as the same processing should be applied across all the cameras. Individual instance properties can be defined through the use of user-defined parameters, which allow for a topology to be parameterized, thus allowing individual pipelines to refer to different values, such as individual cameras RTSP endpoints and credentials. Overall a topology is composed of the following:
Parameters: list of user defined parameters that can be references across the topology nodes.
Sources: list of one or more data sources nodes such as an RTSP source which allows for media to be ingested from cameras.
Processors: list of nodes which perform data analysis or transformations. -Sinks: list of one or more data sinks which allow for data to be stored or exported to other destinations.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- ivar method_name
Required. Direct method method name.Constant filled by server.
- vartype method_name
str
- ivar api_version
Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
- vartype api_version
str
- ivar name
Required. Pipeline topology unique identifier.
- vartype name
str
- ivar system_data
Read-only system metadata associated with this object.
- vartype system_data
~azure.media.videoanalyzer.edge.models.SystemData
- ivar properties
Pipeline topology properties.
- vartype properties
~azure.media.videoanalyzer.edge.models.PipelineTopologyProperties
- Keyword Arguments
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
name (str) – Required. Pipeline topology unique identifier.
system_data (SystemData) – Read-only system metadata associated with this object.
properties (PipelineTopologyProperties) – Pipeline topology properties.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.ProcessorNodeBase(*, name: str, inputs: List[azure.media.videoanalyzeredge._generated.models._models_py3.NodeInput], **kwargs)[source]¶ Base class for topology processor nodes.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: CognitiveServicesVisionProcessor, ExtensionProcessorBase, LineCrossingProcessor, MotionDetectionProcessor, ObjectTrackingProcessor, SignalGateProcessor.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.RateControl(*, bit_rate_limit: Optional[float] = None, encoding_interval: Optional[float] = None, frame_rate_limit: Optional[float] = None, guaranteed_frame_rate: Optional[bool] = None, **kwargs)[source]¶ Class representing the video’s rate control.
- Variables
bit_rate_limit (float) – the maximum output bitrate in kbps.
encoding_interval (float) – Interval at which images are encoded and transmitted.
frame_rate_limit (float) – Maximum output framerate in fps.
guaranteed_frame_rate (bool) – A value of true indicates that frame rate is a fixed value rather than an upper limit, and that the video encoder shall prioritize frame rate over all other adaptable configuration values such as bitrate.
- Keyword Arguments
bit_rate_limit (float) – the maximum output bitrate in kbps.
encoding_interval (float) – Interval at which images are encoded and transmitted.
frame_rate_limit (float) – Maximum output framerate in fps.
guaranteed_frame_rate (bool) – A value of true indicates that frame rate is a fixed value rather than an upper limit, and that the video encoder shall prioritize frame rate over all other adaptable configuration values such as bitrate.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.RemoteDeviceAdapter(*, name: str, system_data: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.SystemData] = None, properties: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.RemoteDeviceAdapterProperties] = None, **kwargs)[source]¶ The Video Analyzer edge module can act as a transparent gateway for video, enabling IoT devices to send video to the cloud from behind a firewall. A remote device adapter should be created for each such IoT device. Communication between the cloud and IoT device would then flow via the Video Analyzer edge module.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – Required. The unique identifier for the remote device adapter.
system_data (SystemData) – Read-only system metadata associated with this object.
properties (RemoteDeviceAdapterProperties) – Properties of the remote device adapter.
- Keyword Arguments
name (str) – Required. The unique identifier for the remote device adapter.
system_data (SystemData) – Read-only system metadata associated with this object.
properties (RemoteDeviceAdapterProperties) – Properties of the remote device adapter.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection(*, value: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.RemoteDeviceAdapter]] = None, continuation_token: Optional[str] = None, **kwargs)[source]¶ A list of remote device adapters.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest(*, name: str, api_version: Optional[str] = '1.1', **kwargs)[source]¶ Deletes an existing remote device adapter.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest(*, name: str, api_version: Optional[str] = '1.1', **kwargs)[source]¶ Retrieves an existing remote device adapter.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest(*, api_version: Optional[str] = '1.1', **kwargs)[source]¶ List all existing remote device adapters.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties(*, target: azure.media.videoanalyzeredge._generated.models._models_py3.RemoteDeviceAdapterTarget, iot_hub_device_connection: azure.media.videoanalyzeredge._generated.models._models_py3.IotHubDeviceConnection, description: Optional[str] = None, **kwargs)[source]¶ Remote device adapter properties.
All required parameters must be populated in order to send to Azure.
- Variables
description (str) – An optional description for the remote device adapter.
target (RemoteDeviceAdapterTarget) – Required. The IoT device to which this remote device will connect.
iot_hub_device_connection (IotHubDeviceConnection) – Required. Information that enables communication between the IoT Hub and the IoT device - allowing this edge module to act as a transparent gateway between the two.
- Keyword Arguments
description (str) – An optional description for the remote device adapter.
target (RemoteDeviceAdapterTarget) – Required. The IoT device to which this remote device will connect.
iot_hub_device_connection (IotHubDeviceConnection) – Required. Information that enables communication between the IoT Hub and the IoT device - allowing this edge module to act as a transparent gateway between the two.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest(*, remote_device_adapter: azure.media.videoanalyzeredge._generated.models._models_py3.RemoteDeviceAdapter, api_version: Optional[str] = '1.1', **kwargs)[source]¶ Creates a new remote device adapter or updates an existing one.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
method_name (str) – Required. Direct method method name.Constant filled by server.
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
remote_device_adapter (RemoteDeviceAdapter) – Required. The Video Analyzer edge module can act as a transparent gateway for video, enabling IoT devices to send video to the cloud from behind a firewall. A remote device adapter should be created for each such IoT device. Communication between the cloud and IoT device would then flow via the Video Analyzer edge module.
- Keyword Arguments
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
remote_device_adapter (RemoteDeviceAdapter) – Required. The Video Analyzer edge module can act as a transparent gateway for video, enabling IoT devices to send video to the cloud from behind a firewall. A remote device adapter should be created for each such IoT device. Communication between the cloud and IoT device would then flow via the Video Analyzer edge module.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize()¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody(*, name: str, api_version: Optional[str] = '1.1', system_data: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.SystemData] = None, properties: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.RemoteDeviceAdapterProperties] = None, **kwargs)[source]¶ The Video Analyzer edge module can act as a transparent gateway for video, enabling IoT devices to send video to the cloud from behind a firewall. A remote device adapter should be created for each such IoT device. Communication between the cloud and IoT device would then flow via the Video Analyzer edge module.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
- Variables
method_name (str) – Required. Direct method method name.Constant filled by server.
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
name (str) – Required. The unique identifier for the remote device adapter.
system_data (SystemData) – Read-only system metadata associated with this object.
properties (RemoteDeviceAdapterProperties) – Properties of the remote device adapter.
- Keyword Arguments
api_version (str) – Video Analyzer API version. The only acceptable values to pass in are None and “1.1”. The default value is “1.1”.
name (str) – Required. The unique identifier for the remote device adapter.
system_data (SystemData) – Read-only system metadata associated with this object.
properties (RemoteDeviceAdapterProperties) – Properties of the remote device adapter.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget(*, host: str, **kwargs)[source]¶ Properties of the remote device adapter target.
All required parameters must be populated in order to send to Azure.
- Variables
host (str) – Required. Hostname or IP address of the remote device.
- Keyword Arguments
host (str) – Required. Hostname or IP address of the remote device.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.RtspSource(*, name: str, endpoint: azure.media.videoanalyzeredge._generated.models._models_py3.EndpointBase, transport: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.RtspTransport]] = None, **kwargs)[source]¶ RTSP source allows for media from an RTSP camera or generic RTSP server to be ingested into a live pipeline.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Node name. Must be unique within the topology.
transport (str or RtspTransport) – Network transport utilized by the RTSP and RTP exchange: TCP or HTTP. When using TCP, the RTP packets are interleaved on the TCP RTSP connection. When using HTTP, the RTSP messages are exchanged through long lived HTTP connections, and the RTP packages are interleaved in the HTTP connections alongside the RTSP messages. Possible values include: “http”, “tcp”.
endpoint (EndpointBase) – Required. RTSP endpoint information for Video Analyzer to connect to. This contains the required information for Video Analyzer to connect to RTSP cameras and/or generic RTSP servers.
- Keyword Arguments
name (str) – Required. Node name. Must be unique within the topology.
transport (str or RtspTransport) – Network transport utilized by the RTSP and RTP exchange: TCP or HTTP. When using TCP, the RTP packets are interleaved on the TCP RTSP connection. When using HTTP, the RTSP messages are exchanged through long lived HTTP connections, and the RTP packages are interleaved in the HTTP connections alongside the RTSP messages. Possible values include: “http”, “tcp”.
endpoint (EndpointBase) – Required. RTSP endpoint information for Video Analyzer to connect to. This contains the required information for Video Analyzer to connect to RTSP cameras and/or generic RTSP servers.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.RtspTransport(value)[source]¶ Network transport utilized by the RTSP and RTP exchange: TCP or HTTP. When using TCP, the RTP packets are interleaved on the TCP RTSP connection. When using HTTP, the RTSP messages are exchanged through long lived HTTP connections, and the RTP packages are interleaved in the HTTP connections alongside the RTSP messages.
-
HTTP= 'http'¶ HTTP transport. RTSP messages are exchanged over long running HTTP requests and RTP packets are interleaved within the HTTP channel.
-
TCP= 'tcp'¶ TCP transport. RTSP is used directly over TCP and RTP packets are interleaved within the TCP channel.
-
-
class
azure.media.videoanalyzeredge.SamplingOptions(*, skip_samples_without_annotation: Optional[str] = None, maximum_samples_per_second: Optional[str] = None, **kwargs)[source]¶ Defines how often media is submitted to the extension plugin.
- 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.
- Keyword Arguments
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.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SignalGateProcessor(*, name: str, inputs: List[azure.media.videoanalyzeredge._generated.models._models_py3.NodeInput], activation_evaluation_window: Optional[str] = None, activation_signal_offset: Optional[str] = None, minimum_activation_time: Optional[str] = None, maximum_activation_time: Optional[str] = None, **kwargs)[source]¶ 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.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
activation_evaluation_window (str) – The period of time over which the gate gathers input events before evaluating them.
activation_signal_offset (str) – 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.
minimum_activation_time (str) – 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.
maximum_activation_time (str) – 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.
- Keyword Arguments
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
activation_evaluation_window (str) – The period of time over which the gate gathers input events before evaluating them.
activation_signal_offset (str) – 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.
minimum_activation_time (str) – 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.
maximum_activation_time (str) – 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.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SinkNodeBase(*, name: str, inputs: List[azure.media.videoanalyzeredge._generated.models._models_py3.NodeInput], **kwargs)[source]¶ Base class for topology sink nodes.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: FileSink, IotHubMessageSink, VideoSink.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SourceNodeBase(*, name: str, **kwargs)[source]¶ Base class for topology source nodes.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: IotHubMessageSource, RtspSource.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
name (str) – Required. Node name. Must be unique within the topology.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation(*, extension_configuration: str, **kwargs)[source]¶ Defines a Spatial Analysis custom operation. This requires the Azure Cognitive Services Spatial analysis module to be deployed alongside the Video Analyzer module, please see https://aka.ms/ava-spatial-analysis for more information.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
extension_configuration (str) – Required. Custom configuration to pass to the Azure Cognitive Services Spatial Analysis module.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisOperationBase(**kwargs)[source]¶ Base class for Azure Cognitive Services Spatial Analysis operations.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: SpatialAnalysisCustomOperation, SpatialAnalysisTypedOperationBase.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. The Type discriminator for the derived types.Constant filled by server.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase(*, threshold: Optional[str] = None, focus: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.SpatialAnalysisOperationFocus]] = None, **kwargs)[source]¶ Defines the Azure Cognitive Services Spatial Analysis operation eventing configuration.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisOperationFocus(value)[source]¶ The operation focus type.
-
BOTTOM_CENTER= 'bottomCenter'¶ The bottom center of the object.
-
CENTER= 'center'¶ The center of the object.
-
FOOTPRINT= 'footprint'¶ The footprint.
-
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent(*, threshold: Optional[str] = None, focus: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.SpatialAnalysisOperationFocus]] = None, trigger: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.SpatialAnalysisPersonCountEventTrigger]] = None, output_frequency: Optional[str] = None, **kwargs)[source]¶ Defines a Spatial Analysis person count operation eventing configuration.
- Variables
threshold (str) – The event threshold.
focus (str or SpatialAnalysisOperationFocus) – The operation focus type. Possible values include: “center”, “bottomCenter”, “footprint”.
trigger (str or SpatialAnalysisPersonCountEventTrigger) – The event trigger type. Possible values include: “event”, “interval”.
output_frequency (str) – The event or interval output frequency.
- Keyword Arguments
threshold (str) – The event threshold.
focus (str or SpatialAnalysisOperationFocus) – The operation focus type. Possible values include: “center”, “bottomCenter”, “footprint”.
trigger (str or SpatialAnalysisPersonCountEventTrigger) – The event trigger type. Possible values include: “event”, “interval”.
output_frequency (str) – The event or interval output frequency.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEventTrigger(value)[source]¶ The event trigger type.
-
EVENT= 'event'¶ Event trigger.
-
INTERVAL= 'interval'¶ Interval trigger.
-
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation(*, zones: List[azure.media.videoanalyzeredge._generated.models._models_py3.SpatialAnalysisPersonCountZoneEvents], debug: Optional[str] = None, calibration_configuration: Optional[str] = None, camera_configuration: Optional[str] = None, camera_calibrator_node_configuration: Optional[str] = None, detector_node_configuration: Optional[str] = None, tracker_node_configuration: Optional[str] = None, enable_face_mask_classifier: Optional[str] = None, **kwargs)[source]¶ Defines a Spatial Analysis person count operation. This requires the Azure Cognitive Services Spatial analysis module to be deployed alongside the Video Analyzer module, please see https://aka.ms/ava-spatial-analysis for more information.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. The Type discriminator for the derived types.Constant filled by server.
debug (str) – If set to ‘true’, enables debugging mode for this operation.
calibration_configuration (str) – Advanced calibration configuration.
camera_configuration (str) – Advanced camera configuration.
camera_calibrator_node_configuration (str) – Advanced camera calibrator configuration.
detector_node_configuration (str) – Advanced detector node configuration.
tracker_node_configuration (str) – Advanced tracker node configuration.
enable_face_mask_classifier (str) – If set to ‘true’, enables face mask detection for this operation.
zones (list[SpatialAnalysisPersonCountZoneEvents]) – Required. The list of zones and optional events.
- Keyword Arguments
debug (str) – If set to ‘true’, enables debugging mode for this operation.
calibration_configuration (str) – Advanced calibration configuration.
camera_configuration (str) – Advanced camera configuration.
camera_calibrator_node_configuration (str) – Advanced camera calibrator configuration.
detector_node_configuration (str) – Advanced detector node configuration.
tracker_node_configuration (str) – Advanced tracker node configuration.
enable_face_mask_classifier (str) – If set to ‘true’, enables face mask detection for this operation.
zones (list[SpatialAnalysisPersonCountZoneEvents]) – Required. The list of zones and optional events.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents(*, zone: azure.media.videoanalyzeredge._generated.models._models_py3.NamedPolygonBase, events: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.SpatialAnalysisPersonCountEvent]] = None, **kwargs)[source]¶ SpatialAnalysisPersonCountZoneEvents.
All required parameters must be populated in order to send to Azure.
- Variables
zone (NamedPolygonBase) – Required. The named zone.
events (list[SpatialAnalysisPersonCountEvent]) – The event configuration.
- Keyword Arguments
zone (NamedPolygonBase) – Required. The named zone.
events (list[SpatialAnalysisPersonCountEvent]) – The event configuration.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent(*, threshold: Optional[str] = None, focus: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.SpatialAnalysisOperationFocus]] = None, trigger: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.SpatialAnalysisPersonDistanceEventTrigger]] = None, output_frequency: Optional[str] = None, minimum_distance_threshold: Optional[str] = None, maximum_distance_threshold: Optional[str] = None, **kwargs)[source]¶ Defines a Spatial Analysis person distance operation eventing configuration.
- Variables
threshold (str) – The event threshold.
focus (str or SpatialAnalysisOperationFocus) – The operation focus type. Possible values include: “center”, “bottomCenter”, “footprint”.
trigger (str or SpatialAnalysisPersonDistanceEventTrigger) – The event trigger type. Possible values include: “event”, “interval”.
output_frequency (str) – The event or interval output frequency.
minimum_distance_threshold (str) – The minimum distance threshold.
maximum_distance_threshold (str) – The maximum distance threshold.
- Keyword Arguments
threshold (str) – The event threshold.
focus (str or SpatialAnalysisOperationFocus) – The operation focus type. Possible values include: “center”, “bottomCenter”, “footprint”.
trigger (str or SpatialAnalysisPersonDistanceEventTrigger) – The event trigger type. Possible values include: “event”, “interval”.
output_frequency (str) – The event or interval output frequency.
minimum_distance_threshold (str) – The minimum distance threshold.
maximum_distance_threshold (str) – The maximum distance threshold.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEventTrigger(value)[source]¶ The event trigger type.
-
EVENT= 'event'¶ Event trigger.
-
INTERVAL= 'interval'¶ Interval trigger.
-
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation(*, zones: List[azure.media.videoanalyzeredge._generated.models._models_py3.SpatialAnalysisPersonDistanceZoneEvents], debug: Optional[str] = None, calibration_configuration: Optional[str] = None, camera_configuration: Optional[str] = None, camera_calibrator_node_configuration: Optional[str] = None, detector_node_configuration: Optional[str] = None, tracker_node_configuration: Optional[str] = None, enable_face_mask_classifier: Optional[str] = None, **kwargs)[source]¶ Defines a Spatial Analysis person distance operation. This requires the Azure Cognitive Services Spatial analysis module to be deployed alongside the Video Analyzer module, please see https://aka.ms/ava-spatial-analysis for more information.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. The Type discriminator for the derived types.Constant filled by server.
debug (str) – If set to ‘true’, enables debugging mode for this operation.
calibration_configuration (str) – Advanced calibration configuration.
camera_configuration (str) – Advanced camera configuration.
camera_calibrator_node_configuration (str) – Advanced camera calibrator configuration.
detector_node_configuration (str) – Advanced detector node configuration.
tracker_node_configuration (str) – Advanced tracker node configuration.
enable_face_mask_classifier (str) – If set to ‘true’, enables face mask detection for this operation.
zones (list[SpatialAnalysisPersonDistanceZoneEvents]) – Required. The list of zones with optional events.
- Keyword Arguments
debug (str) – If set to ‘true’, enables debugging mode for this operation.
calibration_configuration (str) – Advanced calibration configuration.
camera_configuration (str) – Advanced camera configuration.
camera_calibrator_node_configuration (str) – Advanced camera calibrator configuration.
detector_node_configuration (str) – Advanced detector node configuration.
tracker_node_configuration (str) – Advanced tracker node configuration.
enable_face_mask_classifier (str) – If set to ‘true’, enables face mask detection for this operation.
zones (list[SpatialAnalysisPersonDistanceZoneEvents]) – Required. The list of zones with optional events.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents(*, zone: azure.media.videoanalyzeredge._generated.models._models_py3.NamedPolygonBase, events: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.SpatialAnalysisPersonDistanceEvent]] = None, **kwargs)[source]¶ SpatialAnalysisPersonDistanceZoneEvents.
All required parameters must be populated in order to send to Azure.
- Variables
zone (NamedPolygonBase) – Required. The named zone.
events (list[SpatialAnalysisPersonDistanceEvent]) – The event configuration.
- Keyword Arguments
zone (NamedPolygonBase) – Required. The named zone.
events (list[SpatialAnalysisPersonDistanceEvent]) – The event configuration.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent(*, threshold: Optional[str] = None, focus: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.SpatialAnalysisOperationFocus]] = None, **kwargs)[source]¶ Defines a Spatial Analysis person line crossing operation eventing configuration.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents(*, line: azure.media.videoanalyzeredge._generated.models._models_py3.NamedLineBase, events: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.SpatialAnalysisPersonLineCrossingEvent]] = None, **kwargs)[source]¶ SpatialAnalysisPersonLineCrossingLineEvents.
All required parameters must be populated in order to send to Azure.
- Variables
line (NamedLineBase) – Required. The named line.
events (list[SpatialAnalysisPersonLineCrossingEvent]) – The event configuration.
- Keyword Arguments
line (NamedLineBase) – Required. The named line.
events (list[SpatialAnalysisPersonLineCrossingEvent]) – The event configuration.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation(*, lines: List[azure.media.videoanalyzeredge._generated.models._models_py3.SpatialAnalysisPersonLineCrossingLineEvents], debug: Optional[str] = None, calibration_configuration: Optional[str] = None, camera_configuration: Optional[str] = None, camera_calibrator_node_configuration: Optional[str] = None, detector_node_configuration: Optional[str] = None, tracker_node_configuration: Optional[str] = None, enable_face_mask_classifier: Optional[str] = None, **kwargs)[source]¶ Defines a Spatial Analysis person line crossing operation. This requires the Azure Cognitive Services Spatial analysis module to be deployed alongside the Video Analyzer module, please see https://aka.ms/ava-spatial-analysis for more information.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. The Type discriminator for the derived types.Constant filled by server.
debug (str) – If set to ‘true’, enables debugging mode for this operation.
calibration_configuration (str) – Advanced calibration configuration.
camera_configuration (str) – Advanced camera configuration.
camera_calibrator_node_configuration (str) – Advanced camera calibrator configuration.
detector_node_configuration (str) – Advanced detector node configuration.
tracker_node_configuration (str) – Advanced tracker node configuration.
enable_face_mask_classifier (str) – If set to ‘true’, enables face mask detection for this operation.
lines (list[SpatialAnalysisPersonLineCrossingLineEvents]) – Required. The list of lines with optional events.
- Keyword Arguments
debug (str) – If set to ‘true’, enables debugging mode for this operation.
calibration_configuration (str) – Advanced calibration configuration.
camera_configuration (str) – Advanced camera configuration.
camera_calibrator_node_configuration (str) – Advanced camera calibrator configuration.
detector_node_configuration (str) – Advanced detector node configuration.
tracker_node_configuration (str) – Advanced tracker node configuration.
enable_face_mask_classifier (str) – If set to ‘true’, enables face mask detection for this operation.
lines (list[SpatialAnalysisPersonLineCrossingLineEvents]) – Required. The list of lines with optional events.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent(*, threshold: Optional[str] = None, focus: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.SpatialAnalysisOperationFocus]] = None, event_type: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.SpatialAnalysisPersonZoneCrossingEventType]] = None, **kwargs)[source]¶ Defines a Spatial Analysis person crossing zone operation eventing configuration.
- Variables
threshold (str) – The event threshold.
focus (str or SpatialAnalysisOperationFocus) – The operation focus type. Possible values include: “center”, “bottomCenter”, “footprint”.
event_type (str or SpatialAnalysisPersonZoneCrossingEventType) – The event type. Possible values include: “zoneCrossing”, “zoneDwellTime”.
- Keyword Arguments
threshold (str) – The event threshold.
focus (str or SpatialAnalysisOperationFocus) – The operation focus type. Possible values include: “center”, “bottomCenter”, “footprint”.
event_type (str or SpatialAnalysisPersonZoneCrossingEventType) – The event type. Possible values include: “zoneCrossing”, “zoneDwellTime”.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEventType(value)[source]¶ The event type.
-
ZONE_CROSSING= 'zoneCrossing'¶ Zone crossing event type.
-
ZONE_DWELL_TIME= 'zoneDwellTime'¶ Zone dwell time event type.
-
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation(*, zones: List[azure.media.videoanalyzeredge._generated.models._models_py3.SpatialAnalysisPersonZoneCrossingZoneEvents], debug: Optional[str] = None, calibration_configuration: Optional[str] = None, camera_configuration: Optional[str] = None, camera_calibrator_node_configuration: Optional[str] = None, detector_node_configuration: Optional[str] = None, tracker_node_configuration: Optional[str] = None, enable_face_mask_classifier: Optional[str] = None, **kwargs)[source]¶ Defines a Spatial Analysis person zone crossing operation. This requires the Azure Cognitive Services Spatial analysis module to be deployed alongside the Video Analyzer module, please see https://aka.ms/ava-spatial-analysis for more information.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. The Type discriminator for the derived types.Constant filled by server.
debug (str) – If set to ‘true’, enables debugging mode for this operation.
calibration_configuration (str) – Advanced calibration configuration.
camera_configuration (str) – Advanced camera configuration.
camera_calibrator_node_configuration (str) – Advanced camera calibrator configuration.
detector_node_configuration (str) – Advanced detector node configuration.
tracker_node_configuration (str) – Advanced tracker node configuration.
enable_face_mask_classifier (str) – If set to ‘true’, enables face mask detection for this operation.
zones (list[SpatialAnalysisPersonZoneCrossingZoneEvents]) – Required. The list of zones with optional events.
- Keyword Arguments
debug (str) – If set to ‘true’, enables debugging mode for this operation.
calibration_configuration (str) – Advanced calibration configuration.
camera_configuration (str) – Advanced camera configuration.
camera_calibrator_node_configuration (str) – Advanced camera calibrator configuration.
detector_node_configuration (str) – Advanced detector node configuration.
tracker_node_configuration (str) – Advanced tracker node configuration.
enable_face_mask_classifier (str) – If set to ‘true’, enables face mask detection for this operation.
zones (list[SpatialAnalysisPersonZoneCrossingZoneEvents]) – Required. The list of zones with optional events.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents(*, zone: azure.media.videoanalyzeredge._generated.models._models_py3.NamedPolygonBase, events: Optional[List[azure.media.videoanalyzeredge._generated.models._models_py3.SpatialAnalysisPersonZoneCrossingEvent]] = None, **kwargs)[source]¶ SpatialAnalysisPersonZoneCrossingZoneEvents.
All required parameters must be populated in order to send to Azure.
- Variables
zone (NamedPolygonBase) – Required. The named zone.
events (list[SpatialAnalysisPersonZoneCrossingEvent]) – The event configuration.
- Keyword Arguments
zone (NamedPolygonBase) – Required. The named zone.
events (list[SpatialAnalysisPersonZoneCrossingEvent]) – The event configuration.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase(*, debug: Optional[str] = None, calibration_configuration: Optional[str] = None, camera_configuration: Optional[str] = None, camera_calibrator_node_configuration: Optional[str] = None, detector_node_configuration: Optional[str] = None, tracker_node_configuration: Optional[str] = None, enable_face_mask_classifier: Optional[str] = None, **kwargs)[source]¶ Base class for Azure Cognitive Services Spatial Analysis typed operations.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: SpatialAnalysisPersonCountOperation, SpatialAnalysisPersonDistanceOperation, SpatialAnalysisPersonLineCrossingOperation, SpatialAnalysisPersonZoneCrossingOperation.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. The Type discriminator for the derived types.Constant filled by server.
debug (str) – If set to ‘true’, enables debugging mode for this operation.
calibration_configuration (str) – Advanced calibration configuration.
camera_configuration (str) – Advanced camera configuration.
camera_calibrator_node_configuration (str) – Advanced camera calibrator configuration.
detector_node_configuration (str) – Advanced detector node configuration.
tracker_node_configuration (str) – Advanced tracker node configuration.
enable_face_mask_classifier (str) – If set to ‘true’, enables face mask detection for this operation.
- Keyword Arguments
debug (str) – If set to ‘true’, enables debugging mode for this operation.
calibration_configuration (str) – Advanced calibration configuration.
camera_configuration (str) – Advanced camera configuration.
camera_calibrator_node_configuration (str) – Advanced camera calibrator configuration.
detector_node_configuration (str) – Advanced detector node configuration.
tracker_node_configuration (str) – Advanced tracker node configuration.
enable_face_mask_classifier (str) – If set to ‘true’, enables face mask detection for this operation.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SymmetricKeyCredentials(*, key: str, **kwargs)[source]¶ Symmetric key credential.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
key (str) – Required. Symmetric key credential.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.SystemData(*, created_at: Optional[datetime.datetime] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶ Read-only system metadata associated with a resource.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.TlsEndpoint(*, url: str, credentials: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.CredentialsBase] = None, trusted_certificates: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.CertificateSource] = None, validation_options: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.TlsValidationOptions] = None, **kwargs)[source]¶ TLS endpoint describes an endpoint that the pipeline can connect to over TLS transport (data is encrypted in transit).
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
credentials (CredentialsBase) – Credentials to be presented to the endpoint.
url (str) – Required. The endpoint URL for Video Analyzer to connect to.
trusted_certificates (CertificateSource) – List of trusted certificate authorities when authenticating a TLS connection. A null list designates that Azure Video Analyzer’s list of trusted authorities should be used.
validation_options (TlsValidationOptions) – Validation options to use when authenticating a TLS connection. By default, strict validation is used.
- Keyword Arguments
credentials (CredentialsBase) – Credentials to be presented to the endpoint.
url (str) – Required. The endpoint URL for Video Analyzer to connect to.
trusted_certificates (CertificateSource) – List of trusted certificate authorities when authenticating a TLS connection. A null list designates that Azure Video Analyzer’s list of trusted authorities should be used.
validation_options (TlsValidationOptions) – Validation options to use when authenticating a TLS connection. By default, strict validation is used.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.TlsValidationOptions(*, ignore_hostname: Optional[str] = None, ignore_signature: Optional[str] = None, **kwargs)[source]¶ Options for controlling the validation of TLS endpoints.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.UnsecuredEndpoint(*, url: str, credentials: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.CredentialsBase] = None, **kwargs)[source]¶ Unsecured endpoint describes an endpoint that the pipeline can connect to over clear transport (no encryption in transit).
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
credentials (CredentialsBase) – Credentials to be presented to the endpoint.
url (str) – Required. The endpoint URL for Video Analyzer to connect to.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.UsernamePasswordCredentials(*, username: str, password: str, **kwargs)[source]¶ Username and password credentials.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
username (str) – Required. Username to be presented as part of the credentials.
password (str) – Required. Password to be presented as part of the credentials. It is recommended that this value is parameterized as a secret string in order to prevent this value to be returned as part of the resource on API requests.
- Keyword Arguments
username (str) – Required. Username to be presented as part of the credentials.
password (str) – Required. Password to be presented as part of the credentials. It is recommended that this value is parameterized as a secret string in order to prevent this value to be returned as part of the resource on API requests.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.VideoCreationProperties(*, title: Optional[str] = None, description: Optional[str] = None, segment_length: Optional[str] = None, retention_period: Optional[str] = None, **kwargs)[source]¶ Optional video properties to be used in case a new video resource needs to be created on the service. These will not take effect if the video already exists.
- Variables
title (str) – Optional video title provided by the user. Value can be up to 256 characters long.
description (str) – Optional video description provided by the user. Value can be up to 2048 characters long.
segment_length (str) – Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. “PT30S” equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments. Changing this value after the video is initially created can lead to errors when uploading media to the archive. Default value is 30 seconds.
retention_period (str) – Video retention period indicates how long the video is kept in storage, and must be a multiple of 1 day. For example, if this is set to 30 days, then content older than 30 days will be deleted.
- Keyword Arguments
title (str) – Optional video title provided by the user. Value can be up to 256 characters long.
description (str) – Optional video description provided by the user. Value can be up to 2048 characters long.
segment_length (str) – Video segment length indicates the length of individual video files (segments) which are persisted to storage. Smaller segments provide lower archive playback latency but generate larger volume of storage transactions. Larger segments reduce the amount of storage transactions while increasing the archive playback latency. Value must be specified in ISO8601 duration format (i.e. “PT30S” equals 30 seconds) and can vary between 30 seconds to 5 minutes, in 30 seconds increments. Changing this value after the video is initially created can lead to errors when uploading media to the archive. Default value is 30 seconds.
retention_period (str) – Video retention period indicates how long the video is kept in storage, and must be a multiple of 1 day. For example, if this is set to 30 days, then content older than 30 days will be deleted.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.VideoEncoderConfiguration(*, encoding: Optional[Union[str, azure.media.videoanalyzeredge._generated.models._azure_video_analyzerfor_edge_enums.VideoEncoding]] = None, quality: Optional[float] = None, resolution: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.VideoResolution] = None, rate_control: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.RateControl] = None, h264: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.H264Configuration] = None, mpeg4: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.MPEG4Configuration] = None, **kwargs)[source]¶ Class representing the MPEG4 Configuration.
- Variables
encoding (str or VideoEncoding) – The video codec used by the Media Profile. Possible values include: “JPEG”, “H264”, “MPEG4”.
quality (float) – Relative value representing the quality of the video.
resolution (VideoResolution) – The Video Resolution.
rate_control (RateControl) – The Video’s rate control.
h264 (H264Configuration) – The H264 Configuration.
mpeg4 (MPEG4Configuration) – The H264 Configuration.
- Keyword Arguments
encoding (str or VideoEncoding) – The video codec used by the Media Profile. Possible values include: “JPEG”, “H264”, “MPEG4”.
quality (float) – Relative value representing the quality of the video.
resolution (VideoResolution) – The Video Resolution.
rate_control (RateControl) – The Video’s rate control.
h264 (H264Configuration) – The H264 Configuration.
mpeg4 (MPEG4Configuration) – The H264 Configuration.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.VideoEncoding(value)[source]¶ The video codec used by the Media Profile.
-
H264= 'H264'¶ The Media Profile uses H264 encoding.
-
JPEG= 'JPEG'¶ The Media Profile uses JPEG encoding.
-
MPEG4= 'MPEG4'¶ The Media Profile uses MPEG4 encoding.
-
-
class
azure.media.videoanalyzeredge.VideoPublishingOptions(*, enable_video_preview_image: Optional[str] = None, **kwargs)[source]¶ Options for changing video publishing behavior on the video sink and output video.
- Variables
enable_video_preview_image (str) – When set to ‘true’ the video will publish preview images. Default is ‘false’.
- Keyword Arguments
enable_video_preview_image (str) – When set to ‘true’ the video will publish preview images. Default is ‘false’.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.VideoResolution(*, width: Optional[float] = None, height: Optional[float] = None, **kwargs)[source]¶ The Video resolution.
- Variables
- Keyword Arguments
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
-
class
azure.media.videoanalyzeredge.VideoSink(*, name: str, inputs: List[azure.media.videoanalyzeredge._generated.models._models_py3.NodeInput], video_name: str, local_media_cache_path: str, local_media_cache_maximum_size_mi_b: str, video_creation_properties: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.VideoCreationProperties] = None, video_publishing_options: Optional[azure.media.videoanalyzeredge._generated.models._models_py3.VideoPublishingOptions] = None, **kwargs)[source]¶ Video sink allows for video and audio to be recorded to the Video Analyzer service. The recorded video can be played from anywhere and further managed from the cloud. Due to security reasons, a given Video Analyzer edge module instance can only record content to new video entries, or existing video entries previously recorded by the same module. Any attempt to record content to an existing video which has not been created by the same module instance will result in failure to record.
All required parameters must be populated in order to send to Azure.
- Variables
type (str) – Required. Type discriminator for the derived types.Constant filled by server.
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
video_name (str) – Required. Name of a new or existing Video Analyzer video resource used for the media recording.
video_creation_properties (VideoCreationProperties) – Optional video properties to be used in case a new video resource needs to be created on the service.
video_publishing_options (VideoPublishingOptions) – Optional video publishing options to be used for changing publishing behavior of the output video.
local_media_cache_path (str) – Required. Path to a local file system directory for caching of temporary media files. This will also be used to store content which cannot be immediately uploaded to Azure due to Internet connectivity issues.
local_media_cache_maximum_size_mi_b (str) – Required. Maximum amount of disk space that can be used for caching of temporary media files. Once this limit is reached, the oldest segments of the media archive will be continuously deleted in order to make space for new media, thus leading to gaps in the cloud recorded content.
- Keyword Arguments
name (str) – Required. Node name. Must be unique within the topology.
inputs (list[NodeInput]) – Required. An array of upstream node references within the topology to be used as inputs for this node.
video_name (str) – Required. Name of a new or existing Video Analyzer video resource used for the media recording.
video_creation_properties (VideoCreationProperties) – Optional video properties to be used in case a new video resource needs to be created on the service.
video_publishing_options (VideoPublishingOptions) – Optional video publishing options to be used for changing publishing behavior of the output video.
local_media_cache_path (str) – Required. Path to a local file system directory for caching of temporary media files. This will also be used to store content which cannot be immediately uploaded to Azure due to Internet connectivity issues.
local_media_cache_maximum_size_mi_b (str) – Required. Maximum amount of disk space that can be used for caching of temporary media files. Once this limit is reached, the oldest segments of the media archive will be continuously deleted in order to make space for new media, thus leading to gaps in the cloud recorded content.
-
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)¶ Return a dict that can be JSONify using json.dump.
Advanced usage might optionaly use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
- Parameters
key_transformer (function) – A key transformer function.
- Returns
A dict JSON compatible object
- Return type
-
classmethod
deserialize(data, content_type=None)¶ Parse a str using the RestAPI syntax and return a model.
-
classmethod
enable_additional_properties_sending()¶
-
classmethod
from_dict(data, key_extractors=None, content_type=None)¶ Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
-
classmethod
is_xml_model()¶
-
serialize(keep_readonly=False, **kwargs)¶ Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.