Installing Native Dependencies

This is a hidden guide that is not visible in the guides index! If you are reading this, you are probably looking for information on how to install native dependencies for HTTP interactions or voice.

HTTP Interactions

For HTTP interactions, Libsodium is required.

Voice

For voice:

Libsodium is not required by default, as Aes256GcmRtpSizeEncryption is used, which does not require Libsodium. Libsodium is only required when you are using XChaCha20Poly1305RtpSizeEncryption, XSalsa20Poly1305Encryption, XSalsa20Poly1305LiteEncryption, XSalsa20Poly1305LiteRtpSizeEncryption or XSalsa20Poly1305SuffixEncryption encryption mode.
Opus is only required when you are using Opus prefixed classes.

For dynamic linking, you can install Libsodium for the most popular platforms by referencing the official Libsodium NuGet package.

Manual or System-wide Installation

Windows

For dynamic linking on Windows, you need to use the dynamic link libraries (libsodium and/or opus). Here's how to set it up:

Download or build the dynamic link libraries (libsodium and/or opus) compatible with your development environment.
Place these files in the runtime directory of your application. This is the folder where your application's executable is located.

Linux and MacOS

Dynamic linking on Linux and MacOS involves using shared libraries (libsodium and/or opus). You can install them using your system's package manager if available or follow these steps to install them manually:

Download or build the shared libraries (libsodium and/or opus) that are compatible with your development environment.
Place these files in the runtime directory of your application, which is the folder where your application's executable is located.

Note

Static linking requires Native AOT compilation.

Windows

When using static linking on Windows, you need to link to the static libraries (libsodium and/or opus). Here are the steps to set up static linking in your application:

Download or build the static libraries (libsodium and/or opus) compatible with your development environment.

Link these libraries in your project settings. Ensure that you specify the correct paths to these libraries:

<ItemGroup>
  <NativeLibrary Include="C:\path\to\libsodium" Condition="$(RuntimeIdentifier.StartsWith('win'))" />
  <DirectPInvoke Include="libsodium" />

  <NativeLibrary Include="C:\path\to\opus" Condition="$(RuntimeIdentifier.StartsWith('win'))" />
  <DirectPInvoke Include="opus" />
</ItemGroup>

You don't need to place any of these files in the runtime directory, as static linking embeds the library code directly into your application, eliminating the need for separate files.

Linux and MacOS

Static linking on Linux and MacOS involves linking your application with the static libraries (libsodium and/or opus). You can install them using your system's package manager if available or download or build the static libraries (libsodium and/or opus) compatible with your development environment manually.

Link these libraries in your project settings. Make sure you specify the correct paths to these libraries:

<ItemGroup>
  <NativeLibrary Include="/path/to/libsodium" Condition="!$(RuntimeIdentifier.StartsWith('win'))" />
  <DirectPInvoke Include="libsodium" />

  <NativeLibrary Include="/path/to/opus" Condition="!$(RuntimeIdentifier.StartsWith('win'))" />
  <DirectPInvoke Include="opus" />
</ItemGroup>

Since you're statically linking, you won't need to place any of these files in the runtime directory. The necessary code from the libraries will be included directly in your application.

Installation External Links

Library	Installation Link
Libsodium	https://doc.libsodium.org/installation
Opus	https://opus-codec.org/downloads

Table of Contents

Installing Native Dependencies

HTTP Interactions

Voice

Installation

Manual or System-wide Installation

Windows

Linux and MacOS

Installation External Links