Files
XCEngine/docs/api/resources/audio-loader/index.md
ssdfasd c2354530b9 docs: 新增 light-component 全部方法文档及更新其他模块
- components: 新增 light-component 全部12个方法文档
- resources: 更新 audio-loader, resource-file-system 文档
- rhi: 更新 opengl/fence 文档
2026-03-26 02:02:21 +08:00

57 lines
1.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# AudioLoader
## 命名空间
`XCEngine::Resources`
## 类型
类 (Class)
## 描述
音频资源加载器,负责从文件系统加载音频文件并转换为 `AudioClip` 资源。支持 WAV、OGG、MP3、FLAC、AIFF 等常见音频格式。
## 概述
`AudioLoader` 继承自 `IResourceLoader` 接口,实现音频资源的异步加载与格式解析。内部通过文件扩展名和文件头数据双重检测确定音频格式,确保加载结果的准确性。
## 公共方法表格
| 方法 | 返回值 | 描述 |
|------|--------|------|
| [AudioLoader](constructor.md) | - | 构造函数 |
| [~AudioLoader](destructor.md) | - | 析构函数 |
| `GetResourceType()` | `ResourceType` | 返回资源类型 `AudioClip`(继承自 IResourceLoader |
| [GetSupportedExtensions](get-supported-extensions.md) | `Array<String>` | 获取支持的扩展名列表 |
| [CanLoad](can-load.md) | `bool` | 检查是否能够加载指定路径的资源 |
| [Load](load.md) | `LoadResult` | 加载音频资源 |
| [GetDefaultSettings](get-default-settings.md) | `ImportSettings*` | 获取默认导入设置 |
## 使用示例
```cpp
#include <XCEngine/Resources/AudioClip/AudioLoader.h>
#include <XCEngine/Core/Asset/ResourceManager.h>
using namespace XCEngine::Resources;
// 通过 ResourceManager 加载音频
ResourceGUID guid = ResourceGUID::Generate("assets/audio/bgm_music.ogg");
LoadResult result = ResourceManager::Get().Load(guid, "assets/audio/bgm_music.ogg");
if (result.IsSuccess()) {
AudioClip* clip = result.GetResource<AudioClip>();
// 使用音频片段
}
```
## 相关文档
- [GetSupportedExtensions](get-supported-extensions.md) - 获取支持的音频格式
- [CanLoad](can-load.md) - 检查资源可加载性
- [Load](load.md) - 加载音频资源
- [GetDefaultSettings](get-default-settings.md) - 获取默认导入设置
- [IResourceLoader](../iloader/iloader.md) - 资源加载器基类
- [AudioClip](../audioclip/audioclip.md) - 音频资源类型