https://github.com/adrenak/unimic
Unity's Microphone enhanced and made easy.
https://github.com/adrenak/unimic
audio mic microphone pcm streaming-audio unity unity3d voice
Last synced: about 1 month ago
JSON representation
Unity's Microphone enhanced and made easy.
- Host: GitHub
- URL: https://github.com/adrenak/unimic
- Owner: adrenak
- License: mit
- Created: 2017-10-16T05:25:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-13T11:44:46.000Z (2 months ago)
- Last Synced: 2025-03-29T22:04:05.380Z (about 2 months ago)
- Topics: audio, mic, microphone, pcm, streaming-audio, unity, unity3d, voice
- Language: C#
- Homepage: http://www.vatsalambastha.com/unimic/
- Size: 646 KB
- Stars: 122
- Watchers: 6
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-unity-packages - UniMic
README
## UniMic 🎤
A wrapper for Unity's Microphone class.
Provides easy APIs for mic input and management.
Also includes `StreamedAudioSource`, a (not Microphone related) class that can be used for playing streaming audio by feeding it incoming audio samples.
## Documentation 📝
[Refer to the Scripting Reference](https://www.vatsalambastha.com/unimic/api/Adrenak.UniMic.html)
## Installing 📦
⚠️ [OpenUPM](https://openupm.com/packages/com.adrenak.unimic/?subPage=versions) doesn't have up to date releases. Install using NPM registry instead 👇
Ensure you have the NPM registry in the `packages.json` file of your Unity project with `com.adrenak.unimic` as one of the scopes
```
"scopedRegistries": [
{
"name": "npmjs",
"url": "https://registry.npmjs.org",
"scopes": [
"com.npmjs",
"com.adrenak.unimic"
]
}
}
```
Add `"com.adrenak.unimic" : "x.y.z"` to `dependencies` list in `packages.json` file where `x.y.z` is the version name
> 💬 You can see the versions on the NPM page [here](https://www.npmjs.com/package/com.adrenak.unimic?activeTab=versions).
> Also note that v3.x.x is recommended. v3 has several breaking changes against v1 and v2. Refer to the scripting reference if you're upgrading.
## Samples 🚀
Getting started with some samples is the best way to see the features of UniMic, and there are many!
Ensure that atleast one recording device is connected to your PC/Mac for the samples to work.
### Simple MicAudioSource Sample
- A gameobject called `My Mic` is placed. It has the `MicAudioSource` component.
- Another gmeobject called `Sample` has `SimpleMicAudioSourceSample`
- On start it checks if there are any mic devices available
- If yes, it takes the first recording device available and starts the recording using `.StartRecording()`
- Then assigns the device to `MicAudioSource`, which then starts playing the audio
- Play the scene. You should be able to hear your voice in the editor
### Multiple MicAudioSource Sample
- Run the scene, you should see every mic device connected
- On start, all the devices will start recording in parallel and playing back
- Toggling the checkbox on or off will start or stop the recording for a device
- Prefab `MicDeviceCell` is used to represent one device. The `MicDeviceCell.cs` script handles its UI.
- Check out the `MultipleMicAudioSourceSample` script to see how the UI has been created
### MicAudioSource Switch Sample
- Run the scene, recording should start on one device and a dropdown will show all the available recording devices
- Use the dropdown to change to a difference device at runtime
- Check out the `MicAudioSourceSwitchSample` script to see how the Device of a `MicAudioSource` can be changed at runtime.
### Spatial Blend Sample (for spatial audio)
- Run the scene, the audio source is a moving ball.
- When you speak, your audio is played from the balls position. Use headphones to hear the sound moving.
- Using the slider, you can change the spatial blend from 0 to 1
## Note 📄
* Some Xiaomi phones may prevent side loaded APKs from functioning.
* There is no AEC (Acoustic Echo Cancelletion). If you're trying the samples be sure to use headphones to avoid creating a feedback loop.
## Contact 👥
[@github](https://www.github.com/adrenak)
[@website](http://www.vatsalambastha.com)
@discord: `adrenak#1934`