Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/johannesdeml/editoraudioutils

Customizable Unity Editor notification sounds - Like EditorApplication.Beep() but configurable
https://github.com/johannesdeml/editoraudioutils

audio editor-enhancement hacktoberfest notifications unity unity-audioclip unity-editor unity-preferences unity3d

Last synced: 16 days ago
JSON representation

Customizable Unity Editor notification sounds - Like EditorApplication.Beep() but configurable

Host: GitHub
URL: https://github.com/johannesdeml/editoraudioutils
Owner: JohannesDeml
License: mit
Created: 2021-10-24T18:48:56.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-02-04T21:03:47.000Z (9 months ago)
Last Synced: 2024-10-11T10:36:51.162Z (about 1 month ago)
Topics: audio, editor-enhancement, hacktoberfest, notifications, unity, unity-audioclip, unity-editor, unity-preferences, unity3d
Language: C#
Homepage:
Size: 262 KB
Stars: 42
Watchers: 5
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # EditorAudioUtils

*Like [EditorApplication.Beep()](https://docs.unity3d.com/ScriptReference/EditorApplication.Beep.html), but with configurable sounds*

![EditorAudioUtils Settings Screenshot](Documentation~/preview.png)

[![openupm](https://img.shields.io/npm/v/com.jd.editoraudioutils?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.jd.editoraudioutils/)  [![Releases](https://img.shields.io/github/release-date/johannesdeml/editoraudioutils.svg)](https://github.com/johannesdeml/editoraudioutils/releases)  [![Unity 2019.1 or later](https://img.shields.io/badge/unity-2019.1%20or%20later-blue.svg?logo=unity&cacheSeconds=2592000)](https://unity3d.com/get-unity/download/archive)

## Installation

Install the package with [OpenUPM](https://openupm.com/)

```sh

$ openupm add com.jd.editoraudioutils

```

or download the [Latest Unity Packages](../../releases/latest)

## Features

* Set your own notification sounds through Project Settings -> EditorAudioUtils

* Play custom notification sounds through a simple API

* Play, Pause, Resume and stop any AudioClip in the editor without the need of an AudioSource

* Handle different internal Unity API from Unity 2019 onwards

* Disable or overwrite notification sounds through EditorPrefs. This way each user can decide if and what notification settings they want, while the project itself contains the default settings.

## API

Play a predefined notification sound:

```csharp

// This is the simplest call to play a notification

EditorAudioUtility.PlayNotificationSound(EditorNotificationSound type);

// Delayed might be necessary if the sound should be played after a resource intense task

EditorAudioUtility.PlayNotificationSoundDelayed(EditorNotificationSound type, float secondsDelay);

```

Access other internal [AudioUtil](https://github.com/Unity-Technologies/UnityCsReference/blob/master/Editor/Mono/Audio/Bindings/AudioUtil.bindings.cs) methods ([EditorAudioUtility](../../blob/main/Scripts/Editor/EditorAudioUtility.cs)):

```csharp

// Play clip

EditorAudioUtility.PlayPreviewClip(AudioClip audioClip);

EditorAudioUtility.PlayPreviewClip(AudioClip audioClip, int startSample, bool loop);

// For Unity 2020+ the input will be ignored and applied to all clips

// You can use EditorAudioUtility.LastPlayedPreviewClip to get the last clip

EditorAudioUtility.PausePreviewClip(AudioClip audioClip);

EditorAudioUtility.ResumePreviewClip(AudioClip audioClip);

EditorAudioUtility.StopPreviewClip(AudioClip audioClip);

// Stop all clips

EditorAudioUtility.StopAllPreviewClips();

```

## License

* MIT - see [LICENSE](./LICENSE)

* Sounds in Sample are from [Kenney](https://kenney.nl/) (CC0)