Skip to content

IAudioSource

InterfaceAudioToolAudioTool.Editor
public interface IAudioSource

Abstraction for an audio file source, allowing the Audio Tool to work with different sources (standalone files from disk, assets in packages, etc.)

string FileName { get; }

The display name of the audio file.

Returns

System.String — No return description is available.

bool IsInProject { get; }

Whether the source is already in the Unity project’s Assets folder.

Returns

System.Boolean — No return description is available.

string ProjectPath { get; }

The project-relative path if IsInProject is true (e.g., “Assets/Audio/sound.wav”).

Returns

System.String — No return description is available.

GetMaterializedPathAsync(CancellationToken)

Section titled “GetMaterializedPathAsync(CancellationToken)”
Task<string> GetMaterializedPathAsync(CancellationToken ct = default)

Gets a path to the materialized audio file on disk. For files already in the project, this returns the full path directly. For files in packages/archives, this extracts to a temporary location.

Parameters

Name Type Description
ct System.Threading.CancellationToken Cancellation token for async operations

Returns

System.Threading.Tasks.Task{System.String} — Full file system path to the audio file