Crosstales.Common.Audio.WavMaster Class Reference

WAV utility for recording and audio playback functions in Unity. More...

Static Public Member Functions

static AudioClip ToAudioClip (string filePath, string name="wav")
 Load PCM format *.wav audio file and convert to AudioClip. More...
 
static AudioClip ToAudioClip (System.IO.Stream stream, string name="wav")
 Load PCM format *.wav audio stream and convert to AudioClip. More...
 
static AudioClip ToAudioClip (byte[] fileBytes, string name="wav")
 Load PCM format byte-array and convert to AudioClip. More...
 
static byte[] FromAudioClip (AudioClip audioClip)
 Convert an AudioClip to a byte-array. More...
 
static byte[] FromAudioClip (AudioClip audioClip, string filepath, bool saveAsFile=true)
 Convert an AudioClip to a byte-array and save it to a file. More...
 
static ushort BitDepth (AudioClip audioClip)
 Calculates the bit depth of an AudioClip. More...
 

Detailed Description

WAV utility for recording and audio playback functions in Unity.

  • Use "ToAudioClip" method for loading wav file / bytes. Loads .wav (PCM uncompressed) files at 8,16,24 and 32 bits and converts data to Unity's AudioClip.
  • Use "FromAudioClip" method for saving wav file / bytes. Converts an AudioClip's float data into wav byte array at 16 bit.

Partially based on: https://github.com/deadlyfingers/UnityWav

Member Function Documentation

◆ BitDepth()

static ushort Crosstales.Common.Audio.WavMaster.BitDepth ( AudioClip  audioClip)
static

Calculates the bit depth of an AudioClip.

Parameters
audioClipAudio clip.
Returns
The bit depth. Should be 8 or 16 or 32 bit.

◆ FromAudioClip() [1/2]

static byte [] Crosstales.Common.Audio.WavMaster.FromAudioClip ( AudioClip  audioClip)
static

Convert an AudioClip to a byte-array.

Parameters
audioClipAudioClip to convert
Returns
AudioClip as byte-array.

◆ FromAudioClip() [2/2]

static byte [] Crosstales.Common.Audio.WavMaster.FromAudioClip ( AudioClip  audioClip,
string  filepath,
bool  saveAsFile = true 
)
static

Convert an AudioClip to a byte-array and save it to a file.

Parameters
audioClipAudioClip to save
filepathFile path
saveAsFileSave the file (optional, default: true)
Returns
AudioClip as byte-array.

◆ ToAudioClip() [1/3]

static AudioClip Crosstales.Common.Audio.WavMaster.ToAudioClip ( byte[]  fileBytes,
string  name = "wav" 
)
static

Load PCM format byte-array and convert to AudioClip.

Parameters
fileBytesByte array with the PCM data
nameName of the AudioClip (optional, default: wav)
Returns
AudioClip from the byte-array.

◆ ToAudioClip() [2/3]

static AudioClip Crosstales.Common.Audio.WavMaster.ToAudioClip ( string  filePath,
string  name = "wav" 
)
static

Load PCM format *.wav audio file and convert to AudioClip.

Parameters
filePathLocal file path to .wav file
nameName of the AudioClip (optional, default: wav)
Returns
AudioClip from the byte-array.

◆ ToAudioClip() [3/3]

static AudioClip Crosstales.Common.Audio.WavMaster.ToAudioClip ( System.IO.Stream  stream,
string  name = "wav" 
)
static

Load PCM format *.wav audio stream and convert to AudioClip.

Parameters
streamLocal file path to .wav file
nameName of the AudioClip (optional, default: wav)
Returns
AudioClip from the byte-array.

The documentation for this class was generated from the following file:
  • C:/Users/slaub/Unity/assets/DJPro/DJPro/Assets/Plugins/crosstales/Common/Extras/Audio/Scripts/WavMaster.cs