Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
keijiro authored Jun 12, 2024
1 parent cb0ff68 commit 1ebe21e
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ KlakNDI runs without the NDI SDK on most supported platforms, but the iOS
platform requires the SDK for building with Xcode. Please download and install
the NDI SDK for iOS in advance of building.

KlakNDI requires network permissions on Android. Please follow the instruction
in [Android Support section].

[Android Support section]: README.md#android-support

License
-------

Expand Down Expand Up @@ -129,3 +134,19 @@ See the [Sender Benchmark]/[Receiver Benchmark] examples for details.

[Sender Benchmark]: URP/Assets/Script/SenderBenchmark.cs
[Receiver Benchmark]: URP/Assets/Script/ReceiverBenchmark.cs

Android Support
---------------

KlakNDI requires the following permissions when running on Android:

- `android.permission.INTERNET`
- `android.permission.ACCESS_NETWORK_STATE`
- `android.permission.CHANGE_WIFI_MULTICAST_STATE`

You can add them by [overriding the App Manifest]. Please refer to the
[AndroidManifest file] contained in the URP sample.

[overriding the App Manifest]:
https://docs.unity3d.com/Manual/overriding-android-manifest.html
[AndroidManifest file]: URP/Assets/Plugins/Android/AndroidManifest.xml

0 comments on commit 1ebe21e

Please sign in to comment.