|
1 | 1 | # Azure Live Video Analytics for IoT Edge client library for Python |
2 | 2 |
|
3 | | -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. |
4 | | - |
5 | | -Use the client library for Live Video Analytics on IoT Edge to: |
6 | | - |
7 | | -- Simplify interactions with the [Microsoft Azure IoT SDKs](https://github.com/azure/azure-iot-sdks) |
8 | | -- Programatically construct media graph topologies and instances |
9 | | - |
10 | | -[Package (PyPI)][package] | [Product documentation][doc_product] | [Direct methods][doc_direct_methods] | [Media graphs][doc_media_graph] | [Source code][source] | [Samples][samples] |
11 | | - |
12 | | -## Getting started |
13 | | - |
14 | | -### Install the package |
15 | | - |
16 | | -Install the Live Video Analytics client library for Python with pip: |
17 | | - |
18 | | -```bash |
19 | | -pip install azure-media-analytics-edge |
20 | | -``` |
21 | | -### Prerequisites |
22 | | - |
23 | | -* Python 2.7, or 3.5 or later is required to use this package. |
24 | | -* You need an active [Azure subscription][azure_sub], and a [IoT device connection string][iot_device_connection_string] to use this package. |
25 | | -* To interact with Azure IoT Hub you will need to run `pip install azure-iot-hub` |
26 | | -* You will need to use the version of the SDK that corresponds to the version of the LVA Edge module you are using. |
27 | | - |
28 | | - | SDK | LVA Edge Module | |
29 | | - |---|---| |
30 | | - | 1.0.0b1 | 2.0 | |
31 | | -### Creating a graph topology and making requests |
32 | | -Please visit the [Examples](#examples) for starter code |
33 | | -## Key concepts |
34 | | - |
35 | | -### MediaGraph Topology vs MediaGraph Instance |
36 | | -A _graph topology_ is a 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] |
37 | | - |
38 | | -### CloudToDeviceMethod |
39 | | - |
40 | | -The `CloudToDeviceMethod` is part of the [azure-iot-hub SDk][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`. |
41 | | - |
42 | | -The first parameter, `method_name`, is the name of the media graph request you are sending. Make sure to use each method's predefined `method_name` property. For example, `MediaGraphTopologySetRequest.method_name`. |
43 | | - |
44 | | -The second parameter, `payload`, sends the entire serialization of the media graph request. For example, `MediaGraphTopologySetRequest.serialize()` |
45 | | - |
46 | | -## Examples |
47 | | - |
48 | | -### Creating a graph topology |
49 | | -To create a graph topology you need to define parameters, sources, and sinks. |
50 | | -```python |
51 | | -from azure.media.analyticsedge import * |
52 | | - |
53 | | -#Parameters |
54 | | -user_name_param = MediaGraphParameterDeclaration(name="rtspUserName",type="String",default="dummyusername") |
55 | | -password_param = MediaGraphParameterDeclaration(name="rtspPassword",type="String",default="dummypassword") |
56 | | -url_param = MediaGraphParameterDeclaration(name="rtspUrl",type="String",default="rtsp://rtspsim:554/media/camera-300s.mkv") |
57 | | -graph_topology_name = "graphTopology1" |
58 | | - |
59 | | -#Source and Sink |
60 | | -source = MediaGraphRtspSource(name="rtspSource", endpoint=MediaGraphUnsecuredEndpoint(url="${rtspUrl}",credentials=MediaGraphUsernamePasswordCredentials(username="${rtspUserName}",password="${rtspPassword}"))) |
61 | | -node = MediaGraphNodeInput(node_name="rtspSource") |
62 | | -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/") |
63 | | - |
64 | | -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") |
65 | | - |
66 | | -graph_topology = MediaGraphTopology(name=graph_topology_name,properties=graph_properties) |
67 | | - |
68 | | -``` |
69 | | - |
70 | | -### Creating a graph instance |
71 | | -To create a graph instance, you need to have an existing graph topology. |
72 | | -```python |
73 | | -from azure.media.analyticsedge import * |
74 | | - |
75 | | -#Parameters |
76 | | -graph_instance_name = "graphInstance1" |
77 | | -graph_topology_name = "graphTopology1" |
78 | | -graph_url = "rtsp://sample-url-from-camera" |
79 | | - |
80 | | -url_param = MediaGraphParameterDefinition(name="rtspUrl", value=graph_url) |
81 | | -graph_instance_properties = MediaGraphInstanceProperties(description="Sample graph description", topology_name=graph_topology_name, parameters=[url_param]) |
82 | | - |
83 | | -graph_instance = MediaGraphInstance(name=graph_instance_name, properties=graph_instance_properties) |
84 | | - |
85 | | -``` |
86 | | - |
87 | | -### Invoking a graph method request |
88 | | -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` |
89 | | -```python |
90 | | -from azure.media.analyticsedge import * |
91 | | -from azure.iot.hub import IoTHubRegistryManager |
92 | | -from azure.iot.hub.models import CloudToDeviceMethod |
93 | | - |
94 | | -module_d = "mediaedge" |
95 | | -connection_string = "test" |
96 | | -set_method_request = MediaGraphTopologySetRequest(graph=graph_topology) |
97 | | -direct_method = CloudToDeviceMethod(method_name=set_method_request.method_name, payload=set_method_request.serialize()) |
98 | | -registry_manager = IoTHubRegistryManager(connection_string) |
99 | | - |
100 | | -registry_manager.invoke_device_module_method(device_id, module_d, direct_method) |
101 | | -``` |
102 | | - |
103 | | -To try different media graph topologies with the SDK, please see the official [Samples][samples]. |
104 | | - |
105 | | -## Troubleshooting |
106 | | - |
107 | | -- 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]` |
108 | | -- Make sure to serialize the entire method request before passing it to `CloudToDeviceMethod` |
109 | | - |
110 | | -## Next steps |
111 | | - |
112 | | -- [Samples][samples] |
113 | | -- [Azure IoT Device SDK][iot-device-sdk] |
114 | | -- [Azure IoTHub Service SDK][iot-hub-sdk] |
115 | | - |
116 | | -## Contributing |
117 | | - |
118 | | -This project welcomes contributions and suggestions. Most contributions require |
119 | | -you to agree to a Contributor License Agreement (CLA) declaring that you have |
120 | | -the right to, and actually do, grant us the rights to use your contribution. |
121 | | -For details, visit https://cla.microsoft.com. |
122 | | - |
123 | | -If you encounter any issues, please open an issue on our [Github][github-page-issues]. |
124 | | - |
125 | | -When you submit a pull request, a CLA-bot will automatically determine whether |
126 | | -you need to provide a CLA and decorate the PR appropriately (e.g., label, |
127 | | -comment). Simply follow the instructions provided by the bot. You will only |
128 | | -need to do this once across all repos using our CLA. |
129 | | - |
130 | | -This project has adopted the |
131 | | -[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, |
132 | | -see the Code of Conduct FAQ or contact opencode@microsoft.com with any |
133 | | -additional questions or comments. |
134 | | - |
135 | | -<!-- LINKS --> |
136 | | -[azure_cli]: https://docs.microsoft.com/cli/azure |
137 | | -[azure_sub]: https://azure.microsoft.com/free/ |
138 | | - |
139 | | -[cla]: https://cla.microsoft.com |
140 | | -[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ |
141 | | -[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ |
142 | | -[coc_contact]: mailto:opencode@microsoft.com |
143 | | - |
144 | | -[package]: https://pypi.org/project/azure-media-analytics-edge/ |
145 | | -[source]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/media |
146 | | -[samples]: https://github.com/Azure-Samples/video-analyzer-iot-edge-python |
147 | | - |
148 | | -[doc_direct_methods]: https://docs.microsoft.com/azure/media-services/live-video-analytics-edge/direct-methods |
149 | | -[doc_media_graph]: https://docs.microsoft.com/azure/media-services/live-video-analytics-edge/media-graph-concept#media-graph-topologies-and-instances |
150 | | -[doc_product]: https://docs.microsoft.com/azure/azure-video-analyzer/video-analyzer-docs/overview |
151 | | - |
152 | | -[iot-device-sdk]: https://pypi.org/project/azure-iot-device/ |
153 | | -[iot-hub-sdk]: https://pypi.org/project/azure-iot-hub/ |
154 | | -[iot_device_connection_string]: https://docs.microsoft.com/azure/media-services/live-video-analytics-edge/get-started-detect-motion-emit-events-quickstart |
155 | | - |
156 | | -[github-page-issues]: https://github.com/Azure/azure-sdk-for-python/issues |
| 3 | +This package is no longer maintained. Please use [Azure Video Analyzer Edge client library for Python](https://pypi.org/project/azure-media-videoanalyzer-edge) |
0 commit comments