43 lines
901 B
Markdown
43 lines
901 B
Markdown
|
# Stop
|
|||
|
|
|
|||
|
|
**所属类**: `AudioSourceComponent`
|
|||
|
|
|
|||
|
|
**头文件**: `XCEngine/Components/AudioSourceComponent.h`
|
|||
|
|
|
|||
|
|
**描述**: 停止音频播放。
|
|||
|
|
|
|||
|
|
## 函数签名
|
|||
|
|
|
|||
|
|
```cpp
|
|||
|
|
void Stop(Audio::StopMode mode = Audio::StopMode::Immediate);
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 参数
|
|||
|
|
|
|||
|
|
| 参数 | 类型 | 描述 |
|
|||
|
|
|------|------|------|
|
|||
|
|
| `mode` | `Audio::StopMode` | 停止模式，默认为 Immediate（立即停止） |
|
|||
|
|
|
|||
|
|
## 使用示例
|
|||
|
|
|
|||
|
|
```cpp
|
|||
|
|
#include <XCEngine/Components/AudioSourceComponent.h>
|
|||
|
|
#include <XCEngine/Audio/AudioTypes.h>
|
|||
|
|
|
|||
|
|
using namespace XCEngine::Components;
|
|||
|
|
|
|||
|
|
void StopAudio(AudioSourceComponent* source) {
|
|||
|
|
source->Stop(Audio::StopMode::Immediate);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
void FadeOutAndStop(AudioSourceComponent* source) {
|
|||
|
|
source->Stop(Audio::StopMode::FadeOut);
|
|||
|
|
}
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## 相关文档
|
|||
|
|
|
|||
|
|
- [AudioSourceComponent](./audio-source-component.md) - 音频源组件
|
|||
|
|
- [Play](./play.md) - 开始播放
|
|||
|
|
- [Pause](./pause.md) - 暂停播放
|