slococo-uni
/
webviewstream
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Santiago Lo Coco 2025-01-01 16:13:16 +01:00
parent c78e8c90b9
commit 4ab9caa2c7
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -7,14 +7,16 @@ WebViewStream is a Unity-based HoloLens 2 application for high-quality, low-late
- **MRTK-Native**: Built on MRTK for optimized HoloLens 2 functionality.
- **Optimized performance**: Configured and fine-tuned for smooth, low-latency streaming on the HoloLens 2.
- **WebRTC-based streaming**: Uses WebRTC for low-latency, high-quality streaming.
- **Dynamic endpoint management**: Reads streaming endpoints from a REST API [GetEndpoints](https://github.com/se23m504/GetEndpoints), simplifying endpoint updates without typing long URLs directly on the HoloLens.
- **Dynamic endpoint management**: Reads streaming endpoints from a REST API [GetEndpoints](https://git.slc.ar/se23m504/getendpoints), simplifying endpoint updates without typing long URLs directly on the HoloLens.
- **mDNS client**: Compliant with RFC 6762 and RFC 6763 for service discovery.
- **Extendable streaming capacity**: Supports two streams by default and can scale up, limited only by HoloLens 2's hardware.
- **Hand menu and speech commands**: Offers an intuitive `HandMenu` and voice control for hands-free operation.
- **Recording**: Allows streaming recording, with minor frame drops under high-load conditions.
## Installation
1. Clone the repository.
2. Configure the API host for `GetEndpoints` to dynamically retrieve streaming endpoints.
2. Configure the API host for [GetEndpoints](https://git.slc.ar/se23m504/getendpoints) to dynamically retrieve streaming endpoints.
3. Build and sideload the application to the HoloLens 2.
## Technical details
@ -27,11 +29,11 @@ WebViewStream is a Unity-based HoloLens 2 application for high-quality, low-late
- com.microsoft.mixedreality.toolkit.standardassets
- com.microsoft.mixedreality.webview.unity
Note: Install dependencies from my [MixedReality](https://github.com/se23m504/mixedreality) repository. Only use the specific libraries and versions hosted there, as they have been patched for this project's requirements. Using different versions may lead to errors and compatibility issues.
Note: Install dependencies from my [mixedreality](https://git.slc.ar/slococo-uni/mixedreality) repository. Only use the specific libraries and versions hosted there, as they have been patched for this project's requirements. Using different versions may lead to errors and compatibility issues.
## API requirements
The app requires an external API for endpoint retrieval (`GetEndpoints`), expected to be accessible within the HoloLens 2's network environment.
The app requires an external API for endpoint retrieval ([GetEndpoints](https://git.slc.ar/se23m504/getendpoints)), expected to be accessible within the HoloLens 2's network environment.
The application supports local service discovery using UDP broadcasting. This is particularly useful in scenarios where DNS is down or when setting up a DNS record is not feasible.