AudioAsset

Uniasset.Audio.AudioAsset is the high-level audio wrapper for loading audio, reading PCM frames sequentially, seeking arbitrarily, and converting the result to a Unity AudioClip.

Definition

namespace Uniasset.Audio
{
    public sealed class AudioAsset : IDisposable { }
}

Read-only properties

Property	Type	Description
SampleRate	int	Sample rate, for example 44100
SampleCount	long	Total sample count
ChannelCount	int	Number of channels
FrameCount	long	Total frame count

For multi-channel audio:

SampleCount == FrameCount * ChannelCount

Loading

Load

public void Load(string path, SampleFormat sampleFormat = SampleFormat.Float)

Loads audio from a file path.

Parameter	Type	Default	Description
path	string	—	Audio file path
sampleFormat	SampleFormat	Float	Decoded sample format

using var audio = new AudioAsset();
audio.Load("music.mp3");

Load(Span<byte>)

public void Load(Span<byte> data, SampleFormat sampleFormat = SampleFormat.Float)

Loads audio from a byte buffer.

Parameter	Type	Default	Description
data	Span<byte>	—	Encoded audio bytes
sampleFormat	SampleFormat	Float	Decoded sample format

byte[] audioData = File.ReadAllBytes("music.mp3");
audio.Load(audioData);

LoadIO

public void LoadIO(IUniassetStream stream, SampleFormat sampleFormat = SampleFormat.Float)

Loads audio from a custom stream.

If stream is null, the method throws ArgumentNullException.

Note

AudioAsset currently has no LoadAsync(...) overloads and no LoadIO(Stream) convenience overload.

Reading and seeking

Tell

public long Tell()

Returns the current read position in frames.

long position = audio.Tell();
Debug.Log($"Current position: {position} / {audio.FrameCount}");

Seek

public void Seek(long position)

Seeks to the specified frame index.

Parameter	Type	Description
position	long	Target frame index

audio.Seek(1000);

Read<T>

public int Read<T>(Span<T> buffer, int frameCount) where T : unmanaged

Reads PCM frames into the destination buffer.

Parameter	Type	Description
buffer	Span<T>	Destination buffer
frameCount	int	Number of frames to read

The generic type T must match the selected SampleFormat:

SampleFormat	T
Float	float
Int16	short

float[] buffer = new float[1024 * audio.ChannelCount];
int framesRead = audio.Read<float>(buffer, 1024);

The return value is the number of frames actually read.

SeekUnsafe

public void SeekUnsafe(long position)

Seeks to the specified frame position.

Thread safety

This method is not thread-safe. Use it only when the asset is accessed from a single thread. Use Seek in concurrent scenarios.

Parameter	Type	Description
position	long	Target frame index

It behaves like Seek but skips internal synchronization for performance.

audio.SeekUnsafe(1000);

ReadUnsafe<T>

public int ReadUnsafe<T>(Span<T> buffer, int frameCount) where T : unmanaged

Reads PCM frames into the destination buffer.

Thread safety

This method is not thread-safe. Use it only when the asset is accessed from a single thread. Use Read in concurrent scenarios.

Parameter	Type	Description
buffer	Span<T>	Destination buffer
frameCount	int	Number of frames to read

The generic type T must match the selected SampleFormat:

SampleFormat	T
Float	float
Int16	short

It behaves like Read<T> but skips internal synchronization for performance.

float[] buffer = new float[1024 * audio.ChannelCount];
int framesRead = audio.ReadUnsafe<float>(buffer, 1024);

The return value is the number of frames actually read.

Conversion

ToAudioClip

public AudioClip ToAudioClip(string name = "created_from_uniasset", bool stream = true)

Converts the audio into a Unity AudioClip.

Parameter	Type	Default	Description
name	string	"created_from_uniasset"	AudioClip name
stream	bool	true	Whether to create a streaming clip

Streaming (stream = true):

• Audio data is pulled on demand during playback
• Lower memory usage, suitable for long clips

Fully loaded (stream = false):

• Unity pulls the complete audio data during clip creation
• Better for short sound effects or repeated playback

AudioClip bgm = audio.ToAudioClip("BGM", stream: true);
AudioClip sfx = audio.ToAudioClip("Explosion", stream: false);

Lifetime

Unload

public void Unload()

Unloads the currently loaded audio data. You can call Load again afterward.

Dispose

public void Dispose()

Releases the underlying native resources. The instance should not be used afterward.

Examples

Load audio and play it

using Uniasset.Audio;

using var audio = new AudioAsset();
audio.Load("background.mp3");

AudioClip clip = audio.ToAudioClip("BGM");
audioSource.clip = clip;
audioSource.Play();

Read PCM data manually

using var audio = new AudioAsset();
audio.Load("music.flac", SampleFormat.Float);