Files
XCEngine/docs/api/components/audio-source-component/stop.md
ssdfasd a1804f4cb0 docs: 更新 resources, rhi, scene 模块及新增 camera-component 方法文档
- resources: 更新 asyncloader, audioclip, mesh-import-settings, texture-loader 文档
- rhi: 更新 opengl render-target-view 文档
- components: 新增 camera-component 全部方法文档 (15个文件)
2026-03-26 02:00:45 +08:00

43 lines
895 B
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.
# 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) - 暂停播放