# Open Azure Kinect [](https://pypi.org/project/open-azure-kinect/)
Open playback functions for Azure Kinect.
It is possible to playback [Azure Kinect](https://github.com/microsoft/Azure-Kinect-Sensor-SDK) videos files (mkv) without using the official SDK. This allows the software to be used on systems where the depth engine is not implemented, such as MacOS. The library currently **only** supports the **playback** of mkv files and does **not provide direct access** to the Azure Kinect device.
The following functions are currently supported:
- Reading colour, infrared and depth stream from mkv
- Reading and parsing calibration data from mkv
## Installation
```terminal
pip install open-azure-kinect
```
## Usage
In order to load an MKV file, it is necessary to create a new instance of the `OpenK4APlayback` class.
```python
from openk4a.playback import OpenK4APlayback
azure = OpenK4APlayback("my-file.mkv")
azure.open()
```
After that, it is possible to read the available stream information.
```python
for stream in azure.streams:
print(stream)
```
And read the actual capture information (image data).
```python
while capture := azure.read():
# read color frame as numpy array
color_image = capture.color
```
### Calibration Data
To access the calibration data of the two cameras (`Color`, `Depth`), use the parsed information property.
```python
color_calib = azure.color_calibration
depth_calib = azure.depth_calibration
```
## Development and Examples
To run the examples or develop the library please install the `dev-requirements.txt` and `requirements.txt`.
```terminal
pip install -r dev-requirements.txt
pip install -r requirements.txt
```
There is already an example script [demo.py](demo.py) which provides insights in how to use the library.
Raw data
{
"_id": null,
"home_page": "https://github.com/cansik/open-azure-kinect",
"name": "open-azure-kinect",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Florian Bruggisser",
"author_email": "github@broox.ch",
"download_url": null,
"platform": null,
"description": "# Open Azure Kinect [](https://pypi.org/project/open-azure-kinect/)\n\nOpen playback functions for Azure Kinect.\n\nIt is possible to playback [Azure Kinect](https://github.com/microsoft/Azure-Kinect-Sensor-SDK) videos files (mkv) without using the official SDK. This allows the software to be used on systems where the depth engine is not implemented, such as MacOS. The library currently **only** supports the **playback** of mkv files and does **not provide direct access** to the Azure Kinect device.\n\nThe following functions are currently supported:\n\n- Reading colour, infrared and depth stream from mkv\n- Reading and parsing calibration data from mkv\n\n## Installation\n\n```terminal\npip install open-azure-kinect\n```\n\n## Usage\nIn order to load an MKV file, it is necessary to create a new instance of the `OpenK4APlayback` class.\n\n```python\nfrom openk4a.playback import OpenK4APlayback\n\nazure = OpenK4APlayback(\"my-file.mkv\")\nazure.open()\n```\n\nAfter that, it is possible to read the available stream information.\n\n```python\nfor stream in azure.streams:\n print(stream)\n```\n\nAnd read the actual capture information (image data).\n\n```python\nwhile capture := azure.read():\n # read color frame as numpy array\n color_image = capture.color\n```\n\n### Calibration Data\nTo access the calibration data of the two cameras (`Color`, `Depth`), use the parsed information property.\n\n```python\ncolor_calib = azure.color_calibration\ndepth_calib = azure.depth_calibration\n```\n\n## Development and Examples\nTo run the examples or develop the library please install the `dev-requirements.txt` and `requirements.txt`.\n\n```terminal\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\nThere is already an example script [demo.py](demo.py) which provides insights in how to use the library.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Open Azure Kinect recordings without the Azure Kinect SDK.",
"version": "0.1.0a2",
"project_urls": {
"Homepage": "https://github.com/cansik/open-azure-kinect"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3a8b3ba9c52a6ea298ae4c80cab5c3689245ceab0540596db849e5ac8ab49a30",
"md5": "280ce6a5db42eb0f397423010328f03e",
"sha256": "1f19a53421c79f8d10eb054d941e45fb008783a2803280f8da7270c5dcabdbbe"
},
"downloads": -1,
"filename": "open_azure_kinect-0.1.0a2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "280ce6a5db42eb0f397423010328f03e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6502,
"upload_time": "2024-06-12T12:41:07",
"upload_time_iso_8601": "2024-06-12T12:41:07.121628Z",
"url": "https://files.pythonhosted.org/packages/3a/8b/3ba9c52a6ea298ae4c80cab5c3689245ceab0540596db849e5ac8ab49a30/open_azure_kinect-0.1.0a2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-12 12:41:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cansik",
"github_project": "open-azure-kinect",
"github_not_found": true,
"lcname": "open-azure-kinect"
}
JSON
