refactor api documentation structure
This commit is contained in:
@@ -0,0 +1,71 @@
|
||||
# AudioSourceComponent
|
||||
|
||||
**命名空间**: `XCEngine::Components`
|
||||
|
||||
**类型**: `class`
|
||||
|
||||
**头文件**: `XCEngine/Components/AudioSourceComponent.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Components` 子目录中的 `AudioSourceComponent` public API。
|
||||
|
||||
## 概述
|
||||
|
||||
`AudioSourceComponent.h` 是 `XCEngine/Components` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
|
||||
## 声明概览
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `AudioSourceComponent` | `class` | 继承自 `Component` 的公开声明。 |
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [AudioSourceComponent()](Constructor.md) | 构造对象。 |
|
||||
| [~AudioSourceComponent()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [Play](Play.md) | 公开方法,详见头文件声明。 |
|
||||
| [Pause](Pause.md) | 公开方法,详见头文件声明。 |
|
||||
| [Stop](Stop.md) | 公开方法,详见头文件声明。 |
|
||||
| [IsPlaying](IsPlaying.md) | 查询当前状态。 |
|
||||
| [IsPaused](IsPaused.md) | 查询当前状态。 |
|
||||
| [SetClip](SetClip.md) | 设置相关状态或配置。 |
|
||||
| [GetClip](GetClip.md) | 获取相关状态或对象。 |
|
||||
| [SetVolume](SetVolume.md) | 设置相关状态或配置。 |
|
||||
| [GetVolume](GetVolume.md) | 获取相关状态或对象。 |
|
||||
| [SetPitch](SetPitch.md) | 设置相关状态或配置。 |
|
||||
| [GetPitch](GetPitch.md) | 获取相关状态或对象。 |
|
||||
| [SetPan](SetPan.md) | 设置相关状态或配置。 |
|
||||
| [GetPan](GetPan.md) | 获取相关状态或对象。 |
|
||||
| [SetLooping](SetLooping.md) | 设置相关状态或配置。 |
|
||||
| [IsLooping](IsLooping.md) | 查询当前状态。 |
|
||||
| [SetSpatialize](SetSpatialize.md) | 设置相关状态或配置。 |
|
||||
| [IsSpatialize](IsSpatialize.md) | 查询当前状态。 |
|
||||
| [Set3DParams](Set3DParams.md) | 设置相关状态或配置。 |
|
||||
| [Get3DParams](Get3DParams.md) | 获取相关状态或对象。 |
|
||||
| [SetDopplerLevel](SetDopplerLevel.md) | 设置相关状态或配置。 |
|
||||
| [GetDopplerLevel](GetDopplerLevel.md) | 获取相关状态或对象。 |
|
||||
| [SetSpread](SetSpread.md) | 设置相关状态或配置。 |
|
||||
| [GetSpread](GetSpread.md) | 获取相关状态或对象。 |
|
||||
| [SetReverbZoneMix](SetReverbZoneMix.md) | 设置相关状态或配置。 |
|
||||
| [GetReverbZoneMix](GetReverbZoneMix.md) | 获取相关状态或对象。 |
|
||||
| [SetOutputMixer](SetOutputMixer.md) | 设置相关状态或配置。 |
|
||||
| [GetOutputMixer](GetOutputMixer.md) | 获取相关状态或对象。 |
|
||||
| [SetTime](SetTime.md) | 设置相关状态或配置。 |
|
||||
| [GetTime](GetTime.md) | 获取相关状态或对象。 |
|
||||
| [GetDuration](GetDuration.md) | 获取相关状态或对象。 |
|
||||
| [GetEnergy](GetEnergy.md) | 获取相关状态或对象。 |
|
||||
| [StartEnergyDetect](StartEnergyDetect.md) | 公开方法,详见头文件声明。 |
|
||||
| [StopEnergyDetect](StopEnergyDetect.md) | 公开方法,详见头文件声明。 |
|
||||
| [IsEnergyDetecting](IsEnergyDetecting.md) | 查询当前状态。 |
|
||||
| [Update](Update.md) | 更新运行时状态。 |
|
||||
| [OnEnable](OnEnable.md) | 公开方法,详见头文件声明。 |
|
||||
| [OnDisable](OnDisable.md) | 公开方法,详见头文件声明。 |
|
||||
| [OnDestroy](OnDestroy.md) | 公开方法,详见头文件声明。 |
|
||||
| [ProcessAudio](ProcessAudio.md) | 公开方法,详见头文件声明。 |
|
||||
| [GetName](GetName.md) | 获取相关状态或对象。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Components.md) - 返回 `Components` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
Reference in New Issue
Block a user