Unity-AudioLoader

KO | EN

gitlite — search

#hacktoberfest #typescript #llm #go #golang #rust #linux #macos #java #nodejs #windows #security #ios #openai

Unity-AudioLoader

(★ 46)

Asynchronous audio loading from remote or local destination. It has two layers of configurable cache system: RAM and Disk.

Unity-AudioLoader Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Audio Loader

[![OpenUPM](https://img.shields.io/npm/v/extensions.unity.audioloader?label=OpenUPM&registry_uri=https://package.openupm.com&labelColor=333A41 'OpenUPM package')](https://openupm.com/packages/extensions.unity.audioloader/)
[![r](https://github.com/IvanMurzak/Unity-AudioLoader/workflows/release/badge.svg 'Release')](https://github.com/IvanMurzak/Unity-AudioLoader/actions/workflows/release.yml)
[![OpenUPM](https://img.shields.io/badge/dynamic/json?labelColor=333A41&label=Downloads&query=%24.downloads&suffix=%2Fmonth&url=https%3A%2F%2Fpackage.openupm.com%2Fdownloads%2Fpoint%2Flast-month%2Fextensions.unity.audioloader)](https://openupm.com/packages/extensions.unity.audioloader/)
[![Stars](https://img.shields.io/github/stars/IvanMurzak/Unity-AudioLoader 'Stars')](https://github.com/IvanMurzak/Unity-AudioLoader/stargazers)
[![License](https://img.shields.io/github/license/IvanMurzak/Unity-AudioLoader?label=License&labelColor=333A41)](https://github.com/IvanMurzak/Unity-AudioLoader/blob/main/LICENSE)
[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)

Asynchronous audio loading from remote or local destination. It has two layers of configurable cache system: RAM and Disk.

## Features

- ✔️ Async loading from **Web** or **Local** `AudioLoader.LoadAudioClip(audioURL);`
- ✔️ **Memory** and **Disk** caching - tries to load from memory first, then from disk
- ✔️ Dedicated thread for disk operations
- ✔️ Avoids loading same audio multiple times simultaneously, a task waits for completion the first and just returns loaded audio if at least one cache layer activated
- ✔️ Auto set to AudioSource `AudioLoader.SetAudioSource(audioURL, audioSource);`
- ✔️ Debug level for logging `AudioLoader.settings.debugLevel = DebugLevel.Error;`

# Usage

In the main thread somewhere at the start of the project need to call `AudioLoader.Init();` once to initialize static properties in the right thread. It is required to be made in the main thread. Then you can use `AudioLoader` from any thread and at any time.

## Sample - Loading audio file, set to AudioSource

``` C#
using Extensions.Unity.AudioLoader;
using Cysharp.Threading.Tasks;

public class AudioLoaderSample : MonoBehaviour
{
    [SerializeField] string audioURL;
    [SerializeField] AudioSource audioSource;

async void Start()
    {
        // Loading audio file from web, cached for quick load next time
        audioSource.clip = await AudioLoader.LoadAudioClip(audioURL);

// Same loading with auto set to audio
        await AudioLoader.SetAudioSource(audioURL, audioSource);
    }
}
```

## Sample - Loading audio into multiple Audio components

``` C#
using Extensions.Unity.AudioLoader;
using Cysharp.Threading.Tasks;

public class AudioLoaderSample : MonoBehaviour
{
    [SerializeField] string audioURL;
    [SerializeField] AudioSource audioSource1;
    [SerializeField] AudioSource audioSource2;

void Start()
    {
        // Loading with auto set to audio
        AudioLoader.SetAudioSource(audioURL, audioSource1, audioSource2).Forget();
    }
}
```

# Cache

Cache system based on the two layers. The first layer is **memory cache**, and the second is **disk cache**. Each layer could be enabled or disabled. It could be used without caching at all. By default, both layers are enabled.

## Setup Cache

- `AudioLoader.settings.useMemoryCache = true;` default value is `true`
- `AudioLoader.settings.useDiskCache = true;` default value is `true`

Change disk cache folder:

``` C#
AudioLoader.settings.diskSaveLocation = Application.persistentDataPath + "/myCustomFolder";
```

## Override Cache

``` C#
// Override Memory cache for specific audio
AudioLoader.SaveToMemoryCache(url, audioClip);

// Take from Memory cache for specific audio file if exists
AudioLoader.LoadFromMemoryCache(url);
```

## Does Cache contain audio

``` C#
// Check if any cache contains specific audio file
AudioLoader.CacheContains(url);

// Check if Memory cache contains specific audio file
AudioLoader.MemoryCacheContains(url);

// Check if Memory cache contains specific audio file
AudioLoader.DiskCacheContains(url);
```

## Clear Cache

``` C#
// Clear memory Memory and Disk cache
AudioLoader.ClearCache();

// Clear only Memory cache for all audio files
AudioLoader.ClearMemoryCache();

// Clear only Memory cache for specific audio file
AudioLoader.ClearMemoryCache(url);

// Clear only Disk cache for all audio files
AudioLoader.ClearDiskCache();

// Clear only Disk cache for specific audio file
AudioLoader.ClearDiskCache(url);
```

# Installation

### Option 1 - Installer

- **[⬇️ Download Installer](https://github.com/IvanMurzak/Unity-AudioLoader/releases/latest/download/Audio-Loader-Installer.unitypackage)**
- **📂 Import installer into Unity project**
  > - You may use double click on the file - Unity will open it
  > - OR: You may open Unity Editor first, then click on `Assets/Import Package/Custom Package`, then choose the file

### Option 2 - OpenUPM-CLI

- [⬇️ Install OpenUPM-CLI](https://github.com/openupm/openupm-cli#installation)
- 📟 Open command line in Unity project folder

```bash
openupm add extensions.unity.audioloader
```

### Option 3 - Manual (manifest.json)

- Add this code to `/Packages/manifest.json`

```json
{
  "dependencies": {
    "extensions.unity.audioloader": "1.0.4",
    "com.cysharp.unitask": "2.3.3"
  },
  "scopedRegistries": [
    {
      "name": "package.openupm.com",
      "url": "https://package.openupm.com",
      "scopes": [
        "com.cysharp",
        "extensions.unity"
      ]
    }
  ]
}
```

Unity-AudioLoader

Unity-AudioLoader Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Unity-AudioLoader

Unity-AudioLoader Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README