[Media] Added new LVA Edge SDK

sdk/media/azure-media-lva-edge/CHANGELOG.md

@@ -0,0 +1,8 @@
+
+# Release History
+
+-------------------
+
+## 0.0.1 (Unreleased)
+
+- Training day!

sdk/media/azure-media-lva-edge/MANIFEST.in

@@ -0,0 +1,4 @@
+recursive-include tests *.py
+include *.md
+include azure/__init__.py
+recursive-include samples *.py *.md

sdk/media/azure-media-lva-edge/README.md

@@ -0,0 +1,127 @@
+# Azure Live Video Analytics for IoT Edge client library for Python
+
+Live Video Analytics on IoT Edge provides a platform to build intelligent video applications that span the edge and the cloud. The platform offers the capability to capture, record, and analyze live video along with publishing the results, video and video analytics, to Azure services in the cloud or the edge. It is designed to be an extensible platform, enabling you to connect different video analysis edge modules (such as Cognitive services containers, custom edge modules built by you with open-source machine learning models or custom models trained with your own data) to it and use them to analyze live video without worrying about the complexity of building and running a live video pipeline.
+
+Use the client library for Live Video Analytics on IoT Edge to:
+
+- Simplify interactions with the [Microsoft Azure IoT SDKs](https://github.com/azure/azure-iot-sdks) 
+- Programatically construct media graph topologies and instances
+
+[Package (PyPi)][package] | [Product documentation][doc_product] | [Direct methods][doc_direct_methods] | [Media graphs][doc_media_graph] | [Source code][source] | [Samples][samples]
+
+## Getting started
+
+### Install the package
+
+Install the Live Video Analytics client library for Python with pip:
+
+```bash
+pip install azure-lva-edge
+```
+### Prerequisites
+
+* Python 2.7, or 3.5 or later is required to use this package.
+* You need an [Azure subscription][azure_sub], and a [IOT device connection string][iot_device_connection_string] to use this package.
+
+### Creating a graph topology and making requests
+Please visit the [Examples](#examples) for starter code
+## Key concepts
+
+### Graph Topology vs Graph Instance
+A graph topology is essentially the blueprint or template of a graph. It defines the parameters of the graph using placeholders as values for them. A graph instance references a graph topology and specifies the parameters. This way you are able to have multiple graph instances referencing the same topology but with different values for parameters. For more information please visit [Media graph topologies and instances][doc_media_graph] 
+
+### CloudToDeviceMethod
+
+The `CloudToDeviceMethod` is part of the azure-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 graph methods such as `MediaGraphTopologySetRequest` and `MediaGraphTopologyGetRequest`. To use `CloudToDeviceMethod` you need to pass in two parameters: `method_name` and `payload`. `method_name` should be the name of the media graph request you are sending. Each media graph request has a property called `method_name`. For example, `MediaGraphTopologySetRequest.method_name`. For the second parameter `payload` send the entire serialization of the media graph request. For example, `MediaGraphTopologySetRequest.serialize()`
+
+## Examples
+
+### Creating a graph topology
+To create a graph topology you need to define parameters, sources, and sinks.
+```
+#Parameters
+user_name_param = MediaGraphParameterDeclaration(name="rtspUserName",type="String",default="dummyusername")
+password_param = MediaGraphParameterDeclaration(name="rtspPassword",type="String",default="dummypassword")
+url_param = MediaGraphParameterDeclaration(name="rtspUrl",type="String",default="rtsp://www.sample.com")
+
+#Source and Sink
+source = MediaGraphRtspSource(name="rtspSource", endpoint=MediaGraphUnsecuredEndpoint(url="${rtspUrl}",credentials=MediaGraphUsernamePasswordCredentials(username="${rtspUserName}",password="${rtspPassword}")))
+node = MediaGraphNodeInput(node_name="rtspSource")
+sink = MediaGraphAssetSink(name="assetsink", inputs=[node],asset_name_pattern='sampleAsset-${System.GraphTopologyName}-${System.GraphInstanceName}', segment_length="PT0H0M30S",local_media_cache_maximum_size_mi_b=2048,local_media_cache_path="/var/lib/azuremediaservices/tmp/")
+
+graph_properties = MediaGraphTopologyProperties(parameters=[user_name_param, password_param, url_param], sources=[source], sinks=[sink], description="Continuous video recording to an Azure Media Services Asset")
+
+graph_topology = MediaGraphTopology(name=graph_topology_name,properties=graph_properties)
+
+```
+
+### Creating a graph instance 
+To create a graph instance, you need to have an existing graph topology.
+```
+url_param = MediaGraphParameterDefinition(name="rtspUrl", value=graph_url)
+graph_instance_properties = MediaGraphInstanceProperties(description="Sample graph description", topology_name=graph_topology_name, parameters=[url_param])
+
+graph_instance = MediaGraphInstance(name=graph_instance_name, properties=graph_instance_properties)
+
+```
+
+### Invoking a graph method request
+To invoke a graph method on your device you need to first define the request using the lva sdk. Then send that method request using the iot sdk's `CloudToDeviceMethod`
+```
+set_method_request = MediaGraphTopologySetRequest(graph=graph_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)
+```
+
+For more samples please visit [Samples][samples].
+
+## Troubleshooting
+
+- When sending a method request using the IoT Hub's `CloudToDeviceMethod` remember 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 to `CloudToDeviceMethod`
+
+## Next steps
+
+- [Samples][samples]
+- [Azure IoT Device SDK][iot-device-sdk]
+- [Azure IoTHub Service SDK][iot-hub-sdk]
+
+## Contributing
+
+This 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, visit https://cla.microsoft.com.
+
+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 the
+[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information,
+see the Code of Conduct FAQ or contact [email protected] with any
+additional questions or comments.
+
+<!-- LINKS -->
+[azure_cli]: https://docs.microsoft.com/cli/azure
+[azure_sub]: https://azure.microsoft.com/free/
+
+[cla]: https://cla.microsoft.com
+[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
+[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
+[coc_contact]: mailto:[email protected]
+
+[package]: TODO://link-to-published-package
+[source]: TODO://link-to-path-in-the-SDK-repo
+[samples]: https://github.com/Azure-Samples/live-video-analytics-iot-edge-python
+
+[doc_direct_methods]: https://docs.microsoft.com/azure/media-services/live-video-analytics-edge/direct-methods
+[doc_media_graph]: https://docs.microsoft.com/azure/media-services/live-video-analytics-edge/media-graph-concept#media-graph-topologies-and-instances
+[doc_product]: https://docs.microsoft.com/azure/media-services/live-video-analytics-edge/
+
+[iot-device-sdk]: https://pypi.org/project/azure-iot-device/
+[iot-hub-sdk]: https://pypi.org/project/azure-iot-hub/
+[iot_device_connection_string]: https://docs.microsoft.com/azure/media-services/live-video-analytics-edge/get-started-detect-motion-emit-events-quickstart

sdk/media/azure-media-lva-edge/azure/__init__.py

@@ -0,0 +1,7 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------
+
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)

sdk/media/azure-media-lva-edge/azure/media/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__('pkgutil').extend_path(__path__, __name__)

sdk/media/azure-media-lva-edge/azure/media/lva/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__('pkgutil').extend_path(__path__, __name__)

sdk/media/azure-media-lva-edge/azure/media/lva/edge/__init__.py

@@ -0,0 +1,21 @@
+__path__ = __import__('pkgutil').extend_path(__path__, __name__)  # type: ignore
+from azure.media.lva.edge._generated.models import (MediaGraphTopologySetRequestBody,
+MediaGraphTopologySetRequest, MediaGraphInstanceSetRequest, MediaGraphInstanceSetRequestBody)
+
+def _OverrideTopologySetRequestSerialize(self):
+    graph_body = MediaGraphTopologySetRequestBody(name=self.graph.name)
+    graph_body.system_data = self.graph.system_data
+    graph_body.properties = self.graph.properties
+
+    return graph_body.serialize()
+
+MediaGraphTopologySetRequest.serialize = _OverrideTopologySetRequestSerialize
+
+def _OverrideInstanceSetRequestSerialize(self):
+    graph_body = MediaGraphInstanceSetRequestBody(name=self.instance.name)
+    graph_body.system_data = self.instance.system_data
+    graph_body.properties = self.instance.properties
+
+    return graph_body.serialize()
+
+MediaGraphInstanceSetRequest.serialize = _OverrideInstanceSetRequestSerialize

sdk/media/azure-media-lva-edge/azure/media/lva/edge/_generated/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__('pkgutil').extend_path(__path__, __name__)  # type: ignore

sdk/media/azure-media-lva-edge/azure/media/lva/edge/_generated/_version.py

@@ -0,0 +1,9 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+
+VERSION = "1.0"

sdk/media/azure-media-lva-edge/azure/media/lva/edge/_generated/models/__init__.py

@@ -0,0 +1,199 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+
+try:
+    from ._models_py3 import ItemNonSetRequestBase
+    from ._models_py3 import MediaGraphAssetSink
+    from ._models_py3 import MediaGraphCertificateSource
+    from ._models_py3 import MediaGraphCognitiveServicesVisionExtension
+    from ._models_py3 import MediaGraphCredentials
+    from ._models_py3 import MediaGraphEndpoint
+    from ._models_py3 import MediaGraphExtensionProcessorBase
+    from ._models_py3 import MediaGraphFileSink
+    from ._models_py3 import MediaGraphFrameRateFilterProcessor
+    from ._models_py3 import MediaGraphGrpcExtension
+    from ._models_py3 import MediaGraphGrpcExtensionDataTransfer
+    from ._models_py3 import MediaGraphHttpExtension
+    from ._models_py3 import MediaGraphHttpHeaderCredentials
+    from ._models_py3 import MediaGraphImage
+    from ._models_py3 import MediaGraphImageFormat
+    from ._models_py3 import MediaGraphImageFormatEncoded
+    from ._models_py3 import MediaGraphImageFormatRaw
+    from ._models_py3 import MediaGraphImageScale
+    from ._models_py3 import MediaGraphInstance
+    from ._models_py3 import MediaGraphInstanceActivateRequest
+    from ._models_py3 import MediaGraphInstanceCollection
+    from ._models_py3 import MediaGraphInstanceDeActivateRequest
+    from ._models_py3 import MediaGraphInstanceDeleteRequest
+    from ._models_py3 import MediaGraphInstanceGetRequest
+    from ._models_py3 import MediaGraphInstanceListRequest
+    from ._models_py3 import MediaGraphInstanceProperties
+    from ._models_py3 import MediaGraphInstanceSetRequest
+    from ._models_py3 import MediaGraphInstanceSetRequestBody
+    from ._models_py3 import MediaGraphIoTHubMessageSink
+    from ._models_py3 import MediaGraphIoTHubMessageSource
+    from ._models_py3 import MediaGraphMotionDetectionProcessor
+    from ._models_py3 import MediaGraphNodeInput
+    from ._models_py3 import MediaGraphOutputSelector
+    from ._models_py3 import MediaGraphParameterDeclaration
+    from ._models_py3 import MediaGraphParameterDefinition
+    from ._models_py3 import MediaGraphPemCertificateList
+    from ._models_py3 import MediaGraphProcessor
+    from ._models_py3 import MediaGraphRtspSource
+    from ._models_py3 import MediaGraphSignalGateProcessor
+    from ._models_py3 import MediaGraphSink
+    from ._models_py3 import MediaGraphSource
+    from ._models_py3 import MediaGraphSystemData
+    from ._models_py3 import MediaGraphTlsEndpoint
+    from ._models_py3 import MediaGraphTlsValidationOptions
+    from ._models_py3 import MediaGraphTopology
+    from ._models_py3 import MediaGraphTopologyCollection
+    from ._models_py3 import MediaGraphTopologyDeleteRequest
+    from ._models_py3 import MediaGraphTopologyGetRequest
+    from ._models_py3 import MediaGraphTopologyListRequest
+    from ._models_py3 import MediaGraphTopologyProperties
+    from ._models_py3 import MediaGraphTopologySetRequest
+    from ._models_py3 import MediaGraphTopologySetRequestBody
+    from ._models_py3 import MediaGraphUnsecuredEndpoint
+    from ._models_py3 import MediaGraphUsernamePasswordCredentials
+    from ._models_py3 import OperationBase
+except (SyntaxError, ImportError):
+    from ._models import ItemNonSetRequestBase  # type: ignore
+    from ._models import MediaGraphAssetSink  # type: ignore
+    from ._models import MediaGraphCertificateSource  # type: ignore
+    from ._models import MediaGraphCognitiveServicesVisionExtension  # type: ignore
+    from ._models import MediaGraphCredentials  # type: ignore
+    from ._models import MediaGraphEndpoint  # type: ignore
+    from ._models import MediaGraphExtensionProcessorBase  # type: ignore
+    from ._models import MediaGraphFileSink  # type: ignore
+    from ._models import MediaGraphFrameRateFilterProcessor  # type: ignore
+    from ._models import MediaGraphGrpcExtension  # type: ignore
+    from ._models import MediaGraphGrpcExtensionDataTransfer  # type: ignore
+    from ._models import MediaGraphHttpExtension  # type: ignore
+    from ._models import MediaGraphHttpHeaderCredentials  # type: ignore
+    from ._models import MediaGraphImage  # type: ignore
+    from ._models import MediaGraphImageFormat  # type: ignore
+    from ._models import MediaGraphImageFormatEncoded  # type: ignore
+    from ._models import MediaGraphImageFormatRaw  # type: ignore
+    from ._models import MediaGraphImageScale  # type: ignore
+    from ._models import MediaGraphInstance  # type: ignore
+    from ._models import MediaGraphInstanceActivateRequest  # type: ignore
+    from ._models import MediaGraphInstanceCollection  # type: ignore
+    from ._models import MediaGraphInstanceDeActivateRequest  # type: ignore
+    from ._models import MediaGraphInstanceDeleteRequest  # type: ignore
+    from ._models import MediaGraphInstanceGetRequest  # type: ignore
+    from ._models import MediaGraphInstanceListRequest  # type: ignore
+    from ._models import MediaGraphInstanceProperties  # type: ignore
+    from ._models import MediaGraphInstanceSetRequest  # type: ignore
+    from ._models import MediaGraphInstanceSetRequestBody  # type: ignore
+    from ._models import MediaGraphIoTHubMessageSink  # type: ignore
+    from ._models import MediaGraphIoTHubMessageSource  # type: ignore
+    from ._models import MediaGraphMotionDetectionProcessor  # type: ignore
+    from ._models import MediaGraphNodeInput  # type: ignore
+    from ._models import MediaGraphOutputSelector  # type: ignore
+    from ._models import MediaGraphParameterDeclaration  # type: ignore
+    from ._models import MediaGraphParameterDefinition  # type: ignore
+    from ._models import MediaGraphPemCertificateList  # type: ignore
+    from ._models import MediaGraphProcessor  # type: ignore
+    from ._models import MediaGraphRtspSource  # type: ignore
+    from ._models import MediaGraphSignalGateProcessor  # type: ignore
+    from ._models import MediaGraphSink  # type: ignore
+    from ._models import MediaGraphSource  # type: ignore
+    from ._models import MediaGraphSystemData  # type: ignore
+    from ._models import MediaGraphTlsEndpoint  # type: ignore
+    from ._models import MediaGraphTlsValidationOptions  # type: ignore
+    from ._models import MediaGraphTopology  # type: ignore
+    from ._models import MediaGraphTopologyCollection  # type: ignore
+    from ._models import MediaGraphTopologyDeleteRequest  # type: ignore
+    from ._models import MediaGraphTopologyGetRequest  # type: ignore
+    from ._models import MediaGraphTopologyListRequest  # type: ignore
+    from ._models import MediaGraphTopologyProperties  # type: ignore
+    from ._models import MediaGraphTopologySetRequest  # type: ignore
+    from ._models import MediaGraphTopologySetRequestBody  # type: ignore
+    from ._models import MediaGraphUnsecuredEndpoint  # type: ignore
+    from ._models import MediaGraphUsernamePasswordCredentials  # type: ignore
+    from ._models import OperationBase  # type: ignore
+
+from ._definitionsfor_live_video_analyticson_io_tedge_enums import (
+    MediaGraphGrpcExtensionDataTransferMode,
+    MediaGraphImageEncodingFormat,
+    MediaGraphImageFormatRawPixelFormat,
+    MediaGraphImageScaleMode,
+    MediaGraphInstanceState,
+    MediaGraphMotionDetectionSensitivity,
+    MediaGraphOutputSelectorOperator,
+    MediaGraphParameterType,
+    MediaGraphRtspTransport,
+)
+
+__all__ = [
+    'ItemNonSetRequestBase',
+    'MediaGraphAssetSink',
+    'MediaGraphCertificateSource',
+    'MediaGraphCognitiveServicesVisionExtension',
+    'MediaGraphCredentials',
+    'MediaGraphEndpoint',
+    'MediaGraphExtensionProcessorBase',
+    'MediaGraphFileSink',
+    'MediaGraphFrameRateFilterProcessor',
+    'MediaGraphGrpcExtension',
+    'MediaGraphGrpcExtensionDataTransfer',
+    'MediaGraphHttpExtension',
+    'MediaGraphHttpHeaderCredentials',
+    'MediaGraphImage',
+    'MediaGraphImageFormat',
+    'MediaGraphImageFormatEncoded',
+    'MediaGraphImageFormatRaw',
+    'MediaGraphImageScale',
+    'MediaGraphInstance',
+    'MediaGraphInstanceActivateRequest',
+    'MediaGraphInstanceCollection',
+    'MediaGraphInstanceDeActivateRequest',
+    'MediaGraphInstanceDeleteRequest',
+    'MediaGraphInstanceGetRequest',
+    'MediaGraphInstanceListRequest',
+    'MediaGraphInstanceProperties',
+    'MediaGraphInstanceSetRequest',
+    'MediaGraphInstanceSetRequestBody',
+    'MediaGraphIoTHubMessageSink',
+    'MediaGraphIoTHubMessageSource',
+    'MediaGraphMotionDetectionProcessor',
+    'MediaGraphNodeInput',
+    'MediaGraphOutputSelector',
+    'MediaGraphParameterDeclaration',
+    'MediaGraphParameterDefinition',
+    'MediaGraphPemCertificateList',
+    'MediaGraphProcessor',
+    'MediaGraphRtspSource',
+    'MediaGraphSignalGateProcessor',
+    'MediaGraphSink',
+    'MediaGraphSource',
+    'MediaGraphSystemData',
+    'MediaGraphTlsEndpoint',
+    'MediaGraphTlsValidationOptions',
+    'MediaGraphTopology',
+    'MediaGraphTopologyCollection',
+    'MediaGraphTopologyDeleteRequest',
+    'MediaGraphTopologyGetRequest',
+    'MediaGraphTopologyListRequest',
+    'MediaGraphTopologyProperties',
+    'MediaGraphTopologySetRequest',
+    'MediaGraphTopologySetRequestBody',
+    'MediaGraphUnsecuredEndpoint',
+    'MediaGraphUsernamePasswordCredentials',
+    'OperationBase',
+    'MediaGraphGrpcExtensionDataTransferMode',
+    'MediaGraphImageEncodingFormat',
+    'MediaGraphImageFormatRawPixelFormat',
+    'MediaGraphImageScaleMode',
+    'MediaGraphInstanceState',
+    'MediaGraphMotionDetectionSensitivity',
+    'MediaGraphOutputSelectorOperator',
+    'MediaGraphParameterType',
+    'MediaGraphRtspTransport',
+]