Package: azure-media-videoanalyzer-edge
Azure Video Analyzer Edge client library for PythonDeprecated. We’re retiring the Azure Video Analyzer preview service, you're advised to transition your applications off of Video Analyzer by 01 December 2022. This SDK is not longer maintained.Azure Video Analyzer is anAzure Applied AI Servicethat provides a platform for you to build intelligent video applications that can span both edge and cloud infrastructures. The platform offers the capability to capture, record, and analyze live video along with publishing the results, video and video analytics, to Azure services at the edge or in the cloud. It is designed to be an extensible platform, enabling you to connect different video inferencing edge modules such as Cognitive services modules, or custom inferencing modules that have been trained with your own data using either open-source machine learning orAzure Machine Learning.Use the client library for Video Analyzer Edge to:Simplify interactions with theMicrosoft Azure IoT SDKsProgrammatically construct pipeline topologies and live pipelinesPackage (PyPI)|Product documentation|Direct methods|Pipelines|Source code|SamplesGetting startedInstall the packageInstall the Video Analyzer Edge client library for Python with pip:pipinstallazure-media-videoanalyzer-edgePrerequisitesPython 2.7, or 3.6 or later is required to use this package.You need an activeAzure subscription, and a IoT device connection string to use this package.To interact with Azure IoT Hub you will need to runpip install azure-iot-hubYou will need to use the version of the SDK that corresponds to the version of the Video Analyzer Edge module you are using.SDKVideo Analyzer edge module1.0.0b31.11.0.0b21.01.0.0b11.0Creating a pipeline topology and making requestsPlease visit theExamplesfor starter code.Key conceptsPipeline topology vs live pipelineApipeline topologyis a blueprint or template for creating live pipelines. It defines the parameters of the pipeline using placeholders as values for them. Alive pipelinereferences a pipeline topology and specifies the parameters. This way you are able to have multiple live pipelines referencing the same topology but with different values for parameters. For more information please visitpipeline topologies and live pipelines.CloudToDeviceMethodTheCloudToDeviceMethodis part of theazure-iot-hub SDk. This method allows you to communicate one way notifications to a device in your IoT hub. In our case, we want to communicate various direct methods such asPipelineTopologySetRequestandPipelineTopologyGetRequest. To useCloudToDeviceMethodyou need to pass in two parameters:method_nameandpayload.The first parameter,method_name, is the name of the direct method request you are sending. Make sure to use each method's predefinedmethod_nameproperty. For example,PipelineTopologySetRequest.method_name.The second parameter,payload, sends the entire serialization of the pipeline topology request. For example,PipelineTopologySetRequest.serialize()ExamplesCreating a pipeline topologyTo create a pipeline topology you need to define sources and sinks.#Parametersuser_name_param=ParameterDeclaration(name="rtspUserName",type="String",default="testusername")password_param=ParameterDeclaration(name="rtspPassword",type="SecretString",default="testpassword")url_param=ParameterDeclaration(name="rtspUrl",type="String",default="rtsp://www.sample.com")#Source and Sinksource=RtspSource(name="rtspSource",endpoint=UnsecuredEndpoint(url="${rtspUrl}",credentials=UsernamePasswordCredentials(username="${rtspUserName}",password="${rtspPassword}")))node=NodeInput(node_name="rtspSource")sink=VideoSink(name="videoSink",inputs=[node],video_name="video",local_media_cache_path="/var/lib/videoanalyzer/tmp/",local_media_cache_maximum_size_mi_b="1024");pipeline_topology_properties=PipelineTopologyProperties()pipeline_topology_properties.parameters=[user_name_param,password_param,url_param]pipeline_topology_properties.sources=[source]pipeline_topology_properties.sinks=[sink]pipeline_topology=PipelineTopology(name=pipeline_topology_name,properties=pipeline_topology_properties)Creating a live pipelineTo create a live pipeline, you need to have an existing pipeline topology.url_param=ParameterDefinition(name="rtspUrl",value=pipeline_url)pass_param=ParameterDefinition(name="rtspPassword",value="secret_password")live_pipeline_properties=LivePipelineProperties(description="Sample pipeline description",topology_name=pipeline_topology_name,parameters=[url_param])live_pipeline=LivePipeline(name=live_pipeline_name,properties=live_pipeline_properties)Invoking a direct methodTo invoke a direct method on your device you need to first define the request using the Video Analyzer Edge SDK, then send that method request using the IoT SDK'sCloudToDeviceMethod.set_method_request=PipelineTopologySetRequest(pipeline_topology=pipeline_topology)direct_method=CloudToDeviceMethod(method_name=set_method_request.method_name,payload=set_method_request.serialize())registry_manager=IoTHubRegistryManager(connection_string)registry_manager.invoke_device_module_method(device_id,module_d,direct_method)To try different pipeline topologies with the SDK, please see the officialSamples.TroubleshootingWhen sending a method request using the IoT Hub'sCloudToDeviceMethodremember to not type in the method request name directly. Instead use[MethodRequestName.method_name]Make sure to serialize the entire method request before passing it toCloudToDeviceMethodNext stepsSamplesAzure IoT Device SDKAzure IoTHub Service SDKContributingThis project welcomes contributions and suggestions. Most contributions require
you to agree to a Contributor License Agreement (CLA) declaring that you have
the right to, and actually do, grant us the rights to use your contribution.
For details, visithttps://cla.microsoft.com.If you encounter any issues, please open an issue on ourGithub.When you submit a pull request, a CLA-bot will automatically determine whether
you need to provide a CLA and decorate the PR appropriately (e.g., label,
comment). Simply follow the instructions provided by the bot. You will only
need to do this once across all repos using our CLA.This project has adopted theMicrosoft Open Source Code of Conduct. For more information,
see the Code of Conduct FAQ or contactopencode@microsoft.comwith any
additional questions or comments.Release History1.0.0b4 (2022-04-29)Other ChangesDeprecated. We’re retiring the Azure Video Analyzer preview service, you're advised to transition your applications off of Video Analyzer by 01 December 2022. This SDK is not longer maintained.1.0.0b3 (2021-11-09)Added device discovery and device detail request for ONVIF enabled devices.Added Remote Device Adapter configuration for ingesting video in a private networkAdded retention policy to VideoSink1.0.0b2 (2021-05-19)Updated the title and description of the package.1.0.0b1 (2021-05-19)Initial release