Install the Media Blocks SDK in Unity¶

Media Blocks SDK .Net

This guide walks through installing the Media Blocks SDK .NET in Unity 6 on Windows x64. The SDK ships as a ready-to-import .unitypackage that is fully self-contained — you do not build anything from source, you do not need NuGet, and there are no external dependencies to install. After importing, open a sample scene and press Play.

Once it's installed, see the usage guides: Play a media file in Unity and View an RTSP camera in Unity.

Requirements¶

Download¶

Download the latest package:

VisioForge.MediaBlocks.Unity.unitypackage

https://files.visioforge.com/unity/VisioForge.MediaBlocks.Unity.unitypackage

Step 1 — Create or open a Unity project¶

Use an existing Unity 6 project or create a new one (any template). Keep the project root on a short NTFS path (see the warning above).

Step 2 — Import the package¶

In the Editor: Assets → Import Package → Custom Package…, select the downloaded .unitypackage, and click Import (keep all items checked).

The package adds:

Step 3 — Apply the required project settings¶

On first import the setup helper shows a dialog asking to apply two required project settings. Click Apply — both settings are configured for you.

These two settings are mandatory — the SDK will not work without them:

• Api Compatibility Level = .NET Framework — Unity 6 defaults to .NET Standard 2.1, which cannot load this net48 SDK build (symptom: TypeLoadException on play).
• Disable Domain Reload — the SDK initializes once per process and is reused across Play/Stop sessions; with Domain Reload enabled the Editor can hang when leaving Play mode.

Step 4 — Set the settings manually (only if you clicked Skip)¶

If you clicked Skip, set both by hand:

1. Api Compatibility Level = .NET Framework Edit → Project Settings → Player → Other Settings → Configuration → Api Compatibility Level.

1. Disable Domain Reload Edit → Project Settings → Editor → Enter Play Mode Settings → set When entering Play Mode to an option that does not reload the domain — either Reload Scene only (matches what Apply does) or Do not reload Domain or Scene.

Step 5 — Run a sample scene¶

In the Project window open Assets/Scenes/SimplePlayer.unity (double-click it — do not stay on the empty default scene), select the RawImage GameObject, set its File Path in the Inspector, and press ▶ Play. Video renders in the Game view and audio plays through the system default device.

Next, read the usage guides:

• Play a media file in Unity — the SimplePlayer sample.
• View an RTSP camera in Unity — the RTSPViewer sample.

Standalone builds¶

File → Build Settings → Windows x64 → Build produces a standalone player that works without any extra steps: the native runtime in Assets/StreamingAssets/VisioForge/x64 is copied verbatim by Unity into <game>_Data/StreamingAssets/VisioForge/x64, and the managed assemblies in Assets/Plugins are staged automatically. The same load path resolves in both the Editor and the standalone build.

Uninstalling or upgrading the package¶

A .unitypackage has no uninstaller — remove the files manually.

1. Close the Unity Editor first — it locks the native DLLs and the Library/ cache.
2. Delete the VisioForge content from Assets/:
3. Assets/StreamingAssets/VisioForge/ — the native runtime (~300 files).
4. Assets/VisioForge/ — the one-time setup helper.
5. The four reusable scripts in Assets/Scripts/: VisioForgeEnvironment.cs, VisioForgeVideoView.cs, MediaBlocksPlayer.cs, RTSPViewerPlayer.cs (plus their .meta) — keep any scripts of your own that live in the same folder.
6. The sample scenes Assets/Scenes/SimplePlayer.unity and Assets/Scenes/RTSPViewer.unity.
7. The VisioForge assemblies in Assets/Plugins/ (VisioForge.*.dll, GstSharp.dll, GLibSharp.dll, and their dependencies, each with its .meta). Delete the whole Assets/Plugins/ folder only if it contains nothing but VisioForge assemblies.
8. Delete the project's Library/ folder (next to Assets/) to clear the cached import state. Unity regenerates it on the next open (the first launch is slower).

Upgrading: import the new .unitypackage over the old one — the managed-plugin GUIDs are deterministic, so Unity overwrites the existing assets in place and references are preserved. If you are coming from a much older package or see duplicated DLLs in Assets/Plugins/, do a clean removal (steps above) first, then import the new package.

Troubleshooting¶

Known limitations¶

• Windows x64 only — the bundled native runtime is Windows x64. Other platforms are not yet supported by the package.

Frequently Asked Questions¶

Can I install the SDK in Unity via NuGet?¶

No. Unity does not run NuGet restore, and the SDK ships ~300 native files that NuGet would not lay out for Unity. The .unitypackage bundles everything — managed assemblies, native runtime, scripts, and scenes — so you import a single file instead.

Do I need to install GStreamer or any other system dependency?¶

No. The package is fully self-contained; everything the SDK needs is inside it. A system GStreamer install on your machine is not required and is not used by the bundled runtime.

Do other VisioForge SDKs work in Unity?¶

Today the Unity package ships the Media Blocks SDK .NET runtime, which covers playback, capture, processing, and streaming. Other VisioForge SDKs will follow.

See Also¶

• Using VisioForge in Unity — overview of how the integration works
• Play a media file in Unity — the file-playback sample
• View an RTSP camera in Unity — the RTSP sample
• Media Blocks SDK .NET overview — the full block catalog
• Installation guide — install the SDK in other .NET project types