Skip to content

Latest commit

 

History

History
78 lines (71 loc) · 3.09 KB

README.md

File metadata and controls

78 lines (71 loc) · 3.09 KB
Raw

Unity project Vorbis

This is a Unity sample project that uses the VorbisPlugin to save and load audio data in Vorbis format. You can checkout this repository. The latest released binaries are inside Assets/VorbisPlugin/Plugins/ folder

The latest releases you'll find in VorbisPlugin repository

How to use

Load vorbis ogg from file at runtime:

string pathToFile = ...;
UnityEngine.AudioClip audioClip = OggVorbis.VorbisPlugin.Load(pathToFile);

Save vorbis ogg to file at runtime:

string pathToFile = ...;
UnityEngine.AudioClip audioClip = ...;
float quality = 0.4f; // optional parameter, values from 0 to 1 (https://xiph.org/vorbis/doc/vorbisenc/overview.html)
OggVorbis.VorbisPlugin.Save(pathToFile, audioClip, quality);

Get vorbis ogg from bytes array at runtime:

byte[] sourceAudioBytes = ...;
UnityEngine.AudioClip sourceAudioClip = OggVorbis.VorbisPlugin.ToAudioClip(sourceAudioBytes, "NameOfAudioClip");

Serialize vorbis ogg to bytes array at runtime:

UnityEngine.AudioClip sourceAudioClip = ...;
float quality = 0.4f; // optional parameter, values from 0 to 1 (https://xiph.org/vorbis/doc/vorbisenc/overview.html)
byte[] bytes = OggVorbis.VorbisPlugin.GetOggVorbis(sourceAudioClip, quality);

To have more examples you can review the PlayModeTests project, or the PluginTest.cs

Suported platfoms and options

Supported platforms:

  • Mono, one channel audio
  • Stereo, two channels audio

Supported platforms:

  • Windows: x86, x86_64
  • Android: arm64-v8a, armeabi-v7a, x86, x86_64
  • iOS: aarch64
  • Mac OSX: x86_64

Tested platforms:

  • Windows: x86_64
  • Android: arm64-v8a
  • iOS: aarch64
  • Mac OSX: x86_64

Tested with Unity versions:

  • 2021.1.2f1
  • 2019.1.12f1

How to use the test project:

  1. Checkout or download this repository
  2. Open UnityClient project in Unity editor
  3. Open Assets/_Presentation/Scene/Main.scene
  4. Run the app
  5. Press "Save Ogg Audio" to store the source Audio clip at runtime to local storage
  6. Press "Load Ogg Audio" to load stored in local storage ogg audio file

Build libraries for missing platforms:

In case you need some specific platform for the plugin, you can build the libraries yourself. Detailed instructions for building the C wrapper native libraries you'll find here After you build the C libraries, you need to copy it to Assets/VorbisPlugin/Plugins folder:

Windows:

  • Assets/Plugins/Windows/x86_64/VorbisPlugin.dll

Android:

  • Assets/Plugins/VorbisPlugin/Android/libs/arm64-v8a/libVorbisPlugin.so
  • Assets/Plugins/VorbisPlugin/Android/libs/armeabi-v7a/libVorbisPlugin.so
  • Assets/Plugins/VorbisPlugin/Android/libs/x86/libVorbisPlugin.so
  • Assets/Plugins/VorbisPlugin/Android/libs/x86_64/libVorbisPlugin.so

Mac OSX:

  • Assets/Plugins/VorbisPlugin/OSX/libVorbisPlugin.dylib

iOS

  • Assets/Plugins/VorbisPlugin/iOS/libogg.a
  • Assets/Plugins/VorbisPlugin/iOS/libvorbis.a
  • Assets/Plugins/VorbisPlugin/iOS/libvorbisfile.a
  • Assets/Plugins/VorbisPlugin/iOS/libVorbisPlugin.a